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)
987 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
989 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
992 * Get a label of an object
994 * @param obj The Elementary object
995 * @param part The text part name to get (NULL for the default label)
996 * @return text of the label or NULL for any error
998 * @note Elementary objects may have many labels (e.g. Action Slider)
1002 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1004 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
1007 * Set the text for an objects' part, marking it as translatable.
1009 * The string to set as @p text must be the original one. Do not pass the
1010 * return of @c gettext() here. Elementary will translate the string
1011 * internally and set it on the object using elm_object_text_part_set(),
1012 * also storing the original string so that it can be automatically
1013 * translated when the language is changed with elm_language_set().
1015 * The @p domain will be stored along to find the translation in the
1016 * correct catalog. It can be NULL, in which case it will use whatever
1017 * domain was set by the application with @c textdomain(). This is useful
1018 * in case you are building a library on top of Elementary that will have
1019 * its own translatable strings, that should not be mixed with those of
1020 * programs using the library.
1022 * @param obj The object containing the text part
1023 * @param part The name of the part to set
1024 * @param domain The translation domain to use
1025 * @param text The original, non-translated text to set
1029 EAPI void elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1031 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1033 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1036 * Gets the original string set as translatable for an object
1038 * When setting translated strings, the function elm_object_text_part_get()
1039 * will return the translation returned by @c gettext(). To get the
1040 * original string use this function.
1042 * @param obj The object
1043 * @param part The name of the part that was set
1045 * @return The original, untranslated string
1049 EAPI const char *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1051 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1054 * Set a content of an object
1056 * @param obj The Elementary object
1057 * @param part The content part name to set (NULL for the default content)
1058 * @param content The new content of the object
1060 * @note Elementary objects may have many contents
1064 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1066 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
1069 * Get a content of an object
1071 * @param obj The Elementary object
1072 * @param item The content part name to get (NULL for the default content)
1073 * @return content of the object or NULL for any error
1075 * @note Elementary objects may have many contents
1079 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1081 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
1084 * Unset a content of an object
1086 * @param obj The Elementary object
1087 * @param item The content part name to unset (NULL for the default content)
1089 * @note Elementary objects may have many contents
1093 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1095 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1098 * Get the widget object's handle which contains a given item
1100 * @param item The Elementary object item
1101 * @return The widget object
1103 * @note This returns the widget object itself that an item belongs to.
1107 EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1110 * Set a content of an object item
1112 * @param it The Elementary object item
1113 * @param part The content part name to set (NULL for the default content)
1114 * @param content The new content of the object item
1116 * @note Elementary object items may have many contents
1120 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1122 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1125 * Get a content of an object item
1127 * @param it The Elementary object item
1128 * @param part The content part name to unset (NULL for the default content)
1129 * @return content of the object item or NULL for any error
1131 * @note Elementary object items may have many contents
1135 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1137 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1140 * Unset a content of an object item
1142 * @param it The Elementary object item
1143 * @param part The content part name to unset (NULL for the default content)
1145 * @note Elementary object items may have many contents
1149 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1151 #define elm_object_item_content_unset(it) elm_object_item_content_part_unset((it), NULL)
1154 * Set a label of an object item
1156 * @param it The Elementary object item
1157 * @param part The text part name to set (NULL for the default label)
1158 * @param label The new text of the label
1160 * @note Elementary object items may have many labels
1164 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1166 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1169 * Get a label of an object item
1171 * @param it The Elementary object item
1172 * @param part The text part name to get (NULL for the default label)
1173 * @return text of the label or NULL for any error
1175 * @note Elementary object items may have many labels
1179 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1181 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1184 * Set the text to read out when in accessibility mode
1186 * @param obj The object which is to be described
1187 * @param txt The text that describes the widget to people with poor or no vision
1191 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1194 * Set the text to read out when in accessibility mode
1196 * @param it The object item which is to be described
1197 * @param txt The text that describes the widget to people with poor or no vision
1201 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1204 * Get the data associated with an object item
1205 * @param it The object item
1206 * @return The data associated with @p it
1210 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1213 * Set the data associated with an object item
1214 * @param it The object item
1215 * @param data The data to be associated with @p it
1219 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1222 * Send a signal to the edje object of the widget item.
1224 * This function sends a signal to the edje object of the obj item. An
1225 * edje program can respond to a signal by specifying matching
1226 * 'signal' and 'source' fields.
1228 * @param it The Elementary object item
1229 * @param emission The signal's name.
1230 * @param source The signal's source.
1233 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1240 * @defgroup Caches Caches
1242 * These are functions which let one fine-tune some cache values for
1243 * Elementary applications, thus allowing for performance adjustments.
1249 * @brief Flush all caches.
1251 * Frees all data that was in cache and is not currently being used to reduce
1252 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1253 * to calling all of the following functions:
1254 * @li edje_file_cache_flush()
1255 * @li edje_collection_cache_flush()
1256 * @li eet_clearcache()
1257 * @li evas_image_cache_flush()
1258 * @li evas_font_cache_flush()
1259 * @li evas_render_dump()
1260 * @note Evas caches are flushed for every canvas associated with a window.
1264 EAPI void elm_all_flush(void);
1267 * Get the configured cache flush interval time
1269 * This gets the globally configured cache flush interval time, in
1272 * @return The cache flush interval time
1275 * @see elm_all_flush()
1277 EAPI int elm_cache_flush_interval_get(void);
1280 * Set the configured cache flush interval time
1282 * This sets the globally configured cache flush interval time, in ticks
1284 * @param size The cache flush interval time
1287 * @see elm_all_flush()
1289 EAPI void elm_cache_flush_interval_set(int size);
1292 * Set the configured cache flush interval time for all applications on the
1295 * This sets the globally configured cache flush interval time -- in ticks
1296 * -- for all applications on the display.
1298 * @param size The cache flush interval time
1301 EAPI void elm_cache_flush_interval_all_set(int size);
1304 * Get the configured cache flush enabled state
1306 * This gets the globally configured cache flush state - if it is enabled
1307 * or not. When cache flushing is enabled, elementary will regularly
1308 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1309 * memory and allow usage to re-seed caches and data in memory where it
1310 * can do so. An idle application will thus minimise its memory usage as
1311 * data will be freed from memory and not be re-loaded as it is idle and
1312 * not rendering or doing anything graphically right now.
1314 * @return The cache flush state
1317 * @see elm_all_flush()
1319 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1322 * Set the configured cache flush enabled state
1324 * This sets the globally configured cache flush enabled state.
1326 * @param size The cache flush enabled state
1329 * @see elm_all_flush()
1331 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1334 * Set the configured cache flush enabled state for all applications on the
1337 * This sets the globally configured cache flush enabled state for all
1338 * applications on the display.
1340 * @param size The cache flush enabled state
1343 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1346 * Get the configured font cache size
1348 * This gets the globally configured font cache size, in bytes.
1350 * @return The font cache size
1353 EAPI int elm_font_cache_get(void);
1356 * Set the configured font cache size
1358 * This sets the globally configured font cache size, in bytes
1360 * @param size The font cache size
1363 EAPI void elm_font_cache_set(int size);
1366 * Set the configured font cache size for all applications on the
1369 * This sets the globally configured font cache size -- in bytes
1370 * -- for all applications on the display.
1372 * @param size The font cache size
1375 EAPI void elm_font_cache_all_set(int size);
1378 * Get the configured image cache size
1380 * This gets the globally configured image cache size, in bytes
1382 * @return The image cache size
1385 EAPI int elm_image_cache_get(void);
1388 * Set the configured image cache size
1390 * This sets the globally configured image cache size, in bytes
1392 * @param size The image cache size
1395 EAPI void elm_image_cache_set(int size);
1398 * Set the configured image cache size for all applications on the
1401 * This sets the globally configured image cache size -- in bytes
1402 * -- for all applications on the display.
1404 * @param size The image cache size
1407 EAPI void elm_image_cache_all_set(int size);
1410 * Get the configured edje file cache size.
1412 * This gets the globally configured edje file cache size, in number
1415 * @return The edje file cache size
1418 EAPI int elm_edje_file_cache_get(void);
1421 * Set the configured edje file cache size
1423 * This sets the globally configured edje file cache size, in number
1426 * @param size The edje file cache size
1429 EAPI void elm_edje_file_cache_set(int size);
1432 * Set the configured edje file cache size for all applications on the
1435 * This sets the globally configured edje file cache size -- in number
1436 * of files -- for all applications on the display.
1438 * @param size The edje file cache size
1441 EAPI void elm_edje_file_cache_all_set(int size);
1444 * Get the configured edje collections (groups) cache size.
1446 * This gets the globally configured edje collections cache size, in
1447 * number of collections.
1449 * @return The edje collections cache size
1452 EAPI int elm_edje_collection_cache_get(void);
1455 * Set the configured edje collections (groups) cache size
1457 * This sets the globally configured edje collections cache size, in
1458 * number of collections.
1460 * @param size The edje collections cache size
1463 EAPI void elm_edje_collection_cache_set(int size);
1466 * Set the configured edje collections (groups) cache size for all
1467 * applications on the display
1469 * This sets the globally configured edje collections cache size -- in
1470 * number of collections -- for all applications on the display.
1472 * @param size The edje collections cache size
1475 EAPI void elm_edje_collection_cache_all_set(int size);
1482 * @defgroup Scaling Widget Scaling
1484 * Different widgets can be scaled independently. These functions
1485 * allow you to manipulate this scaling on a per-widget basis. The
1486 * object and all its children get their scaling factors multiplied
1487 * by the scale factor set. This is multiplicative, in that if a
1488 * child also has a scale size set it is in turn multiplied by its
1489 * parent's scale size. @c 1.0 means ādon't scaleā, @c 2.0 is
1490 * double size, @c 0.5 is half, etc.
1492 * @ref general_functions_example_page "This" example contemplates
1493 * some of these functions.
1497 * Get the global scaling factor
1499 * This gets the globally configured scaling factor that is applied to all
1502 * @return The scaling factor
1505 EAPI double elm_scale_get(void);
1508 * Set the global scaling factor
1510 * This sets the globally configured scaling factor that is applied to all
1513 * @param scale The scaling factor to set
1516 EAPI void elm_scale_set(double scale);
1519 * Set the global scaling factor for all applications on the display
1521 * This sets the globally configured scaling factor that is applied to all
1522 * objects for all applications.
1523 * @param scale The scaling factor to set
1526 EAPI void elm_scale_all_set(double scale);
1529 * Set the scaling factor for a given Elementary object
1531 * @param obj The Elementary to operate on
1532 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1537 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1540 * Get the scaling factor for a given Elementary object
1542 * @param obj The object
1543 * @return The scaling factor set by elm_object_scale_set()
1547 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1550 * @defgroup Password_last_show Password last input show
1552 * Last show feature of password mode enables user to view
1553 * the last input entered for few seconds before masking it.
1554 * These functions allow to set this feature in password mode
1555 * of entry widget and also allow to manipulate the duration
1556 * for which the input has to be visible.
1562 * Get show last setting of password mode.
1564 * This gets the show last input setting of password mode which might be
1565 * enabled or disabled.
1567 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1569 * @ingroup Password_last_show
1571 EAPI Eina_Bool elm_password_show_last_get(void);
1574 * Set show last setting in password mode.
1576 * This enables or disables show last setting of password mode.
1578 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1579 * @see elm_password_show_last_timeout_set()
1580 * @ingroup Password_last_show
1582 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1585 * Get's the timeout value in last show password mode.
1587 * This gets the time out value for which the last input entered in password
1588 * mode will be visible.
1590 * @return The timeout value of last show password mode.
1591 * @ingroup Password_last_show
1593 EAPI double elm_password_show_last_timeout_get(void);
1596 * Set's the timeout value in last show password mode.
1598 * This sets the time out value for which the last input entered in password
1599 * mode will be visible.
1601 * @param password_show_last_timeout The timeout value.
1602 * @see elm_password_show_last_set()
1603 * @ingroup Password_last_show
1605 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1612 * @defgroup UI-Mirroring Selective Widget mirroring
1614 * These functions allow you to set ui-mirroring on specific
1615 * widgets or the whole interface. Widgets can be in one of two
1616 * modes, automatic and manual. Automatic means they'll be changed
1617 * according to the system mirroring mode and manual means only
1618 * explicit changes will matter. You are not supposed to change
1619 * mirroring state of a widget set to automatic, will mostly work,
1620 * but the behavior is not really defined.
1625 EAPI Eina_Bool elm_mirrored_get(void);
1626 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1629 * Get the system mirrored mode. This determines the default mirrored mode
1632 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1634 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1637 * Set the system mirrored mode. This determines the default mirrored mode
1640 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1642 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1645 * Returns the widget's mirrored mode setting.
1647 * @param obj The widget.
1648 * @return mirrored mode setting of the object.
1651 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1654 * Sets the widget's mirrored mode setting.
1655 * When widget in automatic mode, it follows the system mirrored mode set by
1656 * elm_mirrored_set().
1657 * @param obj The widget.
1658 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1660 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1667 * Set the style to use by a widget
1669 * Sets the style name that will define the appearance of a widget. Styles
1670 * vary from widget to widget and may also be defined by other themes
1671 * by means of extensions and overlays.
1673 * @param obj The Elementary widget to style
1674 * @param style The style name to use
1676 * @see elm_theme_extension_add()
1677 * @see elm_theme_extension_del()
1678 * @see elm_theme_overlay_add()
1679 * @see elm_theme_overlay_del()
1683 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1685 * Get the style used by the widget
1687 * This gets the style being used for that widget. Note that the string
1688 * pointer is only valid as longas the object is valid and the style doesn't
1691 * @param obj The Elementary widget to query for its style
1692 * @return The style name used
1694 * @see elm_object_style_set()
1698 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1701 * @defgroup Styles Styles
1703 * Widgets can have different styles of look. These generic API's
1704 * set styles of widgets, if they support them (and if the theme(s)
1707 * @ref general_functions_example_page "This" example contemplates
1708 * some of these functions.
1712 * Set the disabled state of an Elementary object.
1714 * @param obj The Elementary object to operate on
1715 * @param disabled The state to put in in: @c EINA_TRUE for
1716 * disabled, @c EINA_FALSE for enabled
1718 * Elementary objects can be @b disabled, in which state they won't
1719 * receive input and, in general, will be themed differently from
1720 * their normal state, usually greyed out. Useful for contexts
1721 * where you don't want your users to interact with some of the
1722 * parts of you interface.
1724 * This sets the state for the widget, either disabling it or
1729 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1732 * Get the disabled state of an Elementary object.
1734 * @param obj The Elementary object to operate on
1735 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1736 * if it's enabled (or on errors)
1738 * This gets the state of the widget, which might be enabled or disabled.
1742 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1745 * @defgroup WidgetNavigation Widget Tree Navigation.
1747 * How to check if an Evas Object is an Elementary widget? How to
1748 * get the first elementary widget that is parent of the given
1749 * object? These are all covered in widget tree navigation.
1751 * @ref general_functions_example_page "This" example contemplates
1752 * some of these functions.
1756 * Check if the given Evas Object is an Elementary widget.
1758 * @param obj the object to query.
1759 * @return @c EINA_TRUE if it is an elementary widget variant,
1760 * @c EINA_FALSE otherwise
1761 * @ingroup WidgetNavigation
1763 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1766 * Get the first parent of the given object that is an Elementary
1769 * @param obj the Elementary object to query parent from.
1770 * @return the parent object that is an Elementary widget, or @c
1771 * NULL, if it was not found.
1773 * Use this to query for an object's parent widget.
1775 * @note Most of Elementary users wouldn't be mixing non-Elementary
1776 * smart objects in the objects tree of an application, as this is
1777 * an advanced usage of Elementary with Evas. So, except for the
1778 * application's window, which is the root of that tree, all other
1779 * objects would have valid Elementary widget parents.
1781 * @ingroup WidgetNavigation
1783 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1786 * Get the top level parent of an Elementary widget.
1788 * @param obj The object to query.
1789 * @return The top level Elementary widget, or @c NULL if parent cannot be
1791 * @ingroup WidgetNavigation
1793 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1796 * Get the string that represents this Elementary widget.
1798 * @note Elementary is weird and exposes itself as a single
1799 * Evas_Object_Smart_Class of type "elm_widget", so
1800 * evas_object_type_get() always return that, making debug and
1801 * language bindings hard. This function tries to mitigate this
1802 * problem, but the solution is to change Elementary to use
1803 * proper inheritance.
1805 * @param obj the object to query.
1806 * @return Elementary widget name, or @c NULL if not a valid widget.
1807 * @ingroup WidgetNavigation
1809 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1812 * @defgroup Config Elementary Config
1814 * Elementary configuration is formed by a set options bounded to a
1815 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1816 * "finger size", etc. These are functions with which one syncronizes
1817 * changes made to those values to the configuration storing files, de
1818 * facto. You most probably don't want to use the functions in this
1819 * group unlees you're writing an elementary configuration manager.
1825 * Save back Elementary's configuration, so that it will persist on
1828 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1831 * This function will take effect -- thus, do I/O -- immediately. Use
1832 * it when you want to apply all configuration changes at once. The
1833 * current configuration set will get saved onto the current profile
1834 * configuration file.
1837 EAPI Eina_Bool elm_config_save(void);
1840 * Reload Elementary's configuration, bounded to current selected
1843 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1846 * Useful when you want to force reloading of configuration values for
1847 * a profile. If one removes user custom configuration directories,
1848 * for example, it will force a reload with system values insted.
1851 EAPI void elm_config_reload(void);
1858 * @defgroup Profile Elementary Profile
1860 * Profiles are pre-set options that affect the whole look-and-feel of
1861 * Elementary-based applications. There are, for example, profiles
1862 * aimed at desktop computer applications and others aimed at mobile,
1863 * touchscreen-based ones. You most probably don't want to use the
1864 * functions in this group unlees you're writing an elementary
1865 * configuration manager.
1871 * Get Elementary's profile in use.
1873 * This gets the global profile that is applied to all Elementary
1876 * @return The profile's name
1879 EAPI const char *elm_profile_current_get(void);
1882 * Get an Elementary's profile directory path in the filesystem. One
1883 * may want to fetch a system profile's dir or an user one (fetched
1886 * @param profile The profile's name
1887 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1888 * or a system one (@c EINA_FALSE)
1889 * @return The profile's directory path.
1892 * @note You must free it with elm_profile_dir_free().
1894 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1897 * Free an Elementary's profile directory path, as returned by
1898 * elm_profile_dir_get().
1900 * @param p_dir The profile's path
1904 EAPI void elm_profile_dir_free(const char *p_dir);
1907 * Get Elementary's list of available profiles.
1909 * @return The profiles list. List node data are the profile name
1913 * @note One must free this list, after usage, with the function
1914 * elm_profile_list_free().
1916 EAPI Eina_List *elm_profile_list_get(void);
1919 * Free Elementary's list of available profiles.
1921 * @param l The profiles list, as returned by elm_profile_list_get().
1925 EAPI void elm_profile_list_free(Eina_List *l);
1928 * Set Elementary's profile.
1930 * This sets the global profile that is applied to Elementary
1931 * applications. Just the process the call comes from will be
1934 * @param profile The profile's name
1938 EAPI void elm_profile_set(const char *profile);
1941 * Set Elementary's profile.
1943 * This sets the global profile that is applied to all Elementary
1944 * applications. All running Elementary windows will be affected.
1946 * @param profile The profile's name
1950 EAPI void elm_profile_all_set(const char *profile);
1957 * @defgroup Engine Elementary Engine
1959 * These are functions setting and querying which rendering engine
1960 * Elementary will use for drawing its windows' pixels.
1962 * The following are the available engines:
1963 * @li "software_x11"
1966 * @li "software_16_x11"
1967 * @li "software_8_x11"
1970 * @li "software_gdi"
1971 * @li "software_16_wince_gdi"
1973 * @li "software_16_sdl"
1977 * @li "opengl_cocoa"
1984 * @brief Get Elementary's rendering engine in use.
1986 * @return The rendering engine's name
1987 * @note there's no need to free the returned string, here.
1989 * This gets the global rendering engine that is applied to all Elementary
1992 * @see elm_engine_set()
1994 EAPI const char *elm_engine_current_get(void);
1997 * @brief Set Elementary's rendering engine for use.
1999 * @param engine The rendering engine's name
2001 * This sets global rendering engine that is applied to all Elementary
2002 * applications. Note that it will take effect only to Elementary windows
2003 * created after this is called.
2005 * @see elm_win_add()
2007 EAPI void elm_engine_set(const char *engine);
2014 * @defgroup Fonts Elementary Fonts
2016 * These are functions dealing with font rendering, selection and the
2017 * like for Elementary applications. One might fetch which system
2018 * fonts are there to use and set custom fonts for individual classes
2019 * of UI items containing text (text classes).
2024 typedef struct _Elm_Text_Class
2030 typedef struct _Elm_Font_Overlay
2032 const char *text_class;
2034 Evas_Font_Size size;
2037 typedef struct _Elm_Font_Properties
2041 } Elm_Font_Properties;
2044 * Get Elementary's list of supported text classes.
2046 * @return The text classes list, with @c Elm_Text_Class blobs as data.
2049 * Release the list with elm_text_classes_list_free().
2051 EAPI const Eina_List *elm_text_classes_list_get(void);
2054 * Free Elementary's list of supported text classes.
2058 * @see elm_text_classes_list_get().
2060 EAPI void elm_text_classes_list_free(const Eina_List *list);
2063 * Get Elementary's list of font overlays, set with
2064 * elm_font_overlay_set().
2066 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2071 * For each text class, one can set a <b>font overlay</b> for it,
2072 * overriding the default font properties for that class coming from
2073 * the theme in use. There is no need to free this list.
2075 * @see elm_font_overlay_set() and elm_font_overlay_unset().
2077 EAPI const Eina_List *elm_font_overlay_list_get(void);
2080 * Set a font overlay for a given Elementary text class.
2082 * @param text_class Text class name
2083 * @param font Font name and style string
2084 * @param size Font size
2088 * @p font has to be in the format returned by
2089 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2090 * and elm_font_overlay_unset().
2092 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2095 * Unset a font overlay for a given Elementary text class.
2097 * @param text_class Text class name
2101 * This will bring back text elements belonging to text class
2102 * @p text_class back to their default font settings.
2104 EAPI void elm_font_overlay_unset(const char *text_class);
2107 * Apply the changes made with elm_font_overlay_set() and
2108 * elm_font_overlay_unset() on the current Elementary window.
2112 * This applies all font overlays set to all objects in the UI.
2114 EAPI void elm_font_overlay_apply(void);
2117 * Apply the changes made with elm_font_overlay_set() and
2118 * elm_font_overlay_unset() on all Elementary application windows.
2122 * This applies all font overlays set to all objects in the UI.
2124 EAPI void elm_font_overlay_all_apply(void);
2127 * Translate a font (family) name string in fontconfig's font names
2128 * syntax into an @c Elm_Font_Properties struct.
2130 * @param font The font name and styles string
2131 * @return the font properties struct
2135 * @note The reverse translation can be achived with
2136 * elm_font_fontconfig_name_get(), for one style only (single font
2137 * instance, not family).
2139 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2142 * Free font properties return by elm_font_properties_get().
2144 * @param efp the font properties struct
2148 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2151 * Translate a font name, bound to a style, into fontconfig's font names
2154 * @param name The font (family) name
2155 * @param style The given style (may be @c NULL)
2157 * @return the font name and style string
2161 * @note The reverse translation can be achived with
2162 * elm_font_properties_get(), for one style only (single font
2163 * instance, not family).
2165 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2168 * Free the font string return by elm_font_fontconfig_name_get().
2170 * @param efp the font properties struct
2174 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2177 * Create a font hash table of available system fonts.
2179 * One must call it with @p list being the return value of
2180 * evas_font_available_list(). The hash will be indexed by font
2181 * (family) names, being its values @c Elm_Font_Properties blobs.
2183 * @param list The list of available system fonts, as returned by
2184 * evas_font_available_list().
2185 * @return the font hash.
2189 * @note The user is supposed to get it populated at least with 3
2190 * default font families (Sans, Serif, Monospace), which should be
2191 * present on most systems.
2193 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2196 * Free the hash return by elm_font_available_hash_add().
2198 * @param hash the hash to be freed.
2202 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2209 * @defgroup Fingers Fingers
2211 * Elementary is designed to be finger-friendly for touchscreens,
2212 * and so in addition to scaling for display resolution, it can
2213 * also scale based on finger "resolution" (or size). You can then
2214 * customize the granularity of the areas meant to receive clicks
2217 * Different profiles may have pre-set values for finger sizes.
2219 * @ref general_functions_example_page "This" example contemplates
2220 * some of these functions.
2226 * Get the configured "finger size"
2228 * @return The finger size
2230 * This gets the globally configured finger size, <b>in pixels</b>
2234 EAPI Evas_Coord elm_finger_size_get(void);
2237 * Set the configured finger size
2239 * This sets the globally configured finger size in pixels
2241 * @param size The finger size
2244 EAPI void elm_finger_size_set(Evas_Coord size);
2247 * Set the configured finger size for all applications on the display
2249 * This sets the globally configured finger size in pixels for all
2250 * applications on the display
2252 * @param size The finger size
2255 EAPI void elm_finger_size_all_set(Evas_Coord size);
2262 * @defgroup Focus Focus
2264 * An Elementary application has, at all times, one (and only one)
2265 * @b focused object. This is what determines where the input
2266 * events go to within the application's window. Also, focused
2267 * objects can be decorated differently, in order to signal to the
2268 * user where the input is, at a given moment.
2270 * Elementary applications also have the concept of <b>focus
2271 * chain</b>: one can cycle through all the windows' focusable
2272 * objects by input (tab key) or programmatically. The default
2273 * focus chain for an application is the one define by the order in
2274 * which the widgets where added in code. One will cycle through
2275 * top level widgets, and, for each one containg sub-objects, cycle
2276 * through them all, before returning to the level
2277 * above. Elementary also allows one to set @b custom focus chains
2278 * for their applications.
2280 * Besides the focused decoration a widget may exhibit, when it
2281 * gets focus, Elementary has a @b global focus highlight object
2282 * that can be enabled for a window. If one chooses to do so, this
2283 * extra highlight effect will surround the current focused object,
2286 * @note Some Elementary widgets are @b unfocusable, after
2287 * creation, by their very nature: they are not meant to be
2288 * interacted with input events, but are there just for visual
2291 * @ref general_functions_example_page "This" example contemplates
2292 * some of these functions.
2296 * Get the enable status of the focus highlight
2298 * This gets whether the highlight on focused objects is enabled or not
2301 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2304 * Set the enable status of the focus highlight
2306 * Set whether to show or not the highlight on focused objects
2307 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2310 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2313 * Get the enable status of the highlight animation
2315 * Get whether the focus highlight, if enabled, will animate its switch from
2316 * one object to the next
2319 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2322 * Set the enable status of the highlight animation
2324 * Set whether the focus highlight, if enabled, will animate its switch from
2325 * one object to the next
2326 * @param animate Enable animation if EINA_TRUE, disable otherwise
2329 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2332 * Get the whether an Elementary object has the focus or not.
2334 * @param obj The Elementary object to get the information from
2335 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2336 * not (and on errors).
2338 * @see elm_object_focus_set()
2342 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2345 * Set/unset focus to a given Elementary object.
2347 * @param obj The Elementary object to operate on.
2348 * @param enable @c EINA_TRUE Set focus to a given object,
2349 * @c EINA_FALSE Unset focus to a given object.
2351 * @note When you set focus to this object, if it can handle focus, will
2352 * take the focus away from the one who had it previously and will, for
2353 * now on, be the one receiving input events. Unsetting focus will remove
2354 * the focus from @p obj, passing it back to the previous element in the
2357 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2361 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2364 * Make a given Elementary object the focused one.
2366 * @param obj The Elementary object to make focused.
2368 * @note This object, if it can handle focus, will take the focus
2369 * away from the one who had it previously and will, for now on, be
2370 * the one receiving input events.
2372 * @see elm_object_focus_get()
2373 * @deprecated use elm_object_focus_set() instead.
2377 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2380 * Remove the focus from an Elementary object
2382 * @param obj The Elementary to take focus from
2384 * This removes the focus from @p obj, passing it back to the
2385 * previous element in the focus chain list.
2387 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2388 * @deprecated use elm_object_focus_set() instead.
2392 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2395 * Set the ability for an Element object to be focused
2397 * @param obj The Elementary object to operate on
2398 * @param enable @c EINA_TRUE if the object can be focused, @c
2399 * EINA_FALSE if not (and on errors)
2401 * This sets whether the object @p obj is able to take focus or
2402 * not. Unfocusable objects do nothing when programmatically
2403 * focused, being the nearest focusable parent object the one
2404 * really getting focus. Also, when they receive mouse input, they
2405 * will get the event, but not take away the focus from where it
2410 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2413 * Get whether an Elementary object is focusable or not
2415 * @param obj The Elementary object to operate on
2416 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2417 * EINA_FALSE if not (and on errors)
2419 * @note Objects which are meant to be interacted with by input
2420 * events are created able to be focused, by default. All the
2425 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2428 * Set custom focus chain.
2430 * This function overwrites any previous custom focus chain within
2431 * the list of objects. The previous list will be deleted and this list
2432 * will be managed by elementary. After it is set, don't modify it.
2434 * @note On focus cycle, only will be evaluated children of this container.
2436 * @param obj The container object
2437 * @param objs Chain of objects to pass focus
2440 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2443 * Unset a custom focus chain on a given Elementary widget
2445 * @param obj The container object to remove focus chain from
2447 * Any focus chain previously set on @p obj (for its child objects)
2448 * is removed entirely after this call.
2452 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2455 * Get custom focus chain
2457 * @param obj The container object
2460 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2463 * Append object to custom focus chain.
2465 * @note If relative_child equal to NULL or not in custom chain, the object
2466 * will be added in end.
2468 * @note On focus cycle, only will be evaluated children of this container.
2470 * @param obj The container object
2471 * @param child The child to be added in custom chain
2472 * @param relative_child The relative object to position the child
2475 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2478 * Prepend object to custom focus chain.
2480 * @note If relative_child equal to NULL or not in custom chain, the object
2481 * will be added in begin.
2483 * @note On focus cycle, only will be evaluated children of this container.
2485 * @param obj The container object
2486 * @param child The child to be added in custom chain
2487 * @param relative_child The relative object to position the child
2490 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2493 * Give focus to next object in object tree.
2495 * Give focus to next object in focus chain of one object sub-tree.
2496 * If the last object of chain already have focus, the focus will go to the
2497 * first object of chain.
2499 * @param obj The object root of sub-tree
2500 * @param dir Direction to cycle the focus
2504 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2507 * Give focus to near object in one direction.
2509 * Give focus to near object in direction of one object.
2510 * If none focusable object in given direction, the focus will not change.
2512 * @param obj The reference object
2513 * @param x Horizontal component of direction to focus
2514 * @param y Vertical component of direction to focus
2518 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2521 * Make the elementary object and its children to be unfocusable
2524 * @param obj The Elementary object to operate on
2525 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2526 * @c EINA_FALSE for focusable.
2528 * This sets whether the object @p obj and its children objects
2529 * are able to take focus or not. If the tree is set as unfocusable,
2530 * newest focused object which is not in this tree will get focus.
2531 * This API can be helpful for an object to be deleted.
2532 * When an object will be deleted soon, it and its children may not
2533 * want to get focus (by focus reverting or by other focus controls).
2534 * Then, just use this API before deleting.
2536 * @see elm_object_tree_unfocusable_get()
2540 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2543 * Get whether an Elementary object and its children are unfocusable or not.
2545 * @param obj The Elementary object to get the information from
2546 * @return @c EINA_TRUE, if the tree is unfocussable,
2547 * @c EINA_FALSE if not (and on errors).
2549 * @see elm_object_tree_unfocusable_set()
2553 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2556 * @defgroup Scrolling Scrolling
2558 * These are functions setting how scrollable views in Elementary
2559 * widgets should behave on user interaction.
2565 * Get whether scrollers should bounce when they reach their
2566 * viewport's edge during a scroll.
2568 * @return the thumb scroll bouncing state
2570 * This is the default behavior for touch screens, in general.
2571 * @ingroup Scrolling
2573 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2576 * Set whether scrollers should bounce when they reach their
2577 * viewport's edge during a scroll.
2579 * @param enabled the thumb scroll bouncing state
2581 * @see elm_thumbscroll_bounce_enabled_get()
2582 * @ingroup Scrolling
2584 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2587 * Set whether scrollers should bounce when they reach their
2588 * viewport's edge during a scroll, for all Elementary application
2591 * @param enabled the thumb scroll bouncing state
2593 * @see elm_thumbscroll_bounce_enabled_get()
2594 * @ingroup Scrolling
2596 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2599 * Get the amount of inertia a scroller will impose at bounce
2602 * @return the thumb scroll bounce friction
2604 * @ingroup Scrolling
2606 EAPI double elm_scroll_bounce_friction_get(void);
2609 * Set the amount of inertia a scroller will impose at bounce
2612 * @param friction the thumb scroll bounce friction
2614 * @see elm_thumbscroll_bounce_friction_get()
2615 * @ingroup Scrolling
2617 EAPI void elm_scroll_bounce_friction_set(double friction);
2620 * Set the amount of inertia a scroller will impose at bounce
2621 * animations, for all Elementary application windows.
2623 * @param friction the thumb scroll bounce friction
2625 * @see elm_thumbscroll_bounce_friction_get()
2626 * @ingroup Scrolling
2628 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2631 * Get the amount of inertia a <b>paged</b> scroller will impose at
2632 * page fitting animations.
2634 * @return the page scroll friction
2636 * @ingroup Scrolling
2638 EAPI double elm_scroll_page_scroll_friction_get(void);
2641 * Set the amount of inertia a <b>paged</b> scroller will impose at
2642 * page fitting animations.
2644 * @param friction the page scroll friction
2646 * @see elm_thumbscroll_page_scroll_friction_get()
2647 * @ingroup Scrolling
2649 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2652 * Set the amount of inertia a <b>paged</b> scroller will impose at
2653 * page fitting animations, for all Elementary application windows.
2655 * @param friction the page scroll friction
2657 * @see elm_thumbscroll_page_scroll_friction_get()
2658 * @ingroup Scrolling
2660 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2663 * Get the amount of inertia a scroller will impose at region bring
2666 * @return the bring in scroll friction
2668 * @ingroup Scrolling
2670 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2673 * Set the amount of inertia a scroller will impose at region bring
2676 * @param friction the bring in scroll friction
2678 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2679 * @ingroup Scrolling
2681 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2684 * Set the amount of inertia a scroller will impose at region bring
2685 * animations, for all Elementary application windows.
2687 * @param friction the bring in scroll friction
2689 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2690 * @ingroup Scrolling
2692 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2695 * Get the amount of inertia scrollers will impose at animations
2696 * triggered by Elementary widgets' zooming API.
2698 * @return the zoom friction
2700 * @ingroup Scrolling
2702 EAPI double elm_scroll_zoom_friction_get(void);
2705 * Set the amount of inertia scrollers will impose at animations
2706 * triggered by Elementary widgets' zooming API.
2708 * @param friction the zoom friction
2710 * @see elm_thumbscroll_zoom_friction_get()
2711 * @ingroup Scrolling
2713 EAPI void elm_scroll_zoom_friction_set(double friction);
2716 * Set the amount of inertia scrollers will impose at animations
2717 * triggered by Elementary widgets' zooming API, for all Elementary
2718 * application windows.
2720 * @param friction the zoom friction
2722 * @see elm_thumbscroll_zoom_friction_get()
2723 * @ingroup Scrolling
2725 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2728 * Get whether scrollers should be draggable from any point in their
2731 * @return the thumb scroll state
2733 * @note This is the default behavior for touch screens, in general.
2734 * @note All other functions namespaced with "thumbscroll" will only
2735 * have effect if this mode is enabled.
2737 * @ingroup Scrolling
2739 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2742 * Set whether scrollers should be draggable from any point in their
2745 * @param enabled the thumb scroll state
2747 * @see elm_thumbscroll_enabled_get()
2748 * @ingroup Scrolling
2750 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2753 * Set whether scrollers should be draggable from any point in their
2754 * views, for all Elementary application windows.
2756 * @param enabled the thumb scroll state
2758 * @see elm_thumbscroll_enabled_get()
2759 * @ingroup Scrolling
2761 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2764 * Get the number of pixels one should travel while dragging a
2765 * scroller's view to actually trigger scrolling.
2767 * @return the thumb scroll threshould
2769 * One would use higher values for touch screens, in general, because
2770 * of their inherent imprecision.
2771 * @ingroup Scrolling
2773 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2776 * Set the number of pixels one should travel while dragging a
2777 * scroller's view to actually trigger scrolling.
2779 * @param threshold the thumb scroll threshould
2781 * @see elm_thumbscroll_threshould_get()
2782 * @ingroup Scrolling
2784 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2787 * Set the number of pixels one should travel while dragging a
2788 * scroller's view to actually trigger scrolling, for all Elementary
2789 * application windows.
2791 * @param threshold the thumb scroll threshould
2793 * @see elm_thumbscroll_threshould_get()
2794 * @ingroup Scrolling
2796 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2799 * Get the minimum speed of mouse cursor movement which will trigger
2800 * list self scrolling animation after a mouse up event
2803 * @return the thumb scroll momentum threshould
2805 * @ingroup Scrolling
2807 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2810 * Set the minimum speed of mouse cursor movement which will trigger
2811 * list self scrolling animation after a mouse up event
2814 * @param threshold the thumb scroll momentum threshould
2816 * @see elm_thumbscroll_momentum_threshould_get()
2817 * @ingroup Scrolling
2819 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2822 * Set the minimum speed of mouse cursor movement which will trigger
2823 * list self scrolling animation after a mouse up event
2824 * (pixels/second), for all Elementary application windows.
2826 * @param threshold the thumb scroll momentum threshould
2828 * @see elm_thumbscroll_momentum_threshould_get()
2829 * @ingroup Scrolling
2831 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2834 * Get the amount of inertia a scroller will impose at self scrolling
2837 * @return the thumb scroll friction
2839 * @ingroup Scrolling
2841 EAPI double elm_scroll_thumbscroll_friction_get(void);
2844 * Set the amount of inertia a scroller will impose at self scrolling
2847 * @param friction the thumb scroll friction
2849 * @see elm_thumbscroll_friction_get()
2850 * @ingroup Scrolling
2852 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
2855 * Set the amount of inertia a scroller will impose at self scrolling
2856 * animations, for all Elementary application windows.
2858 * @param friction the thumb scroll friction
2860 * @see elm_thumbscroll_friction_get()
2861 * @ingroup Scrolling
2863 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
2866 * Get the amount of lag between your actual mouse cursor dragging
2867 * movement and a scroller's view movement itself, while pushing it
2868 * into bounce state manually.
2870 * @return the thumb scroll border friction
2872 * @ingroup Scrolling
2874 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2877 * Set the amount of lag between your actual mouse cursor dragging
2878 * movement and a scroller's view movement itself, while pushing it
2879 * into bounce state manually.
2881 * @param friction the thumb scroll border friction. @c 0.0 for
2882 * perfect synchrony between two movements, @c 1.0 for maximum
2885 * @see elm_thumbscroll_border_friction_get()
2886 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2888 * @ingroup Scrolling
2890 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
2893 * Set the amount of lag between your actual mouse cursor dragging
2894 * movement and a scroller's view movement itself, while pushing it
2895 * into bounce state manually, for all Elementary application windows.
2897 * @param friction the thumb scroll border friction. @c 0.0 for
2898 * perfect synchrony between two movements, @c 1.0 for maximum
2901 * @see elm_thumbscroll_border_friction_get()
2902 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2904 * @ingroup Scrolling
2906 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
2909 * Get the sensitivity amount which is be multiplied by the length of
2912 * @return the thumb scroll sensitivity friction
2914 * @ingroup Scrolling
2916 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
2919 * Set the sensitivity amount which is be multiplied by the length of
2922 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2923 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2926 * @see elm_thumbscroll_sensitivity_friction_get()
2927 * @note parameter value will get bound to 0.1 - 1.0 interval, always
2929 * @ingroup Scrolling
2931 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
2934 * Set the sensitivity amount which is be multiplied by the length of
2935 * mouse dragging, for all Elementary application windows.
2937 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2938 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2941 * @see elm_thumbscroll_sensitivity_friction_get()
2942 * @note parameter value will get bound to 0.1 - 1.0 interval, always
2944 * @ingroup Scrolling
2946 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
2953 * @defgroup Scrollhints Scrollhints
2955 * Objects when inside a scroller can scroll, but this may not always be
2956 * desirable in certain situations. This allows an object to hint to itself
2957 * and parents to "not scroll" in one of 2 ways. If any child object of a
2958 * scroller has pushed a scroll freeze or hold then it affects all parent
2959 * scrollers until all children have released them.
2961 * 1. To hold on scrolling. This means just flicking and dragging may no
2962 * longer scroll, but pressing/dragging near an edge of the scroller will
2963 * still scroll. This is automatically used by the entry object when
2966 * 2. To totally freeze scrolling. This means it stops. until
2973 * Push the scroll hold by 1
2975 * This increments the scroll hold count by one. If it is more than 0 it will
2976 * take effect on the parents of the indicated object.
2978 * @param obj The object
2979 * @ingroup Scrollhints
2981 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2984 * Pop the scroll hold by 1
2986 * This decrements the scroll hold count by one. If it is more than 0 it will
2987 * take effect on the parents of the indicated object.
2989 * @param obj The object
2990 * @ingroup Scrollhints
2992 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2995 * Push the scroll freeze by 1
2997 * This increments the scroll freeze count by one. If it is more
2998 * than 0 it will take effect on the parents of the indicated
3001 * @param obj The object
3002 * @ingroup Scrollhints
3004 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3007 * Pop the scroll freeze by 1
3009 * This decrements the scroll freeze count by one. If it is more
3010 * than 0 it will take effect on the parents of the indicated
3013 * @param obj The object
3014 * @ingroup Scrollhints
3016 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3019 * Lock the scrolling of the given widget (and thus all parents)
3021 * This locks the given object from scrolling in the X axis (and implicitly
3022 * also locks all parent scrollers too from doing the same).
3024 * @param obj The object
3025 * @param lock The lock state (1 == locked, 0 == unlocked)
3026 * @ingroup Scrollhints
3028 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3031 * Lock the scrolling of the given widget (and thus all parents)
3033 * This locks the given object from scrolling in the Y axis (and implicitly
3034 * also locks all parent scrollers too from doing the same).
3036 * @param obj The object
3037 * @param lock The lock state (1 == locked, 0 == unlocked)
3038 * @ingroup Scrollhints
3040 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3043 * Get the scrolling lock of the given widget
3045 * This gets the lock for X axis scrolling.
3047 * @param obj The object
3048 * @ingroup Scrollhints
3050 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3053 * Get the scrolling lock of the given widget
3055 * This gets the lock for X axis scrolling.
3057 * @param obj The object
3058 * @ingroup Scrollhints
3060 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3067 * Send a signal to the widget edje object.
3069 * This function sends a signal to the edje object of the obj. An
3070 * edje program can respond to a signal by specifying matching
3071 * 'signal' and 'source' fields.
3073 * @param obj The object
3074 * @param emission The signal's name.
3075 * @param source The signal's source.
3078 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3081 * Add a callback for a signal emitted by widget edje object.
3083 * This function connects a callback function to a signal emitted by the
3084 * edje object of the obj.
3085 * Globs can occur in either the emission or source name.
3087 * @param obj The object
3088 * @param emission The signal's name.
3089 * @param source The signal's source.
3090 * @param func The callback function to be executed when the signal is
3092 * @param data A pointer to data to pass in to the callback function.
3095 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);
3098 * Remove a signal-triggered callback from a widget edje object.
3100 * This function removes a callback, previoulsy attached to a
3101 * signal emitted by the edje object of the obj. The parameters
3102 * emission, source and func must match exactly those passed to a
3103 * previous call to elm_object_signal_callback_add(). The data
3104 * pointer that was passed to this call will be returned.
3106 * @param obj The object
3107 * @param emission The signal's name.
3108 * @param source The signal's source.
3109 * @param func The callback function to be executed when the signal is
3111 * @return The data pointer
3114 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);
3117 * Add a callback for input events (key up, key down, mouse wheel)
3118 * on a given Elementary widget
3120 * @param obj The widget to add an event callback on
3121 * @param func The callback function to be executed when the event
3123 * @param data Data to pass in to @p func
3125 * Every widget in an Elementary interface set to receive focus,
3126 * with elm_object_focus_allow_set(), will propagate @b all of its
3127 * key up, key down and mouse wheel input events up to its parent
3128 * object, and so on. All of the focusable ones in this chain which
3129 * had an event callback set, with this call, will be able to treat
3130 * those events. There are two ways of making the propagation of
3131 * these event upwards in the tree of widgets to @b cease:
3132 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3133 * the event was @b not processed, so the propagation will go on.
3134 * - The @c event_info pointer passed to @p func will contain the
3135 * event's structure and, if you OR its @c event_flags inner
3136 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3137 * one has already handled it, thus killing the event's
3140 * @note Your event callback will be issued on those events taking
3141 * place only if no other child widget of @obj has consumed the
3144 * @note Not to be confused with @c
3145 * evas_object_event_callback_add(), which will add event callbacks
3146 * per type on general Evas objects (no event propagation
3147 * infrastructure taken in account).
3149 * @note Not to be confused with @c
3150 * elm_object_signal_callback_add(), which will add callbacks to @b
3151 * signals coming from a widget's theme, not input events.
3153 * @note Not to be confused with @c
3154 * edje_object_signal_callback_add(), which does the same as
3155 * elm_object_signal_callback_add(), but directly on an Edje
3158 * @note Not to be confused with @c
3159 * evas_object_smart_callback_add(), which adds callbacks to smart
3160 * objects' <b>smart events</b>, and not input events.
3162 * @see elm_object_event_callback_del()
3166 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3169 * Remove an event callback from a widget.
3171 * This function removes a callback, previoulsy attached to event emission
3173 * The parameters func and data must match exactly those passed to
3174 * a previous call to elm_object_event_callback_add(). The data pointer that
3175 * was passed to this call will be returned.
3177 * @param obj The object
3178 * @param func The callback function to be executed when the event is
3180 * @param data Data to pass in to the callback function.
3181 * @return The data pointer
3184 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3187 * Adjust size of an element for finger usage.
3189 * @param times_w How many fingers should fit horizontally
3190 * @param w Pointer to the width size to adjust
3191 * @param times_h How many fingers should fit vertically
3192 * @param h Pointer to the height size to adjust
3194 * This takes width and height sizes (in pixels) as input and a
3195 * size multiple (which is how many fingers you want to place
3196 * within the area, being "finger" the size set by
3197 * elm_finger_size_set()), and adjusts the size to be large enough
3198 * to accommodate the resulting size -- if it doesn't already
3199 * accommodate it. On return the @p w and @p h sizes pointed to by
3200 * these parameters will be modified, on those conditions.
3202 * @note This is kind of a low level Elementary call, most useful
3203 * on size evaluation times for widgets. An external user wouldn't
3204 * be calling, most of the time.
3208 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3211 * Get the duration for occuring long press event.
3213 * @return Timeout for long press event
3214 * @ingroup Longpress
3216 EAPI double elm_longpress_timeout_get(void);
3219 * Set the duration for occuring long press event.
3221 * @param lonpress_timeout Timeout for long press event
3222 * @ingroup Longpress
3224 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3227 * @defgroup Debug Debug
3228 * don't use it unless you are sure
3234 * Print Tree object hierarchy in stdout
3236 * @param obj The root object
3239 EAPI void elm_object_tree_dump(const Evas_Object *top);
3242 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3244 * @param obj The root object
3245 * @param file The path of output file
3248 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3255 * @defgroup Theme Theme
3257 * Elementary uses Edje to theme its widgets, naturally. But for the most
3258 * part this is hidden behind a simpler interface that lets the user set
3259 * extensions and choose the style of widgets in a much easier way.
3261 * Instead of thinking in terms of paths to Edje files and their groups
3262 * each time you want to change the appearance of a widget, Elementary
3263 * works so you can add any theme file with extensions or replace the
3264 * main theme at one point in the application, and then just set the style
3265 * of widgets with elm_object_style_set() and related functions. Elementary
3266 * will then look in its list of themes for a matching group and apply it,
3267 * and when the theme changes midway through the application, all widgets
3268 * will be updated accordingly.
3270 * There are three concepts you need to know to understand how Elementary
3271 * theming works: default theme, extensions and overlays.
3273 * Default theme, obviously enough, is the one that provides the default
3274 * look of all widgets. End users can change the theme used by Elementary
3275 * by setting the @c ELM_THEME environment variable before running an
3276 * application, or globally for all programs using the @c elementary_config
3277 * utility. Applications can change the default theme using elm_theme_set(),
3278 * but this can go against the user wishes, so it's not an adviced practice.
3280 * Ideally, applications should find everything they need in the already
3281 * provided theme, but there may be occasions when that's not enough and
3282 * custom styles are required to correctly express the idea. For this
3283 * cases, Elementary has extensions.
3285 * Extensions allow the application developer to write styles of its own
3286 * to apply to some widgets. This requires knowledge of how each widget
3287 * is themed, as extensions will always replace the entire group used by
3288 * the widget, so important signals and parts need to be there for the
3289 * object to behave properly (see documentation of Edje for details).
3290 * Once the theme for the extension is done, the application needs to add
3291 * it to the list of themes Elementary will look into, using
3292 * elm_theme_extension_add(), and set the style of the desired widgets as
3293 * he would normally with elm_object_style_set().
3295 * Overlays, on the other hand, can replace the look of all widgets by
3296 * overriding the default style. Like extensions, it's up to the application
3297 * developer to write the theme for the widgets it wants, the difference
3298 * being that when looking for the theme, Elementary will check first the
3299 * list of overlays, then the set theme and lastly the list of extensions,
3300 * so with overlays it's possible to replace the default view and every
3301 * widget will be affected. This is very much alike to setting the whole
3302 * theme for the application and will probably clash with the end user
3303 * options, not to mention the risk of ending up with not matching styles
3304 * across the program. Unless there's a very special reason to use them,
3305 * overlays should be avoided for the resons exposed before.
3307 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3308 * keeps one default internally and every function that receives one of
3309 * these can be called with NULL to refer to this default (except for
3310 * elm_theme_free()). It's possible to create a new instance of a
3311 * ::Elm_Theme to set other theme for a specific widget (and all of its
3312 * children), but this is as discouraged, if not even more so, than using
3313 * overlays. Don't use this unless you really know what you are doing.
3315 * But to be less negative about things, you can look at the following
3317 * @li @ref theme_example_01 "Using extensions"
3318 * @li @ref theme_example_02 "Using overlays"
3323 * @typedef Elm_Theme
3325 * Opaque handler for the list of themes Elementary looks for when
3326 * rendering widgets.
3328 * Stay out of this unless you really know what you are doing. For most
3329 * cases, sticking to the default is all a developer needs.
3331 typedef struct _Elm_Theme Elm_Theme;
3334 * Create a new specific theme
3336 * This creates an empty specific theme that only uses the default theme. A
3337 * specific theme has its own private set of extensions and overlays too
3338 * (which are empty by default). Specific themes do not fall back to themes
3339 * of parent objects. They are not intended for this use. Use styles, overlays
3340 * and extensions when needed, but avoid specific themes unless there is no
3341 * other way (example: you want to have a preview of a new theme you are
3342 * selecting in a "theme selector" window. The preview is inside a scroller
3343 * and should display what the theme you selected will look like, but not
3344 * actually apply it yet. The child of the scroller will have a specific
3345 * theme set to show this preview before the user decides to apply it to all
3348 EAPI Elm_Theme *elm_theme_new(void);
3350 * Free a specific theme
3352 * @param th The theme to free
3354 * This frees a theme created with elm_theme_new().
3356 EAPI void elm_theme_free(Elm_Theme *th);
3358 * Copy the theme fom the source to the destination theme
3360 * @param th The source theme to copy from
3361 * @param thdst The destination theme to copy data to
3363 * This makes a one-time static copy of all the theme config, extensions
3364 * and overlays from @p th to @p thdst. If @p th references a theme, then
3365 * @p thdst is also set to reference it, with all the theme settings,
3366 * overlays and extensions that @p th had.
3368 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3370 * Tell the source theme to reference the ref theme
3372 * @param th The theme that will do the referencing
3373 * @param thref The theme that is the reference source
3375 * This clears @p th to be empty and then sets it to refer to @p thref
3376 * so @p th acts as an override to @p thref, but where its overrides
3377 * don't apply, it will fall through to @p thref for configuration.
3379 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3381 * Return the theme referred to
3383 * @param th The theme to get the reference from
3384 * @return The referenced theme handle
3386 * This gets the theme set as the reference theme by elm_theme_ref_set().
3387 * If no theme is set as a reference, NULL is returned.
3389 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3391 * Return the default theme
3393 * @return The default theme handle
3395 * This returns the internal default theme setup handle that all widgets
3396 * use implicitly unless a specific theme is set. This is also often use
3397 * as a shorthand of NULL.
3399 EAPI Elm_Theme *elm_theme_default_get(void);
3401 * Prepends a theme overlay to the list of overlays
3403 * @param th The theme to add to, or if NULL, the default theme
3404 * @param item The Edje file path to be used
3406 * Use this if your application needs to provide some custom overlay theme
3407 * (An Edje file that replaces some default styles of widgets) where adding
3408 * new styles, or changing system theme configuration is not possible. Do
3409 * NOT use this instead of a proper system theme configuration. Use proper
3410 * configuration files, profiles, environment variables etc. to set a theme
3411 * so that the theme can be altered by simple confiugration by a user. Using
3412 * this call to achieve that effect is abusing the API and will create lots
3415 * @see elm_theme_extension_add()
3417 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3419 * Delete a theme overlay from the list of overlays
3421 * @param th The theme to delete from, or if NULL, the default theme
3422 * @param item The name of the theme overlay
3424 * @see elm_theme_overlay_add()
3426 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3428 * Appends a theme extension to the list of extensions.
3430 * @param th The theme to add to, or if NULL, the default theme
3431 * @param item The Edje file path to be used
3433 * This is intended when an application needs more styles of widgets or new
3434 * widget themes that the default does not provide (or may not provide). The
3435 * application has "extended" usage by coming up with new custom style names
3436 * for widgets for specific uses, but as these are not "standard", they are
3437 * not guaranteed to be provided by a default theme. This means the
3438 * application is required to provide these extra elements itself in specific
3439 * Edje files. This call adds one of those Edje files to the theme search
3440 * path to be search after the default theme. The use of this call is
3441 * encouraged when default styles do not meet the needs of the application.
3442 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3444 * @see elm_object_style_set()
3446 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3448 * Deletes a theme extension from the list of extensions.
3450 * @param th The theme to delete from, or if NULL, the default theme
3451 * @param item The name of the theme extension
3453 * @see elm_theme_extension_add()
3455 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3457 * Set the theme search order for the given theme
3459 * @param th The theme to set the search order, or if NULL, the default theme
3460 * @param theme Theme search string
3462 * This sets the search string for the theme in path-notation from first
3463 * theme to search, to last, delimited by the : character. Example:
3465 * "shiny:/path/to/file.edj:default"
3467 * See the ELM_THEME environment variable for more information.
3469 * @see elm_theme_get()
3470 * @see elm_theme_list_get()
3472 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3474 * Return the theme search order
3476 * @param th The theme to get the search order, or if NULL, the default theme
3477 * @return The internal search order path
3479 * This function returns a colon separated string of theme elements as
3480 * returned by elm_theme_list_get().
3482 * @see elm_theme_set()
3483 * @see elm_theme_list_get()
3485 EAPI const char *elm_theme_get(Elm_Theme *th);
3487 * Return a list of theme elements to be used in a theme.
3489 * @param th Theme to get the list of theme elements from.
3490 * @return The internal list of theme elements
3492 * This returns the internal list of theme elements (will only be valid as
3493 * long as the theme is not modified by elm_theme_set() or theme is not
3494 * freed by elm_theme_free(). This is a list of strings which must not be
3495 * altered as they are also internal. If @p th is NULL, then the default
3496 * theme element list is returned.
3498 * A theme element can consist of a full or relative path to a .edj file,
3499 * or a name, without extension, for a theme to be searched in the known
3500 * theme paths for Elemementary.
3502 * @see elm_theme_set()
3503 * @see elm_theme_get()
3505 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3507 * Return the full patrh for a theme element
3509 * @param f The theme element name
3510 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3511 * @return The full path to the file found.
3513 * This returns a string you should free with free() on success, NULL on
3514 * failure. This will search for the given theme element, and if it is a
3515 * full or relative path element or a simple searchable name. The returned
3516 * path is the full path to the file, if searched, and the file exists, or it
3517 * is simply the full path given in the element or a resolved path if
3518 * relative to home. The @p in_search_path boolean pointed to is set to
3519 * EINA_TRUE if the file was a searchable file andis in the search path,
3520 * and EINA_FALSE otherwise.
3522 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3524 * Flush the current theme.
3526 * @param th Theme to flush
3528 * This flushes caches that let elementary know where to find theme elements
3529 * in the given theme. If @p th is NULL, then the default theme is flushed.
3530 * Call this function if source theme data has changed in such a way as to
3531 * make any caches Elementary kept invalid.
3533 EAPI void elm_theme_flush(Elm_Theme *th);
3535 * This flushes all themes (default and specific ones).
3537 * This will flush all themes in the current application context, by calling
3538 * elm_theme_flush() on each of them.
3540 EAPI void elm_theme_full_flush(void);
3542 * Set the theme for all elementary using applications on the current display
3544 * @param theme The name of the theme to use. Format same as the ELM_THEME
3545 * environment variable.
3547 EAPI void elm_theme_all_set(const char *theme);
3549 * Return a list of theme elements in the theme search path
3551 * @return A list of strings that are the theme element names.
3553 * This lists all available theme files in the standard Elementary search path
3554 * for theme elements, and returns them in alphabetical order as theme
3555 * element names in a list of strings. Free this with
3556 * elm_theme_name_available_list_free() when you are done with the list.
3558 EAPI Eina_List *elm_theme_name_available_list_new(void);
3560 * Free the list returned by elm_theme_name_available_list_new()
3562 * This frees the list of themes returned by
3563 * elm_theme_name_available_list_new(). Once freed the list should no longer
3564 * be used. a new list mys be created.
3566 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3568 * Set a specific theme to be used for this object and its children
3570 * @param obj The object to set the theme on
3571 * @param th The theme to set
3573 * This sets a specific theme that will be used for the given object and any
3574 * child objects it has. If @p th is NULL then the theme to be used is
3575 * cleared and the object will inherit its theme from its parent (which
3576 * ultimately will use the default theme if no specific themes are set).
3578 * Use special themes with great care as this will annoy users and make
3579 * configuration difficult. Avoid any custom themes at all if it can be
3582 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3584 * Get the specific theme to be used
3586 * @param obj The object to get the specific theme from
3587 * @return The specifc theme set.
3589 * This will return a specific theme set, or NULL if no specific theme is
3590 * set on that object. It will not return inherited themes from parents, only
3591 * the specific theme set for that specific object. See elm_object_theme_set()
3592 * for more information.
3594 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3597 * Get a data item from a theme
3599 * @param th The theme, or NULL for default theme
3600 * @param key The data key to search with
3601 * @return The data value, or NULL on failure
3603 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3604 * It works the same way as edje_file_data_get() except that the return is stringshared.
3606 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3612 /** @defgroup Win Win
3614 * @image html img/widget/win/preview-00.png
3615 * @image latex img/widget/win/preview-00.eps
3617 * The window class of Elementary. Contains functions to manipulate
3618 * windows. The Evas engine used to render the window contents is specified
3619 * in the system or user elementary config files (whichever is found last),
3620 * and can be overridden with the ELM_ENGINE environment variable for
3621 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3622 * compilation setup and modules actually installed at runtime) are (listed
3623 * in order of best supported and most likely to be complete and work to
3626 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3627 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3629 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3631 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3633 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3635 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3636 * rendering using SDL as the buffer)
3637 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3638 * GDI with software)
3639 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3640 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3641 * grayscale using dedicated 8bit software engine in X11)
3642 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3643 * X11 using 16bit software engine)
3644 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3645 * (Windows CE rendering via GDI with 16bit software renderer)
3646 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3647 * buffer with 16bit software renderer)
3648 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3649 * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3650 * @li "psl1ght" (PS3 rendering using PSL1GHT)
3652 * All engines use a simple string to select the engine to render, EXCEPT
3653 * the "shot" engine. This actually encodes the output of the virtual
3654 * screenshot and how long to delay in the engine string. The engine string
3655 * is encoded in the following way:
3657 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3659 * Where options are separated by a ":" char if more than one option is
3660 * given, with delay, if provided being the first option and file the last
3661 * (order is important). The delay specifies how long to wait after the
3662 * window is shown before doing the virtual "in memory" rendering and then
3663 * save the output to the file specified by the file option (and then exit).
3664 * If no delay is given, the default is 0.5 seconds. If no file is given the
3665 * default output file is "out.png". Repeat option is for continous
3666 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3667 * fixed to "out001.png" Some examples of using the shot engine:
3669 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3670 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3671 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3672 * ELM_ENGINE="shot:delay=2.0" elementary_test
3673 * ELM_ENGINE="shot:" elementary_test
3675 * Signals that you can add callbacks for are:
3677 * @li "delete,request": the user requested to close the window. See
3678 * elm_win_autodel_set().
3679 * @li "focus,in": window got focus
3680 * @li "focus,out": window lost focus
3681 * @li "moved": window that holds the canvas was moved
3684 * @li @ref win_example_01
3689 * Defines the types of window that can be created
3691 * These are hints set on the window so that a running Window Manager knows
3692 * how the window should be handled and/or what kind of decorations it
3695 * Currently, only the X11 backed engines use them.
3697 typedef enum _Elm_Win_Type
3699 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3700 window. Almost every window will be created with this
3702 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3703 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3704 window holding desktop icons. */
3705 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3706 be kept on top of any other window by the Window
3708 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3710 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3711 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3713 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3714 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3715 entry in a menubar is clicked. Typically used
3716 with elm_win_override_set(). This hint exists
3717 for completion only, as the EFL way of
3718 implementing a menu would not normally use a
3719 separate window for its contents. */
3720 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3721 triggered by right-clicking an object. */
3722 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3723 explanatory text that typically appear after the
3724 mouse cursor hovers over an object for a while.
3725 Typically used with elm_win_override_set() and also
3726 not very commonly used in the EFL. */
3727 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3728 battery life or a new E-Mail received. */
3729 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3730 usually used in the EFL. */
3731 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3732 object being dragged across different windows, or even
3733 applications. Typically used with
3734 elm_win_override_set(). */
3735 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3736 buffer. No actual window is created for this
3737 type, instead the window and all of its
3738 contents will be rendered to an image buffer.
3739 This allows to have children window inside a
3740 parent one just like any other object would
3741 be, and do other things like applying @c
3742 Evas_Map effects to it. This is the only type
3743 of window that requires the @c parent
3744 parameter of elm_win_add() to be a valid @c
3749 * The differents layouts that can be requested for the virtual keyboard.
3751 * When the application window is being managed by Illume, it may request
3752 * any of the following layouts for the virtual keyboard.
3754 typedef enum _Elm_Win_Keyboard_Mode
3756 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3757 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3758 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3759 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3760 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3761 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3762 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3763 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3764 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3765 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3766 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3767 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3768 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3769 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3770 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3771 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3772 } Elm_Win_Keyboard_Mode;
3775 * Available commands that can be sent to the Illume manager.
3777 * When running under an Illume session, a window may send commands to the
3778 * Illume manager to perform different actions.
3780 typedef enum _Elm_Illume_Command
3782 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3784 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3786 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3788 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3789 } Elm_Illume_Command;
3792 * Adds a window object. If this is the first window created, pass NULL as
3795 * @param parent Parent object to add the window to, or NULL
3796 * @param name The name of the window
3797 * @param type The window type, one of #Elm_Win_Type.
3799 * The @p parent paramter can be @c NULL for every window @p type except
3800 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3801 * which the image object will be created.
3803 * @return The created object, or NULL on failure
3805 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3807 * Adds a window object with standard setup
3809 * @param name The name of the window
3810 * @param title The title for the window
3812 * This creates a window like elm_win_add() but also puts in a standard
3813 * background with elm_bg_add(), as well as setting the window title to
3814 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
3815 * as the parent widget.
3817 * @return The created object, or NULL on failure
3819 * @see elm_win_add()
3821 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
3823 * Add @p subobj as a resize object of window @p obj.
3826 * Setting an object as a resize object of the window means that the
3827 * @p subobj child's size and position will be controlled by the window
3828 * directly. That is, the object will be resized to match the window size
3829 * and should never be moved or resized manually by the developer.
3831 * In addition, resize objects of the window control what the minimum size
3832 * of it will be, as well as whether it can or not be resized by the user.
3834 * For the end user to be able to resize a window by dragging the handles
3835 * or borders provided by the Window Manager, or using any other similar
3836 * mechanism, all of the resize objects in the window should have their
3837 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3839 * @param obj The window object
3840 * @param subobj The resize object to add
3842 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3844 * Delete @p subobj as a resize object of window @p obj.
3846 * This function removes the object @p subobj from the resize objects of
3847 * the window @p obj. It will not delete the object itself, which will be
3848 * left unmanaged and should be deleted by the developer, manually handled
3849 * or set as child of some other container.
3851 * @param obj The window object
3852 * @param subobj The resize object to add
3854 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3856 * Set the title of the window
3858 * @param obj The window object
3859 * @param title The title to set
3861 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3863 * Get the title of the window
3865 * The returned string is an internal one and should not be freed or
3866 * modified. It will also be rendered invalid if a new title is set or if
3867 * the window is destroyed.
3869 * @param obj The window object
3872 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3874 * Set the window's autodel state.
3876 * When closing the window in any way outside of the program control, like
3877 * pressing the X button in the titlebar or using a command from the
3878 * Window Manager, a "delete,request" signal is emitted to indicate that
3879 * this event occurred and the developer can take any action, which may
3880 * include, or not, destroying the window object.
3882 * When the @p autodel parameter is set, the window will be automatically
3883 * destroyed when this event occurs, after the signal is emitted.
3884 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3885 * and is up to the program to do so when it's required.
3887 * @param obj The window object
3888 * @param autodel If true, the window will automatically delete itself when
3891 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3893 * Get the window's autodel state.
3895 * @param obj The window object
3896 * @return If the window will automatically delete itself when closed
3898 * @see elm_win_autodel_set()
3900 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3902 * Activate a window object.
3904 * This function sends a request to the Window Manager to activate the
3905 * window pointed by @p obj. If honored by the WM, the window will receive
3906 * the keyboard focus.
3908 * @note This is just a request that a Window Manager may ignore, so calling
3909 * this function does not ensure in any way that the window will be the
3910 * active one after it.
3912 * @param obj The window object
3914 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3916 * Lower a window object.
3918 * Places the window pointed by @p obj at the bottom of the stack, so that
3919 * no other window is covered by it.
3921 * If elm_win_override_set() is not set, the Window Manager may ignore this
3924 * @param obj The window object
3926 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3928 * Raise a window object.
3930 * Places the window pointed by @p obj at the top of the stack, so that it's
3931 * not covered by any other window.
3933 * If elm_win_override_set() is not set, the Window Manager may ignore this
3936 * @param obj The window object
3938 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3940 * Set the borderless state of a window.
3942 * This function requests the Window Manager to not draw any decoration
3943 * around the window.
3945 * @param obj The window object
3946 * @param borderless If true, the window is borderless
3948 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3950 * Get the borderless state of a window.
3952 * @param obj The window object
3953 * @return If true, the window is borderless
3955 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3957 * Set the shaped state of a window.
3959 * Shaped windows, when supported, will render the parts of the window that
3960 * has no content, transparent.
3962 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3963 * background object or cover the entire window in any other way, or the
3964 * parts of the canvas that have no data will show framebuffer artifacts.
3966 * @param obj The window object
3967 * @param shaped If true, the window is shaped
3969 * @see elm_win_alpha_set()
3971 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3973 * Get the shaped state of a window.
3975 * @param obj The window object
3976 * @return If true, the window is shaped
3978 * @see elm_win_shaped_set()
3980 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3982 * Set the alpha channel state of a window.
3984 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3985 * possibly making parts of the window completely or partially transparent.
3986 * This is also subject to the underlying system supporting it, like for
3987 * example, running under a compositing manager. If no compositing is
3988 * available, enabling this option will instead fallback to using shaped
3989 * windows, with elm_win_shaped_set().
3991 * @param obj The window object
3992 * @param alpha If true, the window has an alpha channel
3994 * @see elm_win_alpha_set()
3996 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3998 * Get the transparency state of a window.
4000 * @param obj The window object
4001 * @return If true, the window is transparent
4003 * @see elm_win_transparent_set()
4005 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4007 * Set the transparency state of a window.
4009 * Use elm_win_alpha_set() instead.
4011 * @param obj The window object
4012 * @param transparent If true, the window is transparent
4014 * @see elm_win_alpha_set()
4016 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4018 * Get the alpha channel state of a window.
4020 * @param obj The window object
4021 * @return If true, the window has an alpha channel
4023 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4025 * Set the override state of a window.
4027 * A window with @p override set to EINA_TRUE will not be managed by the
4028 * Window Manager. This means that no decorations of any kind will be shown
4029 * for it, moving and resizing must be handled by the application, as well
4030 * as the window visibility.
4032 * This should not be used for normal windows, and even for not so normal
4033 * ones, it should only be used when there's a good reason and with a lot
4034 * of care. Mishandling override windows may result situations that
4035 * disrupt the normal workflow of the end user.
4037 * @param obj The window object
4038 * @param override If true, the window is overridden
4040 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4042 * Get the override state of a window.
4044 * @param obj The window object
4045 * @return If true, the window is overridden
4047 * @see elm_win_override_set()
4049 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4051 * Set the fullscreen state of a window.
4053 * @param obj The window object
4054 * @param fullscreen If true, the window is fullscreen
4056 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4058 * Get the fullscreen state of a window.
4060 * @param obj The window object
4061 * @return If true, the window is fullscreen
4063 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4065 * Set the maximized state of a window.
4067 * @param obj The window object
4068 * @param maximized If true, the window is maximized
4070 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4072 * Get the maximized state of a window.
4074 * @param obj The window object
4075 * @return If true, the window is maximized
4077 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4079 * Set the iconified state of a window.
4081 * @param obj The window object
4082 * @param iconified If true, the window is iconified
4084 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4086 * Get the iconified state of a window.
4088 * @param obj The window object
4089 * @return If true, the window is iconified
4091 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4093 * Set the layer of the window.
4095 * What this means exactly will depend on the underlying engine used.
4097 * In the case of X11 backed engines, the value in @p layer has the
4098 * following meanings:
4099 * @li < 3: The window will be placed below all others.
4100 * @li > 5: The window will be placed above all others.
4101 * @li other: The window will be placed in the default layer.
4103 * @param obj The window object
4104 * @param layer The layer of the window
4106 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4108 * Get the layer of the window.
4110 * @param obj The window object
4111 * @return The layer of the window
4113 * @see elm_win_layer_set()
4115 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4117 * Set the rotation of the window.
4119 * Most engines only work with multiples of 90.
4121 * This function is used to set the orientation of the window @p obj to
4122 * match that of the screen. The window itself will be resized to adjust
4123 * to the new geometry of its contents. If you want to keep the window size,
4124 * see elm_win_rotation_with_resize_set().
4126 * @param obj The window object
4127 * @param rotation The rotation of the window, in degrees (0-360),
4128 * counter-clockwise.
4130 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4132 * Rotates the window and resizes it.
4134 * Like elm_win_rotation_set(), but it also resizes the window's contents so
4135 * that they fit inside the current window geometry.
4137 * @param obj The window object
4138 * @param layer The rotation of the window in degrees (0-360),
4139 * counter-clockwise.
4141 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4143 * Get the rotation of the window.
4145 * @param obj The window object
4146 * @return The rotation of the window in degrees (0-360)
4148 * @see elm_win_rotation_set()
4149 * @see elm_win_rotation_with_resize_set()
4151 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4153 * Set the sticky state of the window.
4155 * Hints the Window Manager that the window in @p obj should be left fixed
4156 * at its position even when the virtual desktop it's on moves or changes.
4158 * @param obj The window object
4159 * @param sticky If true, the window's sticky state is enabled
4161 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4163 * Get the sticky state of the window.
4165 * @param obj The window object
4166 * @return If true, the window's sticky state is enabled
4168 * @see elm_win_sticky_set()
4170 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4172 * Set if this window is an illume conformant window
4174 * @param obj The window object
4175 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4177 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4179 * Get if this window is an illume conformant window
4181 * @param obj The window object
4182 * @return A boolean if this window is illume conformant or not
4184 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4186 * Set a window to be an illume quickpanel window
4188 * By default window objects are not quickpanel windows.
4190 * @param obj The window object
4191 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4193 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4195 * Get if this window is a quickpanel or not
4197 * @param obj The window object
4198 * @return A boolean if this window is a quickpanel or not
4200 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4202 * Set the major priority of a quickpanel window
4204 * @param obj The window object
4205 * @param priority The major priority for this quickpanel
4207 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4209 * Get the major priority of a quickpanel window
4211 * @param obj The window object
4212 * @return The major priority of this quickpanel
4214 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4216 * Set the minor priority of a quickpanel window
4218 * @param obj The window object
4219 * @param priority The minor priority for this quickpanel
4221 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4223 * Get the minor priority of a quickpanel window
4225 * @param obj The window object
4226 * @return The minor priority of this quickpanel
4228 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4230 * Set which zone this quickpanel should appear in
4232 * @param obj The window object
4233 * @param zone The requested zone for this quickpanel
4235 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4237 * Get which zone this quickpanel should appear in
4239 * @param obj The window object
4240 * @return The requested zone for this quickpanel
4242 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4244 * Set the window to be skipped by keyboard focus
4246 * This sets the window to be skipped by normal keyboard input. This means
4247 * a window manager will be asked to not focus this window as well as omit
4248 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4250 * Call this and enable it on a window BEFORE you show it for the first time,
4251 * otherwise it may have no effect.
4253 * Use this for windows that have only output information or might only be
4254 * interacted with by the mouse or fingers, and never for typing input.
4255 * Be careful that this may have side-effects like making the window
4256 * non-accessible in some cases unless the window is specially handled. Use
4259 * @param obj The window object
4260 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4262 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4264 * Send a command to the windowing environment
4266 * This is intended to work in touchscreen or small screen device
4267 * environments where there is a more simplistic window management policy in
4268 * place. This uses the window object indicated to select which part of the
4269 * environment to control (the part that this window lives in), and provides
4270 * a command and an optional parameter structure (use NULL for this if not
4273 * @param obj The window object that lives in the environment to control
4274 * @param command The command to send
4275 * @param params Optional parameters for the command
4277 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4279 * Get the inlined image object handle
4281 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4282 * then the window is in fact an evas image object inlined in the parent
4283 * canvas. You can get this object (be careful to not manipulate it as it
4284 * is under control of elementary), and use it to do things like get pixel
4285 * data, save the image to a file, etc.
4287 * @param obj The window object to get the inlined image from
4288 * @return The inlined image object, or NULL if none exists
4290 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4292 * Set the enabled status for the focus highlight in a window
4294 * This function will enable or disable the focus highlight only for the
4295 * given window, regardless of the global setting for it
4297 * @param obj The window where to enable the highlight
4298 * @param enabled The enabled value for the highlight
4300 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4302 * Get the enabled value of the focus highlight for this window
4304 * @param obj The window in which to check if the focus highlight is enabled
4306 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4308 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4310 * Set the style for the focus highlight on this window
4312 * Sets the style to use for theming the highlight of focused objects on
4313 * the given window. If @p style is NULL, the default will be used.
4315 * @param obj The window where to set the style
4316 * @param style The style to set
4318 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4320 * Get the style set for the focus highlight object
4322 * Gets the style set for this windows highilght object, or NULL if none
4325 * @param obj The window to retrieve the highlights style from
4327 * @return The style set or NULL if none was. Default is used in that case.
4329 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4331 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4332 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4333 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4334 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4335 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4336 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4337 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4339 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4340 * (blank mouse, private mouse obj, defaultmouse)
4344 * Sets the keyboard mode of the window.
4346 * @param obj The window object
4347 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4349 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4351 * Gets the keyboard mode of the window.
4353 * @param obj The window object
4354 * @return The mode, one of #Elm_Win_Keyboard_Mode
4356 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4358 * Sets whether the window is a keyboard.
4360 * @param obj The window object
4361 * @param is_keyboard If true, the window is a virtual keyboard
4363 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4365 * Gets whether the window is a keyboard.
4367 * @param obj The window object
4368 * @return If the window is a virtual keyboard
4370 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4373 * Get the screen position of a window.
4375 * @param obj The window object
4376 * @param x The int to store the x coordinate to
4377 * @param y The int to store the y coordinate to
4379 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4385 * @defgroup Inwin Inwin
4387 * @image html img/widget/inwin/preview-00.png
4388 * @image latex img/widget/inwin/preview-00.eps
4389 * @image html img/widget/inwin/preview-01.png
4390 * @image latex img/widget/inwin/preview-01.eps
4391 * @image html img/widget/inwin/preview-02.png
4392 * @image latex img/widget/inwin/preview-02.eps
4394 * An inwin is a window inside a window that is useful for a quick popup.
4395 * It does not hover.
4397 * It works by creating an object that will occupy the entire window, so it
4398 * must be created using an @ref Win "elm_win" as parent only. The inwin
4399 * object can be hidden or restacked below every other object if it's
4400 * needed to show what's behind it without destroying it. If this is done,
4401 * the elm_win_inwin_activate() function can be used to bring it back to
4402 * full visibility again.
4404 * There are three styles available in the default theme. These are:
4405 * @li default: The inwin is sized to take over most of the window it's
4407 * @li minimal: The size of the inwin will be the minimum necessary to show
4409 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4410 * possible, but it's sized vertically the most it needs to fit its\
4413 * Some examples of Inwin can be found in the following:
4414 * @li @ref inwin_example_01
4419 * Adds an inwin to the current window
4421 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4422 * Never call this function with anything other than the top-most window
4423 * as its parameter, unless you are fond of undefined behavior.
4425 * After creating the object, the widget will set itself as resize object
4426 * for the window with elm_win_resize_object_add(), so when shown it will
4427 * appear to cover almost the entire window (how much of it depends on its
4428 * content and the style used). It must not be added into other container
4429 * objects and it needs not be moved or resized manually.
4431 * @param parent The parent object
4432 * @return The new object or NULL if it cannot be created
4434 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4436 * Activates an inwin object, ensuring its visibility
4438 * This function will make sure that the inwin @p obj is completely visible
4439 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4440 * to the front. It also sets the keyboard focus to it, which will be passed
4443 * The object's theme will also receive the signal "elm,action,show" with
4446 * @param obj The inwin to activate
4448 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4450 * Set the content of an inwin object.
4452 * Once the content object is set, a previously set one will be deleted.
4453 * If you want to keep that old content object, use the
4454 * elm_win_inwin_content_unset() function.
4456 * @param obj The inwin object
4457 * @param content The object to set as content
4459 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4461 * Get the content of an inwin object.
4463 * Return the content object which is set for this widget.
4465 * The returned object is valid as long as the inwin is still alive and no
4466 * other content is set on it. Deleting the object will notify the inwin
4467 * about it and this one will be left empty.
4469 * If you need to remove an inwin's content to be reused somewhere else,
4470 * see elm_win_inwin_content_unset().
4472 * @param obj The inwin object
4473 * @return The content that is being used
4475 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4477 * Unset the content of an inwin object.
4479 * Unparent and return the content object which was set for this widget.
4481 * @param obj The inwin object
4482 * @return The content that was being used
4484 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4488 /* X specific calls - won't work on non-x engines (return 0) */
4491 * Get the Ecore_X_Window of an Evas_Object
4493 * @param obj The object
4495 * @return The Ecore_X_Window of @p obj
4499 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4501 /* smart callbacks called:
4502 * "delete,request" - the user requested to delete the window
4503 * "focus,in" - window got focus
4504 * "focus,out" - window lost focus
4505 * "moved" - window that holds the canvas was moved
4511 * @image html img/widget/bg/preview-00.png
4512 * @image latex img/widget/bg/preview-00.eps
4514 * @brief Background object, used for setting a solid color, image or Edje
4515 * group as background to a window or any container object.
4517 * The bg object is used for setting a solid background to a window or
4518 * packing into any container object. It works just like an image, but has
4519 * some properties useful to a background, like setting it to tiled,
4520 * centered, scaled or stretched.
4522 * Default contents parts of the bg widget that you can use for are:
4523 * @li "elm.swallow.content" - overlay of the bg
4525 * Here is some sample code using it:
4526 * @li @ref bg_01_example_page
4527 * @li @ref bg_02_example_page
4528 * @li @ref bg_03_example_page
4532 typedef enum _Elm_Bg_Option
4534 ELM_BG_OPTION_CENTER, /**< center the background */
4535 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4536 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4537 ELM_BG_OPTION_TILE /**< tile background at its original size */
4541 * Add a new background to the parent
4543 * @param parent The parent object
4544 * @return The new object or NULL if it cannot be created
4548 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4551 * Set the file (image or edje) used for the background
4553 * @param obj The bg object
4554 * @param file The file path
4555 * @param group Optional key (group in Edje) within the file
4557 * This sets the image file used in the background object. The image (or edje)
4558 * will be stretched (retaining aspect if its an image file) to completely fill
4559 * the bg object. This may mean some parts are not visible.
4561 * @note Once the image of @p obj is set, a previously set one will be deleted,
4562 * even if @p file is NULL.
4566 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4569 * Get the file (image or edje) used for the background
4571 * @param obj The bg object
4572 * @param file The file path
4573 * @param group Optional key (group in Edje) within the file
4577 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4580 * Set the option used for the background image
4582 * @param obj The bg object
4583 * @param option The desired background option (TILE, SCALE)
4585 * This sets the option used for manipulating the display of the background
4586 * image. The image can be tiled or scaled.
4590 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4593 * Get the option used for the background image
4595 * @param obj The bg object
4596 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4600 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4602 * Set the option used for the background color
4604 * @param obj The bg object
4609 * This sets the color used for the background rectangle. Its range goes
4614 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4616 * Get the option used for the background color
4618 * @param obj The bg object
4625 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4628 * Set the overlay object used for the background object.
4630 * @param obj The bg object
4631 * @param overlay The overlay object
4633 * This provides a way for elm_bg to have an 'overlay' that will be on top
4634 * of the bg. Once the over object is set, a previously set one will be
4635 * deleted, even if you set the new one to NULL. If you want to keep that
4636 * old content object, use the elm_bg_overlay_unset() function.
4638 * @deprecated use elm_object_content_set() instead
4643 EINA_DEPRECATED EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4646 * Get the overlay object used for the background object.
4648 * @param obj The bg object
4649 * @return The content that is being used
4651 * Return the content object which is set for this widget
4653 * @deprecated use elm_object_content_get() instead
4657 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4660 * Get the overlay object used for the background object.
4662 * @param obj The bg object
4663 * @return The content that was being used
4665 * Unparent and return the overlay object which was set for this widget
4667 * @deprecated use elm_object_content_unset() instead
4671 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4674 * Set the size of the pixmap representation of the image.
4676 * This option just makes sense if an image is going to be set in the bg.
4678 * @param obj The bg object
4679 * @param w The new width of the image pixmap representation.
4680 * @param h The new height of the image pixmap representation.
4682 * This function sets a new size for pixmap representation of the given bg
4683 * image. It allows the image to be loaded already in the specified size,
4684 * reducing the memory usage and load time when loading a big image with load
4685 * size set to a smaller size.
4687 * NOTE: this is just a hint, the real size of the pixmap may differ
4688 * depending on the type of image being loaded, being bigger than requested.
4692 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4693 /* smart callbacks called:
4697 * @defgroup Icon Icon
4699 * @image html img/widget/icon/preview-00.png
4700 * @image latex img/widget/icon/preview-00.eps
4702 * An object that provides standard icon images (delete, edit, arrows, etc.)
4703 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4705 * The icon image requested can be in the elementary theme, or in the
4706 * freedesktop.org paths. It's possible to set the order of preference from
4707 * where the image will be used.
4709 * This API is very similar to @ref Image, but with ready to use images.
4711 * Default images provided by the theme are described below.
4713 * The first list contains icons that were first intended to be used in
4714 * toolbars, but can be used in many other places too:
4730 * Now some icons that were designed to be used in menus (but again, you can
4731 * use them anywhere else):
4736 * @li menu/arrow_down
4737 * @li menu/arrow_left
4738 * @li menu/arrow_right
4747 * And here we have some media player specific icons:
4748 * @li media_player/forward
4749 * @li media_player/info
4750 * @li media_player/next
4751 * @li media_player/pause
4752 * @li media_player/play
4753 * @li media_player/prev
4754 * @li media_player/rewind
4755 * @li media_player/stop
4757 * Signals that you can add callbacks for are:
4759 * "clicked" - This is called when a user has clicked the icon
4761 * An example of usage for this API follows:
4762 * @li @ref tutorial_icon
4770 typedef enum _Elm_Icon_Type
4777 * @enum _Elm_Icon_Lookup_Order
4778 * @typedef Elm_Icon_Lookup_Order
4780 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4781 * theme, FDO paths, or both?
4785 typedef enum _Elm_Icon_Lookup_Order
4787 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4788 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4789 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4790 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4791 } Elm_Icon_Lookup_Order;
4794 * Add a new icon object to the parent.
4796 * @param parent The parent object
4797 * @return The new object or NULL if it cannot be created
4799 * @see elm_icon_file_set()
4803 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4805 * Set the file that will be used as icon.
4807 * @param obj The icon object
4808 * @param file The path to file that will be used as icon image
4809 * @param group The group that the icon belongs to an edje file
4811 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4813 * @note The icon image set by this function can be changed by
4814 * elm_icon_standard_set().
4816 * @see elm_icon_file_get()
4820 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4822 * Set a location in memory to be used as an icon
4824 * @param obj The icon object
4825 * @param img The binary data that will be used as an image
4826 * @param size The size of binary data @p img
4827 * @param format Optional format of @p img to pass to the image loader
4828 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4830 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4832 * @note The icon image set by this function can be changed by
4833 * elm_icon_standard_set().
4837 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);
4839 * Get the file that will be used as icon.
4841 * @param obj The icon object
4842 * @param file The path to file that will be used as the icon image
4843 * @param group The group that the icon belongs to, in edje file
4845 * @see elm_icon_file_set()
4849 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4850 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4852 * Set the icon by icon standards names.
4854 * @param obj The icon object
4855 * @param name The icon name
4857 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4859 * For example, freedesktop.org defines standard icon names such as "home",
4860 * "network", etc. There can be different icon sets to match those icon
4861 * keys. The @p name given as parameter is one of these "keys", and will be
4862 * used to look in the freedesktop.org paths and elementary theme. One can
4863 * change the lookup order with elm_icon_order_lookup_set().
4865 * If name is not found in any of the expected locations and it is the
4866 * absolute path of an image file, this image will be used.
4868 * @note The icon image set by this function can be changed by
4869 * elm_icon_file_set().
4871 * @see elm_icon_standard_get()
4872 * @see elm_icon_file_set()
4876 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4878 * Get the icon name set by icon standard names.
4880 * @param obj The icon object
4881 * @return The icon name
4883 * If the icon image was set using elm_icon_file_set() instead of
4884 * elm_icon_standard_set(), then this function will return @c NULL.
4886 * @see elm_icon_standard_set()
4890 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4892 * Set the smooth scaling for an icon object.
4894 * @param obj The icon object
4895 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4896 * otherwise. Default is @c EINA_TRUE.
4898 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4899 * scaling provides a better resulting image, but is slower.
4901 * The smooth scaling should be disabled when making animations that change
4902 * the icon size, since they will be faster. Animations that don't require
4903 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4904 * is already scaled, since the scaled icon image will be cached).
4906 * @see elm_icon_smooth_get()
4910 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4912 * Get whether smooth scaling is enabled for an icon object.
4914 * @param obj The icon object
4915 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4917 * @see elm_icon_smooth_set()
4921 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4923 * Disable scaling of this object.
4925 * @param obj The icon object.
4926 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4927 * otherwise. Default is @c EINA_FALSE.
4929 * This function disables scaling of the icon object through the function
4930 * elm_object_scale_set(). However, this does not affect the object
4931 * size/resize in any way. For that effect, take a look at
4932 * elm_icon_scale_set().
4934 * @see elm_icon_no_scale_get()
4935 * @see elm_icon_scale_set()
4936 * @see elm_object_scale_set()
4940 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4942 * Get whether scaling is disabled on the object.
4944 * @param obj The icon object
4945 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4947 * @see elm_icon_no_scale_set()
4951 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4953 * Set if the object is (up/down) resizable.
4955 * @param obj The icon object
4956 * @param scale_up A bool to set if the object is resizable up. Default is
4958 * @param scale_down A bool to set if the object is resizable down. Default
4961 * This function limits the icon object resize ability. If @p scale_up is set to
4962 * @c EINA_FALSE, the object can't have its height or width resized to a value
4963 * higher than the original icon size. Same is valid for @p scale_down.
4965 * @see elm_icon_scale_get()
4969 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4971 * Get if the object is (up/down) resizable.
4973 * @param obj The icon object
4974 * @param scale_up A bool to set if the object is resizable up
4975 * @param scale_down A bool to set if the object is resizable down
4977 * @see elm_icon_scale_set()
4981 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4983 * Get the object's image size
4985 * @param obj The icon object
4986 * @param w A pointer to store the width in
4987 * @param h A pointer to store the height in
4991 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4993 * Set if the icon fill the entire object area.
4995 * @param obj The icon object
4996 * @param fill_outside @c EINA_TRUE if the object is filled outside,
4997 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4999 * When the icon object is resized to a different aspect ratio from the
5000 * original icon image, the icon image will still keep its aspect. This flag
5001 * tells how the image should fill the object's area. They are: keep the
5002 * entire icon inside the limits of height and width of the object (@p
5003 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5004 * of the object, and the icon will fill the entire object (@p fill_outside
5007 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5008 * retain property to false. Thus, the icon image will always keep its
5009 * original aspect ratio.
5011 * @see elm_icon_fill_outside_get()
5012 * @see elm_image_fill_outside_set()
5016 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5018 * Get if the object is filled outside.
5020 * @param obj The icon object
5021 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5023 * @see elm_icon_fill_outside_set()
5027 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5029 * Set the prescale size for the icon.
5031 * @param obj The icon object
5032 * @param size The prescale size. This value is used for both width and
5035 * This function sets a new size for pixmap representation of the given
5036 * icon. It allows the icon to be loaded already in the specified size,
5037 * reducing the memory usage and load time when loading a big icon with load
5038 * size set to a smaller size.
5040 * It's equivalent to the elm_bg_load_size_set() function for bg.
5042 * @note this is just a hint, the real size of the pixmap may differ
5043 * depending on the type of icon being loaded, being bigger than requested.
5045 * @see elm_icon_prescale_get()
5046 * @see elm_bg_load_size_set()
5050 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5052 * Get the prescale size for the icon.
5054 * @param obj The icon object
5055 * @return The prescale size
5057 * @see elm_icon_prescale_set()
5061 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5063 * Gets the image object of the icon. DO NOT MODIFY THIS.
5065 * @param obj The icon object
5066 * @return The internal icon object
5070 EAPI Evas_Object *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5072 * Sets the icon lookup order used by elm_icon_standard_set().
5074 * @param obj The icon object
5075 * @param order The icon lookup order (can be one of
5076 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5077 * or ELM_ICON_LOOKUP_THEME)
5079 * @see elm_icon_order_lookup_get()
5080 * @see Elm_Icon_Lookup_Order
5084 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5086 * Gets the icon lookup order.
5088 * @param obj The icon object
5089 * @return The icon lookup order
5091 * @see elm_icon_order_lookup_set()
5092 * @see Elm_Icon_Lookup_Order
5096 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5098 * Enable or disable preloading of the icon
5100 * @param obj The icon object
5101 * @param disable If EINA_TRUE, preloading will be disabled
5104 EAPI void elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5106 * Get if the icon supports animation or not.
5108 * @param obj The icon object
5109 * @return @c EINA_TRUE if the icon supports animation,
5110 * @c EINA_FALSE otherwise.
5112 * Return if this elm icon's image can be animated. Currently Evas only
5113 * supports gif animation. If the return value is EINA_FALSE, other
5114 * elm_icon_animated_XXX APIs won't work.
5117 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5119 * Set animation mode of the icon.
5121 * @param obj The icon object
5122 * @param anim @c EINA_TRUE if the object do animation job,
5123 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5125 * Since the default animation mode is set to EINA_FALSE,
5126 * the icon is shown without animation.
5127 * This might be desirable when the application developer wants to show
5128 * a snapshot of the animated icon.
5129 * Set it to EINA_TRUE when the icon needs to be animated.
5132 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5134 * Get animation mode of the icon.
5136 * @param obj The icon object
5137 * @return The animation mode of the icon object
5138 * @see elm_icon_animated_set
5141 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5143 * Set animation play mode of the icon.
5145 * @param obj The icon object
5146 * @param play @c EINA_TRUE the object play animation images,
5147 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5149 * To play elm icon's animation, set play to EINA_TURE.
5150 * For example, you make gif player using this set/get API and click event.
5152 * 1. Click event occurs
5153 * 2. Check play flag using elm_icon_animaged_play_get
5154 * 3. If elm icon was playing, set play to EINA_FALSE.
5155 * Then animation will be stopped and vice versa
5158 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5160 * Get animation play mode of the icon.
5162 * @param obj The icon object
5163 * @return The play mode of the icon object
5165 * @see elm_icon_animated_play_get
5168 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5175 * @defgroup Image Image
5177 * @image html img/widget/image/preview-00.png
5178 * @image latex img/widget/image/preview-00.eps
5181 * An object that allows one to load an image file to it. It can be used
5182 * anywhere like any other elementary widget.
5184 * This widget provides most of the functionality provided from @ref Bg or @ref
5185 * Icon, but with a slightly different API (use the one that fits better your
5188 * The features not provided by those two other image widgets are:
5189 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5190 * @li change the object orientation with elm_image_orient_set();
5191 * @li and turning the image editable with elm_image_editable_set().
5193 * Signals that you can add callbacks for are:
5195 * @li @c "clicked" - This is called when a user has clicked the image
5197 * An example of usage for this API follows:
5198 * @li @ref tutorial_image
5207 * @enum _Elm_Image_Orient
5208 * @typedef Elm_Image_Orient
5210 * Possible orientation options for elm_image_orient_set().
5212 * @image html elm_image_orient_set.png
5213 * @image latex elm_image_orient_set.eps width=\textwidth
5217 typedef enum _Elm_Image_Orient
5219 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5220 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5221 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5222 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5223 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5224 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5225 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5226 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5230 * Add a new image to the parent.
5232 * @param parent The parent object
5233 * @return The new object or NULL if it cannot be created
5235 * @see elm_image_file_set()
5239 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5241 * Set the file that will be used as image.
5243 * @param obj The image object
5244 * @param file The path to file that will be used as image
5245 * @param group The group that the image belongs in edje file (if it's an
5248 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5250 * @see elm_image_file_get()
5254 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5256 * Get the file that will be used as image.
5258 * @param obj The image object
5259 * @param file The path to file
5260 * @param group The group that the image belongs in edje file
5262 * @see elm_image_file_set()
5266 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5268 * Set the smooth effect for an image.
5270 * @param obj The image object
5271 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5272 * otherwise. Default is @c EINA_TRUE.
5274 * Set the scaling algorithm to be used when scaling the image. Smooth
5275 * scaling provides a better resulting image, but is slower.
5277 * The smooth scaling should be disabled when making animations that change
5278 * the image size, since it will be faster. Animations that don't require
5279 * resizing of the image can keep the smooth scaling enabled (even if the
5280 * image is already scaled, since the scaled image will be cached).
5282 * @see elm_image_smooth_get()
5286 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5288 * Get the smooth effect for an image.
5290 * @param obj The image object
5291 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5293 * @see elm_image_smooth_get()
5297 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5300 * Gets the current size of the image.
5302 * @param obj The image object.
5303 * @param w Pointer to store width, or NULL.
5304 * @param h Pointer to store height, or NULL.
5306 * This is the real size of the image, not the size of the object.
5308 * On error, neither w or h will be written.
5312 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5314 * Disable scaling of this object.
5316 * @param obj The image object.
5317 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5318 * otherwise. Default is @c EINA_FALSE.
5320 * This function disables scaling of the elm_image widget through the
5321 * function elm_object_scale_set(). However, this does not affect the widget
5322 * size/resize in any way. For that effect, take a look at
5323 * elm_image_scale_set().
5325 * @see elm_image_no_scale_get()
5326 * @see elm_image_scale_set()
5327 * @see elm_object_scale_set()
5331 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5333 * Get whether scaling is disabled on the object.
5335 * @param obj The image object
5336 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5338 * @see elm_image_no_scale_set()
5342 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5344 * Set if the object is (up/down) resizable.
5346 * @param obj The image object
5347 * @param scale_up A bool to set if the object is resizable up. Default is
5349 * @param scale_down A bool to set if the object is resizable down. Default
5352 * This function limits the image resize ability. If @p scale_up is set to
5353 * @c EINA_FALSE, the object can't have its height or width resized to a value
5354 * higher than the original image size. Same is valid for @p scale_down.
5356 * @see elm_image_scale_get()
5360 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5362 * Get if the object is (up/down) resizable.
5364 * @param obj The image object
5365 * @param scale_up A bool to set if the object is resizable up
5366 * @param scale_down A bool to set if the object is resizable down
5368 * @see elm_image_scale_set()
5372 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5374 * Set if the image fills the entire object area, when keeping the aspect ratio.
5376 * @param obj The image object
5377 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5378 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5380 * When the image should keep its aspect ratio even if resized to another
5381 * aspect ratio, there are two possibilities to resize it: keep the entire
5382 * image inside the limits of height and width of the object (@p fill_outside
5383 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5384 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5386 * @note This option will have no effect if
5387 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5389 * @see elm_image_fill_outside_get()
5390 * @see elm_image_aspect_ratio_retained_set()
5394 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5396 * Get if the object is filled outside
5398 * @param obj The image object
5399 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5401 * @see elm_image_fill_outside_set()
5405 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5407 * Set the prescale size for the image
5409 * @param obj The image object
5410 * @param size The prescale size. This value is used for both width and
5413 * This function sets a new size for pixmap representation of the given
5414 * image. It allows the image to be loaded already in the specified size,
5415 * reducing the memory usage and load time when loading a big image with load
5416 * size set to a smaller size.
5418 * It's equivalent to the elm_bg_load_size_set() function for bg.
5420 * @note this is just a hint, the real size of the pixmap may differ
5421 * depending on the type of image being loaded, being bigger than requested.
5423 * @see elm_image_prescale_get()
5424 * @see elm_bg_load_size_set()
5428 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5430 * Get the prescale size for the image
5432 * @param obj The image object
5433 * @return The prescale size
5435 * @see elm_image_prescale_set()
5439 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5441 * Set the image orientation.
5443 * @param obj The image object
5444 * @param orient The image orientation @ref Elm_Image_Orient
5445 * Default is #ELM_IMAGE_ORIENT_NONE.
5447 * This function allows to rotate or flip the given image.
5449 * @see elm_image_orient_get()
5450 * @see @ref Elm_Image_Orient
5454 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5456 * Get the image orientation.
5458 * @param obj The image object
5459 * @return The image orientation @ref Elm_Image_Orient
5461 * @see elm_image_orient_set()
5462 * @see @ref Elm_Image_Orient
5466 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5468 * Make the image 'editable'.
5470 * @param obj Image object.
5471 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5473 * This means the image is a valid drag target for drag and drop, and can be
5474 * cut or pasted too.
5478 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5480 * Check if the image 'editable'.
5482 * @param obj Image object.
5483 * @return Editability.
5485 * A return value of EINA_TRUE means the image is a valid drag target
5486 * for drag and drop, and can be cut or pasted too.
5490 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5492 * Get the basic Evas_Image object from this object (widget).
5494 * @param obj The image object to get the inlined image from
5495 * @return The inlined image object, or NULL if none exists
5497 * This function allows one to get the underlying @c Evas_Object of type
5498 * Image from this elementary widget. It can be useful to do things like get
5499 * the pixel data, save the image to a file, etc.
5501 * @note Be careful to not manipulate it, as it is under control of
5506 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5508 * Set whether the original aspect ratio of the image should be kept on resize.
5510 * @param obj The image object.
5511 * @param retained @c EINA_TRUE if the image should retain the aspect,
5512 * @c EINA_FALSE otherwise.
5514 * The original aspect ratio (width / height) of the image is usually
5515 * distorted to match the object's size. Enabling this option will retain
5516 * this original aspect, and the way that the image is fit into the object's
5517 * area depends on the option set by elm_image_fill_outside_set().
5519 * @see elm_image_aspect_ratio_retained_get()
5520 * @see elm_image_fill_outside_set()
5524 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5526 * Get if the object retains the original aspect ratio.
5528 * @param obj The image object.
5529 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5534 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5544 * @image html img/widget/box/preview-00.png
5545 * @image latex img/widget/box/preview-00.eps width=\textwidth
5547 * @image html img/box.png
5548 * @image latex img/box.eps width=\textwidth
5550 * A box arranges objects in a linear fashion, governed by a layout function
5551 * that defines the details of this arrangement.
5553 * By default, the box will use an internal function to set the layout to
5554 * a single row, either vertical or horizontal. This layout is affected
5555 * by a number of parameters, such as the homogeneous flag set by
5556 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5557 * elm_box_align_set() and the hints set to each object in the box.
5559 * For this default layout, it's possible to change the orientation with
5560 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5561 * placing its elements ordered from top to bottom. When horizontal is set,
5562 * the order will go from left to right. If the box is set to be
5563 * homogeneous, every object in it will be assigned the same space, that
5564 * of the largest object. Padding can be used to set some spacing between
5565 * the cell given to each object. The alignment of the box, set with
5566 * elm_box_align_set(), determines how the bounding box of all the elements
5567 * will be placed within the space given to the box widget itself.
5569 * The size hints of each object also affect how they are placed and sized
5570 * within the box. evas_object_size_hint_min_set() will give the minimum
5571 * size the object can have, and the box will use it as the basis for all
5572 * latter calculations. Elementary widgets set their own minimum size as
5573 * needed, so there's rarely any need to use it manually.
5575 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5576 * used to tell whether the object will be allocated the minimum size it
5577 * needs or if the space given to it should be expanded. It's important
5578 * to realize that expanding the size given to the object is not the same
5579 * thing as resizing the object. It could very well end being a small
5580 * widget floating in a much larger empty space. If not set, the weight
5581 * for objects will normally be 0.0 for both axis, meaning the widget will
5582 * not be expanded. To take as much space possible, set the weight to
5583 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5585 * Besides how much space each object is allocated, it's possible to control
5586 * how the widget will be placed within that space using
5587 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5588 * for both axis, meaning the object will be centered, but any value from
5589 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5590 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5591 * is -1.0, means the object will be resized to fill the entire space it
5594 * In addition, customized functions to define the layout can be set, which
5595 * allow the application developer to organize the objects within the box
5596 * in any number of ways.
5598 * The special elm_box_layout_transition() function can be used
5599 * to switch from one layout to another, animating the motion of the
5600 * children of the box.
5602 * @note Objects should not be added to box objects using _add() calls.
5604 * Some examples on how to use boxes follow:
5605 * @li @ref box_example_01
5606 * @li @ref box_example_02
5611 * @typedef Elm_Box_Transition
5613 * Opaque handler containing the parameters to perform an animated
5614 * transition of the layout the box uses.
5616 * @see elm_box_transition_new()
5617 * @see elm_box_layout_set()
5618 * @see elm_box_layout_transition()
5620 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5623 * Add a new box to the parent
5625 * By default, the box will be in vertical mode and non-homogeneous.
5627 * @param parent The parent object
5628 * @return The new object or NULL if it cannot be created
5630 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5632 * Set the horizontal orientation
5634 * By default, box object arranges their contents vertically from top to
5636 * By calling this function with @p horizontal as EINA_TRUE, the box will
5637 * become horizontal, arranging contents from left to right.
5639 * @note This flag is ignored if a custom layout function is set.
5641 * @param obj The box object
5642 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5643 * EINA_FALSE = vertical)
5645 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5647 * Get the horizontal orientation
5649 * @param obj The box object
5650 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5652 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5654 * Set the box to arrange its children homogeneously
5656 * If enabled, homogeneous layout makes all items the same size, according
5657 * to the size of the largest of its children.
5659 * @note This flag is ignored if a custom layout function is set.
5661 * @param obj The box object
5662 * @param homogeneous The homogeneous flag
5664 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5666 * Get whether the box is using homogeneous mode or not
5668 * @param obj The box object
5669 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5671 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5672 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5673 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5675 * Add an object to the beginning of the pack list
5677 * Pack @p subobj into the box @p obj, placing it first in the list of
5678 * children objects. The actual position the object will get on screen
5679 * depends on the layout used. If no custom layout is set, it will be at
5680 * the top or left, depending if the box is vertical or horizontal,
5683 * @param obj The box object
5684 * @param subobj The object to add to the box
5686 * @see elm_box_pack_end()
5687 * @see elm_box_pack_before()
5688 * @see elm_box_pack_after()
5689 * @see elm_box_unpack()
5690 * @see elm_box_unpack_all()
5691 * @see elm_box_clear()
5693 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5695 * Add an object at the end of the pack list
5697 * Pack @p subobj into the box @p obj, placing it last in the list of
5698 * children objects. The actual position the object will get on screen
5699 * depends on the layout used. If no custom layout is set, it will be at
5700 * the bottom or right, depending if the box is vertical or horizontal,
5703 * @param obj The box object
5704 * @param subobj The object to add to the box
5706 * @see elm_box_pack_start()
5707 * @see elm_box_pack_before()
5708 * @see elm_box_pack_after()
5709 * @see elm_box_unpack()
5710 * @see elm_box_unpack_all()
5711 * @see elm_box_clear()
5713 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5715 * Adds an object to the box before the indicated object
5717 * This will add the @p subobj to the box indicated before the object
5718 * indicated with @p before. If @p before is not already in the box, results
5719 * are undefined. Before means either to the left of the indicated object or
5720 * above it depending on orientation.
5722 * @param obj The box object
5723 * @param subobj The object to add to the box
5724 * @param before The object before which to add it
5726 * @see elm_box_pack_start()
5727 * @see elm_box_pack_end()
5728 * @see elm_box_pack_after()
5729 * @see elm_box_unpack()
5730 * @see elm_box_unpack_all()
5731 * @see elm_box_clear()
5733 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5735 * Adds an object to the box after the indicated object
5737 * This will add the @p subobj to the box indicated after the object
5738 * indicated with @p after. If @p after is not already in the box, results
5739 * are undefined. After means either to the right of the indicated object or
5740 * below it depending on orientation.
5742 * @param obj The box object
5743 * @param subobj The object to add to the box
5744 * @param after The object after which to add it
5746 * @see elm_box_pack_start()
5747 * @see elm_box_pack_end()
5748 * @see elm_box_pack_before()
5749 * @see elm_box_unpack()
5750 * @see elm_box_unpack_all()
5751 * @see elm_box_clear()
5753 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5755 * Clear the box of all children
5757 * Remove all the elements contained by the box, deleting the respective
5760 * @param obj The box object
5762 * @see elm_box_unpack()
5763 * @see elm_box_unpack_all()
5765 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5769 * Remove the object given by @p subobj from the box @p obj without
5772 * @param obj The box object
5774 * @see elm_box_unpack_all()
5775 * @see elm_box_clear()
5777 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5779 * Remove all items from the box, without deleting them
5781 * Clear the box from all children, but don't delete the respective objects.
5782 * If no other references of the box children exist, the objects will never
5783 * be deleted, and thus the application will leak the memory. Make sure
5784 * when using this function that you hold a reference to all the objects
5785 * in the box @p obj.
5787 * @param obj The box object
5789 * @see elm_box_clear()
5790 * @see elm_box_unpack()
5792 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5794 * Retrieve a list of the objects packed into the box
5796 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5797 * The order of the list corresponds to the packing order the box uses.
5799 * You must free this list with eina_list_free() once you are done with it.
5801 * @param obj The box object
5803 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5805 * Set the space (padding) between the box's elements.
5807 * Extra space in pixels that will be added between a box child and its
5808 * neighbors after its containing cell has been calculated. This padding
5809 * is set for all elements in the box, besides any possible padding that
5810 * individual elements may have through their size hints.
5812 * @param obj The box object
5813 * @param horizontal The horizontal space between elements
5814 * @param vertical The vertical space between elements
5816 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5818 * Get the space (padding) between the box's elements.
5820 * @param obj The box object
5821 * @param horizontal The horizontal space between elements
5822 * @param vertical The vertical space between elements
5824 * @see elm_box_padding_set()
5826 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5828 * Set the alignment of the whole bouding box of contents.
5830 * Sets how the bounding box containing all the elements of the box, after
5831 * their sizes and position has been calculated, will be aligned within
5832 * the space given for the whole box widget.
5834 * @param obj The box object
5835 * @param horizontal The horizontal alignment of elements
5836 * @param vertical The vertical alignment of elements
5838 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5840 * Get the alignment of the whole bouding box of contents.
5842 * @param obj The box object
5843 * @param horizontal The horizontal alignment of elements
5844 * @param vertical The vertical alignment of elements
5846 * @see elm_box_align_set()
5848 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5851 * Force the box to recalculate its children packing.
5853 * If any children was added or removed, box will not calculate the
5854 * values immediately rather leaving it to the next main loop
5855 * iteration. While this is great as it would save lots of
5856 * recalculation, whenever you need to get the position of a just
5857 * added item you must force recalculate before doing so.
5859 * @param obj The box object.
5861 EAPI void elm_box_recalculate(Evas_Object *obj);
5864 * Set the layout defining function to be used by the box
5866 * Whenever anything changes that requires the box in @p obj to recalculate
5867 * the size and position of its elements, the function @p cb will be called
5868 * to determine what the layout of the children will be.
5870 * Once a custom function is set, everything about the children layout
5871 * is defined by it. The flags set by elm_box_horizontal_set() and
5872 * elm_box_homogeneous_set() no longer have any meaning, and the values
5873 * given by elm_box_padding_set() and elm_box_align_set() are up to this
5874 * layout function to decide if they are used and how. These last two
5875 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5876 * passed to @p cb. The @c Evas_Object the function receives is not the
5877 * Elementary widget, but the internal Evas Box it uses, so none of the
5878 * functions described here can be used on it.
5880 * Any of the layout functions in @c Evas can be used here, as well as the
5881 * special elm_box_layout_transition().
5883 * The final @p data argument received by @p cb is the same @p data passed
5884 * here, and the @p free_data function will be called to free it
5885 * whenever the box is destroyed or another layout function is set.
5887 * Setting @p cb to NULL will revert back to the default layout function.
5889 * @param obj The box object
5890 * @param cb The callback function used for layout
5891 * @param data Data that will be passed to layout function
5892 * @param free_data Function called to free @p data
5894 * @see elm_box_layout_transition()
5896 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);
5898 * Special layout function that animates the transition from one layout to another
5900 * Normally, when switching the layout function for a box, this will be
5901 * reflected immediately on screen on the next render, but it's also
5902 * possible to do this through an animated transition.
5904 * This is done by creating an ::Elm_Box_Transition and setting the box
5905 * layout to this function.
5909 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5910 * evas_object_box_layout_vertical, // start
5911 * NULL, // data for initial layout
5912 * NULL, // free function for initial data
5913 * evas_object_box_layout_horizontal, // end
5914 * NULL, // data for final layout
5915 * NULL, // free function for final data
5916 * anim_end, // will be called when animation ends
5917 * NULL); // data for anim_end function\
5918 * elm_box_layout_set(box, elm_box_layout_transition, t,
5919 * elm_box_transition_free);
5922 * @note This function can only be used with elm_box_layout_set(). Calling
5923 * it directly will not have the expected results.
5925 * @see elm_box_transition_new
5926 * @see elm_box_transition_free
5927 * @see elm_box_layout_set
5929 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5931 * Create a new ::Elm_Box_Transition to animate the switch of layouts
5933 * If you want to animate the change from one layout to another, you need
5934 * to set the layout function of the box to elm_box_layout_transition(),
5935 * passing as user data to it an instance of ::Elm_Box_Transition with the
5936 * necessary information to perform this animation. The free function to
5937 * set for the layout is elm_box_transition_free().
5939 * The parameters to create an ::Elm_Box_Transition sum up to how long
5940 * will it be, in seconds, a layout function to describe the initial point,
5941 * another for the final position of the children and one function to be
5942 * called when the whole animation ends. This last function is useful to
5943 * set the definitive layout for the box, usually the same as the end
5944 * layout for the animation, but could be used to start another transition.
5946 * @param start_layout The layout function that will be used to start the animation
5947 * @param start_layout_data The data to be passed the @p start_layout function
5948 * @param start_layout_free_data Function to free @p start_layout_data
5949 * @param end_layout The layout function that will be used to end the animation
5950 * @param end_layout_free_data The data to be passed the @p end_layout function
5951 * @param end_layout_free_data Function to free @p end_layout_data
5952 * @param transition_end_cb Callback function called when animation ends
5953 * @param transition_end_data Data to be passed to @p transition_end_cb
5954 * @return An instance of ::Elm_Box_Transition
5956 * @see elm_box_transition_new
5957 * @see elm_box_layout_transition
5959 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);
5961 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5963 * This function is mostly useful as the @c free_data parameter in
5964 * elm_box_layout_set() when elm_box_layout_transition().
5966 * @param data The Elm_Box_Transition instance to be freed.
5968 * @see elm_box_transition_new
5969 * @see elm_box_layout_transition
5971 EAPI void elm_box_transition_free(void *data);
5978 * @defgroup Button Button
5980 * @image html img/widget/button/preview-00.png
5981 * @image latex img/widget/button/preview-00.eps
5982 * @image html img/widget/button/preview-01.png
5983 * @image latex img/widget/button/preview-01.eps
5984 * @image html img/widget/button/preview-02.png
5985 * @image latex img/widget/button/preview-02.eps
5987 * This is a push-button. Press it and run some function. It can contain
5988 * a simple label and icon object and it also has an autorepeat feature.
5990 * This widgets emits the following signals:
5991 * @li "clicked": the user clicked the button (press/release).
5992 * @li "repeated": the user pressed the button without releasing it.
5993 * @li "pressed": button was pressed.
5994 * @li "unpressed": button was released after being pressed.
5995 * In all three cases, the @c event parameter of the callback will be
5998 * Also, defined in the default theme, the button has the following styles
6000 * @li default: a normal button.
6001 * @li anchor: Like default, but the button fades away when the mouse is not
6002 * over it, leaving only the text or icon.
6003 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6004 * continuous look across its options.
6005 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6007 * Default contents parts of the button widget that you can use for are:
6008 * @li "elm.swallow.content" - A icon of the button
6010 * Default text parts of the button widget that you can use for are:
6011 * @li "elm.text" - Label of the button
6013 * Follow through a complete example @ref button_example_01 "here".
6017 * Add a new button to the parent's canvas
6019 * @param parent The parent object
6020 * @return The new object or NULL if it cannot be created
6022 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6024 * Set the label used in the button
6026 * The passed @p label can be NULL to clean any existing text in it and
6027 * leave the button as an icon only object.
6029 * @param obj The button object
6030 * @param label The text will be written on the button
6031 * @deprecated use elm_object_text_set() instead.
6033 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6035 * Get the label set for the button
6037 * The string returned is an internal pointer and should not be freed or
6038 * altered. It will also become invalid when the button is destroyed.
6039 * The string returned, if not NULL, is a stringshare, so if you need to
6040 * keep it around even after the button is destroyed, you can use
6041 * eina_stringshare_ref().
6043 * @param obj The button object
6044 * @return The text set to the label, or NULL if nothing is set
6045 * @deprecated use elm_object_text_set() instead.
6047 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6049 * Set the icon used for the button
6051 * Setting a new icon will delete any other that was previously set, making
6052 * any reference to them invalid. If you need to maintain the previous
6053 * object alive, unset it first with elm_button_icon_unset().
6055 * @param obj The button object
6056 * @param icon The icon object for the button
6057 * @deprecated use elm_object_content_set() instead.
6059 EINA_DEPRECATED EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6061 * Get the icon used for the button
6063 * Return the icon object which is set for this widget. If the button is
6064 * destroyed or another icon is set, the returned object will be deleted
6065 * and any reference to it will be invalid.
6067 * @param obj The button object
6068 * @return The icon object that is being used
6070 * @deprecated use elm_button_icon_unset() instead
6072 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6074 * Remove the icon set without deleting it and return the object
6076 * This function drops the reference the button holds of the icon object
6077 * and returns this last object. It is used in case you want to remove any
6078 * icon, or set another one, without deleting the actual object. The button
6079 * will be left without an icon set.
6081 * @param obj The button object
6082 * @return The icon object that was being used
6083 * @deprecated use elm_object_content_unset() instead.
6085 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6087 * Turn on/off the autorepeat event generated when the button is kept pressed
6089 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6090 * signal when they are clicked.
6092 * When on, keeping a button pressed will continuously emit a @c repeated
6093 * signal until the button is released. The time it takes until it starts
6094 * emitting the signal is given by
6095 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6096 * new emission by elm_button_autorepeat_gap_timeout_set().
6098 * @param obj The button object
6099 * @param on A bool to turn on/off the event
6101 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6103 * Get whether the autorepeat feature is enabled
6105 * @param obj The button object
6106 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6108 * @see elm_button_autorepeat_set()
6110 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6112 * Set the initial timeout before the autorepeat event is generated
6114 * Sets the timeout, in seconds, since the button is pressed until the
6115 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6116 * won't be any delay and the even will be fired the moment the button is
6119 * @param obj The button object
6120 * @param t Timeout in seconds
6122 * @see elm_button_autorepeat_set()
6123 * @see elm_button_autorepeat_gap_timeout_set()
6125 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6127 * Get the initial timeout before the autorepeat event is generated
6129 * @param obj The button object
6130 * @return Timeout in seconds
6132 * @see elm_button_autorepeat_initial_timeout_set()
6134 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6136 * Set the interval between each generated autorepeat event
6138 * After the first @c repeated event is fired, all subsequent ones will
6139 * follow after a delay of @p t seconds for each.
6141 * @param obj The button object
6142 * @param t Interval in seconds
6144 * @see elm_button_autorepeat_initial_timeout_set()
6146 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6148 * Get the interval between each generated autorepeat event
6150 * @param obj The button object
6151 * @return Interval in seconds
6153 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6159 * @defgroup File_Selector_Button File Selector Button
6161 * @image html img/widget/fileselector_button/preview-00.png
6162 * @image latex img/widget/fileselector_button/preview-00.eps
6163 * @image html img/widget/fileselector_button/preview-01.png
6164 * @image latex img/widget/fileselector_button/preview-01.eps
6165 * @image html img/widget/fileselector_button/preview-02.png
6166 * @image latex img/widget/fileselector_button/preview-02.eps
6168 * This is a button that, when clicked, creates an Elementary
6169 * window (or inner window) <b> with a @ref Fileselector "file
6170 * selector widget" within</b>. When a file is chosen, the (inner)
6171 * window is closed and the button emits a signal having the
6172 * selected file as it's @c event_info.
6174 * This widget encapsulates operations on its internal file
6175 * selector on its own API. There is less control over its file
6176 * selector than that one would have instatiating one directly.
6178 * The following styles are available for this button:
6181 * @li @c "hoversel_vertical"
6182 * @li @c "hoversel_vertical_entry"
6184 * Smart callbacks one can register to:
6185 * - @c "file,chosen" - the user has selected a path, whose string
6186 * pointer comes as the @c event_info data (a stringshared
6189 * Here is an example on its usage:
6190 * @li @ref fileselector_button_example
6192 * @see @ref File_Selector_Entry for a similar widget.
6197 * Add a new file selector button widget to the given parent
6198 * Elementary (container) object
6200 * @param parent The parent object
6201 * @return a new file selector button widget handle or @c NULL, on
6204 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6207 * Set the label for a given file selector button widget
6209 * @param obj The file selector button widget
6210 * @param label The text label to be displayed on @p obj
6212 * @deprecated use elm_object_text_set() instead.
6214 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6217 * Get the label set for a given file selector button widget
6219 * @param obj The file selector button widget
6220 * @return The button label
6222 * @deprecated use elm_object_text_set() instead.
6224 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6227 * Set the icon on a given file selector button widget
6229 * @param obj The file selector button widget
6230 * @param icon The icon object for the button
6232 * Once the icon object is set, a previously set one will be
6233 * deleted. If you want to keep the latter, use the
6234 * elm_fileselector_button_icon_unset() function.
6236 * @see elm_fileselector_button_icon_get()
6238 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6241 * Get the icon set for a given file selector button widget
6243 * @param obj The file selector button widget
6244 * @return The icon object currently set on @p obj or @c NULL, if
6247 * @see elm_fileselector_button_icon_set()
6249 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6252 * Unset the icon used in a given file selector button widget
6254 * @param obj The file selector button widget
6255 * @return The icon object that was being used on @p obj or @c
6258 * Unparent and return the icon object which was set for this
6261 * @see elm_fileselector_button_icon_set()
6263 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6266 * Set the title for a given file selector button widget's window
6268 * @param obj The file selector button widget
6269 * @param title The title string
6271 * This will change the window's title, when the file selector pops
6272 * out after a click on the button. Those windows have the default
6273 * (unlocalized) value of @c "Select a file" as titles.
6275 * @note It will only take any effect if the file selector
6276 * button widget is @b not under "inwin mode".
6278 * @see elm_fileselector_button_window_title_get()
6280 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6283 * Get the title set for a given file selector button widget's
6286 * @param obj The file selector button widget
6287 * @return Title of the file selector button's window
6289 * @see elm_fileselector_button_window_title_get() for more details
6291 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6294 * Set the size of a given file selector button widget's window,
6295 * holding the file selector itself.
6297 * @param obj The file selector button widget
6298 * @param width The window's width
6299 * @param height The window's height
6301 * @note it will only take any effect if the file selector button
6302 * widget is @b not under "inwin mode". The default size for the
6303 * window (when applicable) is 400x400 pixels.
6305 * @see elm_fileselector_button_window_size_get()
6307 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6310 * Get the size of a given file selector button widget's window,
6311 * holding the file selector itself.
6313 * @param obj The file selector button widget
6314 * @param width Pointer into which to store the width value
6315 * @param height Pointer into which to store the height value
6317 * @note Use @c NULL pointers on the size values you're not
6318 * interested in: they'll be ignored by the function.
6320 * @see elm_fileselector_button_window_size_set(), for more details
6322 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6325 * Set the initial file system path for a given file selector
6328 * @param obj The file selector button widget
6329 * @param path The path string
6331 * It must be a <b>directory</b> path, which will have the contents
6332 * displayed initially in the file selector's view, when invoked
6333 * from @p obj. The default initial path is the @c "HOME"
6334 * environment variable's value.
6336 * @see elm_fileselector_button_path_get()
6338 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6341 * Get the initial file system path set for a given file selector
6344 * @param obj The file selector button widget
6345 * @return path The path string
6347 * @see elm_fileselector_button_path_set() for more details
6349 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6352 * Enable/disable a tree view in the given file selector button
6353 * widget's internal file selector
6355 * @param obj The file selector button widget
6356 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6359 * This has the same effect as elm_fileselector_expandable_set(),
6360 * but now applied to a file selector button's internal file
6363 * @note There's no way to put a file selector button's internal
6364 * file selector in "grid mode", as one may do with "pure" file
6367 * @see elm_fileselector_expandable_get()
6369 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6372 * Get whether tree view is enabled for the given file selector
6373 * button widget's internal file selector
6375 * @param obj The file selector button widget
6376 * @return @c EINA_TRUE if @p obj widget's internal file selector
6377 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6379 * @see elm_fileselector_expandable_set() for more details
6381 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6384 * Set whether a given file selector button widget's internal file
6385 * selector is to display folders only or the directory contents,
6388 * @param obj The file selector button widget
6389 * @param only @c EINA_TRUE to make @p obj widget's internal file
6390 * selector only display directories, @c EINA_FALSE to make files
6391 * to be displayed in it too
6393 * This has the same effect as elm_fileselector_folder_only_set(),
6394 * but now applied to a file selector button's internal file
6397 * @see elm_fileselector_folder_only_get()
6399 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6402 * Get whether a given file selector button widget's internal file
6403 * selector is displaying folders only or the directory contents,
6406 * @param obj The file selector button widget
6407 * @return @c EINA_TRUE if @p obj widget's internal file
6408 * selector is only displaying directories, @c EINA_FALSE if files
6409 * are being displayed in it too (and on errors)
6411 * @see elm_fileselector_button_folder_only_set() for more details
6413 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6416 * Enable/disable the file name entry box where the user can type
6417 * in a name for a file, in a given file selector button widget's
6418 * internal file selector.
6420 * @param obj The file selector button widget
6421 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6422 * file selector a "saving dialog", @c EINA_FALSE otherwise
6424 * This has the same effect as elm_fileselector_is_save_set(),
6425 * but now applied to a file selector button's internal file
6428 * @see elm_fileselector_is_save_get()
6430 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6433 * Get whether the given file selector button widget's internal
6434 * file selector is in "saving dialog" mode
6436 * @param obj The file selector button widget
6437 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6438 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6441 * @see elm_fileselector_button_is_save_set() for more details
6443 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6446 * Set whether a given file selector button widget's internal file
6447 * selector will raise an Elementary "inner window", instead of a
6448 * dedicated Elementary window. By default, it won't.
6450 * @param obj The file selector button widget
6451 * @param value @c EINA_TRUE to make it use an inner window, @c
6452 * EINA_TRUE to make it use a dedicated window
6454 * @see elm_win_inwin_add() for more information on inner windows
6455 * @see elm_fileselector_button_inwin_mode_get()
6457 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6460 * Get whether a given file selector button widget's internal file
6461 * selector will raise an Elementary "inner window", instead of a
6462 * dedicated Elementary window.
6464 * @param obj The file selector button widget
6465 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6466 * if it will use a dedicated window
6468 * @see elm_fileselector_button_inwin_mode_set() for more details
6470 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6477 * @defgroup File_Selector_Entry File Selector Entry
6479 * @image html img/widget/fileselector_entry/preview-00.png
6480 * @image latex img/widget/fileselector_entry/preview-00.eps
6482 * This is an entry made to be filled with or display a <b>file
6483 * system path string</b>. Besides the entry itself, the widget has
6484 * a @ref File_Selector_Button "file selector button" on its side,
6485 * which will raise an internal @ref Fileselector "file selector widget",
6486 * when clicked, for path selection aided by file system
6489 * This file selector may appear in an Elementary window or in an
6490 * inner window. When a file is chosen from it, the (inner) window
6491 * is closed and the selected file's path string is exposed both as
6492 * an smart event and as the new text on the entry.
6494 * This widget encapsulates operations on its internal file
6495 * selector on its own API. There is less control over its file
6496 * selector than that one would have instatiating one directly.
6498 * Smart callbacks one can register to:
6499 * - @c "changed" - The text within the entry was changed
6500 * - @c "activated" - The entry has had editing finished and
6501 * changes are to be "committed"
6502 * - @c "press" - The entry has been clicked
6503 * - @c "longpressed" - The entry has been clicked (and held) for a
6505 * - @c "clicked" - The entry has been clicked
6506 * - @c "clicked,double" - The entry has been double clicked
6507 * - @c "focused" - The entry has received focus
6508 * - @c "unfocused" - The entry has lost focus
6509 * - @c "selection,paste" - A paste action has occurred on the
6511 * - @c "selection,copy" - A copy action has occurred on the entry
6512 * - @c "selection,cut" - A cut action has occurred on the entry
6513 * - @c "unpressed" - The file selector entry's button was released
6514 * after being pressed.
6515 * - @c "file,chosen" - The user has selected a path via the file
6516 * selector entry's internal file selector, whose string pointer
6517 * comes as the @c event_info data (a stringshared string)
6519 * Here is an example on its usage:
6520 * @li @ref fileselector_entry_example
6522 * @see @ref File_Selector_Button for a similar widget.
6527 * Add a new file selector entry widget to the given parent
6528 * Elementary (container) object
6530 * @param parent The parent object
6531 * @return a new file selector entry widget handle or @c NULL, on
6534 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6537 * Set the label for a given file selector entry widget's button
6539 * @param obj The file selector entry widget
6540 * @param label The text label to be displayed on @p obj widget's
6543 * @deprecated use elm_object_text_set() instead.
6545 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6548 * Get the label set for a given file selector entry widget's button
6550 * @param obj The file selector entry widget
6551 * @return The widget button's label
6553 * @deprecated use elm_object_text_set() instead.
6555 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6558 * Set the icon on a given file selector entry widget's button
6560 * @param obj The file selector entry widget
6561 * @param icon The icon object for the entry's button
6563 * Once the icon object is set, a previously set one will be
6564 * deleted. If you want to keep the latter, use the
6565 * elm_fileselector_entry_button_icon_unset() function.
6567 * @see elm_fileselector_entry_button_icon_get()
6569 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6572 * Get the icon set for a given file selector entry widget's button
6574 * @param obj The file selector entry widget
6575 * @return The icon object currently set on @p obj widget's button
6576 * or @c NULL, if none is
6578 * @see elm_fileselector_entry_button_icon_set()
6580 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6583 * Unset the icon used in a given file selector entry widget's
6586 * @param obj The file selector entry widget
6587 * @return The icon object that was being used on @p obj widget's
6588 * button or @c NULL, on errors
6590 * Unparent and return the icon object which was set for this
6593 * @see elm_fileselector_entry_button_icon_set()
6595 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6598 * Set the title for a given file selector entry widget's window
6600 * @param obj The file selector entry widget
6601 * @param title The title string
6603 * This will change the window's title, when the file selector pops
6604 * out after a click on the entry's button. Those windows have the
6605 * default (unlocalized) value of @c "Select a file" as titles.
6607 * @note It will only take any effect if the file selector
6608 * entry widget is @b not under "inwin mode".
6610 * @see elm_fileselector_entry_window_title_get()
6612 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6615 * Get the title set for a given file selector entry widget's
6618 * @param obj The file selector entry widget
6619 * @return Title of the file selector entry's window
6621 * @see elm_fileselector_entry_window_title_get() for more details
6623 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6626 * Set the size of a given file selector entry widget's window,
6627 * holding the file selector itself.
6629 * @param obj The file selector entry widget
6630 * @param width The window's width
6631 * @param height The window's height
6633 * @note it will only take any effect if the file selector entry
6634 * widget is @b not under "inwin mode". The default size for the
6635 * window (when applicable) is 400x400 pixels.
6637 * @see elm_fileselector_entry_window_size_get()
6639 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6642 * Get the size of a given file selector entry widget's window,
6643 * holding the file selector itself.
6645 * @param obj The file selector entry widget
6646 * @param width Pointer into which to store the width value
6647 * @param height Pointer into which to store the height value
6649 * @note Use @c NULL pointers on the size values you're not
6650 * interested in: they'll be ignored by the function.
6652 * @see elm_fileselector_entry_window_size_set(), for more details
6654 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6657 * Set the initial file system path and the entry's path string for
6658 * a given file selector entry widget
6660 * @param obj The file selector entry widget
6661 * @param path The path string
6663 * It must be a <b>directory</b> path, which will have the contents
6664 * displayed initially in the file selector's view, when invoked
6665 * from @p obj. The default initial path is the @c "HOME"
6666 * environment variable's value.
6668 * @see elm_fileselector_entry_path_get()
6670 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6673 * Get the entry's path string for a given file selector entry
6676 * @param obj The file selector entry widget
6677 * @return path The path string
6679 * @see elm_fileselector_entry_path_set() for more details
6681 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6684 * Enable/disable a tree view in the given file selector entry
6685 * widget's internal file selector
6687 * @param obj The file selector entry widget
6688 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6691 * This has the same effect as elm_fileselector_expandable_set(),
6692 * but now applied to a file selector entry's internal file
6695 * @note There's no way to put a file selector entry's internal
6696 * file selector in "grid mode", as one may do with "pure" file
6699 * @see elm_fileselector_expandable_get()
6701 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6704 * Get whether tree view is enabled for the given file selector
6705 * entry widget's internal file selector
6707 * @param obj The file selector entry widget
6708 * @return @c EINA_TRUE if @p obj widget's internal file selector
6709 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6711 * @see elm_fileselector_expandable_set() for more details
6713 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6716 * Set whether a given file selector entry widget's internal file
6717 * selector is to display folders only or the directory contents,
6720 * @param obj The file selector entry widget
6721 * @param only @c EINA_TRUE to make @p obj widget's internal file
6722 * selector only display directories, @c EINA_FALSE to make files
6723 * to be displayed in it too
6725 * This has the same effect as elm_fileselector_folder_only_set(),
6726 * but now applied to a file selector entry's internal file
6729 * @see elm_fileselector_folder_only_get()
6731 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6734 * Get whether a given file selector entry widget's internal file
6735 * selector is displaying folders only or the directory contents,
6738 * @param obj The file selector entry widget
6739 * @return @c EINA_TRUE if @p obj widget's internal file
6740 * selector is only displaying directories, @c EINA_FALSE if files
6741 * are being displayed in it too (and on errors)
6743 * @see elm_fileselector_entry_folder_only_set() for more details
6745 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6748 * Enable/disable the file name entry box where the user can type
6749 * in a name for a file, in a given file selector entry widget's
6750 * internal file selector.
6752 * @param obj The file selector entry widget
6753 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6754 * file selector a "saving dialog", @c EINA_FALSE otherwise
6756 * This has the same effect as elm_fileselector_is_save_set(),
6757 * but now applied to a file selector entry's internal file
6760 * @see elm_fileselector_is_save_get()
6762 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6765 * Get whether the given file selector entry widget's internal
6766 * file selector is in "saving dialog" mode
6768 * @param obj The file selector entry widget
6769 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6770 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6773 * @see elm_fileselector_entry_is_save_set() for more details
6775 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6778 * Set whether a given file selector entry widget's internal file
6779 * selector will raise an Elementary "inner window", instead of a
6780 * dedicated Elementary window. By default, it won't.
6782 * @param obj The file selector entry widget
6783 * @param value @c EINA_TRUE to make it use an inner window, @c
6784 * EINA_TRUE to make it use a dedicated window
6786 * @see elm_win_inwin_add() for more information on inner windows
6787 * @see elm_fileselector_entry_inwin_mode_get()
6789 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6792 * Get whether a given file selector entry widget's internal file
6793 * selector will raise an Elementary "inner window", instead of a
6794 * dedicated Elementary window.
6796 * @param obj The file selector entry widget
6797 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6798 * if it will use a dedicated window
6800 * @see elm_fileselector_entry_inwin_mode_set() for more details
6802 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6805 * Set the initial file system path for a given file selector entry
6808 * @param obj The file selector entry widget
6809 * @param path The path string
6811 * It must be a <b>directory</b> path, which will have the contents
6812 * displayed initially in the file selector's view, when invoked
6813 * from @p obj. The default initial path is the @c "HOME"
6814 * environment variable's value.
6816 * @see elm_fileselector_entry_path_get()
6818 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6821 * Get the parent directory's path to the latest file selection on
6822 * a given filer selector entry widget
6824 * @param obj The file selector object
6825 * @return The (full) path of the directory of the last selection
6826 * on @p obj widget, a @b stringshared string
6828 * @see elm_fileselector_entry_path_set()
6830 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6837 * @defgroup Scroller Scroller
6839 * A scroller holds a single object and "scrolls it around". This means that
6840 * it allows the user to use a scrollbar (or a finger) to drag the viewable
6841 * region around, allowing to move through a much larger object that is
6842 * contained in the scroller. The scroller will always have a small minimum
6843 * size by default as it won't be limited by the contents of the scroller.
6845 * Signals that you can add callbacks for are:
6846 * @li "edge,left" - the left edge of the content has been reached
6847 * @li "edge,right" - the right edge of the content has been reached
6848 * @li "edge,top" - the top edge of the content has been reached
6849 * @li "edge,bottom" - the bottom edge of the content has been reached
6850 * @li "scroll" - the content has been scrolled (moved)
6851 * @li "scroll,anim,start" - scrolling animation has started
6852 * @li "scroll,anim,stop" - scrolling animation has stopped
6853 * @li "scroll,drag,start" - dragging the contents around has started
6854 * @li "scroll,drag,stop" - dragging the contents around has stopped
6855 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6858 * @note When Elemementary is in embedded mode the scrollbars will not be
6859 * dragable, they appear merely as indicators of how much has been scrolled.
6860 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6861 * fingerscroll) won't work.
6863 * To set/get/unset the content of the panel, you can use
6864 * elm_object_content_set/get/unset APIs.
6865 * Once the content object is set, a previously set one will be deleted.
6866 * If you want to keep that old content object, use the
6867 * elm_object_content_unset() function
6869 * In @ref tutorial_scroller you'll find an example of how to use most of
6874 * @brief Type that controls when scrollbars should appear.
6876 * @see elm_scroller_policy_set()
6878 typedef enum _Elm_Scroller_Policy
6880 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6881 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6882 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6883 ELM_SCROLLER_POLICY_LAST
6884 } Elm_Scroller_Policy;
6886 * @brief Add a new scroller to the parent
6888 * @param parent The parent object
6889 * @return The new object or NULL if it cannot be created
6891 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6893 * @brief Set the content of the scroller widget (the object to be scrolled around).
6895 * @param obj The scroller object
6896 * @param content The new content object
6898 * Once the content object is set, a previously set one will be deleted.
6899 * If you want to keep that old content object, use the
6900 * elm_scroller_content_unset() function.
6901 * @deprecated use elm_object_content_set() instead
6903 EINA_DEPRECATED EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6905 * @brief Get the content of the scroller widget
6907 * @param obj The slider object
6908 * @return The content that is being used
6910 * Return the content object which is set for this widget
6912 * @see elm_scroller_content_set()
6913 * @deprecated use elm_object_content_get() instead.
6915 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6917 * @brief Unset the content of the scroller widget
6919 * @param obj The slider object
6920 * @return The content that was being used
6922 * Unparent and return the content object which was set for this widget
6924 * @see elm_scroller_content_set()
6925 * @deprecated use elm_object_content_unset() instead.
6927 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6929 * @brief Set custom theme elements for the scroller
6931 * @param obj The scroller object
6932 * @param widget The widget name to use (default is "scroller")
6933 * @param base The base name to use (default is "base")
6935 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6937 * @brief Make the scroller minimum size limited to the minimum size of the content
6939 * @param obj The scroller object
6940 * @param w Enable limiting minimum size horizontally
6941 * @param h Enable limiting minimum size vertically
6943 * By default the scroller will be as small as its design allows,
6944 * irrespective of its content. This will make the scroller minimum size the
6945 * right size horizontally and/or vertically to perfectly fit its content in
6948 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6950 * @brief Show a specific virtual region within the scroller content object
6952 * @param obj The scroller object
6953 * @param x X coordinate of the region
6954 * @param y Y coordinate of the region
6955 * @param w Width of the region
6956 * @param h Height of the region
6958 * This will ensure all (or part if it does not fit) of the designated
6959 * region in the virtual content object (0, 0 starting at the top-left of the
6960 * virtual content object) is shown within the scroller.
6962 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);
6964 * @brief Set the scrollbar visibility policy
6966 * @param obj The scroller object
6967 * @param policy_h Horizontal scrollbar policy
6968 * @param policy_v Vertical scrollbar policy
6970 * This sets the scrollbar visibility policy for the given scroller.
6971 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
6972 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6973 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6974 * respectively for the horizontal and vertical scrollbars.
6976 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6978 * @brief Gets scrollbar visibility policy
6980 * @param obj The scroller object
6981 * @param policy_h Horizontal scrollbar policy
6982 * @param policy_v Vertical scrollbar policy
6984 * @see elm_scroller_policy_set()
6986 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
6988 * @brief Get the currently visible content region
6990 * @param obj The scroller object
6991 * @param x X coordinate of the region
6992 * @param y Y coordinate of the region
6993 * @param w Width of the region
6994 * @param h Height of the region
6996 * This gets the current region in the content object that is visible through
6997 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
6998 * w, @p h values pointed to.
7000 * @note All coordinates are relative to the content.
7002 * @see elm_scroller_region_show()
7004 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);
7006 * @brief Get the size of the content object
7008 * @param obj The scroller object
7009 * @param w Width of the content object.
7010 * @param h Height of the content object.
7012 * This gets the size of the content object of the scroller.
7014 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7016 * @brief Set bouncing behavior
7018 * @param obj The scroller object
7019 * @param h_bounce Allow bounce horizontally
7020 * @param v_bounce Allow bounce vertically
7022 * When scrolling, the scroller may "bounce" when reaching an edge of the
7023 * content object. This is a visual way to indicate the end has been reached.
7024 * This is enabled by default for both axis. This API will set if it is enabled
7025 * for the given axis with the boolean parameters for each axis.
7027 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7029 * @brief Get the bounce behaviour
7031 * @param obj The Scroller object
7032 * @param h_bounce Will the scroller bounce horizontally or not
7033 * @param v_bounce Will the scroller bounce vertically or not
7035 * @see elm_scroller_bounce_set()
7037 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7039 * @brief Set scroll page size relative to viewport size.
7041 * @param obj The scroller object
7042 * @param h_pagerel The horizontal page relative size
7043 * @param v_pagerel The vertical page relative size
7045 * The scroller is capable of limiting scrolling by the user to "pages". That
7046 * is to jump by and only show a "whole page" at a time as if the continuous
7047 * area of the scroller content is split into page sized pieces. This sets
7048 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7049 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7050 * axis. This is mutually exclusive with page size
7051 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7052 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7053 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7056 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7058 * @brief Set scroll page size.
7060 * @param obj The scroller object
7061 * @param h_pagesize The horizontal page size
7062 * @param v_pagesize The vertical page size
7064 * This sets the page size to an absolute fixed value, with 0 turning it off
7067 * @see elm_scroller_page_relative_set()
7069 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7071 * @brief Get scroll current page number.
7073 * @param obj The scroller object
7074 * @param h_pagenumber The horizontal page number
7075 * @param v_pagenumber The vertical page number
7077 * The page number starts from 0. 0 is the first page.
7078 * Current page means the page which meets the top-left of the viewport.
7079 * If there are two or more pages in the viewport, it returns the number of the page
7080 * which meets the top-left of the viewport.
7082 * @see elm_scroller_last_page_get()
7083 * @see elm_scroller_page_show()
7084 * @see elm_scroller_page_brint_in()
7086 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7088 * @brief Get scroll last page number.
7090 * @param obj The scroller object
7091 * @param h_pagenumber The horizontal page number
7092 * @param v_pagenumber The vertical page number
7094 * The page number starts from 0. 0 is the first page.
7095 * This returns the last page number among the pages.
7097 * @see elm_scroller_current_page_get()
7098 * @see elm_scroller_page_show()
7099 * @see elm_scroller_page_brint_in()
7101 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7103 * Show a specific virtual region within the scroller content object by page number.
7105 * @param obj The scroller object
7106 * @param h_pagenumber The horizontal page number
7107 * @param v_pagenumber The vertical page number
7109 * 0, 0 of the indicated page is located at the top-left of the viewport.
7110 * This will jump to the page directly without animation.
7115 * sc = elm_scroller_add(win);
7116 * elm_scroller_content_set(sc, content);
7117 * elm_scroller_page_relative_set(sc, 1, 0);
7118 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7119 * elm_scroller_page_show(sc, h_page + 1, v_page);
7122 * @see elm_scroller_page_bring_in()
7124 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7126 * Show a specific virtual region within the scroller content object by page number.
7128 * @param obj The scroller object
7129 * @param h_pagenumber The horizontal page number
7130 * @param v_pagenumber The vertical page number
7132 * 0, 0 of the indicated page is located at the top-left of the viewport.
7133 * This will slide to the page with animation.
7138 * sc = elm_scroller_add(win);
7139 * elm_scroller_content_set(sc, content);
7140 * elm_scroller_page_relative_set(sc, 1, 0);
7141 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7142 * elm_scroller_page_bring_in(sc, h_page, v_page);
7145 * @see elm_scroller_page_show()
7147 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7149 * @brief Show a specific virtual region within the scroller content object.
7151 * @param obj The scroller object
7152 * @param x X coordinate of the region
7153 * @param y Y coordinate of the region
7154 * @param w Width of the region
7155 * @param h Height of the region
7157 * This will ensure all (or part if it does not fit) of the designated
7158 * region in the virtual content object (0, 0 starting at the top-left of the
7159 * virtual content object) is shown within the scroller. Unlike
7160 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7161 * to this location (if configuration in general calls for transitions). It
7162 * may not jump immediately to the new location and make take a while and
7163 * show other content along the way.
7165 * @see elm_scroller_region_show()
7167 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);
7169 * @brief Set event propagation on a scroller
7171 * @param obj The scroller object
7172 * @param propagation If propagation is enabled or not
7174 * This enables or disabled event propagation from the scroller content to
7175 * the scroller and its parent. By default event propagation is disabled.
7177 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7179 * @brief Get event propagation for a scroller
7181 * @param obj The scroller object
7182 * @return The propagation state
7184 * This gets the event propagation for a scroller.
7186 * @see elm_scroller_propagate_events_set()
7188 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7190 * @brief Set scrolling gravity on a scroller
7192 * @param obj The scroller object
7193 * @param x The scrolling horizontal gravity
7194 * @param y The scrolling vertical gravity
7196 * The gravity, defines how the scroller will adjust its view
7197 * when the size of the scroller contents increase.
7199 * The scroller will adjust the view to glue itself as follows.
7201 * x=0.0, for showing the left most region of the content.
7202 * x=1.0, for showing the right most region of the content.
7203 * y=0.0, for showing the bottom most region of the content.
7204 * y=1.0, for showing the top most region of the content.
7206 * Default values for x and y are 0.0
7208 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7210 * @brief Get scrolling gravity values for a scroller
7212 * @param obj The scroller object
7213 * @param x The scrolling horizontal gravity
7214 * @param y The scrolling vertical gravity
7216 * This gets gravity values for a scroller.
7218 * @see elm_scroller_gravity_set()
7221 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7227 * @defgroup Label Label
7229 * @image html img/widget/label/preview-00.png
7230 * @image latex img/widget/label/preview-00.eps
7232 * @brief Widget to display text, with simple html-like markup.
7234 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7235 * text doesn't fit the geometry of the label it will be ellipsized or be
7236 * cut. Elementary provides several themes for this widget:
7237 * @li default - No animation
7238 * @li marker - Centers the text in the label and make it bold by default
7239 * @li slide_long - The entire text appears from the right of the screen and
7240 * slides until it disappears in the left of the screen(reappering on the
7242 * @li slide_short - The text appears in the left of the label and slides to
7243 * the right to show the overflow. When all of the text has been shown the
7244 * position is reset.
7245 * @li slide_bounce - The text appears in the left of the label and slides to
7246 * the right to show the overflow. When all of the text has been shown the
7247 * animation reverses, moving the text to the left.
7249 * Custom themes can of course invent new markup tags and style them any way
7252 * The following signals may be emitted by the label widget:
7253 * @li "language,changed": The program's language changed.
7255 * See @ref tutorial_label for a demonstration of how to use a label widget.
7259 * @brief Add a new label to the parent
7261 * @param parent The parent object
7262 * @return The new object or NULL if it cannot be created
7264 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7266 * @brief Set the label on the label object
7268 * @param obj The label object
7269 * @param label The label will be used on the label object
7270 * @deprecated See elm_object_text_set()
7272 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 */
7274 * @brief Get the label used on the label object
7276 * @param obj The label object
7277 * @return The string inside the label
7278 * @deprecated See elm_object_text_get()
7280 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7282 * @brief Set the wrapping behavior of the label
7284 * @param obj The label object
7285 * @param wrap To wrap text or not
7287 * By default no wrapping is done. Possible values for @p wrap are:
7288 * @li ELM_WRAP_NONE - No wrapping
7289 * @li ELM_WRAP_CHAR - wrap between characters
7290 * @li ELM_WRAP_WORD - wrap between words
7291 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7293 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7295 * @brief Get the wrapping behavior of the label
7297 * @param obj The label object
7300 * @see elm_label_line_wrap_set()
7302 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7304 * @brief Set wrap width of the label
7306 * @param obj The label object
7307 * @param w The wrap width in pixels at a minimum where words need to wrap
7309 * This function sets the maximum width size hint of the label.
7311 * @warning This is only relevant if the label is inside a container.
7313 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7315 * @brief Get wrap width of the label
7317 * @param obj The label object
7318 * @return The wrap width in pixels at a minimum where words need to wrap
7320 * @see elm_label_wrap_width_set()
7322 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7324 * @brief Set wrap height of the label
7326 * @param obj The label object
7327 * @param h The wrap height in pixels at a minimum where words need to wrap
7329 * This function sets the maximum height size hint of the label.
7331 * @warning This is only relevant if the label is inside a container.
7333 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7335 * @brief get wrap width of the label
7337 * @param obj The label object
7338 * @return The wrap height in pixels at a minimum where words need to wrap
7340 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7342 * @brief Set the font size on the label object.
7344 * @param obj The label object
7345 * @param size font size
7347 * @warning NEVER use this. It is for hyper-special cases only. use styles
7348 * instead. e.g. "big", "medium", "small" - or better name them by use:
7349 * "title", "footnote", "quote" etc.
7351 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7353 * @brief Set the text color on the label object
7355 * @param obj The label object
7356 * @param r Red property background color of The label object
7357 * @param g Green property background color of The label object
7358 * @param b Blue property background color of The label object
7359 * @param a Alpha property background color of The label object
7361 * @warning NEVER use this. It is for hyper-special cases only. use styles
7362 * instead. e.g. "big", "medium", "small" - or better name them by use:
7363 * "title", "footnote", "quote" etc.
7365 EAPI void elm_label_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a) EINA_ARG_NONNULL(1);
7367 * @brief Set the text align on the label object
7369 * @param obj The label object
7370 * @param align align mode ("left", "center", "right")
7372 * @warning NEVER use this. It is for hyper-special cases only. use styles
7373 * instead. e.g. "big", "medium", "small" - or better name them by use:
7374 * "title", "footnote", "quote" etc.
7376 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7378 * @brief Set background color of the label
7380 * @param obj The label object
7381 * @param r Red property background color of The label object
7382 * @param g Green property background color of The label object
7383 * @param b Blue property background color of The label object
7384 * @param a Alpha property background alpha of The label object
7386 * @warning NEVER use this. It is for hyper-special cases only. use styles
7387 * instead. e.g. "big", "medium", "small" - or better name them by use:
7388 * "title", "footnote", "quote" etc.
7390 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);
7392 * @brief Set the ellipsis behavior of the label
7394 * @param obj The label object
7395 * @param ellipsis To ellipsis text or not
7397 * If set to true and the text doesn't fit in the label an ellipsis("...")
7398 * will be shown at the end of the widget.
7400 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7401 * choosen wrap method was ELM_WRAP_WORD.
7403 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7405 * @brief Set the text slide of the label
7407 * @param obj The label object
7408 * @param slide To start slide or stop
7410 * If set to true, the text of the label will slide/scroll through the length of
7413 * @warning This only works with the themes "slide_short", "slide_long" and
7416 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7418 * @brief Get the text slide mode of the label
7420 * @param obj The label object
7421 * @return slide slide mode value
7423 * @see elm_label_slide_set()
7425 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7427 * @brief Set the slide duration(speed) of the label
7429 * @param obj The label object
7430 * @return The duration in seconds in moving text from slide begin position
7431 * to slide end position
7433 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7435 * @brief Get the slide duration(speed) of the label
7437 * @param obj The label object
7438 * @return The duration time in moving text from slide begin position to slide end position
7440 * @see elm_label_slide_duration_set()
7442 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7448 * @defgroup Toggle Toggle
7450 * @image html img/widget/toggle/preview-00.png
7451 * @image latex img/widget/toggle/preview-00.eps
7453 * @brief A toggle is a slider which can be used to toggle between
7454 * two values. It has two states: on and off.
7456 * This widget is deprecated. Please use elm_check_add() instead using the
7457 * toggle style like:
7460 * obj = elm_check_add(parent);
7461 * elm_object_style_set(obj, "toggle");
7462 * elm_object_text_part_set(obj, "on", "ON");
7463 * elm_object_text_part_set(obj, "off", "OFF");
7466 * Signals that you can add callbacks for are:
7467 * @li "changed" - Whenever the toggle value has been changed. Is not called
7468 * until the toggle is released by the cursor (assuming it
7469 * has been triggered by the cursor in the first place).
7471 * @ref tutorial_toggle show how to use a toggle.
7475 * @brief Add a toggle to @p parent.
7477 * @param parent The parent object
7479 * @return The toggle object
7481 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7483 * @brief Sets the label to be displayed with the toggle.
7485 * @param obj The toggle object
7486 * @param label The label to be displayed
7488 * @deprecated use elm_object_text_set() instead.
7490 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7492 * @brief Gets the label of the toggle
7494 * @param obj toggle object
7495 * @return The label of the toggle
7497 * @deprecated use elm_object_text_get() instead.
7499 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7501 * @brief Set the icon used for the toggle
7503 * @param obj The toggle object
7504 * @param icon The icon object for the button
7506 * Once the icon object is set, a previously set one will be deleted
7507 * If you want to keep that old content object, use the
7508 * elm_toggle_icon_unset() function.
7510 * @deprecated use elm_object_content_set() instead.
7512 EINA_DEPRECATED EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7514 * @brief Get the icon used for the toggle
7516 * @param obj The toggle object
7517 * @return The icon object that is being used
7519 * Return the icon object which is set for this widget.
7521 * @see elm_toggle_icon_set()
7523 * @deprecated use elm_object_content_get() instead.
7525 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7527 * @brief Unset the icon used for the toggle
7529 * @param obj The toggle object
7530 * @return The icon object that was being used
7532 * Unparent and return the icon object which was set for this widget.
7534 * @see elm_toggle_icon_set()
7536 * @deprecated use elm_object_content_unset() instead.
7538 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7540 * @brief Sets the labels to be associated with the on and off states of the toggle.
7542 * @param obj The toggle object
7543 * @param onlabel The label displayed when the toggle is in the "on" state
7544 * @param offlabel The label displayed when the toggle is in the "off" state
7546 * @deprecated use elm_object_text_part_set() for "on" and "off" parts
7549 EINA_DEPRECATED EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7551 * @brief Gets the labels associated with the on and off states of the
7554 * @param obj The toggle object
7555 * @param onlabel A char** to place the onlabel of @p obj into
7556 * @param offlabel A char** to place the offlabel of @p obj into
7558 * @deprecated use elm_object_text_part_get() for "on" and "off" parts
7561 EINA_DEPRECATED EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7563 * @brief Sets the state of the toggle to @p state.
7565 * @param obj The toggle object
7566 * @param state The state of @p obj
7568 * @deprecated use elm_check_state_set() instead.
7570 EINA_DEPRECATED EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7572 * @brief Gets the state of the toggle to @p state.
7574 * @param obj The toggle object
7575 * @return The state of @p obj
7577 * @deprecated use elm_check_state_get() instead.
7579 EINA_DEPRECATED EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7581 * @brief Sets the state pointer of the toggle to @p statep.
7583 * @param obj The toggle object
7584 * @param statep The state pointer of @p obj
7586 * @deprecated use elm_check_state_pointer_set() instead.
7588 EINA_DEPRECATED EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7594 * @defgroup Frame Frame
7596 * @image html img/widget/frame/preview-00.png
7597 * @image latex img/widget/frame/preview-00.eps
7599 * @brief Frame is a widget that holds some content and has a title.
7601 * The default look is a frame with a title, but Frame supports multple
7609 * @li outdent_bottom
7611 * Of all this styles only default shows the title. Frame emits no signals.
7613 * Default contents parts of the frame widget that you can use for are:
7614 * @li "elm.swallow.content" - A content of the frame
7616 * Default text parts of the frame widget that you can use for are:
7617 * @li "elm.text" - Label of the frame
7619 * For a detailed example see the @ref tutorial_frame.
7624 * @brief Add a new frame to the parent
7626 * @param parent The parent object
7627 * @return The new object or NULL if it cannot be created
7629 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7631 * @brief Set the frame label
7633 * @param obj The frame object
7634 * @param label The label of this frame object
7636 * @deprecated use elm_object_text_set() instead.
7638 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7640 * @brief Get the frame label
7642 * @param obj The frame object
7644 * @return The label of this frame objet or NULL if unable to get frame
7646 * @deprecated use elm_object_text_get() instead.
7648 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7650 * @brief Set the content of the frame widget
7652 * Once the content object is set, a previously set one will be deleted.
7653 * If you want to keep that old content object, use the
7654 * elm_frame_content_unset() function.
7656 * @param obj The frame object
7657 * @param content The content will be filled in this frame object
7659 * @deprecated use elm_object_content_set() instead.
7661 EINA_DEPRECATED EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7663 * @brief Get the content of the frame widget
7665 * Return the content object which is set for this widget
7667 * @param obj The frame object
7668 * @return The content that is being used
7670 * @deprecated use elm_object_content_get() instead.
7672 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7674 * @brief Unset the content of the frame widget
7676 * Unparent and return the content object which was set for this widget
7678 * @param obj The frame object
7679 * @return The content that was being used
7681 * @deprecated use elm_object_content_unset() instead.
7683 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7689 * @defgroup Table Table
7691 * A container widget to arrange other widgets in a table where items can
7692 * also span multiple columns or rows - even overlap (and then be raised or
7693 * lowered accordingly to adjust stacking if they do overlap).
7695 * For a Table widget the row/column count is not fixed.
7696 * The table widget adjusts itself when subobjects are added to it dynamically.
7698 * The followin are examples of how to use a table:
7699 * @li @ref tutorial_table_01
7700 * @li @ref tutorial_table_02
7705 * @brief Add a new table to the parent
7707 * @param parent The parent object
7708 * @return The new object or NULL if it cannot be created
7710 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7712 * @brief Set the homogeneous layout in the table
7714 * @param obj The layout object
7715 * @param homogeneous A boolean to set if the layout is homogeneous in the
7716 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7718 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7720 * @brief Get the current table homogeneous mode.
7722 * @param obj The table object
7723 * @return A boolean to indicating if the layout is homogeneous in the table
7724 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7726 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7728 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7730 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7732 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7734 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7736 * @brief Set padding between cells.
7738 * @param obj The layout object.
7739 * @param horizontal set the horizontal padding.
7740 * @param vertical set the vertical padding.
7742 * Default value is 0.
7744 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7746 * @brief Get padding between cells.
7748 * @param obj The layout object.
7749 * @param horizontal set the horizontal padding.
7750 * @param vertical set the vertical padding.
7752 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7754 * @brief Add a subobject on the table with the coordinates passed
7756 * @param obj The table object
7757 * @param subobj The subobject to be added to the table
7758 * @param x Row number
7759 * @param y Column number
7763 * @note All positioning inside the table is relative to rows and columns, so
7764 * a value of 0 for x and y, means the top left cell of the table, and a
7765 * value of 1 for w and h means @p subobj only takes that 1 cell.
7767 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7769 * @brief Remove child from table.
7771 * @param obj The table object
7772 * @param subobj The subobject
7774 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7776 * @brief Faster way to remove all child objects from a table object.
7778 * @param obj The table object
7779 * @param clear If true, will delete children, else just remove from table.
7781 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7783 * @brief Set the packing location of an existing child of the table
7785 * @param subobj The subobject to be modified in the table
7786 * @param x Row number
7787 * @param y Column number
7791 * Modifies the position of an object already in the table.
7793 * @note All positioning inside the table is relative to rows and columns, so
7794 * a value of 0 for x and y, means the top left cell of the table, and a
7795 * value of 1 for w and h means @p subobj only takes that 1 cell.
7797 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7799 * @brief Get the packing location of an existing child of the table
7801 * @param subobj The subobject to be modified in the table
7802 * @param x Row number
7803 * @param y Column number
7807 * @see elm_table_pack_set()
7809 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7814 /* TEMPORARY: DOCS WILL BE FILLED IN WITH CNP/SED */
7815 typedef struct Elm_Gen_Item Elm_Gen_Item;
7816 typedef struct _Elm_Gen_Item_Class Elm_Gen_Item_Class;
7817 typedef struct _Elm_Gen_Item_Class_Func Elm_Gen_Item_Class_Func; /**< Class functions for gen item classes. */
7818 typedef char *(*Elm_Gen_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gen item classes. */
7819 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. */
7820 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. */
7821 typedef void (*Elm_Gen_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gen item classes. */
7822 struct _Elm_Gen_Item_Class
7824 const char *item_style;
7825 struct _Elm_Gen_Item_Class_Func
7827 Elm_Gen_Item_Label_Get_Cb label_get;
7828 Elm_Gen_Item_Content_Get_Cb content_get;
7829 Elm_Gen_Item_State_Get_Cb state_get;
7830 Elm_Gen_Item_Del_Cb del;
7833 EAPI void elm_gen_clear(Evas_Object *obj);
7834 EAPI void elm_gen_item_selected_set(Elm_Gen_Item *it, Eina_Bool selected);
7835 EAPI Eina_Bool elm_gen_item_selected_get(const Elm_Gen_Item *it);
7836 EAPI void elm_gen_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
7837 EAPI Eina_Bool elm_gen_always_select_mode_get(const Evas_Object *obj);
7838 EAPI void elm_gen_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
7839 EAPI Eina_Bool elm_gen_no_select_mode_get(const Evas_Object *obj);
7840 EAPI void elm_gen_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
7841 EAPI void elm_gen_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
7842 EAPI void elm_gen_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
7843 EAPI void elm_gen_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
7844 EAPI void elm_gen_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
7845 EAPI void elm_gen_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
7846 EAPI void elm_gen_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
7847 EAPI void elm_gen_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
7848 EAPI void elm_gen_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
7849 EAPI Elm_Gen_Item *elm_gen_first_item_get(const Evas_Object *obj);
7850 EAPI Elm_Gen_Item *elm_gen_last_item_get(const Evas_Object *obj);
7851 EAPI Elm_Gen_Item *elm_gen_item_next_get(const Elm_Gen_Item *it);
7852 EAPI Elm_Gen_Item *elm_gen_item_prev_get(const Elm_Gen_Item *it);
7853 EAPI Evas_Object *elm_gen_item_widget_get(const Elm_Gen_Item *it);
7856 * @defgroup Gengrid Gengrid (Generic grid)
7858 * This widget aims to position objects in a grid layout while
7859 * actually creating and rendering only the visible ones, using the
7860 * same idea as the @ref Genlist "genlist": the user defines a @b
7861 * class for each item, specifying functions that will be called at
7862 * object creation, deletion, etc. When those items are selected by
7863 * the user, a callback function is issued. Users may interact with
7864 * a gengrid via the mouse (by clicking on items to select them and
7865 * clicking on the grid's viewport and swiping to pan the whole
7866 * view) or via the keyboard, navigating through item with the
7869 * @section Gengrid_Layouts Gengrid layouts
7871 * Gengrid may layout its items in one of two possible layouts:
7875 * When in "horizontal mode", items will be placed in @b columns,
7876 * from top to bottom and, when the space for a column is filled,
7877 * another one is started on the right, thus expanding the grid
7878 * horizontally, making for horizontal scrolling. When in "vertical
7879 * mode" , though, items will be placed in @b rows, from left to
7880 * right and, when the space for a row is filled, another one is
7881 * started below, thus expanding the grid vertically (and making
7882 * for vertical scrolling).
7884 * @section Gengrid_Items Gengrid items
7886 * An item in a gengrid can have 0 or more text labels (they can be
7887 * regular text or textblock Evas objects - that's up to the style
7888 * to determine), 0 or more icons (which are simply objects
7889 * swallowed into the gengrid item's theming Edje object) and 0 or
7890 * more <b>boolean states</b>, which have the behavior left to the
7891 * user to define. The Edje part names for each of these properties
7892 * will be looked up, in the theme file for the gengrid, under the
7893 * Edje (string) data items named @c "labels", @c "icons" and @c
7894 * "states", respectively. For each of those properties, if more
7895 * than one part is provided, they must have names listed separated
7896 * by spaces in the data fields. For the default gengrid item
7897 * theme, we have @b one label part (@c "elm.text"), @b two icon
7898 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7901 * A gengrid item may be at one of several styles. Elementary
7902 * provides one by default - "default", but this can be extended by
7903 * system or application custom themes/overlays/extensions (see
7904 * @ref Theme "themes" for more details).
7906 * @section Gengrid_Item_Class Gengrid item classes
7908 * In order to have the ability to add and delete items on the fly,
7909 * gengrid implements a class (callback) system where the
7910 * application provides a structure with information about that
7911 * type of item (gengrid may contain multiple different items with
7912 * different classes, states and styles). Gengrid will call the
7913 * functions in this struct (methods) when an item is "realized"
7914 * (i.e., created dynamically, while the user is scrolling the
7915 * grid). All objects will simply be deleted when no longer needed
7916 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7917 * contains the following members:
7918 * - @c item_style - This is a constant string and simply defines
7919 * the name of the item style. It @b must be specified and the
7920 * default should be @c "default".
7921 * - @c func.label_get - This function is called when an item
7922 * object is actually created. The @c data parameter will point to
7923 * the same data passed to elm_gengrid_item_append() and related
7924 * item creation functions. The @c obj parameter is the gengrid
7925 * object itself, while the @c part one is the name string of one
7926 * of the existing text parts in the Edje group implementing the
7927 * item's theme. This function @b must return a strdup'()ed string,
7928 * as the caller will free() it when done. See
7929 * #Elm_Gengrid_Item_Label_Get_Cb.
7930 * - @c func.content_get - This function is called when an item object
7931 * is actually created. The @c data parameter will point to the
7932 * same data passed to elm_gengrid_item_append() and related item
7933 * creation functions. The @c obj parameter is the gengrid object
7934 * itself, while the @c part one is the name string of one of the
7935 * existing (content) swallow parts in the Edje group implementing the
7936 * item's theme. It must return @c NULL, when no content is desired,
7937 * or a valid object handle, otherwise. The object will be deleted
7938 * by the gengrid on its deletion or when the item is "unrealized".
7939 * See #Elm_Gengrid_Item_Content_Get_Cb.
7940 * - @c func.state_get - This function is called when an item
7941 * object is actually created. The @c data parameter will point to
7942 * the same data passed to elm_gengrid_item_append() and related
7943 * item creation functions. The @c obj parameter is the gengrid
7944 * object itself, while the @c part one is the name string of one
7945 * of the state parts in the Edje group implementing the item's
7946 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7947 * true/on. Gengrids will emit a signal to its theming Edje object
7948 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7949 * "source" arguments, respectively, when the state is true (the
7950 * default is false), where @c XXX is the name of the (state) part.
7951 * See #Elm_Gengrid_Item_State_Get_Cb.
7952 * - @c func.del - This is called when elm_gengrid_item_del() is
7953 * called on an item or elm_gengrid_clear() is called on the
7954 * gengrid. This is intended for use when gengrid items are
7955 * deleted, so any data attached to the item (e.g. its data
7956 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7958 * @section Gengrid_Usage_Hints Usage hints
7960 * If the user wants to have multiple items selected at the same
7961 * time, elm_gengrid_multi_select_set() will permit it. If the
7962 * gengrid is single-selection only (the default), then
7963 * elm_gengrid_select_item_get() will return the selected item or
7964 * @c NULL, if none is selected. If the gengrid is under
7965 * multi-selection, then elm_gengrid_selected_items_get() will
7966 * return a list (that is only valid as long as no items are
7967 * modified (added, deleted, selected or unselected) of child items
7970 * If an item changes (internal (boolean) state, label or content
7971 * changes), then use elm_gengrid_item_update() to have gengrid
7972 * update the item with the new state. A gengrid will re-"realize"
7973 * the item, thus calling the functions in the
7974 * #Elm_Gengrid_Item_Class set for that item.
7976 * To programmatically (un)select an item, use
7977 * elm_gengrid_item_selected_set(). To get its selected state use
7978 * elm_gengrid_item_selected_get(). To make an item disabled
7979 * (unable to be selected and appear differently) use
7980 * elm_gengrid_item_disabled_set() to set this and
7981 * elm_gengrid_item_disabled_get() to get the disabled state.
7983 * Grid cells will only have their selection smart callbacks called
7984 * when firstly getting selected. Any further clicks will do
7985 * nothing, unless you enable the "always select mode", with
7986 * elm_gengrid_always_select_mode_set(), thus making every click to
7987 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7988 * turn off the ability to select items entirely in the widget and
7989 * they will neither appear selected nor call the selection smart
7992 * Remember that you can create new styles and add your own theme
7993 * augmentation per application with elm_theme_extension_add(). If
7994 * you absolutely must have a specific style that overrides any
7995 * theme the user or system sets up you can use
7996 * elm_theme_overlay_add() to add such a file.
7998 * @section Gengrid_Smart_Events Gengrid smart events
8000 * Smart events that you can add callbacks for are:
8001 * - @c "activated" - The user has double-clicked or pressed
8002 * (enter|return|spacebar) on an item. The @c event_info parameter
8003 * is the gengrid item that was activated.
8004 * - @c "clicked,double" - The user has double-clicked an item.
8005 * The @c event_info parameter is the gengrid item that was double-clicked.
8006 * - @c "longpressed" - This is called when the item is pressed for a certain
8007 * amount of time. By default it's 1 second.
8008 * - @c "selected" - The user has made an item selected. The
8009 * @c event_info parameter is the gengrid item that was selected.
8010 * - @c "unselected" - The user has made an item unselected. The
8011 * @c event_info parameter is the gengrid item that was unselected.
8012 * - @c "realized" - This is called when the item in the gengrid
8013 * has its implementing Evas object instantiated, de facto. @c
8014 * event_info is the gengrid item that was created. The object
8015 * may be deleted at any time, so it is highly advised to the
8016 * caller @b not to use the object pointer returned from
8017 * elm_gengrid_item_object_get(), because it may point to freed
8019 * - @c "unrealized" - This is called when the implementing Evas
8020 * object for this item is deleted. @c event_info is the gengrid
8021 * item that was deleted.
8022 * - @c "changed" - Called when an item is added, removed, resized
8023 * or moved and when the gengrid is resized or gets "horizontal"
8025 * - @c "scroll,anim,start" - This is called when scrolling animation has
8027 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8029 * - @c "drag,start,up" - Called when the item in the gengrid has
8030 * been dragged (not scrolled) up.
8031 * - @c "drag,start,down" - Called when the item in the gengrid has
8032 * been dragged (not scrolled) down.
8033 * - @c "drag,start,left" - Called when the item in the gengrid has
8034 * been dragged (not scrolled) left.
8035 * - @c "drag,start,right" - Called when the item in the gengrid has
8036 * been dragged (not scrolled) right.
8037 * - @c "drag,stop" - Called when the item in the gengrid has
8038 * stopped being dragged.
8039 * - @c "drag" - Called when the item in the gengrid is being
8041 * - @c "scroll" - called when the content has been scrolled
8043 * - @c "scroll,drag,start" - called when dragging the content has
8045 * - @c "scroll,drag,stop" - called when dragging the content has
8047 * - @c "edge,top" - This is called when the gengrid is scrolled until
8049 * - @c "edge,bottom" - This is called when the gengrid is scrolled
8050 * until the bottom edge.
8051 * - @c "edge,left" - This is called when the gengrid is scrolled
8052 * until the left edge.
8053 * - @c "edge,right" - This is called when the gengrid is scrolled
8054 * until the right edge.
8056 * List of gengrid examples:
8057 * @li @ref gengrid_example
8061 * @addtogroup Gengrid
8065 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8066 #define Elm_Gengrid_Item_Class Elm_Gen_Item_Class
8067 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8068 #define Elm_Gengrid_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
8069 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8070 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
8071 typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Content (swallowed object) fetching class function for gengrid item classes. */
8072 typedef Eina_Bool (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gengrid item classes. */
8073 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
8076 * @struct _Elm_Gengrid_Item_Class
8078 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8081 struct _Elm_Gengrid_Item_Class
8083 const char *item_style;
8084 struct _Elm_Gengrid_Item_Class_Func
8086 Elm_Gengrid_Item_Label_Get_Cb label_get;
8087 Elm_Gengrid_Item_Content_Get_Cb content_get;
8088 Elm_Gengrid_Item_State_Get_Cb state_get;
8089 Elm_Gengrid_Item_Del_Cb del;
8091 }; /**< #Elm_Gengrid_Item_Class member definitions */
8092 #define Elm_Gengrid_Item_Class_Func Elm_Gen_Item_Class_Func
8094 * Add a new gengrid widget to the given parent Elementary
8095 * (container) object
8097 * @param parent The parent object
8098 * @return a new gengrid widget handle or @c NULL, on errors
8100 * This function inserts a new gengrid widget on the canvas.
8102 * @see elm_gengrid_item_size_set()
8103 * @see elm_gengrid_group_item_size_set()
8104 * @see elm_gengrid_horizontal_set()
8105 * @see elm_gengrid_item_append()
8106 * @see elm_gengrid_item_del()
8107 * @see elm_gengrid_clear()
8111 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8114 * Set the size for the items of a given gengrid widget
8116 * @param obj The gengrid object.
8117 * @param w The items' width.
8118 * @param h The items' height;
8120 * A gengrid, after creation, has still no information on the size
8121 * to give to each of its cells. So, you most probably will end up
8122 * with squares one @ref Fingers "finger" wide, the default
8123 * size. Use this function to force a custom size for you items,
8124 * making them as big as you wish.
8126 * @see elm_gengrid_item_size_get()
8130 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8133 * Get the size set for the items of a given gengrid widget
8135 * @param obj The gengrid object.
8136 * @param w Pointer to a variable where to store the items' width.
8137 * @param h Pointer to a variable where to store the items' height.
8139 * @note Use @c NULL pointers on the size values you're not
8140 * interested in: they'll be ignored by the function.
8142 * @see elm_gengrid_item_size_get() for more details
8146 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8149 * Set the size for the group items of a given gengrid widget
8151 * @param obj The gengrid object.
8152 * @param w The group items' width.
8153 * @param h The group items' height;
8155 * A gengrid, after creation, has still no information on the size
8156 * to give to each of its cells. So, you most probably will end up
8157 * with squares one @ref Fingers "finger" wide, the default
8158 * size. Use this function to force a custom size for you group items,
8159 * making them as big as you wish.
8161 * @see elm_gengrid_group_item_size_get()
8165 EAPI void elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8168 * Get the size set for the group items of a given gengrid widget
8170 * @param obj The gengrid object.
8171 * @param w Pointer to a variable where to store the group items' width.
8172 * @param h Pointer to a variable where to store the group items' height.
8174 * @note Use @c NULL pointers on the size values you're not
8175 * interested in: they'll be ignored by the function.
8177 * @see elm_gengrid_group_item_size_get() for more details
8181 EAPI void elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8184 * Set the items grid's alignment within a given gengrid widget
8186 * @param obj The gengrid object.
8187 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8188 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8190 * This sets the alignment of the whole grid of items of a gengrid
8191 * within its given viewport. By default, those values are both
8192 * 0.5, meaning that the gengrid will have its items grid placed
8193 * exactly in the middle of its viewport.
8195 * @note If given alignment values are out of the cited ranges,
8196 * they'll be changed to the nearest boundary values on the valid
8199 * @see elm_gengrid_align_get()
8203 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8206 * Get the items grid's alignment values within a given gengrid
8209 * @param obj The gengrid object.
8210 * @param align_x Pointer to a variable where to store the
8211 * horizontal alignment.
8212 * @param align_y Pointer to a variable where to store the vertical
8215 * @note Use @c NULL pointers on the alignment values you're not
8216 * interested in: they'll be ignored by the function.
8218 * @see elm_gengrid_align_set() for more details
8222 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8225 * Set whether a given gengrid widget is or not able have items
8228 * @param obj The gengrid object
8229 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8230 * @c EINA_FALSE to turn it off
8232 * If a gengrid is set to allow reordering, a click held for more
8233 * than 0.5 over a given item will highlight it specially,
8234 * signalling the gengrid has entered the reordering state. From
8235 * that time on, the user will be able to, while still holding the
8236 * mouse button down, move the item freely in the gengrid's
8237 * viewport, replacing to said item to the locations it goes to.
8238 * The replacements will be animated and, whenever the user
8239 * releases the mouse button, the item being replaced gets a new
8240 * definitive place in the grid.
8242 * @see elm_gengrid_reorder_mode_get()
8246 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8249 * Get whether a given gengrid widget is or not able have items
8252 * @param obj The gengrid object
8253 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8256 * @see elm_gengrid_reorder_mode_set() for more details
8260 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8263 * Append a new item in a given gengrid widget.
8265 * @param obj The gengrid object.
8266 * @param gic The item class for the item.
8267 * @param data The item data.
8268 * @param func Convenience function called when the item is
8270 * @param func_data Data to be passed to @p func.
8271 * @return A handle to the item added or @c NULL, on errors.
8273 * This adds an item to the beginning of the gengrid.
8275 * @see elm_gengrid_item_prepend()
8276 * @see elm_gengrid_item_insert_before()
8277 * @see elm_gengrid_item_insert_after()
8278 * @see elm_gengrid_item_del()
8282 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);
8285 * Prepend a new item in a given gengrid widget.
8287 * @param obj The gengrid object.
8288 * @param gic The item class for the item.
8289 * @param data The item data.
8290 * @param func Convenience function called when the item is
8292 * @param func_data Data to be passed to @p func.
8293 * @return A handle to the item added or @c NULL, on errors.
8295 * This adds an item to the end of the gengrid.
8297 * @see elm_gengrid_item_append()
8298 * @see elm_gengrid_item_insert_before()
8299 * @see elm_gengrid_item_insert_after()
8300 * @see elm_gengrid_item_del()
8304 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);
8307 * Insert an item before another in a gengrid widget
8309 * @param obj The gengrid object.
8310 * @param gic The item class for the item.
8311 * @param data The item data.
8312 * @param relative The item to place this new one before.
8313 * @param func Convenience function called when the item is
8315 * @param func_data Data to be passed to @p func.
8316 * @return A handle to the item added or @c NULL, on errors.
8318 * This inserts an item before another in the gengrid.
8320 * @see elm_gengrid_item_append()
8321 * @see elm_gengrid_item_prepend()
8322 * @see elm_gengrid_item_insert_after()
8323 * @see elm_gengrid_item_del()
8327 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);
8330 * Insert an item after another in a gengrid widget
8332 * @param obj The gengrid object.
8333 * @param gic The item class for the item.
8334 * @param data The item data.
8335 * @param relative The item to place this new one after.
8336 * @param func Convenience function called when the item is
8338 * @param func_data Data to be passed to @p func.
8339 * @return A handle to the item added or @c NULL, on errors.
8341 * This inserts an item after another in the gengrid.
8343 * @see elm_gengrid_item_append()
8344 * @see elm_gengrid_item_prepend()
8345 * @see elm_gengrid_item_insert_after()
8346 * @see elm_gengrid_item_del()
8350 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);
8353 * Insert an item in a gengrid widget using a user-defined sort function.
8355 * @param obj The gengrid object.
8356 * @param gic The item class for the item.
8357 * @param data The item data.
8358 * @param comp User defined comparison function that defines the sort order based on
8359 * Elm_Gen_Item and its data param.
8360 * @param func Convenience function called when the item is selected.
8361 * @param func_data Data to be passed to @p func.
8362 * @return A handle to the item added or @c NULL, on errors.
8364 * This inserts an item in the gengrid based on user defined comparison function.
8366 * @see elm_gengrid_item_append()
8367 * @see elm_gengrid_item_prepend()
8368 * @see elm_gengrid_item_insert_after()
8369 * @see elm_gengrid_item_del()
8370 * @see elm_gengrid_item_direct_sorted_insert()
8374 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);
8377 * Insert an item in a gengrid widget using a user-defined sort function.
8379 * @param obj The gengrid object.
8380 * @param gic The item class for the item.
8381 * @param data The item data.
8382 * @param comp User defined comparison function that defines the sort order based on
8384 * @param func Convenience function called when the item is selected.
8385 * @param func_data Data to be passed to @p func.
8386 * @return A handle to the item added or @c NULL, on errors.
8388 * This inserts an item in the gengrid based on user defined comparison function.
8390 * @see elm_gengrid_item_append()
8391 * @see elm_gengrid_item_prepend()
8392 * @see elm_gengrid_item_insert_after()
8393 * @see elm_gengrid_item_del()
8394 * @see elm_gengrid_item_sorted_insert()
8398 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);
8401 * Set whether items on a given gengrid widget are to get their
8402 * selection callbacks issued for @b every subsequent selection
8403 * click on them or just for the first click.
8405 * @param obj The gengrid object
8406 * @param always_select @c EINA_TRUE to make items "always
8407 * selected", @c EINA_FALSE, otherwise
8409 * By default, grid items will only call their selection callback
8410 * function when firstly getting selected, any subsequent further
8411 * clicks will do nothing. With this call, you make those
8412 * subsequent clicks also to issue the selection callbacks.
8414 * @note <b>Double clicks</b> will @b always be reported on items.
8416 * @see elm_gengrid_always_select_mode_get()
8420 EINA_DEPRECATED EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8423 * Get whether items on a given gengrid widget have their selection
8424 * callbacks issued for @b every subsequent selection click on them
8425 * or just for the first click.
8427 * @param obj The gengrid object.
8428 * @return @c EINA_TRUE if the gengrid items are "always selected",
8429 * @c EINA_FALSE, otherwise
8431 * @see elm_gengrid_always_select_mode_set() for more details
8435 EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8438 * Set whether items on a given gengrid widget can be selected or not.
8440 * @param obj The gengrid object
8441 * @param no_select @c EINA_TRUE to make items selectable,
8442 * @c EINA_FALSE otherwise
8444 * This will make items in @p obj selectable or not. In the latter
8445 * case, any user interaction on the gengrid items will neither make
8446 * them appear selected nor them call their selection callback
8449 * @see elm_gengrid_no_select_mode_get()
8453 EINA_DEPRECATED EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8456 * Get whether items on a given gengrid widget can be selected or
8459 * @param obj The gengrid object
8460 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8463 * @see elm_gengrid_no_select_mode_set() for more details
8467 EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8470 * Enable or disable multi-selection in a given gengrid widget
8472 * @param obj The gengrid object.
8473 * @param multi @c EINA_TRUE, to enable multi-selection,
8474 * @c EINA_FALSE to disable it.
8476 * Multi-selection is the ability to have @b more than one
8477 * item selected, on a given gengrid, simultaneously. When it is
8478 * enabled, a sequence of clicks on different items will make them
8479 * all selected, progressively. A click on an already selected item
8480 * will unselect it. If interacting via the keyboard,
8481 * multi-selection is enabled while holding the "Shift" key.
8483 * @note By default, multi-selection is @b disabled on gengrids
8485 * @see elm_gengrid_multi_select_get()
8489 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8492 * Get whether multi-selection is enabled or disabled for a given
8495 * @param obj The gengrid object.
8496 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8497 * EINA_FALSE otherwise
8499 * @see elm_gengrid_multi_select_set() for more details
8503 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8506 * Enable or disable bouncing effect for a given gengrid widget
8508 * @param obj The gengrid object
8509 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8510 * @c EINA_FALSE to disable it
8511 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8512 * @c EINA_FALSE to disable it
8514 * The bouncing effect occurs whenever one reaches the gengrid's
8515 * edge's while panning it -- it will scroll past its limits a
8516 * little bit and return to the edge again, in a animated for,
8519 * @note By default, gengrids have bouncing enabled on both axis
8521 * @see elm_gengrid_bounce_get()
8525 EINA_DEPRECATED EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8528 * Get whether bouncing effects are enabled or disabled, for a
8529 * given gengrid widget, on each axis
8531 * @param obj The gengrid object
8532 * @param h_bounce Pointer to a variable where to store the
8533 * horizontal bouncing flag.
8534 * @param v_bounce Pointer to a variable where to store the
8535 * vertical bouncing flag.
8537 * @see elm_gengrid_bounce_set() for more details
8541 EINA_DEPRECATED EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8544 * Set a given gengrid widget's scrolling page size, relative to
8545 * its viewport size.
8547 * @param obj The gengrid object
8548 * @param h_pagerel The horizontal page (relative) size
8549 * @param v_pagerel The vertical page (relative) size
8551 * The gengrid's scroller is capable of binding scrolling by the
8552 * user to "pages". It means that, while scrolling and, specially
8553 * after releasing the mouse button, the grid will @b snap to the
8554 * nearest displaying page's area. When page sizes are set, the
8555 * grid's continuous content area is split into (equal) page sized
8558 * This function sets the size of a page <b>relatively to the
8559 * viewport dimensions</b> of the gengrid, for each axis. A value
8560 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8561 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8562 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8563 * 1.0. Values beyond those will make it behave behave
8564 * inconsistently. If you only want one axis to snap to pages, use
8565 * the value @c 0.0 for the other one.
8567 * There is a function setting page size values in @b absolute
8568 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8569 * is mutually exclusive to this one.
8571 * @see elm_gengrid_page_relative_get()
8575 EINA_DEPRECATED EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8578 * Get a given gengrid widget's scrolling page size, relative to
8579 * its viewport size.
8581 * @param obj The gengrid object
8582 * @param h_pagerel Pointer to a variable where to store the
8583 * horizontal page (relative) size
8584 * @param v_pagerel Pointer to a variable where to store the
8585 * vertical page (relative) size
8587 * @see elm_gengrid_page_relative_set() for more details
8591 EINA_DEPRECATED EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8594 * Set a given gengrid widget's scrolling page size
8596 * @param obj The gengrid object
8597 * @param h_pagerel The horizontal page size, in pixels
8598 * @param v_pagerel The vertical page size, in pixels
8600 * The gengrid's scroller is capable of binding scrolling by the
8601 * user to "pages". It means that, while scrolling and, specially
8602 * after releasing the mouse button, the grid will @b snap to the
8603 * nearest displaying page's area. When page sizes are set, the
8604 * grid's continuous content area is split into (equal) page sized
8607 * This function sets the size of a page of the gengrid, in pixels,
8608 * for each axis. Sane usable values are, between @c 0 and the
8609 * dimensions of @p obj, for each axis. Values beyond those will
8610 * make it behave behave inconsistently. If you only want one axis
8611 * to snap to pages, use the value @c 0 for the other one.
8613 * There is a function setting page size values in @b relative
8614 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8615 * use is mutually exclusive to this one.
8619 EINA_DEPRECATED EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8622 * @brief Get gengrid current page number.
8624 * @param obj The gengrid object
8625 * @param h_pagenumber The horizontal page number
8626 * @param v_pagenumber The vertical page number
8628 * The page number starts from 0. 0 is the first page.
8629 * Current page means the page which meet the top-left of the viewport.
8630 * If there are two or more pages in the viewport, it returns the number of page
8631 * which meet the top-left of the viewport.
8633 * @see elm_gengrid_last_page_get()
8634 * @see elm_gengrid_page_show()
8635 * @see elm_gengrid_page_brint_in()
8637 EINA_DEPRECATED EAPI void elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8640 * @brief Get scroll last page number.
8642 * @param obj The gengrid object
8643 * @param h_pagenumber The horizontal page number
8644 * @param v_pagenumber The vertical page number
8646 * The page number starts from 0. 0 is the first page.
8647 * This returns the last page number among the pages.
8649 * @see elm_gengrid_current_page_get()
8650 * @see elm_gengrid_page_show()
8651 * @see elm_gengrid_page_brint_in()
8653 EINA_DEPRECATED EAPI void elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8656 * Show a specific virtual region within the gengrid content object by page number.
8658 * @param obj The gengrid object
8659 * @param h_pagenumber The horizontal page number
8660 * @param v_pagenumber The vertical page number
8662 * 0, 0 of the indicated page is located at the top-left of the viewport.
8663 * This will jump to the page directly without animation.
8668 * sc = elm_gengrid_add(win);
8669 * elm_gengrid_content_set(sc, content);
8670 * elm_gengrid_page_relative_set(sc, 1, 0);
8671 * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8672 * elm_gengrid_page_show(sc, h_page + 1, v_page);
8675 * @see elm_gengrid_page_bring_in()
8677 EINA_DEPRECATED EAPI void elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8680 * Show a specific virtual region within the gengrid content object by page number.
8682 * @param obj The gengrid object
8683 * @param h_pagenumber The horizontal page number
8684 * @param v_pagenumber The vertical page number
8686 * 0, 0 of the indicated page is located at the top-left of the viewport.
8687 * This will slide to the page with animation.
8692 * sc = elm_gengrid_add(win);
8693 * elm_gengrid_content_set(sc, content);
8694 * elm_gengrid_page_relative_set(sc, 1, 0);
8695 * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8696 * elm_gengrid_page_bring_in(sc, h_page, v_page);
8699 * @see elm_gengrid_page_show()
8701 EINA_DEPRECATED EAPI void elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8704 * Set the direction in which a given gengrid widget will expand while
8705 * placing its items.
8707 * @param obj The gengrid object.
8708 * @param setting @c EINA_TRUE to make the gengrid expand
8709 * horizontally, @c EINA_FALSE to expand vertically.
8711 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8712 * in @b columns, from top to bottom and, when the space for a
8713 * column is filled, another one is started on the right, thus
8714 * expanding the grid horizontally. When in "vertical mode"
8715 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8716 * to right and, when the space for a row is filled, another one is
8717 * started below, thus expanding the grid vertically.
8719 * @see elm_gengrid_horizontal_get()
8723 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8726 * Get for what direction a given gengrid widget will expand while
8727 * placing its items.
8729 * @param obj The gengrid object.
8730 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8731 * @c EINA_FALSE if it's set to expand vertically.
8733 * @see elm_gengrid_horizontal_set() for more detais
8737 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8740 * Get the first item in a given gengrid widget
8742 * @param obj The gengrid object
8743 * @return The first item's handle or @c NULL, if there are no
8744 * items in @p obj (and on errors)
8746 * This returns the first item in the @p obj's internal list of
8749 * @see elm_gengrid_last_item_get()
8753 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8756 * Get the last item in a given gengrid widget
8758 * @param obj The gengrid object
8759 * @return The last item's handle or @c NULL, if there are no
8760 * items in @p obj (and on errors)
8762 * This returns the last item in the @p obj's internal list of
8765 * @see elm_gengrid_first_item_get()
8769 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8772 * Get the @b next item in a gengrid widget's internal list of items,
8773 * given a handle to one of those items.
8775 * @param item The gengrid item to fetch next from
8776 * @return The item after @p item, or @c NULL if there's none (and
8779 * This returns the item placed after the @p item, on the container
8782 * @see elm_gengrid_item_prev_get()
8786 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8789 * Get the @b previous item in a gengrid widget's internal list of items,
8790 * given a handle to one of those items.
8792 * @param item The gengrid item to fetch previous from
8793 * @return The item before @p item, or @c NULL if there's none (and
8796 * This returns the item placed before the @p item, on the container
8799 * @see elm_gengrid_item_next_get()
8803 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8806 * Get the gengrid object's handle which contains a given gengrid
8809 * @param item The item to fetch the container from
8810 * @return The gengrid (parent) object
8812 * This returns the gengrid object itself that an item belongs to.
8816 EINA_DEPRECATED EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8819 * Remove a gengrid item from its parent, deleting it.
8821 * @param item The item to be removed.
8822 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8824 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8829 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8832 * Update the contents of a given gengrid item
8834 * @param item The gengrid item
8836 * This updates an item by calling all the item class functions
8837 * again to get the contents, labels and states. Use this when the
8838 * original item data has changed and you want the changes to be
8843 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8846 * Get the Gengrid Item class for the given Gengrid Item.
8848 * @param item The gengrid item
8850 * This returns the Gengrid_Item_Class for the given item. It can be used to examine
8851 * the function pointers and item_style.
8855 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8858 * Get the Gengrid Item class for the given Gengrid Item.
8860 * This sets the Gengrid_Item_Class for the given item. It can be used to examine
8861 * the function pointers and item_style.
8863 * @param item The gengrid item
8864 * @param gic The gengrid item class describing the function pointers and the item style.
8868 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8871 * Return the data associated to a given gengrid item
8873 * @param item The gengrid item.
8874 * @return the data associated with this item.
8876 * This returns the @c data value passed on the
8877 * elm_gengrid_item_append() and related item addition calls.
8879 * @see elm_gengrid_item_append()
8880 * @see elm_gengrid_item_data_set()
8884 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8887 * Set the data associated with a given gengrid item
8889 * @param item The gengrid item
8890 * @param data The data pointer to set on it
8892 * This @b overrides the @c data value passed on the
8893 * elm_gengrid_item_append() and related item addition calls. This
8894 * function @b won't call elm_gengrid_item_update() automatically,
8895 * so you'd issue it afterwards if you want to have the item
8896 * updated to reflect the new data.
8898 * @see elm_gengrid_item_data_get()
8899 * @see elm_gengrid_item_update()
8903 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8906 * Get a given gengrid item's position, relative to the whole
8907 * gengrid's grid area.
8909 * @param item The Gengrid item.
8910 * @param x Pointer to variable to store the item's <b>row number</b>.
8911 * @param y Pointer to variable to store the item's <b>column number</b>.
8913 * This returns the "logical" position of the item within the
8914 * gengrid. For example, @c (0, 1) would stand for first row,
8919 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8922 * Set whether a given gengrid item is selected or not
8924 * @param item The gengrid item
8925 * @param selected Use @c EINA_TRUE, to make it selected, @c
8926 * EINA_FALSE to make it unselected
8928 * This sets the selected state of an item. If multi-selection is
8929 * not enabled on the containing gengrid and @p selected is @c
8930 * EINA_TRUE, any other previously selected items will get
8931 * unselected in favor of this new one.
8933 * @see elm_gengrid_item_selected_get()
8937 EINA_DEPRECATED EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8940 * Get whether a given gengrid item is selected or not
8942 * @param item The gengrid item
8943 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8945 * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
8947 * @see elm_gengrid_item_selected_set() for more details
8951 EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8954 * Get the real Evas object created to implement the view of a
8955 * given gengrid item
8957 * @param item The gengrid item.
8958 * @return the Evas object implementing this item's view.
8960 * This returns the actual Evas object used to implement the
8961 * specified gengrid item's view. This may be @c NULL, as it may
8962 * not have been created or may have been deleted, at any time, by
8963 * the gengrid. <b>Do not modify this object</b> (move, resize,
8964 * show, hide, etc.), as the gengrid is controlling it. This
8965 * function is for querying, emitting custom signals or hooking
8966 * lower level callbacks for events on that object. Do not delete
8967 * this object under any circumstances.
8969 * @see elm_gengrid_item_data_get()
8973 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8976 * Show the portion of a gengrid's internal grid containing a given
8977 * item, @b immediately.
8979 * @param item The item to display
8981 * This causes gengrid to @b redraw its viewport's contents to the
8982 * region contining the given @p item item, if it is not fully
8985 * @see elm_gengrid_item_bring_in()
8989 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8992 * Animatedly bring in, to the visible area of a gengrid, a given
8995 * @param item The gengrid item to display
8997 * This causes gengrid to jump to the given @p item and show
8998 * it (by scrolling), if it is not fully visible. This will use
8999 * animation to do so and take a period of time to complete.
9001 * @see elm_gengrid_item_show()
9005 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9008 * Set whether a given gengrid item is disabled or not.
9010 * @param item The gengrid item
9011 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9012 * to enable it back.
9014 * A disabled item cannot be selected or unselected. It will also
9015 * change its appearance, to signal the user it's disabled.
9017 * @see elm_gengrid_item_disabled_get()
9021 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9024 * Get whether a given gengrid item is disabled or not.
9026 * @param item The gengrid item
9027 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9030 * @see elm_gengrid_item_disabled_set() for more details
9034 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9037 * Set the text to be shown in a given gengrid item's tooltips.
9039 * @param item The gengrid item
9040 * @param text The text to set in the content
9042 * This call will setup the text to be used as tooltip to that item
9043 * (analogous to elm_object_tooltip_text_set(), but being item
9044 * tooltips with higher precedence than object tooltips). It can
9045 * have only one tooltip at a time, so any previous tooltip data
9050 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9053 * Set the content to be shown in a given gengrid item's tooltip
9055 * @param item The gengrid item.
9056 * @param func The function returning the tooltip contents.
9057 * @param data What to provide to @a func as callback data/context.
9058 * @param del_cb Called when data is not needed anymore, either when
9059 * another callback replaces @p func, the tooltip is unset with
9060 * elm_gengrid_item_tooltip_unset() or the owner @p item
9061 * dies. This callback receives as its first parameter the
9062 * given @p data, being @c event_info the item handle.
9064 * This call will setup the tooltip's contents to @p item
9065 * (analogous to elm_object_tooltip_content_cb_set(), but being
9066 * item tooltips with higher precedence than object tooltips). It
9067 * can have only one tooltip at a time, so any previous tooltip
9068 * content will get removed. @p func (with @p data) will be called
9069 * every time Elementary needs to show the tooltip and it should
9070 * return a valid Evas object, which will be fully managed by the
9071 * tooltip system, getting deleted when the tooltip is gone.
9075 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);
9078 * Unset a tooltip from a given gengrid item
9080 * @param item gengrid item to remove a previously set tooltip from.
9082 * This call removes any tooltip set on @p item. The callback
9083 * provided as @c del_cb to
9084 * elm_gengrid_item_tooltip_content_cb_set() will be called to
9085 * notify it is not used anymore (and have resources cleaned, if
9088 * @see elm_gengrid_item_tooltip_content_cb_set()
9092 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9095 * Set a different @b style for a given gengrid item's tooltip.
9097 * @param item gengrid item with tooltip set
9098 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9099 * "default", @c "transparent", etc)
9101 * Tooltips can have <b>alternate styles</b> to be displayed on,
9102 * which are defined by the theme set on Elementary. This function
9103 * works analogously as elm_object_tooltip_style_set(), but here
9104 * applied only to gengrid item objects. The default style for
9105 * tooltips is @c "default".
9107 * @note before you set a style you should define a tooltip with
9108 * elm_gengrid_item_tooltip_content_cb_set() or
9109 * elm_gengrid_item_tooltip_text_set()
9111 * @see elm_gengrid_item_tooltip_style_get()
9115 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9118 * Get the style set a given gengrid item's tooltip.
9120 * @param item gengrid item with tooltip already set on.
9121 * @return style the theme style in use, which defaults to
9122 * "default". If the object does not have a tooltip set,
9123 * then @c NULL is returned.
9125 * @see elm_gengrid_item_tooltip_style_set() for more details
9129 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9131 * @brief Disable size restrictions on an object's tooltip
9132 * @param item The tooltip's anchor object
9133 * @param disable If EINA_TRUE, size restrictions are disabled
9134 * @return EINA_FALSE on failure, EINA_TRUE on success
9136 * This function allows a tooltip to expand beyond its parant window's canvas.
9137 * It will instead be limited only by the size of the display.
9139 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9141 * @brief Retrieve size restriction state of an object's tooltip
9142 * @param item The tooltip's anchor object
9143 * @return If EINA_TRUE, size restrictions are disabled
9145 * This function returns whether a tooltip is allowed to expand beyond
9146 * its parant window's canvas.
9147 * It will instead be limited only by the size of the display.
9149 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9151 * Set the type of mouse pointer/cursor decoration to be shown,
9152 * when the mouse pointer is over the given gengrid widget item
9154 * @param item gengrid item to customize cursor on
9155 * @param cursor the cursor type's name
9157 * This function works analogously as elm_object_cursor_set(), but
9158 * here the cursor's changing area is restricted to the item's
9159 * area, and not the whole widget's. Note that that item cursors
9160 * have precedence over widget cursors, so that a mouse over @p
9161 * item will always show cursor @p type.
9163 * If this function is called twice for an object, a previously set
9164 * cursor will be unset on the second call.
9166 * @see elm_object_cursor_set()
9167 * @see elm_gengrid_item_cursor_get()
9168 * @see elm_gengrid_item_cursor_unset()
9172 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9175 * Get the type of mouse pointer/cursor decoration set to be shown,
9176 * when the mouse pointer is over the given gengrid widget item
9178 * @param item gengrid item with custom cursor set
9179 * @return the cursor type's name or @c NULL, if no custom cursors
9180 * were set to @p item (and on errors)
9182 * @see elm_object_cursor_get()
9183 * @see elm_gengrid_item_cursor_set() for more details
9184 * @see elm_gengrid_item_cursor_unset()
9188 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9191 * Unset any custom mouse pointer/cursor decoration set to be
9192 * shown, when the mouse pointer is over the given gengrid widget
9193 * item, thus making it show the @b default cursor again.
9195 * @param item a gengrid item
9197 * Use this call to undo any custom settings on this item's cursor
9198 * decoration, bringing it back to defaults (no custom style set).
9200 * @see elm_object_cursor_unset()
9201 * @see elm_gengrid_item_cursor_set() for more details
9205 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9208 * Set a different @b style for a given custom cursor set for a
9211 * @param item gengrid item with custom cursor set
9212 * @param style the <b>theme style</b> to use (e.g. @c "default",
9213 * @c "transparent", etc)
9215 * This function only makes sense when one is using custom mouse
9216 * cursor decorations <b>defined in a theme file</b> , which can
9217 * have, given a cursor name/type, <b>alternate styles</b> on
9218 * it. It works analogously as elm_object_cursor_style_set(), but
9219 * here applied only to gengrid item objects.
9221 * @warning Before you set a cursor style you should have defined a
9222 * custom cursor previously on the item, with
9223 * elm_gengrid_item_cursor_set()
9225 * @see elm_gengrid_item_cursor_engine_only_set()
9226 * @see elm_gengrid_item_cursor_style_get()
9230 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9233 * Get the current @b style set for a given gengrid item's custom
9236 * @param item gengrid item with custom cursor set.
9237 * @return style the cursor style in use. If the object does not
9238 * have a cursor set, then @c NULL is returned.
9240 * @see elm_gengrid_item_cursor_style_set() for more details
9244 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9247 * Set if the (custom) cursor for a given gengrid item should be
9248 * searched in its theme, also, or should only rely on the
9251 * @param item item with custom (custom) cursor already set on
9252 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9253 * only on those provided by the rendering engine, @c EINA_FALSE to
9254 * have them searched on the widget's theme, as well.
9256 * @note This call is of use only if you've set a custom cursor
9257 * for gengrid items, with elm_gengrid_item_cursor_set().
9259 * @note By default, cursors will only be looked for between those
9260 * provided by the rendering engine.
9264 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9267 * Get if the (custom) cursor for a given gengrid item is being
9268 * searched in its theme, also, or is only relying on the rendering
9271 * @param item a gengrid item
9272 * @return @c EINA_TRUE, if cursors are being looked for only on
9273 * those provided by the rendering engine, @c EINA_FALSE if they
9274 * are being searched on the widget's theme, as well.
9276 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9280 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9283 * Remove all items from a given gengrid widget
9285 * @param obj The gengrid object.
9287 * This removes (and deletes) all items in @p obj, leaving it
9290 * @see elm_gengrid_item_del(), to remove just one item.
9294 EINA_DEPRECATED EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9297 * Get the selected item in a given gengrid widget
9299 * @param obj The gengrid object.
9300 * @return The selected item's handleor @c NULL, if none is
9301 * selected at the moment (and on errors)
9303 * This returns the selected item in @p obj. If multi selection is
9304 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9305 * the first item in the list is selected, which might not be very
9306 * useful. For that case, see elm_gengrid_selected_items_get().
9310 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9313 * Get <b>a list</b> of selected items in a given gengrid
9315 * @param obj The gengrid object.
9316 * @return The list of selected items or @c NULL, if none is
9317 * selected at the moment (and on errors)
9319 * This returns a list of the selected items, in the order that
9320 * they appear in the grid. This list is only valid as long as no
9321 * more items are selected or unselected (or unselected implictly
9322 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9325 * @see elm_gengrid_selected_item_get()
9329 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9336 * @defgroup Clock Clock
9338 * @image html img/widget/clock/preview-00.png
9339 * @image latex img/widget/clock/preview-00.eps
9341 * This is a @b digital clock widget. In its default theme, it has a
9342 * vintage "flipping numbers clock" appearance, which will animate
9343 * sheets of individual algarisms individually as time goes by.
9345 * A newly created clock will fetch system's time (already
9346 * considering local time adjustments) to start with, and will tick
9347 * accondingly. It may or may not show seconds.
9349 * Clocks have an @b edition mode. When in it, the sheets will
9350 * display extra arrow indications on the top and bottom and the
9351 * user may click on them to raise or lower the time values. After
9352 * it's told to exit edition mode, it will keep ticking with that
9353 * new time set (it keeps the difference from local time).
9355 * Also, when under edition mode, user clicks on the cited arrows
9356 * which are @b held for some time will make the clock to flip the
9357 * sheet, thus editing the time, continuosly and automatically for
9358 * the user. The interval between sheet flips will keep growing in
9359 * time, so that it helps the user to reach a time which is distant
9362 * The time display is, by default, in military mode (24h), but an
9363 * am/pm indicator may be optionally shown, too, when it will
9366 * Smart callbacks one can register to:
9367 * - "changed" - the clock's user changed the time
9369 * Here is an example on its usage:
9370 * @li @ref clock_example
9379 * Identifiers for which clock digits should be editable, when a
9380 * clock widget is in edition mode. Values may be ORed together to
9381 * make a mask, naturally.
9383 * @see elm_clock_edit_set()
9384 * @see elm_clock_digit_edit_set()
9386 typedef enum _Elm_Clock_Digedit
9388 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9389 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9390 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9391 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9392 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9393 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9394 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9395 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9396 } Elm_Clock_Digedit;
9399 * Add a new clock widget to the given parent Elementary
9400 * (container) object
9402 * @param parent The parent object
9403 * @return a new clock widget handle or @c NULL, on errors
9405 * This function inserts a new clock widget on the canvas.
9409 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9412 * Set a clock widget's time, programmatically
9414 * @param obj The clock widget object
9415 * @param hrs The hours to set
9416 * @param min The minutes to set
9417 * @param sec The secondes to set
9419 * This function updates the time that is showed by the clock
9422 * Values @b must be set within the following ranges:
9423 * - 0 - 23, for hours
9424 * - 0 - 59, for minutes
9425 * - 0 - 59, for seconds,
9427 * even if the clock is not in "military" mode.
9429 * @warning The behavior for values set out of those ranges is @b
9434 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9437 * Get a clock widget's time values
9439 * @param obj The clock object
9440 * @param[out] hrs Pointer to the variable to get the hours value
9441 * @param[out] min Pointer to the variable to get the minutes value
9442 * @param[out] sec Pointer to the variable to get the seconds value
9444 * This function gets the time set for @p obj, returning
9445 * it on the variables passed as the arguments to function
9447 * @note Use @c NULL pointers on the time values you're not
9448 * interested in: they'll be ignored by the function.
9452 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9455 * Set whether a given clock widget is under <b>edition mode</b> or
9456 * under (default) displaying-only mode.
9458 * @param obj The clock object
9459 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9460 * put it back to "displaying only" mode
9462 * This function makes a clock's time to be editable or not <b>by
9463 * user interaction</b>. When in edition mode, clocks @b stop
9464 * ticking, until one brings them back to canonical mode. The
9465 * elm_clock_digit_edit_set() function will influence which digits
9466 * of the clock will be editable. By default, all of them will be
9467 * (#ELM_CLOCK_NONE).
9469 * @note am/pm sheets, if being shown, will @b always be editable
9470 * under edition mode.
9472 * @see elm_clock_edit_get()
9476 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9479 * Retrieve whether a given clock widget is under <b>edition
9480 * mode</b> or under (default) displaying-only mode.
9482 * @param obj The clock object
9483 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9486 * This function retrieves whether the clock's time can be edited
9487 * or not by user interaction.
9489 * @see elm_clock_edit_set() for more details
9493 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9496 * Set what digits of the given clock widget should be editable
9497 * when in edition mode.
9499 * @param obj The clock object
9500 * @param digedit Bit mask indicating the digits to be editable
9501 * (values in #Elm_Clock_Digedit).
9503 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9504 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9507 * @see elm_clock_digit_edit_get()
9511 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9514 * Retrieve what digits of the given clock widget should be
9515 * editable when in edition mode.
9517 * @param obj The clock object
9518 * @return Bit mask indicating the digits to be editable
9519 * (values in #Elm_Clock_Digedit).
9521 * @see elm_clock_digit_edit_set() for more details
9525 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9528 * Set if the given clock widget must show hours in military or
9531 * @param obj The clock object
9532 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9535 * This function sets if the clock must show hours in military or
9536 * am/pm mode. In some countries like Brazil the military mode
9537 * (00-24h-format) is used, in opposition to the USA, where the
9538 * am/pm mode is more commonly used.
9540 * @see elm_clock_show_am_pm_get()
9544 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9547 * Get if the given clock widget shows hours in military or am/pm
9550 * @param obj The clock object
9551 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9554 * This function gets if the clock shows hours in military or am/pm
9557 * @see elm_clock_show_am_pm_set() for more details
9561 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9564 * Set if the given clock widget must show time with seconds or not
9566 * @param obj The clock object
9567 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9569 * This function sets if the given clock must show or not elapsed
9570 * seconds. By default, they are @b not shown.
9572 * @see elm_clock_show_seconds_get()
9576 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9579 * Get whether the given clock widget is showing time with seconds
9582 * @param obj The clock object
9583 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9585 * This function gets whether @p obj is showing or not the elapsed
9588 * @see elm_clock_show_seconds_set()
9592 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9595 * Set the interval on time updates for an user mouse button hold
9596 * on clock widgets' time edition.
9598 * @param obj The clock object
9599 * @param interval The (first) interval value in seconds
9601 * This interval value is @b decreased while the user holds the
9602 * mouse pointer either incrementing or decrementing a given the
9603 * clock digit's value.
9605 * This helps the user to get to a given time distant from the
9606 * current one easier/faster, as it will start to flip quicker and
9607 * quicker on mouse button holds.
9609 * The calculation for the next flip interval value, starting from
9610 * the one set with this call, is the previous interval divided by
9611 * 1.05, so it decreases a little bit.
9613 * The default starting interval value for automatic flips is
9616 * @see elm_clock_interval_get()
9620 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9623 * Get the interval on time updates for an user mouse button hold
9624 * on clock widgets' time edition.
9626 * @param obj The clock object
9627 * @return The (first) interval value, in seconds, set on it
9629 * @see elm_clock_interval_set() for more details
9633 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9640 * @defgroup Layout Layout
9642 * @image html img/widget/layout/preview-00.png
9643 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9645 * @image html img/layout-predefined.png
9646 * @image latex img/layout-predefined.eps width=\textwidth
9648 * This is a container widget that takes a standard Edje design file and
9649 * wraps it very thinly in a widget.
9651 * An Edje design (theme) file has a very wide range of possibilities to
9652 * describe the behavior of elements added to the Layout. Check out the Edje
9653 * documentation and the EDC reference to get more information about what can
9654 * be done with Edje.
9656 * Just like @ref List, @ref Box, and other container widgets, any
9657 * object added to the Layout will become its child, meaning that it will be
9658 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9660 * The Layout widget can contain as many Contents, Boxes or Tables as
9661 * described in its theme file. For instance, objects can be added to
9662 * different Tables by specifying the respective Table part names. The same
9663 * is valid for Content and Box.
9665 * The objects added as child of the Layout will behave as described in the
9666 * part description where they were added. There are 3 possible types of
9667 * parts where a child can be added:
9669 * @section secContent Content (SWALLOW part)
9671 * Only one object can be added to the @c SWALLOW part (but you still can
9672 * have many @c SWALLOW parts and one object on each of them). Use the @c
9673 * elm_object_content_set/get/unset functions to set, retrieve and unset
9674 * objects as content of the @c SWALLOW. After being set to this part, the
9675 * object size, position, visibility, clipping and other description
9676 * properties will be totally controled by the description of the given part
9677 * (inside the Edje theme file).
9679 * One can use @c evas_object_size_hint_* functions on the child to have some
9680 * kind of control over its behavior, but the resulting behavior will still
9681 * depend heavily on the @c SWALLOW part description.
9683 * The Edje theme also can change the part description, based on signals or
9684 * scripts running inside the theme. This change can also be animated. All of
9685 * this will affect the child object set as content accordingly. The object
9686 * size will be changed if the part size is changed, it will animate move if
9687 * the part is moving, and so on.
9689 * The following picture demonstrates a Layout widget with a child object
9690 * added to its @c SWALLOW:
9692 * @image html layout_swallow.png
9693 * @image latex layout_swallow.eps width=\textwidth
9695 * @section secBox Box (BOX part)
9697 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9698 * allows one to add objects to the box and have them distributed along its
9699 * area, accordingly to the specified @a layout property (now by @a layout we
9700 * mean the chosen layouting design of the Box, not the Layout widget
9703 * A similar effect for having a box with its position, size and other things
9704 * controled by the Layout theme would be to create an Elementary @ref Box
9705 * widget and add it as a Content in the @c SWALLOW part.
9707 * The main difference of using the Layout Box is that its behavior, the box
9708 * properties like layouting format, padding, align, etc. will be all
9709 * controled by the theme. This means, for example, that a signal could be
9710 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9711 * handled the signal by changing the box padding, or align, or both. Using
9712 * the Elementary @ref Box widget is not necessarily harder or easier, it
9713 * just depends on the circunstances and requirements.
9715 * The Layout Box can be used through the @c elm_layout_box_* set of
9718 * The following picture demonstrates a Layout widget with many child objects
9719 * added to its @c BOX part:
9721 * @image html layout_box.png
9722 * @image latex layout_box.eps width=\textwidth
9724 * @section secTable Table (TABLE part)
9726 * Just like the @ref secBox, the Layout Table is very similar to the
9727 * Elementary @ref Table widget. It allows one to add objects to the Table
9728 * specifying the row and column where the object should be added, and any
9729 * column or row span if necessary.
9731 * Again, we could have this design by adding a @ref Table widget to the @c
9732 * SWALLOW part using elm_object_content_part_set(). The same difference happens
9733 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9734 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9736 * The Layout Table can be used through the @c elm_layout_table_* set of
9739 * The following picture demonstrates a Layout widget with many child objects
9740 * added to its @c TABLE part:
9742 * @image html layout_table.png
9743 * @image latex layout_table.eps width=\textwidth
9745 * @section secPredef Predefined Layouts
9747 * Another interesting thing about the Layout widget is that it offers some
9748 * predefined themes that come with the default Elementary theme. These
9749 * themes can be set by the call elm_layout_theme_set(), and provide some
9750 * basic functionality depending on the theme used.
9752 * Most of them already send some signals, some already provide a toolbar or
9753 * back and next buttons.
9755 * These are available predefined theme layouts. All of them have class = @c
9756 * layout, group = @c application, and style = one of the following options:
9758 * @li @c toolbar-content - application with toolbar and main content area
9759 * @li @c toolbar-content-back - application with toolbar and main content
9760 * area with a back button and title area
9761 * @li @c toolbar-content-back-next - application with toolbar and main
9762 * content area with a back and next buttons and title area
9763 * @li @c content-back - application with a main content area with a back
9764 * button and title area
9765 * @li @c content-back-next - application with a main content area with a
9766 * back and next buttons and title area
9767 * @li @c toolbar-vbox - application with toolbar and main content area as a
9769 * @li @c toolbar-table - application with toolbar and main content area as a
9772 * @section secExamples Examples
9774 * Some examples of the Layout widget can be found here:
9775 * @li @ref layout_example_01
9776 * @li @ref layout_example_02
9777 * @li @ref layout_example_03
9778 * @li @ref layout_example_edc
9783 * Add a new layout to the parent
9785 * @param parent The parent object
9786 * @return The new object or NULL if it cannot be created
9788 * @see elm_layout_file_set()
9789 * @see elm_layout_theme_set()
9793 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9795 * Set the file that will be used as layout
9797 * @param obj The layout object
9798 * @param file The path to file (edj) that will be used as layout
9799 * @param group The group that the layout belongs in edje file
9801 * @return (1 = success, 0 = error)
9805 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9807 * Set the edje group from the elementary theme that will be used as layout
9809 * @param obj The layout object
9810 * @param clas the clas of the group
9811 * @param group the group
9812 * @param style the style to used
9814 * @return (1 = success, 0 = error)
9818 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9820 * Set the layout content.
9822 * @param obj The layout object
9823 * @param swallow The swallow part name in the edje file
9824 * @param content The child that will be added in this layout object
9826 * Once the content object is set, a previously set one will be deleted.
9827 * If you want to keep that old content object, use the
9828 * elm_object_content_part_unset() function.
9830 * @note In an Edje theme, the part used as a content container is called @c
9831 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9832 * expected to be a part name just like the second parameter of
9833 * elm_layout_box_append().
9835 * @see elm_layout_box_append()
9836 * @see elm_object_content_part_get()
9837 * @see elm_object_content_part_unset()
9839 * @deprecated use elm_object_content_part_set() instead
9843 EINA_DEPRECATED EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9845 * Get the child object in the given content part.
9847 * @param obj The layout object
9848 * @param swallow The SWALLOW part to get its content
9850 * @return The swallowed object or NULL if none or an error occurred
9852 * @deprecated use elm_object_content_part_get() instead
9856 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9858 * Unset the layout content.
9860 * @param obj The layout object
9861 * @param swallow The swallow part name in the edje file
9862 * @return The content that was being used
9864 * Unparent and return the content object which was set for this part.
9866 * @deprecated use elm_object_content_part_unset() instead
9870 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9872 * Set the text of the given part
9874 * @param obj The layout object
9875 * @param part The TEXT part where to set the text
9876 * @param text The text to set
9879 * @deprecated use elm_object_text_part_set() instead.
9881 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9883 * Get the text set in the given part
9885 * @param obj The layout object
9886 * @param part The TEXT part to retrieve the text off
9888 * @return The text set in @p part
9891 * @deprecated use elm_object_text_part_get() instead.
9893 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9895 * Append child to layout box part.
9897 * @param obj the layout object
9898 * @param part the box part to which the object will be appended.
9899 * @param child the child object to append to box.
9901 * Once the object is appended, it will become child of the layout. Its
9902 * lifetime will be bound to the layout, whenever the layout dies the child
9903 * will be deleted automatically. One should use elm_layout_box_remove() to
9904 * make this layout forget about the object.
9906 * @see elm_layout_box_prepend()
9907 * @see elm_layout_box_insert_before()
9908 * @see elm_layout_box_insert_at()
9909 * @see elm_layout_box_remove()
9913 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9915 * Prepend child to layout box part.
9917 * @param obj the layout object
9918 * @param part the box part to prepend.
9919 * @param child the child object to prepend to box.
9921 * Once the object is prepended, it will become child of the layout. Its
9922 * lifetime will be bound to the layout, whenever the layout dies the child
9923 * will be deleted automatically. One should use elm_layout_box_remove() to
9924 * make this layout forget about the object.
9926 * @see elm_layout_box_append()
9927 * @see elm_layout_box_insert_before()
9928 * @see elm_layout_box_insert_at()
9929 * @see elm_layout_box_remove()
9933 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9935 * Insert child to layout box part before a reference object.
9937 * @param obj the layout object
9938 * @param part the box part to insert.
9939 * @param child the child object to insert into box.
9940 * @param reference another reference object to insert before in box.
9942 * Once the object is inserted, it will become child of the layout. Its
9943 * lifetime will be bound to the layout, whenever the layout dies the child
9944 * will be deleted automatically. One should use elm_layout_box_remove() to
9945 * make this layout forget about the object.
9947 * @see elm_layout_box_append()
9948 * @see elm_layout_box_prepend()
9949 * @see elm_layout_box_insert_before()
9950 * @see elm_layout_box_remove()
9954 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9956 * Insert child to layout box part at a given position.
9958 * @param obj the layout object
9959 * @param part the box part to insert.
9960 * @param child the child object to insert into box.
9961 * @param pos the numeric position >=0 to insert the child.
9963 * Once the object is inserted, it will become child of the layout. Its
9964 * lifetime will be bound to the layout, whenever the layout dies the child
9965 * will be deleted automatically. One should use elm_layout_box_remove() to
9966 * make this layout forget about the object.
9968 * @see elm_layout_box_append()
9969 * @see elm_layout_box_prepend()
9970 * @see elm_layout_box_insert_before()
9971 * @see elm_layout_box_remove()
9975 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9977 * Remove a child of the given part box.
9979 * @param obj The layout object
9980 * @param part The box part name to remove child.
9981 * @param child The object to remove from box.
9982 * @return The object that was being used, or NULL if not found.
9984 * The object will be removed from the box part and its lifetime will
9985 * not be handled by the layout anymore. This is equivalent to
9986 * elm_object_content_part_unset() for box.
9988 * @see elm_layout_box_append()
9989 * @see elm_layout_box_remove_all()
9993 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9995 * Remove all child of the given part box.
9997 * @param obj The layout object
9998 * @param part The box part name to remove child.
9999 * @param clear If EINA_TRUE, then all objects will be deleted as
10000 * well, otherwise they will just be removed and will be
10001 * dangling on the canvas.
10003 * The objects will be removed from the box part and their lifetime will
10004 * not be handled by the layout anymore. This is equivalent to
10005 * elm_layout_box_remove() for all box children.
10007 * @see elm_layout_box_append()
10008 * @see elm_layout_box_remove()
10012 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10014 * Insert child to layout table part.
10016 * @param obj the layout object
10017 * @param part the box part to pack child.
10018 * @param child_obj the child object to pack into table.
10019 * @param col the column to which the child should be added. (>= 0)
10020 * @param row the row to which the child should be added. (>= 0)
10021 * @param colspan how many columns should be used to store this object. (>=
10023 * @param rowspan how many rows should be used to store this object. (>= 1)
10025 * Once the object is inserted, it will become child of the table. Its
10026 * lifetime will be bound to the layout, and whenever the layout dies the
10027 * child will be deleted automatically. One should use
10028 * elm_layout_table_remove() to make this layout forget about the object.
10030 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10031 * more space than a single cell. For instance, the following code:
10033 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10036 * Would result in an object being added like the following picture:
10038 * @image html layout_colspan.png
10039 * @image latex layout_colspan.eps width=\textwidth
10041 * @see elm_layout_table_unpack()
10042 * @see elm_layout_table_clear()
10046 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);
10048 * Unpack (remove) a child of the given part table.
10050 * @param obj The layout object
10051 * @param part The table part name to remove child.
10052 * @param child_obj The object to remove from table.
10053 * @return The object that was being used, or NULL if not found.
10055 * The object will be unpacked from the table part and its lifetime
10056 * will not be handled by the layout anymore. This is equivalent to
10057 * elm_object_content_part_unset() for table.
10059 * @see elm_layout_table_pack()
10060 * @see elm_layout_table_clear()
10064 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10066 * Remove all child of the given part table.
10068 * @param obj The layout object
10069 * @param part The table part name to remove child.
10070 * @param clear If EINA_TRUE, then all objects will be deleted as
10071 * well, otherwise they will just be removed and will be
10072 * dangling on the canvas.
10074 * The objects will be removed from the table part and their lifetime will
10075 * not be handled by the layout anymore. This is equivalent to
10076 * elm_layout_table_unpack() for all table children.
10078 * @see elm_layout_table_pack()
10079 * @see elm_layout_table_unpack()
10083 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10085 * Get the edje layout
10087 * @param obj The layout object
10089 * @return A Evas_Object with the edje layout settings loaded
10090 * with function elm_layout_file_set
10092 * This returns the edje object. It is not expected to be used to then
10093 * swallow objects via edje_object_part_swallow() for example. Use
10094 * elm_object_content_part_set() instead so child object handling and sizing is
10097 * @note This function should only be used if you really need to call some
10098 * low level Edje function on this edje object. All the common stuff (setting
10099 * text, emitting signals, hooking callbacks to signals, etc.) can be done
10100 * with proper elementary functions.
10102 * @see elm_object_signal_callback_add()
10103 * @see elm_object_signal_emit()
10104 * @see elm_object_text_part_set()
10105 * @see elm_object_content_part_set()
10106 * @see elm_layout_box_append()
10107 * @see elm_layout_table_pack()
10108 * @see elm_layout_data_get()
10112 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10114 * Get the edje data from the given layout
10116 * @param obj The layout object
10117 * @param key The data key
10119 * @return The edje data string
10121 * This function fetches data specified inside the edje theme of this layout.
10122 * This function return NULL if data is not found.
10124 * In EDC this comes from a data block within the group block that @p
10125 * obj was loaded from. E.g.
10132 * item: "key1" "value1";
10133 * item: "key2" "value2";
10141 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10145 * @param obj The layout object
10147 * Manually forces a sizing re-evaluation. This is useful when the minimum
10148 * size required by the edje theme of this layout has changed. The change on
10149 * the minimum size required by the edje theme is not immediately reported to
10150 * the elementary layout, so one needs to call this function in order to tell
10151 * the widget (layout) that it needs to reevaluate its own size.
10153 * The minimum size of the theme is calculated based on minimum size of
10154 * parts, the size of elements inside containers like box and table, etc. All
10155 * of this can change due to state changes, and that's when this function
10156 * should be called.
10158 * Also note that a standard signal of "size,eval" "elm" emitted from the
10159 * edje object will cause this to happen too.
10163 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10166 * Sets a specific cursor for an edje part.
10168 * @param obj The layout object.
10169 * @param part_name a part from loaded edje group.
10170 * @param cursor cursor name to use, see Elementary_Cursor.h
10172 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10173 * part not exists or it has "mouse_events: 0".
10177 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10180 * Get the cursor to be shown when mouse is over an edje part
10182 * @param obj The layout object.
10183 * @param part_name a part from loaded edje group.
10184 * @return the cursor name.
10188 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10191 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10193 * @param obj The layout object.
10194 * @param part_name a part from loaded edje group, that had a cursor set
10195 * with elm_layout_part_cursor_set().
10199 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10202 * Sets a specific cursor style for an edje part.
10204 * @param obj The layout object.
10205 * @param part_name a part from loaded edje group.
10206 * @param style the theme style to use (default, transparent, ...)
10208 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10209 * part not exists or it did not had a cursor set.
10213 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10216 * Gets a specific cursor style for an edje part.
10218 * @param obj The layout object.
10219 * @param part_name a part from loaded edje group.
10221 * @return the theme style in use, defaults to "default". If the
10222 * object does not have a cursor set, then NULL is returned.
10226 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10229 * Sets if the cursor set should be searched on the theme or should use
10230 * the provided by the engine, only.
10232 * @note before you set if should look on theme you should define a
10233 * cursor with elm_layout_part_cursor_set(). By default it will only
10234 * look for cursors provided by the engine.
10236 * @param obj The layout object.
10237 * @param part_name a part from loaded edje group.
10238 * @param engine_only if cursors should be just provided by the engine
10239 * or should also search on widget's theme as well
10241 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10242 * part not exists or it did not had a cursor set.
10246 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);
10249 * Gets a specific cursor engine_only for an edje part.
10251 * @param obj The layout object.
10252 * @param part_name a part from loaded edje group.
10254 * @return whenever the cursor is just provided by engine or also from theme.
10258 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10261 * @def elm_layout_icon_set
10262 * Convienience macro to set the icon object in a layout that follows the
10263 * Elementary naming convention for its parts.
10267 #define elm_layout_icon_set(_ly, _obj) \
10270 elm_object_content_part_set((_ly), "elm.swallow.icon", (_obj)); \
10271 if ((_obj)) sig = "elm,state,icon,visible"; \
10272 else sig = "elm,state,icon,hidden"; \
10273 elm_object_signal_emit((_ly), sig, "elm"); \
10277 * @def elm_layout_icon_get
10278 * Convienience macro to get the icon object from a layout that follows the
10279 * Elementary naming convention for its parts.
10283 #define elm_layout_icon_get(_ly) \
10284 elm_object_content_part_get((_ly), "elm.swallow.icon")
10287 * @def elm_layout_end_set
10288 * Convienience macro to set the end object in a layout that follows the
10289 * Elementary naming convention for its parts.
10293 #define elm_layout_end_set(_ly, _obj) \
10296 elm_object_content_part_set((_ly), "elm.swallow.end", (_obj)); \
10297 if ((_obj)) sig = "elm,state,end,visible"; \
10298 else sig = "elm,state,end,hidden"; \
10299 elm_object_signal_emit((_ly), sig, "elm"); \
10303 * @def elm_layout_end_get
10304 * Convienience macro to get the end object in a layout that follows the
10305 * Elementary naming convention for its parts.
10309 #define elm_layout_end_get(_ly) \
10310 elm_object_content_part_get((_ly), "elm.swallow.end")
10313 * @def elm_layout_label_set
10314 * Convienience macro to set the label in a layout that follows the
10315 * Elementary naming convention for its parts.
10318 * @deprecated use elm_object_text_set() instead.
10320 #define elm_layout_label_set(_ly, _txt) \
10321 elm_layout_text_set((_ly), "elm.text", (_txt))
10324 * @def elm_layout_label_get
10325 * Convenience macro to get the label in a layout that follows the
10326 * Elementary naming convention for its parts.
10329 * @deprecated use elm_object_text_set() instead.
10331 #define elm_layout_label_get(_ly) \
10332 elm_layout_text_get((_ly), "elm.text")
10334 /* smart callbacks called:
10335 * "theme,changed" - when elm theme is changed.
10339 * @defgroup Notify Notify
10341 * @image html img/widget/notify/preview-00.png
10342 * @image latex img/widget/notify/preview-00.eps
10344 * Display a container in a particular region of the parent(top, bottom,
10345 * etc). A timeout can be set to automatically hide the notify. This is so
10346 * that, after an evas_object_show() on a notify object, if a timeout was set
10347 * on it, it will @b automatically get hidden after that time.
10349 * Signals that you can add callbacks for are:
10350 * @li "timeout" - when timeout happens on notify and it's hidden
10351 * @li "block,clicked" - when a click outside of the notify happens
10353 * Default contents parts of the notify widget that you can use for are:
10354 * @li "elm.swallow.content" - A content of the notify
10356 * @ref tutorial_notify show usage of the API.
10361 * @brief Possible orient values for notify.
10363 * This values should be used in conjunction to elm_notify_orient_set() to
10364 * set the position in which the notify should appear(relative to its parent)
10365 * and in conjunction with elm_notify_orient_get() to know where the notify
10368 typedef enum _Elm_Notify_Orient
10370 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10371 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10372 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10373 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10374 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10375 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10376 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10377 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10378 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10379 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10380 } Elm_Notify_Orient;
10382 * @brief Add a new notify to the parent
10384 * @param parent The parent object
10385 * @return The new object or NULL if it cannot be created
10387 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10389 * @brief Set the content of the notify widget
10391 * @param obj The notify object
10392 * @param content The content will be filled in this notify object
10394 * Once the content object is set, a previously set one will be deleted. If
10395 * you want to keep that old content object, use the
10396 * elm_notify_content_unset() function.
10398 * @deprecated use elm_object_content_set() instead
10401 EINA_DEPRECATED EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10403 * @brief Unset the content of the notify widget
10405 * @param obj The notify object
10406 * @return The content that was being used
10408 * Unparent and return the content object which was set for this widget
10410 * @see elm_notify_content_set()
10411 * @deprecated use elm_object_content_unset() instead
10414 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10416 * @brief Return the content of the notify widget
10418 * @param obj The notify object
10419 * @return The content that is being used
10421 * @see elm_notify_content_set()
10422 * @deprecated use elm_object_content_get() instead
10425 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10427 * @brief Set the notify parent
10429 * @param obj The notify object
10430 * @param content The new parent
10432 * Once the parent object is set, a previously set one will be disconnected
10435 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10437 * @brief Get the notify parent
10439 * @param obj The notify object
10440 * @return The parent
10442 * @see elm_notify_parent_set()
10444 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10446 * @brief Set the orientation
10448 * @param obj The notify object
10449 * @param orient The new orientation
10451 * Sets the position in which the notify will appear in its parent.
10453 * @see @ref Elm_Notify_Orient for possible values.
10455 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10457 * @brief Return the orientation
10458 * @param obj The notify object
10459 * @return The orientation of the notification
10461 * @see elm_notify_orient_set()
10462 * @see Elm_Notify_Orient
10464 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10466 * @brief Set the time interval after which the notify window is going to be
10469 * @param obj The notify object
10470 * @param time The timeout in seconds
10472 * This function sets a timeout and starts the timer controlling when the
10473 * notify is hidden. Since calling evas_object_show() on a notify restarts
10474 * the timer controlling when the notify is hidden, setting this before the
10475 * notify is shown will in effect mean starting the timer when the notify is
10478 * @note Set a value <= 0.0 to disable a running timer.
10480 * @note If the value > 0.0 and the notify is previously visible, the
10481 * timer will be started with this value, canceling any running timer.
10483 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10485 * @brief Return the timeout value (in seconds)
10486 * @param obj the notify object
10488 * @see elm_notify_timeout_set()
10490 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10492 * @brief Sets whether events should be passed to by a click outside
10495 * @param obj The notify object
10496 * @param repeats EINA_TRUE Events are repeats, else no
10498 * When true if the user clicks outside the window the events will be caught
10499 * by the others widgets, else the events are blocked.
10501 * @note The default value is EINA_TRUE.
10503 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10505 * @brief Return true if events are repeat below the notify object
10506 * @param obj the notify object
10508 * @see elm_notify_repeat_events_set()
10510 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10516 * @defgroup Hover Hover
10518 * @image html img/widget/hover/preview-00.png
10519 * @image latex img/widget/hover/preview-00.eps
10521 * A Hover object will hover over its @p parent object at the @p target
10522 * location. Anything in the background will be given a darker coloring to
10523 * indicate that the hover object is on top (at the default theme). When the
10524 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10525 * clicked that @b doesn't cause the hover to be dismissed.
10527 * A Hover object has two parents. One parent that owns it during creation
10528 * and the other parent being the one over which the hover object spans.
10531 * @note The hover object will take up the entire space of @p target
10534 * Elementary has the following styles for the hover widget:
10538 * @li hoversel_vertical
10540 * The following are the available position for content:
10552 * Signals that you can add callbacks for are:
10553 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10554 * @li "smart,changed" - a content object placed under the "smart"
10555 * policy was replaced to a new slot direction.
10557 * See @ref tutorial_hover for more information.
10561 typedef enum _Elm_Hover_Axis
10563 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10564 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10565 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10566 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10569 * @brief Adds a hover object to @p parent
10571 * @param parent The parent object
10572 * @return The hover object or NULL if one could not be created
10574 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10576 * @brief Sets the target object for the hover.
10578 * @param obj The hover object
10579 * @param target The object to center the hover onto. The hover
10581 * This function will cause the hover to be centered on the target object.
10583 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10585 * @brief Gets the target object for the hover.
10587 * @param obj The hover object
10588 * @param parent The object to locate the hover over.
10590 * @see elm_hover_target_set()
10592 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10594 * @brief Sets the parent object for the hover.
10596 * @param obj The hover object
10597 * @param parent The object to locate the hover over.
10599 * This function will cause the hover to take up the entire space that the
10600 * parent object fills.
10602 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10604 * @brief Gets the parent object for the hover.
10606 * @param obj The hover object
10607 * @return The parent object to locate the hover over.
10609 * @see elm_hover_parent_set()
10611 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10613 * @brief Sets the content of the hover object and the direction in which it
10616 * @param obj The hover object
10617 * @param swallow The direction that the object will be displayed
10618 * at. Accepted values are "left", "top-left", "top", "top-right",
10619 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10621 * @param content The content to place at @p swallow
10623 * Once the content object is set for a given direction, a previously
10624 * set one (on the same direction) will be deleted. If you want to
10625 * keep that old content object, use the elm_hover_content_unset()
10628 * All directions may have contents at the same time, except for
10629 * "smart". This is a special placement hint and its use case
10630 * independs of the calculations coming from
10631 * elm_hover_best_content_location_get(). Its use is for cases when
10632 * one desires only one hover content, but with a dinamic special
10633 * placement within the hover area. The content's geometry, whenever
10634 * it changes, will be used to decide on a best location not
10635 * extrapolating the hover's parent object view to show it in (still
10636 * being the hover's target determinant of its medium part -- move and
10637 * resize it to simulate finger sizes, for example). If one of the
10638 * directions other than "smart" are used, a previously content set
10639 * using it will be deleted, and vice-versa.
10641 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10643 * @brief Get the content of the hover object, in a given direction.
10645 * Return the content object which was set for this widget in the
10646 * @p swallow direction.
10648 * @param obj The hover object
10649 * @param swallow The direction that the object was display at.
10650 * @return The content that was being used
10652 * @see elm_hover_content_set()
10654 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10656 * @brief Unset the content of the hover object, in a given direction.
10658 * Unparent and return the content object set at @p swallow direction.
10660 * @param obj The hover object
10661 * @param swallow The direction that the object was display at.
10662 * @return The content that was being used.
10664 * @see elm_hover_content_set()
10666 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10668 * @brief Returns the best swallow location for content in the hover.
10670 * @param obj The hover object
10671 * @param pref_axis The preferred orientation axis for the hover object to use
10672 * @return The edje location to place content into the hover or @c
10675 * Best is defined here as the location at which there is the most available
10678 * @p pref_axis may be one of
10679 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10680 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10681 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10682 * - @c ELM_HOVER_AXIS_BOTH -- both
10684 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10685 * nescessarily be along the horizontal axis("left" or "right"). If
10686 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10687 * be along the vertical axis("top" or "bottom"). Chossing
10688 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10689 * returned position may be in either axis.
10691 * @see elm_hover_content_set()
10693 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10700 * @defgroup Entry Entry
10702 * @image html img/widget/entry/preview-00.png
10703 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10704 * @image html img/widget/entry/preview-01.png
10705 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10706 * @image html img/widget/entry/preview-02.png
10707 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10708 * @image html img/widget/entry/preview-03.png
10709 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10711 * An entry is a convenience widget which shows a box that the user can
10712 * enter text into. Entries by default don't scroll, so they grow to
10713 * accomodate the entire text, resizing the parent window as needed. This
10714 * can be changed with the elm_entry_scrollable_set() function.
10716 * They can also be single line or multi line (the default) and when set
10717 * to multi line mode they support text wrapping in any of the modes
10718 * indicated by #Elm_Wrap_Type.
10720 * Other features include password mode, filtering of inserted text with
10721 * elm_entry_text_filter_append() and related functions, inline "items" and
10722 * formatted markup text.
10724 * @section entry-markup Formatted text
10726 * The markup tags supported by the Entry are defined by the theme, but
10727 * even when writing new themes or extensions it's a good idea to stick to
10728 * a sane default, to maintain coherency and avoid application breakages.
10729 * Currently defined by the default theme are the following tags:
10730 * @li \<br\>: Inserts a line break.
10731 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10733 * @li \<tab\>: Inserts a tab.
10734 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10736 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10737 * @li \<link\>...\</link\>: Underlines the enclosed text.
10738 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10740 * @section entry-special Special markups
10742 * Besides those used to format text, entries support two special markup
10743 * tags used to insert clickable portions of text or items inlined within
10746 * @subsection entry-anchors Anchors
10748 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10749 * \</a\> tags and an event will be generated when this text is clicked,
10753 * This text is outside <a href=anc-01>but this one is an anchor</a>
10756 * The @c href attribute in the opening tag gives the name that will be
10757 * used to identify the anchor and it can be any valid utf8 string.
10759 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10760 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10761 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10762 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10765 * @subsection entry-items Items
10767 * Inlined in the text, any other @c Evas_Object can be inserted by using
10768 * \<item\> tags this way:
10771 * <item size=16x16 vsize=full href=emoticon/haha></item>
10774 * Just like with anchors, the @c href identifies each item, but these need,
10775 * in addition, to indicate their size, which is done using any one of
10776 * @c size, @c absize or @c relsize attributes. These attributes take their
10777 * value in the WxH format, where W is the width and H the height of the
10780 * @li absize: Absolute pixel size for the item. Whatever value is set will
10781 * be the item's size regardless of any scale value the object may have
10782 * been set to. The final line height will be adjusted to fit larger items.
10783 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10785 * @li relsize: Size is adjusted for the item to fit within the current
10788 * Besides their size, items are specificed a @c vsize value that affects
10789 * how their final size and position are calculated. The possible values
10791 * @li ascent: Item will be placed within the line's baseline and its
10792 * ascent. That is, the height between the line where all characters are
10793 * positioned and the highest point in the line. For @c size and @c absize
10794 * items, the descent value will be added to the total line height to make
10795 * them fit. @c relsize items will be adjusted to fit within this space.
10796 * @li full: Items will be placed between the descent and ascent, or the
10797 * lowest point in the line and its highest.
10799 * The next image shows different configurations of items and how they
10800 * are the previously mentioned options affect their sizes. In all cases,
10801 * the green line indicates the ascent, blue for the baseline and red for
10804 * @image html entry_item.png
10805 * @image latex entry_item.eps width=\textwidth
10807 * And another one to show how size differs from absize. In the first one,
10808 * the scale value is set to 1.0, while the second one is using one of 2.0.
10810 * @image html entry_item_scale.png
10811 * @image latex entry_item_scale.eps width=\textwidth
10813 * After the size for an item is calculated, the entry will request an
10814 * object to place in its space. For this, the functions set with
10815 * elm_entry_item_provider_append() and related functions will be called
10816 * in order until one of them returns a @c non-NULL value. If no providers
10817 * are available, or all of them return @c NULL, then the entry falls back
10818 * to one of the internal defaults, provided the name matches with one of
10821 * All of the following are currently supported:
10824 * - emoticon/angry-shout
10825 * - emoticon/crazy-laugh
10826 * - emoticon/evil-laugh
10828 * - emoticon/goggle-smile
10829 * - emoticon/grumpy
10830 * - emoticon/grumpy-smile
10831 * - emoticon/guilty
10832 * - emoticon/guilty-smile
10834 * - emoticon/half-smile
10835 * - emoticon/happy-panting
10837 * - emoticon/indifferent
10839 * - emoticon/knowing-grin
10841 * - emoticon/little-bit-sorry
10842 * - emoticon/love-lots
10844 * - emoticon/minimal-smile
10845 * - emoticon/not-happy
10846 * - emoticon/not-impressed
10848 * - emoticon/opensmile
10851 * - emoticon/squint-laugh
10852 * - emoticon/surprised
10853 * - emoticon/suspicious
10854 * - emoticon/tongue-dangling
10855 * - emoticon/tongue-poke
10857 * - emoticon/unhappy
10858 * - emoticon/very-sorry
10861 * - emoticon/worried
10864 * Alternatively, an item may reference an image by its path, using
10865 * the URI form @c file:///path/to/an/image.png and the entry will then
10866 * use that image for the item.
10868 * @section entry-files Loading and saving files
10870 * Entries have convinience functions to load text from a file and save
10871 * changes back to it after a short delay. The automatic saving is enabled
10872 * by default, but can be disabled with elm_entry_autosave_set() and files
10873 * can be loaded directly as plain text or have any markup in them
10874 * recognized. See elm_entry_file_set() for more details.
10876 * @section entry-signals Emitted signals
10878 * This widget emits the following signals:
10880 * @li "changed": The text within the entry was changed.
10881 * @li "changed,user": The text within the entry was changed because of user interaction.
10882 * @li "activated": The enter key was pressed on a single line entry.
10883 * @li "press": A mouse button has been pressed on the entry.
10884 * @li "longpressed": A mouse button has been pressed and held for a couple
10886 * @li "clicked": The entry has been clicked (mouse press and release).
10887 * @li "clicked,double": The entry has been double clicked.
10888 * @li "clicked,triple": The entry has been triple clicked.
10889 * @li "focused": The entry has received focus.
10890 * @li "unfocused": The entry has lost focus.
10891 * @li "selection,paste": A paste of the clipboard contents was requested.
10892 * @li "selection,copy": A copy of the selected text into the clipboard was
10894 * @li "selection,cut": A cut of the selected text into the clipboard was
10896 * @li "selection,start": A selection has begun and no previous selection
10898 * @li "selection,changed": The current selection has changed.
10899 * @li "selection,cleared": The current selection has been cleared.
10900 * @li "cursor,changed": The cursor has changed position.
10901 * @li "anchor,clicked": An anchor has been clicked. The event_info
10902 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10903 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10904 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10905 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10906 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10907 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10908 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10909 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10910 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10911 * @li "preedit,changed": The preedit string has changed.
10912 * @li "language,changed": Program language changed.
10914 * @section entry-examples
10916 * An overview of the Entry API can be seen in @ref entry_example_01
10921 * @typedef Elm_Entry_Anchor_Info
10923 * The info sent in the callback for the "anchor,clicked" signals emitted
10926 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10928 * @struct _Elm_Entry_Anchor_Info
10930 * The info sent in the callback for the "anchor,clicked" signals emitted
10933 struct _Elm_Entry_Anchor_Info
10935 const char *name; /**< The name of the anchor, as stated in its href */
10936 int button; /**< The mouse button used to click on it */
10937 Evas_Coord x, /**< Anchor geometry, relative to canvas */
10938 y, /**< Anchor geometry, relative to canvas */
10939 w, /**< Anchor geometry, relative to canvas */
10940 h; /**< Anchor geometry, relative to canvas */
10943 * @typedef Elm_Entry_Filter_Cb
10944 * This callback type is used by entry filters to modify text.
10945 * @param data The data specified as the last param when adding the filter
10946 * @param entry The entry object
10947 * @param text A pointer to the location of the text being filtered. This data can be modified,
10948 * but any additional allocations must be managed by the user.
10949 * @see elm_entry_text_filter_append
10950 * @see elm_entry_text_filter_prepend
10952 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10955 * @typedef Elm_Entry_Change_Info
10956 * This corresponds to Edje_Entry_Change_Info. Includes information about
10957 * a change in the entry.
10959 typedef Edje_Entry_Change_Info Elm_Entry_Change_Info;
10963 * This adds an entry to @p parent object.
10965 * By default, entries are:
10969 * @li autosave is enabled
10971 * @param parent The parent object
10972 * @return The new object or NULL if it cannot be created
10974 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10976 * Sets the entry to single line mode.
10978 * In single line mode, entries don't ever wrap when the text reaches the
10979 * edge, and instead they keep growing horizontally. Pressing the @c Enter
10980 * key will generate an @c "activate" event instead of adding a new line.
10982 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10983 * and pressing enter will break the text into a different line
10984 * without generating any events.
10986 * @param obj The entry object
10987 * @param single_line If true, the text in the entry
10988 * will be on a single line.
10990 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10992 * Gets whether the entry is set to be single line.
10994 * @param obj The entry object
10995 * @return single_line If true, the text in the entry is set to display
10996 * on a single line.
10998 * @see elm_entry_single_line_set()
11000 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11002 * Sets the entry to password mode.
11004 * In password mode, entries are implicitly single line and the display of
11005 * any text in them is replaced with asterisks (*).
11007 * @param obj The entry object
11008 * @param password If true, password mode is enabled.
11010 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11012 * Gets whether the entry is set to password mode.
11014 * @param obj The entry object
11015 * @return If true, the entry is set to display all characters
11016 * as asterisks (*).
11018 * @see elm_entry_password_set()
11020 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11022 * This sets the text displayed within the entry to @p entry.
11024 * @param obj The entry object
11025 * @param entry The text to be displayed
11027 * @deprecated Use elm_object_text_set() instead.
11028 * @note Using this function bypasses text filters
11030 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11032 * This returns the text currently shown in object @p entry.
11033 * See also elm_entry_entry_set().
11035 * @param obj The entry object
11036 * @return The currently displayed text or NULL on failure
11038 * @deprecated Use elm_object_text_get() instead.
11040 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11042 * Appends @p entry to the text of the entry.
11044 * Adds the text in @p entry to the end of any text already present in the
11047 * The appended text is subject to any filters set for the widget.
11049 * @param obj The entry object
11050 * @param entry The text to be displayed
11052 * @see elm_entry_text_filter_append()
11054 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11056 * Gets whether the entry is empty.
11058 * Empty means no text at all. If there are any markup tags, like an item
11059 * tag for which no provider finds anything, and no text is displayed, this
11060 * function still returns EINA_FALSE.
11062 * @param obj The entry object
11063 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11065 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11067 * Gets any selected text within the entry.
11069 * If there's any selected text in the entry, this function returns it as
11070 * a string in markup format. NULL is returned if no selection exists or
11071 * if an error occurred.
11073 * The returned value points to an internal string and should not be freed
11074 * or modified in any way. If the @p entry object is deleted or its
11075 * contents are changed, the returned pointer should be considered invalid.
11077 * @param obj The entry object
11078 * @return The selected text within the entry or NULL on failure
11080 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11082 * Inserts the given text into the entry at the current cursor position.
11084 * This inserts text at the cursor position as if it was typed
11085 * by the user (note that this also allows markup which a user
11086 * can't just "type" as it would be converted to escaped text, so this
11087 * call can be used to insert things like emoticon items or bold push/pop
11088 * tags, other font and color change tags etc.)
11090 * If any selection exists, it will be replaced by the inserted text.
11092 * The inserted text is subject to any filters set for the widget.
11094 * @param obj The entry object
11095 * @param entry The text to insert
11097 * @see elm_entry_text_filter_append()
11099 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11101 * Set the line wrap type to use on multi-line entries.
11103 * Sets the wrap type used by the entry to any of the specified in
11104 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11105 * line (without inserting a line break or paragraph separator) when it
11106 * reaches the far edge of the widget.
11108 * Note that this only makes sense for multi-line entries. A widget set
11109 * to be single line will never wrap.
11111 * @param obj The entry object
11112 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11114 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11116 * Gets the wrap mode the entry was set to use.
11118 * @param obj The entry object
11119 * @return Wrap type
11121 * @see also elm_entry_line_wrap_set()
11123 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11125 * Sets if the entry is to be editable or not.
11127 * By default, entries are editable and when focused, any text input by the
11128 * user will be inserted at the current cursor position. But calling this
11129 * function with @p editable as EINA_FALSE will prevent the user from
11130 * inputting text into the entry.
11132 * The only way to change the text of a non-editable entry is to use
11133 * elm_object_text_set(), elm_entry_entry_insert() and other related
11136 * @param obj The entry object
11137 * @param editable If EINA_TRUE, user input will be inserted in the entry,
11138 * if not, the entry is read-only and no user input is allowed.
11140 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11142 * Gets whether the entry is editable or not.
11144 * @param obj The entry object
11145 * @return If true, the entry is editable by the user.
11146 * If false, it is not editable by the user
11148 * @see elm_entry_editable_set()
11150 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11152 * This drops any existing text selection within the entry.
11154 * @param obj The entry object
11156 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11158 * This selects all text within the entry.
11160 * @param obj The entry object
11162 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11164 * This moves the cursor one place to the right within the entry.
11166 * @param obj The entry object
11167 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11169 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11171 * This moves the cursor one place to the left within the entry.
11173 * @param obj The entry object
11174 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11176 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11178 * This moves the cursor one line up within the entry.
11180 * @param obj The entry object
11181 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11183 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11185 * This moves the cursor one line down within the entry.
11187 * @param obj The entry object
11188 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11190 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11192 * This moves the cursor to the beginning of the entry.
11194 * @param obj The entry object
11196 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11198 * This moves the cursor to the end of the entry.
11200 * @param obj The entry object
11202 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11204 * This moves the cursor to the beginning of the current line.
11206 * @param obj The entry object
11208 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11210 * This moves the cursor to the end of the current line.
11212 * @param obj The entry object
11214 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11216 * This begins a selection within the entry as though
11217 * the user were holding down the mouse button to make a selection.
11219 * @param obj The entry object
11221 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11223 * This ends a selection within the entry as though
11224 * the user had just released the mouse button while making a selection.
11226 * @param obj The entry object
11228 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11230 * Gets whether a format node exists at the current cursor position.
11232 * A format node is anything that defines how the text is rendered. It can
11233 * be a visible format node, such as a line break or a paragraph separator,
11234 * or an invisible one, such as bold begin or end tag.
11235 * This function returns whether any format node exists at the current
11238 * @param obj The entry object
11239 * @return EINA_TRUE if the current cursor position contains a format node,
11240 * EINA_FALSE otherwise.
11242 * @see elm_entry_cursor_is_visible_format_get()
11244 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11246 * Gets if the current cursor position holds a visible format node.
11248 * @param obj The entry object
11249 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11250 * if it's an invisible one or no format exists.
11252 * @see elm_entry_cursor_is_format_get()
11254 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11256 * Gets the character pointed by the cursor at its current position.
11258 * This function returns a string with the utf8 character stored at the
11259 * current cursor position.
11260 * Only the text is returned, any format that may exist will not be part
11261 * of the return value.
11263 * @param obj The entry object
11264 * @return The text pointed by the cursors.
11266 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11268 * This function returns the geometry of the cursor.
11270 * It's useful if you want to draw something on the cursor (or where it is),
11271 * or for example in the case of scrolled entry where you want to show the
11274 * @param obj The entry object
11275 * @param x returned geometry
11276 * @param y returned geometry
11277 * @param w returned geometry
11278 * @param h returned geometry
11279 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11281 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);
11283 * Sets the cursor position in the entry to the given value
11285 * The value in @p pos is the index of the character position within the
11286 * contents of the string as returned by elm_entry_cursor_pos_get().
11288 * @param obj The entry object
11289 * @param pos The position of the cursor
11291 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11293 * Retrieves the current position of the cursor in the entry
11295 * @param obj The entry object
11296 * @return The cursor position
11298 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11300 * This executes a "cut" action on the selected text in the entry.
11302 * @param obj The entry object
11304 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11306 * This executes a "copy" action on the selected text in the entry.
11308 * @param obj The entry object
11310 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11312 * This executes a "paste" action in the entry.
11314 * @param obj The entry object
11316 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11318 * This clears and frees the items in a entry's contextual (longpress)
11321 * @param obj The entry object
11323 * @see elm_entry_context_menu_item_add()
11325 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11327 * This adds an item to the entry's contextual menu.
11329 * A longpress on an entry will make the contextual menu show up, if this
11330 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11331 * By default, this menu provides a few options like enabling selection mode,
11332 * which is useful on embedded devices that need to be explicit about it,
11333 * and when a selection exists it also shows the copy and cut actions.
11335 * With this function, developers can add other options to this menu to
11336 * perform any action they deem necessary.
11338 * @param obj The entry object
11339 * @param label The item's text label
11340 * @param icon_file The item's icon file
11341 * @param icon_type The item's icon type
11342 * @param func The callback to execute when the item is clicked
11343 * @param data The data to associate with the item for related functions
11345 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);
11347 * This disables the entry's contextual (longpress) menu.
11349 * @param obj The entry object
11350 * @param disabled If true, the menu is disabled
11352 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11354 * This returns whether the entry's contextual (longpress) menu is
11357 * @param obj The entry object
11358 * @return If true, the menu is disabled
11360 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11362 * This appends a custom item provider to the list for that entry
11364 * This appends the given callback. The list is walked from beginning to end
11365 * with each function called given the item href string in the text. If the
11366 * function returns an object handle other than NULL (it should create an
11367 * object to do this), then this object is used to replace that item. If
11368 * not the next provider is called until one provides an item object, or the
11369 * default provider in entry does.
11371 * @param obj The entry object
11372 * @param func The function called to provide the item object
11373 * @param data The data passed to @p func
11375 * @see @ref entry-items
11377 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);
11379 * This prepends a custom item provider to the list for that entry
11381 * This prepends the given callback. See elm_entry_item_provider_append() for
11384 * @param obj The entry object
11385 * @param func The function called to provide the item object
11386 * @param data The data passed to @p func
11388 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);
11390 * This removes a custom item provider to the list for that entry
11392 * This removes the given callback. See elm_entry_item_provider_append() for
11395 * @param obj The entry object
11396 * @param func The function called to provide the item object
11397 * @param data The data passed to @p func
11399 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);
11401 * Append a filter function for text inserted in the entry
11403 * Append the given callback to the list. This functions will be called
11404 * whenever any text is inserted into the entry, with the text to be inserted
11405 * as a parameter. The callback function is free to alter the text in any way
11406 * it wants, but it must remember to free the given pointer and update it.
11407 * If the new text is to be discarded, the function can free it and set its
11408 * text parameter to NULL. This will also prevent any following filters from
11411 * @param obj The entry object
11412 * @param func The function to use as text filter
11413 * @param data User data to pass to @p func
11415 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11417 * Prepend a filter function for text insdrted in the entry
11419 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11420 * for more information
11422 * @param obj The entry object
11423 * @param func The function to use as text filter
11424 * @param data User data to pass to @p func
11426 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11428 * Remove a filter from the list
11430 * Removes the given callback from the filter list. See
11431 * elm_entry_text_filter_append() for more information.
11433 * @param obj The entry object
11434 * @param func The filter function to remove
11435 * @param data The user data passed when adding the function
11437 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11439 * This converts a markup (HTML-like) string into UTF-8.
11441 * The returned string is a malloc'ed buffer and it should be freed when
11442 * not needed anymore.
11444 * @param s The string (in markup) to be converted
11445 * @return The converted string (in UTF-8). It should be freed.
11447 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11449 * This converts a UTF-8 string into markup (HTML-like).
11451 * The returned string is a malloc'ed buffer and it should be freed when
11452 * not needed anymore.
11454 * @param s The string (in UTF-8) to be converted
11455 * @return The converted string (in markup). It should be freed.
11457 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11459 * This sets the file (and implicitly loads it) for the text to display and
11460 * then edit. All changes are written back to the file after a short delay if
11461 * the entry object is set to autosave (which is the default).
11463 * If the entry had any other file set previously, any changes made to it
11464 * will be saved if the autosave feature is enabled, otherwise, the file
11465 * will be silently discarded and any non-saved changes will be lost.
11467 * @param obj The entry object
11468 * @param file The path to the file to load and save
11469 * @param format The file format
11471 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11473 * Gets the file being edited by the entry.
11475 * This function can be used to retrieve any file set on the entry for
11476 * edition, along with the format used to load and save it.
11478 * @param obj The entry object
11479 * @param file The path to the file to load and save
11480 * @param format The file format
11482 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11484 * This function writes any changes made to the file set with
11485 * elm_entry_file_set()
11487 * @param obj The entry object
11489 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11491 * This sets the entry object to 'autosave' the loaded text file or not.
11493 * @param obj The entry object
11494 * @param autosave Autosave the loaded file or not
11496 * @see elm_entry_file_set()
11498 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11500 * This gets the entry object's 'autosave' status.
11502 * @param obj The entry object
11503 * @return Autosave the loaded file or not
11505 * @see elm_entry_file_set()
11507 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11509 * Control pasting of text and images for the widget.
11511 * Normally the entry allows both text and images to be pasted. By setting
11512 * textonly to be true, this prevents images from being pasted.
11514 * Note this only changes the behaviour of text.
11516 * @param obj The entry object
11517 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11518 * text+image+other.
11520 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11522 * Getting elm_entry text paste/drop mode.
11524 * In textonly mode, only text may be pasted or dropped into the widget.
11526 * @param obj The entry object
11527 * @return If the widget only accepts text from pastes.
11529 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11531 * Enable or disable scrolling in entry
11533 * Normally the entry is not scrollable unless you enable it with this call.
11535 * @param obj The entry object
11536 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11538 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11540 * Get the scrollable state of the entry
11542 * Normally the entry is not scrollable. This gets the scrollable state
11543 * of the entry. See elm_entry_scrollable_set() for more information.
11545 * @param obj The entry object
11546 * @return The scrollable state
11548 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11550 * This sets a widget to be displayed to the left of a scrolled entry.
11552 * @param obj The scrolled entry object
11553 * @param icon The widget to display on the left side of the scrolled
11556 * @note A previously set widget will be destroyed.
11557 * @note If the object being set does not have minimum size hints set,
11558 * it won't get properly displayed.
11560 * @see elm_entry_end_set()
11562 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11564 * Gets the leftmost widget of the scrolled entry. This object is
11565 * owned by the scrolled entry and should not be modified.
11567 * @param obj The scrolled entry object
11568 * @return the left widget inside the scroller
11570 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11572 * Unset the leftmost widget of the scrolled entry, unparenting and
11575 * @param obj The scrolled entry object
11576 * @return the previously set icon sub-object of this entry, on
11579 * @see elm_entry_icon_set()
11581 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11583 * Sets the visibility of the left-side widget of the scrolled entry,
11584 * set by elm_entry_icon_set().
11586 * @param obj The scrolled entry object
11587 * @param setting EINA_TRUE if the object should be displayed,
11588 * EINA_FALSE if not.
11590 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11592 * This sets a widget to be displayed to the end of a scrolled entry.
11594 * @param obj The scrolled entry object
11595 * @param end The widget to display on the right side of the scrolled
11598 * @note A previously set widget will be destroyed.
11599 * @note If the object being set does not have minimum size hints set,
11600 * it won't get properly displayed.
11602 * @see elm_entry_icon_set
11604 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11606 * Gets the endmost widget of the scrolled entry. This object is owned
11607 * by the scrolled entry and should not be modified.
11609 * @param obj The scrolled entry object
11610 * @return the right widget inside the scroller
11612 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11614 * Unset the endmost widget of the scrolled entry, unparenting and
11617 * @param obj The scrolled entry object
11618 * @return the previously set icon sub-object of this entry, on
11621 * @see elm_entry_icon_set()
11623 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11625 * Sets the visibility of the end widget of the scrolled entry, set by
11626 * elm_entry_end_set().
11628 * @param obj The scrolled entry object
11629 * @param setting EINA_TRUE if the object should be displayed,
11630 * EINA_FALSE if not.
11632 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11634 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11637 * Setting an entry to single-line mode with elm_entry_single_line_set()
11638 * will automatically disable the display of scrollbars when the entry
11639 * moves inside its scroller.
11641 * @param obj The scrolled entry object
11642 * @param h The horizontal scrollbar policy to apply
11643 * @param v The vertical scrollbar policy to apply
11645 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11647 * This enables/disables bouncing within the entry.
11649 * This function sets whether the entry will bounce when scrolling reaches
11650 * the end of the contained entry.
11652 * @param obj The scrolled entry object
11653 * @param h The horizontal bounce state
11654 * @param v The vertical bounce state
11656 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11658 * Get the bounce mode
11660 * @param obj The Entry object
11661 * @param h_bounce Allow bounce horizontally
11662 * @param v_bounce Allow bounce vertically
11664 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11666 /* pre-made filters for entries */
11668 * @typedef Elm_Entry_Filter_Limit_Size
11670 * Data for the elm_entry_filter_limit_size() entry filter.
11672 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11674 * @struct _Elm_Entry_Filter_Limit_Size
11676 * Data for the elm_entry_filter_limit_size() entry filter.
11678 struct _Elm_Entry_Filter_Limit_Size
11680 int max_char_count; /**< The maximum number of characters allowed. */
11681 int max_byte_count; /**< The maximum number of bytes allowed*/
11684 * Filter inserted text based on user defined character and byte limits
11686 * Add this filter to an entry to limit the characters that it will accept
11687 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11688 * The funtion works on the UTF-8 representation of the string, converting
11689 * it from the set markup, thus not accounting for any format in it.
11691 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11692 * it as data when setting the filter. In it, it's possible to set limits
11693 * by character count or bytes (any of them is disabled if 0), and both can
11694 * be set at the same time. In that case, it first checks for characters,
11697 * The function will cut the inserted text in order to allow only the first
11698 * number of characters that are still allowed. The cut is made in
11699 * characters, even when limiting by bytes, in order to always contain
11700 * valid ones and avoid half unicode characters making it in.
11702 * This filter, like any others, does not apply when setting the entry text
11703 * directly with elm_object_text_set() (or the deprecated
11704 * elm_entry_entry_set()).
11706 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11708 * @typedef Elm_Entry_Filter_Accept_Set
11710 * Data for the elm_entry_filter_accept_set() entry filter.
11712 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11714 * @struct _Elm_Entry_Filter_Accept_Set
11716 * Data for the elm_entry_filter_accept_set() entry filter.
11718 struct _Elm_Entry_Filter_Accept_Set
11720 const char *accepted; /**< Set of characters accepted in the entry. */
11721 const char *rejected; /**< Set of characters rejected from the entry. */
11724 * Filter inserted text based on accepted or rejected sets of characters
11726 * Add this filter to an entry to restrict the set of accepted characters
11727 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11728 * This structure contains both accepted and rejected sets, but they are
11729 * mutually exclusive.
11731 * The @c accepted set takes preference, so if it is set, the filter will
11732 * only work based on the accepted characters, ignoring anything in the
11733 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11735 * In both cases, the function filters by matching utf8 characters to the
11736 * raw markup text, so it can be used to remove formatting tags.
11738 * This filter, like any others, does not apply when setting the entry text
11739 * directly with elm_object_text_set() (or the deprecated
11740 * elm_entry_entry_set()).
11742 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11744 * Set the input panel layout of the entry
11746 * @param obj The entry object
11747 * @param layout layout type
11749 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11751 * Get the input panel layout of the entry
11753 * @param obj The entry object
11754 * @return layout type
11756 * @see elm_entry_input_panel_layout_set
11758 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11760 * Set the autocapitalization type on the immodule.
11762 * @param obj The entry object
11763 * @param autocapital_type The type of autocapitalization
11765 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11767 * Retrieve the autocapitalization type on the immodule.
11769 * @param obj The entry object
11770 * @return autocapitalization type
11772 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11774 * Sets the attribute to show the input panel automatically.
11776 * @param obj The entry object
11777 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
11779 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
11781 * Retrieve the attribute to show the input panel automatically.
11783 * @param obj The entry object
11784 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
11786 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11792 /* composite widgets - these basically put together basic widgets above
11793 * in convenient packages that do more than basic stuff */
11797 * @defgroup Anchorview Anchorview
11799 * @image html img/widget/anchorview/preview-00.png
11800 * @image latex img/widget/anchorview/preview-00.eps
11802 * Anchorview is for displaying text that contains markup with anchors
11803 * like <c>\<a href=1234\>something\</\></c> in it.
11805 * Besides being styled differently, the anchorview widget provides the
11806 * necessary functionality so that clicking on these anchors brings up a
11807 * popup with user defined content such as "call", "add to contacts" or
11808 * "open web page". This popup is provided using the @ref Hover widget.
11810 * This widget is very similar to @ref Anchorblock, so refer to that
11811 * widget for an example. The only difference Anchorview has is that the
11812 * widget is already provided with scrolling functionality, so if the
11813 * text set to it is too large to fit in the given space, it will scroll,
11814 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11815 * text can be displayed.
11817 * This widget emits the following signals:
11818 * @li "anchor,clicked": will be called when an anchor is clicked. The
11819 * @p event_info parameter on the callback will be a pointer of type
11820 * ::Elm_Entry_Anchorview_Info.
11822 * See @ref Anchorblock for an example on how to use both of them.
11831 * @typedef Elm_Entry_Anchorview_Info
11833 * The info sent in the callback for "anchor,clicked" signals emitted by
11834 * the Anchorview widget.
11836 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11838 * @struct _Elm_Entry_Anchorview_Info
11840 * The info sent in the callback for "anchor,clicked" signals emitted by
11841 * the Anchorview widget.
11843 struct _Elm_Entry_Anchorview_Info
11845 const char *name; /**< Name of the anchor, as indicated in its href
11847 int button; /**< The mouse button used to click on it */
11848 Evas_Object *hover; /**< The hover object to use for the popup */
11850 Evas_Coord x, y, w, h;
11851 } anchor, /**< Geometry selection of text used as anchor */
11852 hover_parent; /**< Geometry of the object used as parent by the
11854 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11855 for content on the left side of
11856 the hover. Before calling the
11857 callback, the widget will make the
11858 necessary calculations to check
11859 which sides are fit to be set with
11860 content, based on the position the
11861 hover is activated and its distance
11862 to the edges of its parent object
11864 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11865 the right side of the hover.
11866 See @ref hover_left */
11867 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11868 of the hover. See @ref hover_left */
11869 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11870 below the hover. See @ref
11874 * Add a new Anchorview object
11876 * @param parent The parent object
11877 * @return The new object or NULL if it cannot be created
11879 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11881 * Set the text to show in the anchorview
11883 * Sets the text of the anchorview to @p text. This text can include markup
11884 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11885 * text that will be specially styled and react to click events, ended with
11886 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11887 * "anchor,clicked" signal that you can attach a callback to with
11888 * evas_object_smart_callback_add(). The name of the anchor given in the
11889 * event info struct will be the one set in the href attribute, in this
11890 * case, anchorname.
11892 * Other markup can be used to style the text in different ways, but it's
11893 * up to the style defined in the theme which tags do what.
11894 * @deprecated use elm_object_text_set() instead.
11896 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11898 * Get the markup text set for the anchorview
11900 * Retrieves the text set on the anchorview, with markup tags included.
11902 * @param obj The anchorview object
11903 * @return The markup text set or @c NULL if nothing was set or an error
11905 * @deprecated use elm_object_text_set() instead.
11907 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11909 * Set the parent of the hover popup
11911 * Sets the parent object to use by the hover created by the anchorview
11912 * when an anchor is clicked. See @ref Hover for more details on this.
11913 * If no parent is set, the same anchorview object will be used.
11915 * @param obj The anchorview object
11916 * @param parent The object to use as parent for the hover
11918 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11920 * Get the parent of the hover popup
11922 * Get the object used as parent for the hover created by the anchorview
11923 * widget. See @ref Hover for more details on this.
11925 * @param obj The anchorview object
11926 * @return The object used as parent for the hover, NULL if none is set.
11928 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11930 * Set the style that the hover should use
11932 * When creating the popup hover, anchorview will request that it's
11933 * themed according to @p style.
11935 * @param obj The anchorview object
11936 * @param style The style to use for the underlying hover
11938 * @see elm_object_style_set()
11940 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11942 * Get the style that the hover should use
11944 * Get the style the hover created by anchorview will use.
11946 * @param obj The anchorview object
11947 * @return The style to use by the hover. NULL means the default is used.
11949 * @see elm_object_style_set()
11951 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11953 * Ends the hover popup in the anchorview
11955 * When an anchor is clicked, the anchorview widget will create a hover
11956 * object to use as a popup with user provided content. This function
11957 * terminates this popup, returning the anchorview to its normal state.
11959 * @param obj The anchorview object
11961 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11963 * Set bouncing behaviour when the scrolled content reaches an edge
11965 * Tell the internal scroller object whether it should bounce or not
11966 * when it reaches the respective edges for each axis.
11968 * @param obj The anchorview object
11969 * @param h_bounce Whether to bounce or not in the horizontal axis
11970 * @param v_bounce Whether to bounce or not in the vertical axis
11972 * @see elm_scroller_bounce_set()
11974 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11976 * Get the set bouncing behaviour of the internal scroller
11978 * Get whether the internal scroller should bounce when the edge of each
11979 * axis is reached scrolling.
11981 * @param obj The anchorview object
11982 * @param h_bounce Pointer where to store the bounce state of the horizontal
11984 * @param v_bounce Pointer where to store the bounce state of the vertical
11987 * @see elm_scroller_bounce_get()
11989 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11991 * Appends a custom item provider to the given anchorview
11993 * Appends the given function to the list of items providers. This list is
11994 * called, one function at a time, with the given @p data pointer, the
11995 * anchorview object and, in the @p item parameter, the item name as
11996 * referenced in its href string. Following functions in the list will be
11997 * called in order until one of them returns something different to NULL,
11998 * which should be an Evas_Object which will be used in place of the item
12001 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12002 * href=item/name\>\</item\>
12004 * @param obj The anchorview object
12005 * @param func The function to add to the list of providers
12006 * @param data User data that will be passed to the callback function
12008 * @see elm_entry_item_provider_append()
12010 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);
12012 * Prepend a custom item provider to the given anchorview
12014 * Like elm_anchorview_item_provider_append(), but it adds the function
12015 * @p func to the beginning of the list, instead of the end.
12017 * @param obj The anchorview object
12018 * @param func The function to add to the list of providers
12019 * @param data User data that will be passed to the callback function
12021 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);
12023 * Remove a custom item provider from the list of the given anchorview
12025 * Removes the function and data pairing that matches @p func and @p data.
12026 * That is, unless the same function and same user data are given, the
12027 * function will not be removed from the list. This allows us to add the
12028 * same callback several times, with different @p data pointers and be
12029 * able to remove them later without conflicts.
12031 * @param obj The anchorview object
12032 * @param func The function to remove from the list
12033 * @param data The data matching the function to remove from the list
12035 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);
12042 * @defgroup Anchorblock Anchorblock
12044 * @image html img/widget/anchorblock/preview-00.png
12045 * @image latex img/widget/anchorblock/preview-00.eps
12047 * Anchorblock is for displaying text that contains markup with anchors
12048 * like <c>\<a href=1234\>something\</\></c> in it.
12050 * Besides being styled differently, the anchorblock widget provides the
12051 * necessary functionality so that clicking on these anchors brings up a
12052 * popup with user defined content such as "call", "add to contacts" or
12053 * "open web page". This popup is provided using the @ref Hover widget.
12055 * This widget emits the following signals:
12056 * @li "anchor,clicked": will be called when an anchor is clicked. The
12057 * @p event_info parameter on the callback will be a pointer of type
12058 * ::Elm_Entry_Anchorblock_Info.
12064 * Since examples are usually better than plain words, we might as well
12065 * try @ref tutorial_anchorblock_example "one".
12068 * @addtogroup Anchorblock
12072 * @typedef Elm_Entry_Anchorblock_Info
12074 * The info sent in the callback for "anchor,clicked" signals emitted by
12075 * the Anchorblock widget.
12077 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12079 * @struct _Elm_Entry_Anchorblock_Info
12081 * The info sent in the callback for "anchor,clicked" signals emitted by
12082 * the Anchorblock widget.
12084 struct _Elm_Entry_Anchorblock_Info
12086 const char *name; /**< Name of the anchor, as indicated in its href
12088 int button; /**< The mouse button used to click on it */
12089 Evas_Object *hover; /**< The hover object to use for the popup */
12091 Evas_Coord x, y, w, h;
12092 } anchor, /**< Geometry selection of text used as anchor */
12093 hover_parent; /**< Geometry of the object used as parent by the
12095 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12096 for content on the left side of
12097 the hover. Before calling the
12098 callback, the widget will make the
12099 necessary calculations to check
12100 which sides are fit to be set with
12101 content, based on the position the
12102 hover is activated and its distance
12103 to the edges of its parent object
12105 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12106 the right side of the hover.
12107 See @ref hover_left */
12108 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12109 of the hover. See @ref hover_left */
12110 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12111 below the hover. See @ref
12115 * Add a new Anchorblock object
12117 * @param parent The parent object
12118 * @return The new object or NULL if it cannot be created
12120 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12122 * Set the text to show in the anchorblock
12124 * Sets the text of the anchorblock to @p text. This text can include markup
12125 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12126 * of text that will be specially styled and react to click events, ended
12127 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12128 * "anchor,clicked" signal that you can attach a callback to with
12129 * evas_object_smart_callback_add(). The name of the anchor given in the
12130 * event info struct will be the one set in the href attribute, in this
12131 * case, anchorname.
12133 * Other markup can be used to style the text in different ways, but it's
12134 * up to the style defined in the theme which tags do what.
12135 * @deprecated use elm_object_text_set() instead.
12137 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12139 * Get the markup text set for the anchorblock
12141 * Retrieves the text set on the anchorblock, with markup tags included.
12143 * @param obj The anchorblock object
12144 * @return The markup text set or @c NULL if nothing was set or an error
12146 * @deprecated use elm_object_text_set() instead.
12148 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12150 * Set the parent of the hover popup
12152 * Sets the parent object to use by the hover created by the anchorblock
12153 * when an anchor is clicked. See @ref Hover for more details on this.
12155 * @param obj The anchorblock object
12156 * @param parent The object to use as parent for the hover
12158 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12160 * Get the parent of the hover popup
12162 * Get the object used as parent for the hover created by the anchorblock
12163 * widget. See @ref Hover for more details on this.
12164 * If no parent is set, the same anchorblock object will be used.
12166 * @param obj The anchorblock object
12167 * @return The object used as parent for the hover, NULL if none is set.
12169 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12171 * Set the style that the hover should use
12173 * When creating the popup hover, anchorblock will request that it's
12174 * themed according to @p style.
12176 * @param obj The anchorblock object
12177 * @param style The style to use for the underlying hover
12179 * @see elm_object_style_set()
12181 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12183 * Get the style that the hover should use
12185 * Get the style, the hover created by anchorblock will use.
12187 * @param obj The anchorblock object
12188 * @return The style to use by the hover. NULL means the default is used.
12190 * @see elm_object_style_set()
12192 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12194 * Ends the hover popup in the anchorblock
12196 * When an anchor is clicked, the anchorblock widget will create a hover
12197 * object to use as a popup with user provided content. This function
12198 * terminates this popup, returning the anchorblock to its normal state.
12200 * @param obj The anchorblock object
12202 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12204 * Appends a custom item provider to the given anchorblock
12206 * Appends the given function to the list of items providers. This list is
12207 * called, one function at a time, with the given @p data pointer, the
12208 * anchorblock object and, in the @p item parameter, the item name as
12209 * referenced in its href string. Following functions in the list will be
12210 * called in order until one of them returns something different to NULL,
12211 * which should be an Evas_Object which will be used in place of the item
12214 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12215 * href=item/name\>\</item\>
12217 * @param obj The anchorblock object
12218 * @param func The function to add to the list of providers
12219 * @param data User data that will be passed to the callback function
12221 * @see elm_entry_item_provider_append()
12223 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);
12225 * Prepend a custom item provider to the given anchorblock
12227 * Like elm_anchorblock_item_provider_append(), but it adds the function
12228 * @p func to the beginning of the list, instead of the end.
12230 * @param obj The anchorblock object
12231 * @param func The function to add to the list of providers
12232 * @param data User data that will be passed to the callback function
12234 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);
12236 * Remove a custom item provider from the list of the given anchorblock
12238 * Removes the function and data pairing that matches @p func and @p data.
12239 * That is, unless the same function and same user data are given, the
12240 * function will not be removed from the list. This allows us to add the
12241 * same callback several times, with different @p data pointers and be
12242 * able to remove them later without conflicts.
12244 * @param obj The anchorblock object
12245 * @param func The function to remove from the list
12246 * @param data The data matching the function to remove from the list
12248 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);
12254 * @defgroup Bubble Bubble
12256 * @image html img/widget/bubble/preview-00.png
12257 * @image latex img/widget/bubble/preview-00.eps
12258 * @image html img/widget/bubble/preview-01.png
12259 * @image latex img/widget/bubble/preview-01.eps
12260 * @image html img/widget/bubble/preview-02.png
12261 * @image latex img/widget/bubble/preview-02.eps
12263 * @brief The Bubble is a widget to show text similar to how speech is
12264 * represented in comics.
12266 * The bubble widget contains 5 important visual elements:
12267 * @li The frame is a rectangle with rounded edjes and an "arrow".
12268 * @li The @p icon is an image to which the frame's arrow points to.
12269 * @li The @p label is a text which appears to the right of the icon if the
12270 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12272 * @li The @p info is a text which appears to the right of the label. Info's
12273 * font is of a ligther color than label.
12274 * @li The @p content is an evas object that is shown inside the frame.
12276 * The position of the arrow, icon, label and info depends on which corner is
12277 * selected. The four available corners are:
12278 * @li "top_left" - Default
12280 * @li "bottom_left"
12281 * @li "bottom_right"
12283 * Signals that you can add callbacks for are:
12284 * @li "clicked" - This is called when a user has clicked the bubble.
12286 * For an example of using a buble see @ref bubble_01_example_page "this".
12291 #define ELM_BUBBLE_CONTENT_ICON "elm.swallow.icon"
12294 * Add a new bubble to the parent
12296 * @param parent The parent object
12297 * @return The new object or NULL if it cannot be created
12299 * This function adds a text bubble to the given parent evas object.
12301 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12303 * Set the label of the bubble
12305 * @param obj The bubble object
12306 * @param label The string to set in the label
12308 * This function sets the title of the bubble. Where this appears depends on
12309 * the selected corner.
12310 * @deprecated use elm_object_text_set() instead.
12312 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12314 * Get the label of the bubble
12316 * @param obj The bubble object
12317 * @return The string of set in the label
12319 * This function gets the title of the bubble.
12320 * @deprecated use elm_object_text_get() instead.
12322 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12324 * Set the info of the bubble
12326 * @param obj The bubble object
12327 * @param info The given info about the bubble
12329 * This function sets the info of the bubble. Where this appears depends on
12330 * the selected corner.
12331 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12333 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12335 * Get the info of the bubble
12337 * @param obj The bubble object
12339 * @return The "info" string of the bubble
12341 * This function gets the info text.
12342 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12344 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12346 * Set the content to be shown in the bubble
12348 * Once the content object is set, a previously set one will be deleted.
12349 * If you want to keep the old content object, use the
12350 * elm_bubble_content_unset() function.
12352 * @param obj The bubble object
12353 * @param content The given content of the bubble
12355 * This function sets the content shown on the middle of the bubble.
12357 * @deprecated use elm_object_content_set() instead
12360 EINA_DEPRECATED EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12362 * Get the content shown in the bubble
12364 * Return the content object which is set for this widget.
12366 * @param obj The bubble object
12367 * @return The content that is being used
12369 * @deprecated use elm_object_content_get() instead
12372 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12374 * Unset the content shown in the bubble
12376 * Unparent and return the content object which was set for this widget.
12378 * @param obj The bubble object
12379 * @return The content that was being used
12381 * @deprecated use elm_object_content_unset() instead
12384 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12386 * Set the icon of the bubble
12388 * Once the icon object is set, a previously set one will be deleted.
12389 * If you want to keep the old content object, use the
12390 * elm_icon_content_unset() function.
12392 * @param obj The bubble object
12393 * @param icon The given icon for the bubble
12395 * @deprecated use elm_object_content_part_set() instead
12398 EINA_DEPRECATED EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12400 * Get the icon of the bubble
12402 * @param obj The bubble object
12403 * @return The icon for the bubble
12405 * This function gets the icon shown on the top left of bubble.
12407 * @deprecated use elm_object_content_part_get() instead
12410 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12412 * Unset the icon of the bubble
12414 * Unparent and return the icon object which was set for this widget.
12416 * @param obj The bubble object
12417 * @return The icon that was being used
12419 * @deprecated use elm_object_content_part_unset() instead
12422 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12424 * Set the corner of the bubble
12426 * @param obj The bubble object.
12427 * @param corner The given corner for the bubble.
12429 * This function sets the corner of the bubble. The corner will be used to
12430 * determine where the arrow in the frame points to and where label, icon and
12433 * Possible values for corner are:
12434 * @li "top_left" - Default
12436 * @li "bottom_left"
12437 * @li "bottom_right"
12439 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12441 * Get the corner of the bubble
12443 * @param obj The bubble object.
12444 * @return The given corner for the bubble.
12446 * This function gets the selected corner of the bubble.
12448 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12454 * @defgroup Photo Photo
12456 * For displaying the photo of a person (contact). Simple, yet
12457 * with a very specific purpose.
12459 * Signals that you can add callbacks for are:
12461 * "clicked" - This is called when a user has clicked the photo
12462 * "drag,start" - Someone started dragging the image out of the object
12463 * "drag,end" - Dragged item was dropped (somewhere)
12469 * Add a new photo to the parent
12471 * @param parent The parent object
12472 * @return The new object or NULL if it cannot be created
12476 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12479 * Set the file that will be used as photo
12481 * @param obj The photo object
12482 * @param file The path to file that will be used as photo
12484 * @return (1 = success, 0 = error)
12488 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12491 * Set the file that will be used as thumbnail in the photo.
12493 * @param obj The photo object.
12494 * @param file The path to file that will be used as thumb.
12495 * @param group The key used in case of an EET file.
12499 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12502 * Set the size that will be used on the photo
12504 * @param obj The photo object
12505 * @param size The size that the photo will be
12509 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12512 * Set if the photo should be completely visible or not.
12514 * @param obj The photo object
12515 * @param fill if true the photo will be completely visible
12519 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12522 * Set editability of the photo.
12524 * An editable photo can be dragged to or from, and can be cut or
12525 * pasted too. Note that pasting an image or dropping an item on
12526 * the image will delete the existing content.
12528 * @param obj The photo object.
12529 * @param set To set of clear editablity.
12531 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12537 /* gesture layer */
12539 * @defgroup Elm_Gesture_Layer Gesture Layer
12540 * Gesture Layer Usage:
12542 * Use Gesture Layer to detect gestures.
12543 * The advantage is that you don't have to implement
12544 * gesture detection, just set callbacks of gesture state.
12545 * By using gesture layer we make standard interface.
12547 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12548 * with a parent object parameter.
12549 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12550 * call. Usually with same object as target (2nd parameter).
12552 * Now you need to tell gesture layer what gestures you follow.
12553 * This is done with @ref elm_gesture_layer_cb_set call.
12554 * By setting the callback you actually saying to gesture layer:
12555 * I would like to know when the gesture @ref Elm_Gesture_Types
12556 * switches to state @ref Elm_Gesture_State.
12558 * Next, you need to implement the actual action that follows the input
12559 * in your callback.
12561 * Note that if you like to stop being reported about a gesture, just set
12562 * all callbacks referring this gesture to NULL.
12563 * (again with @ref elm_gesture_layer_cb_set)
12565 * The information reported by gesture layer to your callback is depending
12566 * on @ref Elm_Gesture_Types:
12567 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12568 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12569 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12571 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12572 * @ref ELM_GESTURE_MOMENTUM.
12574 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12575 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12576 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12577 * Note that we consider a flick as a line-gesture that should be completed
12578 * in flick-time-limit as defined in @ref Config.
12580 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12582 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12585 * Gesture Layer Tweaks:
12587 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12588 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12590 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12591 * so gesture starts when user touches (a *DOWN event) touch-surface
12592 * and ends when no fingers touches surface (a *UP event).
12596 * @enum _Elm_Gesture_Types
12597 * Enum of supported gesture types.
12598 * @ingroup Elm_Gesture_Layer
12600 enum _Elm_Gesture_Types
12602 ELM_GESTURE_FIRST = 0,
12604 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12605 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12606 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12607 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12609 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12611 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12612 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12614 ELM_GESTURE_ZOOM, /**< Zoom */
12615 ELM_GESTURE_ROTATE, /**< Rotate */
12621 * @typedef Elm_Gesture_Types
12622 * gesture types enum
12623 * @ingroup Elm_Gesture_Layer
12625 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12628 * @enum _Elm_Gesture_State
12629 * Enum of gesture states.
12630 * @ingroup Elm_Gesture_Layer
12632 enum _Elm_Gesture_State
12634 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12635 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12636 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12637 ELM_GESTURE_STATE_END, /**< Gesture completed */
12638 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12642 * @typedef Elm_Gesture_State
12643 * gesture states enum
12644 * @ingroup Elm_Gesture_Layer
12646 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12649 * @struct _Elm_Gesture_Taps_Info
12650 * Struct holds taps info for user
12651 * @ingroup Elm_Gesture_Layer
12653 struct _Elm_Gesture_Taps_Info
12655 Evas_Coord x, y; /**< Holds center point between fingers */
12656 unsigned int n; /**< Number of fingers tapped */
12657 unsigned int timestamp; /**< event timestamp */
12661 * @typedef Elm_Gesture_Taps_Info
12662 * holds taps info for user
12663 * @ingroup Elm_Gesture_Layer
12665 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12668 * @struct _Elm_Gesture_Momentum_Info
12669 * Struct holds momentum info for user
12670 * x1 and y1 are not necessarily in sync
12671 * x1 holds x value of x direction starting point
12672 * and same holds for y1.
12673 * This is noticeable when doing V-shape movement
12674 * @ingroup Elm_Gesture_Layer
12676 struct _Elm_Gesture_Momentum_Info
12677 { /* Report line ends, timestamps, and momentum computed */
12678 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12679 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12680 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12681 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12683 unsigned int tx; /**< Timestamp of start of final x-swipe */
12684 unsigned int ty; /**< Timestamp of start of final y-swipe */
12686 Evas_Coord mx; /**< Momentum on X */
12687 Evas_Coord my; /**< Momentum on Y */
12689 unsigned int n; /**< Number of fingers */
12693 * @typedef Elm_Gesture_Momentum_Info
12694 * holds momentum info for user
12695 * @ingroup Elm_Gesture_Layer
12697 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12700 * @struct _Elm_Gesture_Line_Info
12701 * Struct holds line info for user
12702 * @ingroup Elm_Gesture_Layer
12704 struct _Elm_Gesture_Line_Info
12705 { /* Report line ends, timestamps, and momentum computed */
12706 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12707 double angle; /**< Angle (direction) of lines */
12711 * @typedef Elm_Gesture_Line_Info
12712 * Holds line info for user
12713 * @ingroup Elm_Gesture_Layer
12715 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12718 * @struct _Elm_Gesture_Zoom_Info
12719 * Struct holds zoom info for user
12720 * @ingroup Elm_Gesture_Layer
12722 struct _Elm_Gesture_Zoom_Info
12724 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12725 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12726 double zoom; /**< Zoom value: 1.0 means no zoom */
12727 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12731 * @typedef Elm_Gesture_Zoom_Info
12732 * Holds zoom info for user
12733 * @ingroup Elm_Gesture_Layer
12735 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12738 * @struct _Elm_Gesture_Rotate_Info
12739 * Struct holds rotation info for user
12740 * @ingroup Elm_Gesture_Layer
12742 struct _Elm_Gesture_Rotate_Info
12744 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12745 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12746 double base_angle; /**< Holds start-angle */
12747 double angle; /**< Rotation value: 0.0 means no rotation */
12748 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12752 * @typedef Elm_Gesture_Rotate_Info
12753 * Holds rotation info for user
12754 * @ingroup Elm_Gesture_Layer
12756 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12759 * @typedef Elm_Gesture_Event_Cb
12760 * User callback used to stream gesture info from gesture layer
12761 * @param data user data
12762 * @param event_info gesture report info
12763 * Returns a flag field to be applied on the causing event.
12764 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12765 * upon the event, in an irreversible way.
12767 * @ingroup Elm_Gesture_Layer
12769 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12772 * Use function to set callbacks to be notified about
12773 * change of state of gesture.
12774 * When a user registers a callback with this function
12775 * this means this gesture has to be tested.
12777 * When ALL callbacks for a gesture are set to NULL
12778 * it means user isn't interested in gesture-state
12779 * and it will not be tested.
12781 * @param obj Pointer to gesture-layer.
12782 * @param idx The gesture you would like to track its state.
12783 * @param cb callback function pointer.
12784 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12785 * @param data user info to be sent to callback (usually, Smart Data)
12787 * @ingroup Elm_Gesture_Layer
12789 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);
12792 * Call this function to get repeat-events settings.
12794 * @param obj Pointer to gesture-layer.
12796 * @return repeat events settings.
12797 * @see elm_gesture_layer_hold_events_set()
12798 * @ingroup Elm_Gesture_Layer
12800 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12803 * This function called in order to make gesture-layer repeat events.
12804 * Set this of you like to get the raw events only if gestures were not detected.
12805 * Clear this if you like gesture layer to fwd events as testing gestures.
12807 * @param obj Pointer to gesture-layer.
12808 * @param r Repeat: TRUE/FALSE
12810 * @ingroup Elm_Gesture_Layer
12812 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12815 * This function sets step-value for zoom action.
12816 * Set step to any positive value.
12817 * Cancel step setting by setting to 0.0
12819 * @param obj Pointer to gesture-layer.
12820 * @param s new zoom step value.
12822 * @ingroup Elm_Gesture_Layer
12824 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12827 * This function sets step-value for rotate action.
12828 * Set step to any positive value.
12829 * Cancel step setting by setting to 0.0
12831 * @param obj Pointer to gesture-layer.
12832 * @param s new roatate step value.
12834 * @ingroup Elm_Gesture_Layer
12836 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12839 * This function called to attach gesture-layer to an Evas_Object.
12840 * @param obj Pointer to gesture-layer.
12841 * @param t Pointer to underlying object (AKA Target)
12843 * @return TRUE, FALSE on success, failure.
12845 * @ingroup Elm_Gesture_Layer
12847 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12850 * Call this function to construct a new gesture-layer object.
12851 * This does not activate the gesture layer. You have to
12852 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12854 * @param parent the parent object.
12856 * @return Pointer to new gesture-layer object.
12858 * @ingroup Elm_Gesture_Layer
12860 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12863 * @defgroup Thumb Thumb
12865 * @image html img/widget/thumb/preview-00.png
12866 * @image latex img/widget/thumb/preview-00.eps
12868 * A thumb object is used for displaying the thumbnail of an image or video.
12869 * You must have compiled Elementary with Ethumb_Client support and the DBus
12870 * service must be present and auto-activated in order to have thumbnails to
12873 * Once the thumbnail object becomes visible, it will check if there is a
12874 * previously generated thumbnail image for the file set on it. If not, it
12875 * will start generating this thumbnail.
12877 * Different config settings will cause different thumbnails to be generated
12878 * even on the same file.
12880 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12881 * Ethumb documentation to change this path, and to see other configuration
12884 * Signals that you can add callbacks for are:
12886 * - "clicked" - This is called when a user has clicked the thumb without dragging
12888 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12889 * - "press" - This is called when a user has pressed down the thumb.
12890 * - "generate,start" - The thumbnail generation started.
12891 * - "generate,stop" - The generation process stopped.
12892 * - "generate,error" - The generation failed.
12893 * - "load,error" - The thumbnail image loading failed.
12895 * available styles:
12899 * An example of use of thumbnail:
12901 * - @ref thumb_example_01
12905 * @addtogroup Thumb
12910 * @enum _Elm_Thumb_Animation_Setting
12911 * @typedef Elm_Thumb_Animation_Setting
12913 * Used to set if a video thumbnail is animating or not.
12917 typedef enum _Elm_Thumb_Animation_Setting
12919 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12920 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
12921 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
12922 ELM_THUMB_ANIMATION_LAST
12923 } Elm_Thumb_Animation_Setting;
12926 * Add a new thumb object to the parent.
12928 * @param parent The parent object.
12929 * @return The new object or NULL if it cannot be created.
12931 * @see elm_thumb_file_set()
12932 * @see elm_thumb_ethumb_client_get()
12936 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12938 * Reload thumbnail if it was generated before.
12940 * @param obj The thumb object to reload
12942 * This is useful if the ethumb client configuration changed, like its
12943 * size, aspect or any other property one set in the handle returned
12944 * by elm_thumb_ethumb_client_get().
12946 * If the options didn't change, the thumbnail won't be generated again, but
12947 * the old one will still be used.
12949 * @see elm_thumb_file_set()
12953 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12955 * Set the file that will be used as thumbnail.
12957 * @param obj The thumb object.
12958 * @param file The path to file that will be used as thumb.
12959 * @param key The key used in case of an EET file.
12961 * The file can be an image or a video (in that case, acceptable extensions are:
12962 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12963 * function elm_thumb_animate().
12965 * @see elm_thumb_file_get()
12966 * @see elm_thumb_reload()
12967 * @see elm_thumb_animate()
12971 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12973 * Get the image or video path and key used to generate the thumbnail.
12975 * @param obj The thumb object.
12976 * @param file Pointer to filename.
12977 * @param key Pointer to key.
12979 * @see elm_thumb_file_set()
12980 * @see elm_thumb_path_get()
12984 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12986 * Get the path and key to the image or video generated by ethumb.
12988 * One just need to make sure that the thumbnail was generated before getting
12989 * its path; otherwise, the path will be NULL. One way to do that is by asking
12990 * for the path when/after the "generate,stop" smart callback is called.
12992 * @param obj The thumb object.
12993 * @param file Pointer to thumb path.
12994 * @param key Pointer to thumb key.
12996 * @see elm_thumb_file_get()
13000 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13002 * Set the animation state for the thumb object. If its content is an animated
13003 * video, you may start/stop the animation or tell it to play continuously and
13006 * @param obj The thumb object.
13007 * @param setting The animation setting.
13009 * @see elm_thumb_file_set()
13013 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13015 * Get the animation state for the thumb object.
13017 * @param obj The thumb object.
13018 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13021 * @see elm_thumb_animate_set()
13025 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13027 * Get the ethumb_client handle so custom configuration can be made.
13029 * @return Ethumb_Client instance or NULL.
13031 * This must be called before the objects are created to be sure no object is
13032 * visible and no generation started.
13034 * Example of usage:
13037 * #include <Elementary.h>
13038 * #ifndef ELM_LIB_QUICKLAUNCH
13040 * elm_main(int argc, char **argv)
13042 * Ethumb_Client *client;
13044 * elm_need_ethumb();
13048 * client = elm_thumb_ethumb_client_get();
13051 * ERR("could not get ethumb_client");
13054 * ethumb_client_size_set(client, 100, 100);
13055 * ethumb_client_crop_align_set(client, 0.5, 0.5);
13058 * // Create elm_thumb objects here
13068 * @note There's only one client handle for Ethumb, so once a configuration
13069 * change is done to it, any other request for thumbnails (for any thumbnail
13070 * object) will use that configuration. Thus, this configuration is global.
13074 EAPI void *elm_thumb_ethumb_client_get(void);
13076 * Get the ethumb_client connection state.
13078 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13081 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
13083 * Make the thumbnail 'editable'.
13085 * @param obj Thumb object.
13086 * @param set Turn on or off editability. Default is @c EINA_FALSE.
13088 * This means the thumbnail is a valid drag target for drag and drop, and can be
13089 * cut or pasted too.
13091 * @see elm_thumb_editable_get()
13095 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13097 * Make the thumbnail 'editable'.
13099 * @param obj Thumb object.
13100 * @return Editability.
13102 * This means the thumbnail is a valid drag target for drag and drop, and can be
13103 * cut or pasted too.
13105 * @see elm_thumb_editable_set()
13109 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13116 * @defgroup Web Web
13118 * @image html img/widget/web/preview-00.png
13119 * @image latex img/widget/web/preview-00.eps
13121 * A web object is used for displaying web pages (HTML/CSS/JS)
13122 * using WebKit-EFL. You must have compiled Elementary with
13125 * Signals that you can add callbacks for are:
13126 * @li "download,request": A file download has been requested. Event info is
13127 * a pointer to a Elm_Web_Download
13128 * @li "editorclient,contents,changed": Editor client's contents changed
13129 * @li "editorclient,selection,changed": Editor client's selection changed
13130 * @li "frame,created": A new frame was created. Event info is an
13131 * Evas_Object which can be handled with WebKit's ewk_frame API
13132 * @li "icon,received": An icon was received by the main frame
13133 * @li "inputmethod,changed": Input method changed. Event info is an
13134 * Eina_Bool indicating whether it's enabled or not
13135 * @li "js,windowobject,clear": JS window object has been cleared
13136 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13137 * is a char *link[2], where the first string contains the URL the link
13138 * points to, and the second one the title of the link
13139 * @li "link,hover,out": Mouse cursor left the link
13140 * @li "load,document,finished": Loading of a document finished. Event info
13141 * is the frame that finished loading
13142 * @li "load,error": Load failed. Event info is a pointer to
13143 * Elm_Web_Frame_Load_Error
13144 * @li "load,finished": Load finished. Event info is NULL on success, on
13145 * error it's a pointer to Elm_Web_Frame_Load_Error
13146 * @li "load,newwindow,show": A new window was created and is ready to be
13148 * @li "load,progress": Overall load progress. Event info is a pointer to
13149 * a double containing a value between 0.0 and 1.0
13150 * @li "load,provisional": Started provisional load
13151 * @li "load,started": Loading of a document started
13152 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13153 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13154 * the menubar is visible, or EINA_FALSE in case it's not
13155 * @li "menubar,visible,set": Informs menubar visibility. Event info is
13156 * an Eina_Bool indicating the visibility
13157 * @li "popup,created": A dropdown widget was activated, requesting its
13158 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13159 * @li "popup,willdelete": The web object is ready to destroy the popup
13160 * object created. Event info is a pointer to Elm_Web_Menu
13161 * @li "ready": Page is fully loaded
13162 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13163 * info is a pointer to Eina_Bool where the visibility state should be set
13164 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13165 * is an Eina_Bool with the visibility state set
13166 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13167 * a string with the new text
13168 * @li "statusbar,visible,get": Queries visibility of the status bar.
13169 * Event info is a pointer to Eina_Bool where the visibility state should be
13171 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13172 * an Eina_Bool with the visibility value
13173 * @li "title,changed": Title of the main frame changed. Event info is a
13174 * string with the new title
13175 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13176 * is a pointer to Eina_Bool where the visibility state should be set
13177 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13178 * info is an Eina_Bool with the visibility state
13179 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13180 * a string with the text to show
13181 * @li "uri,changed": URI of the main frame changed. Event info is a string
13183 * @li "view,resized": The web object internal's view changed sized
13184 * @li "windows,close,request": A JavaScript request to close the current
13185 * window was requested
13186 * @li "zoom,animated,end": Animated zoom finished
13188 * available styles:
13191 * An example of use of web:
13193 * - @ref web_example_01 TBD
13202 * Structure used to report load errors.
13204 * Load errors are reported as signal by elm_web. All the strings are
13205 * temporary references and should @b not be used after the signal
13206 * callback returns. If it's required, make copies with strdup() or
13207 * eina_stringshare_add() (they are not even guaranteed to be
13208 * stringshared, so must use eina_stringshare_add() and not
13209 * eina_stringshare_ref()).
13211 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13213 * Structure used to report load errors.
13215 * Load errors are reported as signal by elm_web. All the strings are
13216 * temporary references and should @b not be used after the signal
13217 * callback returns. If it's required, make copies with strdup() or
13218 * eina_stringshare_add() (they are not even guaranteed to be
13219 * stringshared, so must use eina_stringshare_add() and not
13220 * eina_stringshare_ref()).
13222 struct _Elm_Web_Frame_Load_Error
13224 int code; /**< Numeric error code */
13225 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13226 const char *domain; /**< Error domain name */
13227 const char *description; /**< Error description (already localized) */
13228 const char *failing_url; /**< The URL that failed to load */
13229 Evas_Object *frame; /**< Frame object that produced the error */
13233 * The possibles types that the items in a menu can be
13235 typedef enum _Elm_Web_Menu_Item_Type
13237 ELM_WEB_MENU_SEPARATOR,
13238 ELM_WEB_MENU_GROUP,
13239 ELM_WEB_MENU_OPTION
13240 } Elm_Web_Menu_Item_Type;
13243 * Structure describing the items in a menu
13245 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13247 * Structure describing the items in a menu
13249 struct _Elm_Web_Menu_Item
13251 const char *text; /**< The text for the item */
13252 Elm_Web_Menu_Item_Type type; /**< The type of the item */
13256 * Structure describing the menu of a popup
13258 * This structure will be passed as the @c event_info for the "popup,create"
13259 * signal, which is emitted when a dropdown menu is opened. Users wanting
13260 * to handle these popups by themselves should listen to this signal and
13261 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13262 * property as @c EINA_FALSE means that the user will not handle the popup
13263 * and the default implementation will be used.
13265 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13266 * will be emitted to notify the user that it can destroy any objects and
13267 * free all data related to it.
13269 * @see elm_web_popup_selected_set()
13270 * @see elm_web_popup_destroy()
13272 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13274 * Structure describing the menu of a popup
13276 * This structure will be passed as the @c event_info for the "popup,create"
13277 * signal, which is emitted when a dropdown menu is opened. Users wanting
13278 * to handle these popups by themselves should listen to this signal and
13279 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13280 * property as @c EINA_FALSE means that the user will not handle the popup
13281 * and the default implementation will be used.
13283 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13284 * will be emitted to notify the user that it can destroy any objects and
13285 * free all data related to it.
13287 * @see elm_web_popup_selected_set()
13288 * @see elm_web_popup_destroy()
13290 struct _Elm_Web_Menu
13292 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13293 int x; /**< The X position of the popup, relative to the elm_web object */
13294 int y; /**< The Y position of the popup, relative to the elm_web object */
13295 int width; /**< Width of the popup menu */
13296 int height; /**< Height of the popup menu */
13298 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. */
13301 typedef struct _Elm_Web_Download Elm_Web_Download;
13302 struct _Elm_Web_Download
13308 * Types of zoom available.
13310 typedef enum _Elm_Web_Zoom_Mode
13312 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13313 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13314 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13315 ELM_WEB_ZOOM_MODE_LAST
13316 } Elm_Web_Zoom_Mode;
13318 * Opaque handler containing the features (such as statusbar, menubar, etc)
13319 * that are to be set on a newly requested window.
13321 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13323 * Callback type for the create_window hook.
13325 * The function parameters are:
13326 * @li @p data User data pointer set when setting the hook function
13327 * @li @p obj The elm_web object requesting the new window
13328 * @li @p js Set to @c EINA_TRUE if the request was originated from
13329 * JavaScript. @c EINA_FALSE otherwise.
13330 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13331 * the features requested for the new window.
13333 * The returned value of the function should be the @c elm_web widget where
13334 * the request will be loaded. That is, if a new window or tab is created,
13335 * the elm_web widget in it should be returned, and @b NOT the window
13337 * Returning @c NULL should cancel the request.
13339 * @see elm_web_window_create_hook_set()
13341 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13343 * Callback type for the JS alert hook.
13345 * The function parameters are:
13346 * @li @p data User data pointer set when setting the hook function
13347 * @li @p obj The elm_web object requesting the new window
13348 * @li @p message The message to show in the alert dialog
13350 * The function should return the object representing the alert dialog.
13351 * Elm_Web will run a second main loop to handle the dialog and normal
13352 * flow of the application will be restored when the object is deleted, so
13353 * the user should handle the popup properly in order to delete the object
13354 * when the action is finished.
13355 * If the function returns @c NULL the popup will be ignored.
13357 * @see elm_web_dialog_alert_hook_set()
13359 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13361 * Callback type for the JS confirm hook.
13363 * The function parameters are:
13364 * @li @p data User data pointer set when setting the hook function
13365 * @li @p obj The elm_web object requesting the new window
13366 * @li @p message The message to show in the confirm dialog
13367 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13368 * the user selected @c Ok, @c EINA_FALSE otherwise.
13370 * The function should return the object representing the confirm dialog.
13371 * Elm_Web will run a second main loop to handle the dialog and normal
13372 * flow of the application will be restored when the object is deleted, so
13373 * the user should handle the popup properly in order to delete the object
13374 * when the action is finished.
13375 * If the function returns @c NULL the popup will be ignored.
13377 * @see elm_web_dialog_confirm_hook_set()
13379 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13381 * Callback type for the JS prompt hook.
13383 * The function parameters are:
13384 * @li @p data User data pointer set when setting the hook function
13385 * @li @p obj The elm_web object requesting the new window
13386 * @li @p message The message to show in the prompt dialog
13387 * @li @p def_value The default value to present the user in the entry
13388 * @li @p value Pointer where to store the value given by the user. Must
13389 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13390 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13391 * the user selected @c Ok, @c EINA_FALSE otherwise.
13393 * The function should return the object representing the prompt dialog.
13394 * Elm_Web will run a second main loop to handle the dialog and normal
13395 * flow of the application will be restored when the object is deleted, so
13396 * the user should handle the popup properly in order to delete the object
13397 * when the action is finished.
13398 * If the function returns @c NULL the popup will be ignored.
13400 * @see elm_web_dialog_prompt_hook_set()
13402 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13404 * Callback type for the JS file selector hook.
13406 * The function parameters are:
13407 * @li @p data User data pointer set when setting the hook function
13408 * @li @p obj The elm_web object requesting the new window
13409 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13410 * @li @p accept_types Mime types accepted
13411 * @li @p selected Pointer where to store the list of malloc'ed strings
13412 * containing the path to each file selected. Must be @c NULL if the file
13413 * dialog is cancelled
13414 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13415 * the user selected @c Ok, @c EINA_FALSE otherwise.
13417 * The function should return the object representing the file selector
13419 * Elm_Web will run a second main loop to handle the dialog and normal
13420 * flow of the application will be restored when the object is deleted, so
13421 * the user should handle the popup properly in order to delete the object
13422 * when the action is finished.
13423 * If the function returns @c NULL the popup will be ignored.
13425 * @see elm_web_dialog_file selector_hook_set()
13427 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);
13429 * Callback type for the JS console message hook.
13431 * When a console message is added from JavaScript, any set function to the
13432 * console message hook will be called for the user to handle. There is no
13433 * default implementation of this hook.
13435 * The function parameters are:
13436 * @li @p data User data pointer set when setting the hook function
13437 * @li @p obj The elm_web object that originated the message
13438 * @li @p message The message sent
13439 * @li @p line_number The line number
13440 * @li @p source_id Source id
13442 * @see elm_web_console_message_hook_set()
13444 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13446 * Add a new web object to the parent.
13448 * @param parent The parent object.
13449 * @return The new object or NULL if it cannot be created.
13451 * @see elm_web_uri_set()
13452 * @see elm_web_webkit_view_get()
13454 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13457 * Get internal ewk_view object from web object.
13459 * Elementary may not provide some low level features of EWebKit,
13460 * instead of cluttering the API with proxy methods we opted to
13461 * return the internal reference. Be careful using it as it may
13462 * interfere with elm_web behavior.
13464 * @param obj The web object.
13465 * @return The internal ewk_view object or NULL if it does not
13466 * exist. (Failure to create or Elementary compiled without
13469 * @see elm_web_add()
13471 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13474 * Sets the function to call when a new window is requested
13476 * This hook will be called when a request to create a new window is
13477 * issued from the web page loaded.
13478 * There is no default implementation for this feature, so leaving this
13479 * unset or passing @c NULL in @p func will prevent new windows from
13482 * @param obj The web object where to set the hook function
13483 * @param func The hook function to be called when a window is requested
13484 * @param data User data
13486 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13488 * Sets the function to call when an alert dialog
13490 * This hook will be called when a JavaScript alert dialog is requested.
13491 * If no function is set or @c NULL is passed in @p func, the default
13492 * implementation will take place.
13494 * @param obj The web object where to set the hook function
13495 * @param func The callback function to be used
13496 * @param data User data
13498 * @see elm_web_inwin_mode_set()
13500 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13502 * Sets the function to call when an confirm dialog
13504 * This hook will be called when a JavaScript confirm dialog is requested.
13505 * If no function is set or @c NULL is passed in @p func, the default
13506 * implementation will take place.
13508 * @param obj The web object where to set the hook function
13509 * @param func The callback function to be used
13510 * @param data User data
13512 * @see elm_web_inwin_mode_set()
13514 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13516 * Sets the function to call when an prompt dialog
13518 * This hook will be called when a JavaScript prompt dialog is requested.
13519 * If no function is set or @c NULL is passed in @p func, the default
13520 * implementation will take place.
13522 * @param obj The web object where to set the hook function
13523 * @param func The callback function to be used
13524 * @param data User data
13526 * @see elm_web_inwin_mode_set()
13528 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13530 * Sets the function to call when an file selector dialog
13532 * This hook will be called when a JavaScript file selector dialog is
13534 * If no function is set or @c NULL is passed in @p func, the default
13535 * implementation will take place.
13537 * @param obj The web object where to set the hook function
13538 * @param func The callback function to be used
13539 * @param data User data
13541 * @see elm_web_inwin_mode_set()
13543 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13545 * Sets the function to call when a console message is emitted from JS
13547 * This hook will be called when a console message is emitted from
13548 * JavaScript. There is no default implementation for this feature.
13550 * @param obj The web object where to set the hook function
13551 * @param func The callback function to be used
13552 * @param data User data
13554 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13556 * Gets the status of the tab propagation
13558 * @param obj The web object to query
13559 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13561 * @see elm_web_tab_propagate_set()
13563 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13565 * Sets whether to use tab propagation
13567 * If tab propagation is enabled, whenever the user presses the Tab key,
13568 * Elementary will handle it and switch focus to the next widget.
13569 * The default value is disabled, where WebKit will handle the Tab key to
13570 * cycle focus though its internal objects, jumping to the next widget
13571 * only when that cycle ends.
13573 * @param obj The web object
13574 * @param propagate Whether to propagate Tab keys to Elementary or not
13576 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13578 * Sets the URI for the web object
13580 * It must be a full URI, with resource included, in the form
13581 * http://www.enlightenment.org or file:///tmp/something.html
13583 * @param obj The web object
13584 * @param uri The URI to set
13585 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13587 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13589 * Gets the current URI for the object
13591 * The returned string must not be freed and is guaranteed to be
13594 * @param obj The web object
13595 * @return A stringshared internal string with the current URI, or NULL on
13598 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13600 * Gets the current title
13602 * The returned string must not be freed and is guaranteed to be
13605 * @param obj The web object
13606 * @return A stringshared internal string with the current title, or NULL on
13609 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13611 * Sets the background color to be used by the web object
13613 * This is the color that will be used by default when the loaded page
13614 * does not set it's own. Color values are pre-multiplied.
13616 * @param obj The web object
13617 * @param r Red component
13618 * @param g Green component
13619 * @param b Blue component
13620 * @param a Alpha component
13622 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13624 * Gets the background color to be used by the web object
13626 * This is the color that will be used by default when the loaded page
13627 * does not set it's own. Color values are pre-multiplied.
13629 * @param obj The web object
13630 * @param r Red component
13631 * @param g Green component
13632 * @param b Blue component
13633 * @param a Alpha component
13635 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13637 * Gets a copy of the currently selected text
13639 * The string returned must be freed by the user when it's done with it.
13641 * @param obj The web object
13642 * @return A newly allocated string, or NULL if nothing is selected or an
13645 EAPI char *elm_view_selection_get(const Evas_Object *obj);
13647 * Tells the web object which index in the currently open popup was selected
13649 * When the user handles the popup creation from the "popup,created" signal,
13650 * it needs to tell the web object which item was selected by calling this
13651 * function with the index corresponding to the item.
13653 * @param obj The web object
13654 * @param index The index selected
13656 * @see elm_web_popup_destroy()
13658 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
13660 * Dismisses an open dropdown popup
13662 * When the popup from a dropdown widget is to be dismissed, either after
13663 * selecting an option or to cancel it, this function must be called, which
13664 * will later emit an "popup,willdelete" signal to notify the user that
13665 * any memory and objects related to this popup can be freed.
13667 * @param obj The web object
13668 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13669 * if there was no menu to destroy
13671 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
13673 * Searches the given string in a document.
13675 * @param obj The web object where to search the text
13676 * @param string String to search
13677 * @param case_sensitive If search should be case sensitive or not
13678 * @param forward If search is from cursor and on or backwards
13679 * @param wrap If search should wrap at the end
13681 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13684 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13686 * Marks matches of the given string in a document.
13688 * @param obj The web object where to search text
13689 * @param string String to match
13690 * @param case_sensitive If match should be case sensitive or not
13691 * @param highlight If matches should be highlighted
13692 * @param limit Maximum amount of matches, or zero to unlimited
13694 * @return number of matched @a string
13696 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13698 * Clears all marked matches in the document
13700 * @param obj The web object
13702 * @return EINA_TRUE on success, EINA_FALSE otherwise
13704 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
13706 * Sets whether to highlight the matched marks
13708 * If enabled, marks set with elm_web_text_matches_mark() will be
13711 * @param obj The web object
13712 * @param highlight Whether to highlight the marks or not
13714 * @return EINA_TRUE on success, EINA_FALSE otherwise
13716 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13718 * Gets whether highlighting marks is enabled
13720 * @param The web object
13722 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13725 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
13727 * Gets the overall loading progress of the page
13729 * Returns the estimated loading progress of the page, with a value between
13730 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13731 * included in the page.
13733 * @param The web object
13735 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13738 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
13740 * Stops loading the current page
13742 * Cancels the loading of the current page in the web object. This will
13743 * cause a "load,error" signal to be emitted, with the is_cancellation
13744 * flag set to EINA_TRUE.
13746 * @param obj The web object
13748 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13750 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
13752 * Requests a reload of the current document in the object
13754 * @param obj The web object
13756 * @return EINA_TRUE on success, EINA_FALSE otherwise
13758 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
13760 * Requests a reload of the current document, avoiding any existing caches
13762 * @param obj The web object
13764 * @return EINA_TRUE on success, EINA_FALSE otherwise
13766 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
13768 * Goes back one step in the browsing history
13770 * This is equivalent to calling elm_web_object_navigate(obj, -1);
13772 * @param obj The web object
13774 * @return EINA_TRUE on success, EINA_FALSE otherwise
13776 * @see elm_web_history_enable_set()
13777 * @see elm_web_back_possible()
13778 * @see elm_web_forward()
13779 * @see elm_web_navigate()
13781 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
13783 * Goes forward one step in the browsing history
13785 * This is equivalent to calling elm_web_object_navigate(obj, 1);
13787 * @param obj The web object
13789 * @return EINA_TRUE on success, EINA_FALSE otherwise
13791 * @see elm_web_history_enable_set()
13792 * @see elm_web_forward_possible()
13793 * @see elm_web_back()
13794 * @see elm_web_navigate()
13796 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
13798 * Jumps the given number of steps in the browsing history
13800 * The @p steps value can be a negative integer to back in history, or a
13801 * positive to move forward.
13803 * @param obj The web object
13804 * @param steps The number of steps to jump
13806 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13807 * history exists to jump the given number of steps
13809 * @see elm_web_history_enable_set()
13810 * @see elm_web_navigate_possible()
13811 * @see elm_web_back()
13812 * @see elm_web_forward()
13814 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
13816 * Queries whether it's possible to go back in history
13818 * @param obj The web object
13820 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13823 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
13825 * Queries whether it's possible to go forward in history
13827 * @param obj The web object
13829 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13832 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
13834 * Queries whether it's possible to jump the given number of steps
13836 * The @p steps value can be a negative integer to back in history, or a
13837 * positive to move forward.
13839 * @param obj The web object
13840 * @param steps The number of steps to check for
13842 * @return EINA_TRUE if enough history exists to perform the given jump,
13843 * EINA_FALSE otherwise
13845 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
13847 * Gets whether browsing history is enabled for the given object
13849 * @param obj The web object
13851 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13853 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
13855 * Enables or disables the browsing history
13857 * @param obj The web object
13858 * @param enable Whether to enable or disable the browsing history
13860 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13862 * Sets the zoom level of the web object
13864 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
13865 * values meaning zoom in and lower meaning zoom out. This function will
13866 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
13867 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
13869 * @param obj The web object
13870 * @param zoom The zoom level to set
13872 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
13874 * Gets the current zoom level set on the web object
13876 * Note that this is the zoom level set on the web object and not that
13877 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
13878 * the two zoom levels should match, but for the other two modes the
13879 * Webkit zoom is calculated internally to match the chosen mode without
13880 * changing the zoom level set for the web object.
13882 * @param obj The web object
13884 * @return The zoom level set on the object
13886 EAPI double elm_web_zoom_get(const Evas_Object *obj);
13888 * Sets the zoom mode to use
13890 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
13891 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
13893 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
13894 * with the elm_web_zoom_set() function.
13895 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
13896 * make sure the entirety of the web object's contents are shown.
13897 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
13898 * fit the contents in the web object's size, without leaving any space
13901 * @param obj The web object
13902 * @param mode The mode to set
13904 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
13906 * Gets the currently set zoom mode
13908 * @param obj The web object
13910 * @return The current zoom mode set for the object, or
13911 * ::ELM_WEB_ZOOM_MODE_LAST on error
13913 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
13915 * Shows the given region in the web object
13917 * @param obj The web object
13918 * @param x The x coordinate of the region to show
13919 * @param y The y coordinate of the region to show
13920 * @param w The width of the region to show
13921 * @param h The height of the region to show
13923 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
13925 * Brings in the region to the visible area
13927 * Like elm_web_region_show(), but it animates the scrolling of the object
13930 * @param obj The web object
13931 * @param x The x coordinate of the region to show
13932 * @param y The y coordinate of the region to show
13933 * @param w The width of the region to show
13934 * @param h The height of the region to show
13936 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
13938 * Sets the default dialogs to use an Inwin instead of a normal window
13940 * If set, then the default implementation for the JavaScript dialogs and
13941 * file selector will be opened in an Inwin. Otherwise they will use a
13942 * normal separated window.
13944 * @param obj The web object
13945 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
13947 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
13949 * Gets whether Inwin mode is set for the current object
13951 * @param obj The web object
13953 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
13955 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
13957 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
13958 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
13959 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);
13960 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
13967 * @defgroup Hoversel Hoversel
13969 * @image html img/widget/hoversel/preview-00.png
13970 * @image latex img/widget/hoversel/preview-00.eps
13972 * A hoversel is a button that pops up a list of items (automatically
13973 * choosing the direction to display) that have a label and, optionally, an
13974 * icon to select from. It is a convenience widget to avoid the need to do
13975 * all the piecing together yourself. It is intended for a small number of
13976 * items in the hoversel menu (no more than 8), though is capable of many
13979 * Signals that you can add callbacks for are:
13980 * "clicked" - the user clicked the hoversel button and popped up the sel
13981 * "selected" - an item in the hoversel list is selected. event_info is the item
13982 * "dismissed" - the hover is dismissed
13984 * See @ref tutorial_hoversel for an example.
13987 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
13989 * @brief Add a new Hoversel object
13991 * @param parent The parent object
13992 * @return The new object or NULL if it cannot be created
13994 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13996 * @brief This sets the hoversel to expand horizontally.
13998 * @param obj The hoversel object
13999 * @param horizontal If true, the hover will expand horizontally to the
14002 * @note The initial button will display horizontally regardless of this
14005 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14007 * @brief This returns whether the hoversel is set to expand horizontally.
14009 * @param obj The hoversel object
14010 * @return If true, the hover will expand horizontally to the right.
14012 * @see elm_hoversel_horizontal_set()
14014 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14016 * @brief Set the Hover parent
14018 * @param obj The hoversel object
14019 * @param parent The parent to use
14021 * Sets the hover parent object, the area that will be darkened when the
14022 * hoversel is clicked. Should probably be the window that the hoversel is
14023 * in. See @ref Hover objects for more information.
14025 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14027 * @brief Get the Hover parent
14029 * @param obj The hoversel object
14030 * @return The used parent
14032 * Gets the hover parent object.
14034 * @see elm_hoversel_hover_parent_set()
14036 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14038 * @brief Set the hoversel button label
14040 * @param obj The hoversel object
14041 * @param label The label text.
14043 * This sets the label of the button that is always visible (before it is
14044 * clicked and expanded).
14046 * @deprecated elm_object_text_set()
14048 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14050 * @brief Get the hoversel button label
14052 * @param obj The hoversel object
14053 * @return The label text.
14055 * @deprecated elm_object_text_get()
14057 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14059 * @brief Set the icon of the hoversel button
14061 * @param obj The hoversel object
14062 * @param icon The icon object
14064 * Sets the icon of the button that is always visible (before it is clicked
14065 * and expanded). Once the icon object is set, a previously set one will be
14066 * deleted, if you want to keep that old content object, use the
14067 * elm_hoversel_icon_unset() function.
14069 * @see elm_object_content_set() for the button widget
14071 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14073 * @brief Get the icon of the hoversel button
14075 * @param obj The hoversel object
14076 * @return The icon object
14078 * Get the icon of the button that is always visible (before it is clicked
14079 * and expanded). Also see elm_object_content_get() for the button widget.
14081 * @see elm_hoversel_icon_set()
14083 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14085 * @brief Get and unparent the icon of the hoversel button
14087 * @param obj The hoversel object
14088 * @return The icon object that was being used
14090 * Unparent and return the icon of the button that is always visible
14091 * (before it is clicked and expanded).
14093 * @see elm_hoversel_icon_set()
14094 * @see elm_object_content_unset() for the button widget
14096 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14098 * @brief This triggers the hoversel popup from code, the same as if the user
14099 * had clicked the button.
14101 * @param obj The hoversel object
14103 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14105 * @brief This dismisses the hoversel popup as if the user had clicked
14106 * outside the hover.
14108 * @param obj The hoversel object
14110 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14112 * @brief Returns whether the hoversel is expanded.
14114 * @param obj The hoversel object
14115 * @return This will return EINA_TRUE if the hoversel is expanded or
14116 * EINA_FALSE if it is not expanded.
14118 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14120 * @brief This will remove all the children items from the hoversel.
14122 * @param obj The hoversel object
14124 * @warning Should @b not be called while the hoversel is active; use
14125 * elm_hoversel_expanded_get() to check first.
14127 * @see elm_hoversel_item_del_cb_set()
14128 * @see elm_hoversel_item_del()
14130 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14132 * @brief Get the list of items within the given hoversel.
14134 * @param obj The hoversel object
14135 * @return Returns a list of Elm_Hoversel_Item*
14137 * @see elm_hoversel_item_add()
14139 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14141 * @brief Add an item to the hoversel button
14143 * @param obj The hoversel object
14144 * @param label The text label to use for the item (NULL if not desired)
14145 * @param icon_file An image file path on disk to use for the icon or standard
14146 * icon name (NULL if not desired)
14147 * @param icon_type The icon type if relevant
14148 * @param func Convenience function to call when this item is selected
14149 * @param data Data to pass to item-related functions
14150 * @return A handle to the item added.
14152 * This adds an item to the hoversel to show when it is clicked. Note: if you
14153 * need to use an icon from an edje file then use
14154 * elm_hoversel_item_icon_set() right after the this function, and set
14155 * icon_file to NULL here.
14157 * For more information on what @p icon_file and @p icon_type are see the
14158 * @ref Icon "icon documentation".
14160 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);
14162 * @brief Delete an item from the hoversel
14164 * @param item The item to delete
14166 * This deletes the item from the hoversel (should not be called while the
14167 * hoversel is active; use elm_hoversel_expanded_get() to check first).
14169 * @see elm_hoversel_item_add()
14170 * @see elm_hoversel_item_del_cb_set()
14172 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14174 * @brief Set the function to be called when an item from the hoversel is
14177 * @param item The item to set the callback on
14178 * @param func The function called
14180 * That function will receive these parameters:
14181 * @li void *item_data
14182 * @li Evas_Object *the_item_object
14183 * @li Elm_Hoversel_Item *the_object_struct
14185 * @see elm_hoversel_item_add()
14187 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14189 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14190 * that will be passed to associated function callbacks.
14192 * @param item The item to get the data from
14193 * @return The data pointer set with elm_hoversel_item_add()
14195 * @see elm_hoversel_item_add()
14197 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14199 * @brief This returns the label text of the given hoversel item.
14201 * @param item The item to get the label
14202 * @return The label text of the hoversel item
14204 * @see elm_hoversel_item_add()
14206 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14208 * @brief This sets the icon for the given hoversel item.
14210 * @param item The item to set the icon
14211 * @param icon_file An image file path on disk to use for the icon or standard
14213 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14214 * to NULL if the icon is not an edje file
14215 * @param icon_type The icon type
14217 * The icon can be loaded from the standard set, from an image file, or from
14220 * @see elm_hoversel_item_add()
14222 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);
14224 * @brief Get the icon object of the hoversel item
14226 * @param item The item to get the icon from
14227 * @param icon_file The image file path on disk used for the icon or standard
14229 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14230 * if the icon is not an edje file
14231 * @param icon_type The icon type
14233 * @see elm_hoversel_item_icon_set()
14234 * @see elm_hoversel_item_add()
14236 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);
14242 * @defgroup Toolbar Toolbar
14243 * @ingroup Elementary
14245 * @image html img/widget/toolbar/preview-00.png
14246 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14248 * @image html img/toolbar.png
14249 * @image latex img/toolbar.eps width=\textwidth
14251 * A toolbar is a widget that displays a list of items inside
14252 * a box. It can be scrollable, show a menu with items that don't fit
14253 * to toolbar size or even crop them.
14255 * Only one item can be selected at a time.
14257 * Items can have multiple states, or show menus when selected by the user.
14259 * Smart callbacks one can listen to:
14260 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14261 * - "language,changed" - when the program language changes
14263 * Available styles for it:
14265 * - @c "transparent" - no background or shadow, just show the content
14267 * List of examples:
14268 * @li @ref toolbar_example_01
14269 * @li @ref toolbar_example_02
14270 * @li @ref toolbar_example_03
14274 * @addtogroup Toolbar
14279 * @enum _Elm_Toolbar_Shrink_Mode
14280 * @typedef Elm_Toolbar_Shrink_Mode
14282 * Set toolbar's items display behavior, it can be scrollabel,
14283 * show a menu with exceeding items, or simply hide them.
14285 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14288 * Values <b> don't </b> work as bitmask, only one can be choosen.
14290 * @see elm_toolbar_mode_shrink_set()
14291 * @see elm_toolbar_mode_shrink_get()
14295 typedef enum _Elm_Toolbar_Shrink_Mode
14297 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14298 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14299 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14300 ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
14301 ELM_TOOLBAR_SHRINK_LAST /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14302 } Elm_Toolbar_Shrink_Mode;
14304 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(). */
14306 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(). */
14309 * Add a new toolbar widget to the given parent Elementary
14310 * (container) object.
14312 * @param parent The parent object.
14313 * @return a new toolbar widget handle or @c NULL, on errors.
14315 * This function inserts a new toolbar widget on the canvas.
14319 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14322 * Set the icon size, in pixels, to be used by toolbar items.
14324 * @param obj The toolbar object
14325 * @param icon_size The icon size in pixels
14327 * @note Default value is @c 32. It reads value from elm config.
14329 * @see elm_toolbar_icon_size_get()
14333 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14336 * Get the icon size, in pixels, to be used by toolbar items.
14338 * @param obj The toolbar object.
14339 * @return The icon size in pixels.
14341 * @see elm_toolbar_icon_size_set() for details.
14345 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14348 * Sets icon lookup order, for toolbar items' icons.
14350 * @param obj The toolbar object.
14351 * @param order The icon lookup order.
14353 * Icons added before calling this function will not be affected.
14354 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14356 * @see elm_toolbar_icon_order_lookup_get()
14360 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14363 * Gets the icon lookup order.
14365 * @param obj The toolbar object.
14366 * @return The icon lookup order.
14368 * @see elm_toolbar_icon_order_lookup_set() for details.
14372 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14375 * Set whether the toolbar should always have an item selected.
14377 * @param obj The toolbar object.
14378 * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14381 * This will cause the toolbar to always have an item selected, and clicking
14382 * the selected item will not cause a selected event to be emitted. Enabling this mode
14383 * will immediately select the first toolbar item.
14385 * Always-selected is disabled by default.
14387 * @see elm_toolbar_always_select_mode_get().
14391 EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14394 * Get whether the toolbar should always have an item selected.
14396 * @param obj The toolbar object.
14397 * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14398 * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14400 * @see elm_toolbar_always_select_mode_set() for details.
14404 EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14407 * Set whether the toolbar items' should be selected by the user or not.
14409 * @param obj The toolbar object.
14410 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14413 * This will turn off the ability to select items entirely and they will
14414 * neither appear selected nor emit selected signals. The clicked
14415 * callback function will still be called.
14417 * Selection is enabled by default.
14419 * @see elm_toolbar_no_select_mode_get().
14423 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14426 * Set whether the toolbar items' should be selected by the user or not.
14428 * @param obj The toolbar object.
14429 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14430 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14432 * @see elm_toolbar_no_select_mode_set() for details.
14436 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14439 * Append item to the toolbar.
14441 * @param obj The toolbar object.
14442 * @param icon A string with icon name or the absolute path of an image file.
14443 * @param label The label of the item.
14444 * @param func The function to call when the item is clicked.
14445 * @param data The data to associate with the item for related callbacks.
14446 * @return The created item or @c NULL upon failure.
14448 * A new item will be created and appended to the toolbar, i.e., will
14449 * be set as @b last item.
14451 * Items created with this method can be deleted with
14452 * elm_toolbar_item_del().
14454 * Associated @p data can be properly freed when item is deleted if a
14455 * callback function is set with elm_toolbar_item_del_cb_set().
14457 * If a function is passed as argument, it will be called everytime this item
14458 * is selected, i.e., the user clicks over an unselected item.
14459 * If such function isn't needed, just passing
14460 * @c NULL as @p func is enough. The same should be done for @p data.
14462 * Toolbar will load icon image from fdo or current theme.
14463 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14464 * If an absolute path is provided it will load it direct from a file.
14466 * @see elm_toolbar_item_icon_set()
14467 * @see elm_toolbar_item_del()
14468 * @see elm_toolbar_item_del_cb_set()
14472 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);
14475 * Prepend item to the toolbar.
14477 * @param obj The toolbar object.
14478 * @param icon A string with icon name or the absolute path of an image file.
14479 * @param label The label of the item.
14480 * @param func The function to call when the item is clicked.
14481 * @param data The data to associate with the item for related callbacks.
14482 * @return The created item or @c NULL upon failure.
14484 * A new item will be created and prepended to the toolbar, i.e., will
14485 * be set as @b first item.
14487 * Items created with this method can be deleted with
14488 * elm_toolbar_item_del().
14490 * Associated @p data can be properly freed when item is deleted if a
14491 * callback function is set with elm_toolbar_item_del_cb_set().
14493 * If a function is passed as argument, it will be called everytime this item
14494 * is selected, i.e., the user clicks over an unselected item.
14495 * If such function isn't needed, just passing
14496 * @c NULL as @p func is enough. The same should be done for @p data.
14498 * Toolbar will load icon image from fdo or current theme.
14499 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14500 * If an absolute path is provided it will load it direct from a file.
14502 * @see elm_toolbar_item_icon_set()
14503 * @see elm_toolbar_item_del()
14504 * @see elm_toolbar_item_del_cb_set()
14508 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);
14511 * Insert a new item into the toolbar object before item @p before.
14513 * @param obj The toolbar object.
14514 * @param before The toolbar item to insert before.
14515 * @param icon A string with icon name or the absolute path of an image file.
14516 * @param label The label of the item.
14517 * @param func The function to call when the item is clicked.
14518 * @param data The data to associate with the item for related callbacks.
14519 * @return The created item or @c NULL upon failure.
14521 * A new item will be created and added to the toolbar. Its position in
14522 * this toolbar will be just before item @p before.
14524 * Items created with this method can be deleted with
14525 * elm_toolbar_item_del().
14527 * Associated @p data can be properly freed when item is deleted if a
14528 * callback function is set with elm_toolbar_item_del_cb_set().
14530 * If a function is passed as argument, it will be called everytime this item
14531 * is selected, i.e., the user clicks over an unselected item.
14532 * If such function isn't needed, just passing
14533 * @c NULL as @p func is enough. The same should be done for @p data.
14535 * Toolbar will load icon image from fdo or current theme.
14536 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14537 * If an absolute path is provided it will load it direct from a file.
14539 * @see elm_toolbar_item_icon_set()
14540 * @see elm_toolbar_item_del()
14541 * @see elm_toolbar_item_del_cb_set()
14545 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);
14548 * Insert a new item into the toolbar object after item @p after.
14550 * @param obj The toolbar object.
14551 * @param after The toolbar item to insert after.
14552 * @param icon A string with icon name or the absolute path of an image file.
14553 * @param label The label of the item.
14554 * @param func The function to call when the item is clicked.
14555 * @param data The data to associate with the item for related callbacks.
14556 * @return The created item or @c NULL upon failure.
14558 * A new item will be created and added to the toolbar. Its position in
14559 * this toolbar will be just after item @p after.
14561 * Items created with this method can be deleted with
14562 * elm_toolbar_item_del().
14564 * Associated @p data can be properly freed when item is deleted if a
14565 * callback function is set with elm_toolbar_item_del_cb_set().
14567 * If a function is passed as argument, it will be called everytime this item
14568 * is selected, i.e., the user clicks over an unselected item.
14569 * If such function isn't needed, just passing
14570 * @c NULL as @p func is enough. The same should be done for @p data.
14572 * Toolbar will load icon image from fdo or current theme.
14573 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14574 * If an absolute path is provided it will load it direct from a file.
14576 * @see elm_toolbar_item_icon_set()
14577 * @see elm_toolbar_item_del()
14578 * @see elm_toolbar_item_del_cb_set()
14582 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);
14585 * Get the first item in the given toolbar widget's list of
14588 * @param obj The toolbar object
14589 * @return The first item or @c NULL, if it has no items (and on
14592 * @see elm_toolbar_item_append()
14593 * @see elm_toolbar_last_item_get()
14597 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14600 * Get the last item in the given toolbar widget's list of
14603 * @param obj The toolbar object
14604 * @return The last item or @c NULL, if it has no items (and on
14607 * @see elm_toolbar_item_prepend()
14608 * @see elm_toolbar_first_item_get()
14612 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14615 * Get the item after @p item in toolbar.
14617 * @param item The toolbar item.
14618 * @return The item after @p item, or @c NULL if none or on failure.
14620 * @note If it is the last item, @c NULL will be returned.
14622 * @see elm_toolbar_item_append()
14626 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14629 * Get the item before @p item in toolbar.
14631 * @param item The toolbar item.
14632 * @return The item before @p item, or @c NULL if none or on failure.
14634 * @note If it is the first item, @c NULL will be returned.
14636 * @see elm_toolbar_item_prepend()
14640 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14643 * Get the toolbar object from an item.
14645 * @param item The item.
14646 * @return The toolbar object.
14648 * This returns the toolbar object itself that an item belongs to.
14652 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14655 * Set the priority of a toolbar item.
14657 * @param item The toolbar item.
14658 * @param priority The item priority. The default is zero.
14660 * This is used only when the toolbar shrink mode is set to
14661 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14662 * When space is less than required, items with low priority
14663 * will be removed from the toolbar and added to a dynamically-created menu,
14664 * while items with higher priority will remain on the toolbar,
14665 * with the same order they were added.
14667 * @see elm_toolbar_item_priority_get()
14671 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14674 * Get the priority of a toolbar item.
14676 * @param item The toolbar item.
14677 * @return The @p item priority, or @c 0 on failure.
14679 * @see elm_toolbar_item_priority_set() for details.
14683 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14686 * Get the label of item.
14688 * @param item The item of toolbar.
14689 * @return The label of item.
14691 * The return value is a pointer to the label associated to @p item when
14692 * it was created, with function elm_toolbar_item_append() or similar,
14694 * with function elm_toolbar_item_label_set. If no label
14695 * was passed as argument, it will return @c NULL.
14697 * @see elm_toolbar_item_label_set() for more details.
14698 * @see elm_toolbar_item_append()
14702 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14705 * Set the label of item.
14707 * @param item The item of toolbar.
14708 * @param text The label of item.
14710 * The label to be displayed by the item.
14711 * Label will be placed at icons bottom (if set).
14713 * If a label was passed as argument on item creation, with function
14714 * elm_toolbar_item_append() or similar, it will be already
14715 * displayed by the item.
14717 * @see elm_toolbar_item_label_get()
14718 * @see elm_toolbar_item_append()
14722 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14725 * Return the data associated with a given toolbar widget item.
14727 * @param item The toolbar widget item handle.
14728 * @return The data associated with @p item.
14730 * @see elm_toolbar_item_data_set()
14734 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14737 * Set the data associated with a given toolbar widget item.
14739 * @param item The toolbar widget item handle.
14740 * @param data The new data pointer to set to @p item.
14742 * This sets new item data on @p item.
14744 * @warning The old data pointer won't be touched by this function, so
14745 * the user had better to free that old data himself/herself.
14749 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14752 * Returns a pointer to a toolbar item by its label.
14754 * @param obj The toolbar object.
14755 * @param label The label of the item to find.
14757 * @return The pointer to the toolbar item matching @p label or @c NULL
14762 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14765 * Get whether the @p item is selected or not.
14767 * @param item The toolbar item.
14768 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14769 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14771 * @see elm_toolbar_selected_item_set() for details.
14772 * @see elm_toolbar_item_selected_get()
14776 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14779 * Set the selected state of an item.
14781 * @param item The toolbar item
14782 * @param selected The selected state
14784 * This sets the selected state of the given item @p it.
14785 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14787 * If a new item is selected the previosly selected will be unselected.
14788 * Previoulsy selected item can be get with function
14789 * elm_toolbar_selected_item_get().
14791 * Selected items will be highlighted.
14793 * @see elm_toolbar_item_selected_get()
14794 * @see elm_toolbar_selected_item_get()
14798 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14801 * Get the selected item.
14803 * @param obj The toolbar object.
14804 * @return The selected toolbar item.
14806 * The selected item can be unselected with function
14807 * elm_toolbar_item_selected_set().
14809 * The selected item always will be highlighted on toolbar.
14811 * @see elm_toolbar_selected_items_get()
14815 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14818 * Set the icon associated with @p item.
14820 * @param obj The parent of this item.
14821 * @param item The toolbar item.
14822 * @param icon A string with icon name or the absolute path of an image file.
14824 * Toolbar will load icon image from fdo or current theme.
14825 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14826 * If an absolute path is provided it will load it direct from a file.
14828 * @see elm_toolbar_icon_order_lookup_set()
14829 * @see elm_toolbar_icon_order_lookup_get()
14833 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14836 * Get the string used to set the icon of @p item.
14838 * @param item The toolbar item.
14839 * @return The string associated with the icon object.
14841 * @see elm_toolbar_item_icon_set() for details.
14845 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14848 * Get the object of @p item.
14850 * @param item The toolbar item.
14851 * @return The object
14855 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14858 * Get the icon object of @p item.
14860 * @param item The toolbar item.
14861 * @return The icon object
14863 * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14867 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14870 * Set the icon associated with @p item to an image in a binary buffer.
14872 * @param item The toolbar item.
14873 * @param img The binary data that will be used as an image
14874 * @param size The size of binary data @p img
14875 * @param format Optional format of @p img to pass to the image loader
14876 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
14878 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
14880 * @note The icon image set by this function can be changed by
14881 * elm_toolbar_item_icon_set().
14885 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);
14888 * Delete them item from the toolbar.
14890 * @param item The item of toolbar to be deleted.
14892 * @see elm_toolbar_item_append()
14893 * @see elm_toolbar_item_del_cb_set()
14897 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14900 * Set the function called when a toolbar item is freed.
14902 * @param item The item to set the callback on.
14903 * @param func The function called.
14905 * If there is a @p func, then it will be called prior item's memory release.
14906 * That will be called with the following arguments:
14908 * @li item's Evas object;
14911 * This way, a data associated to a toolbar item could be properly freed.
14915 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14918 * Get a value whether toolbar item is disabled or not.
14920 * @param item The item.
14921 * @return The disabled state.
14923 * @see elm_toolbar_item_disabled_set() for more details.
14927 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14930 * Sets the disabled/enabled state of a toolbar item.
14932 * @param item The item.
14933 * @param disabled The disabled state.
14935 * A disabled item cannot be selected or unselected. It will also
14936 * change its appearance (generally greyed out). This sets the
14937 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
14942 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14945 * Set or unset item as a separator.
14947 * @param item The toolbar item.
14948 * @param setting @c EINA_TRUE to set item @p item as separator or
14949 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
14951 * Items aren't set as separator by default.
14953 * If set as separator it will display separator theme, so won't display
14956 * @see elm_toolbar_item_separator_get()
14960 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
14963 * Get a value whether item is a separator or not.
14965 * @param item The toolbar item.
14966 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
14967 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
14969 * @see elm_toolbar_item_separator_set() for details.
14973 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14976 * Set the shrink state of toolbar @p obj.
14978 * @param obj The toolbar object.
14979 * @param shrink_mode Toolbar's items display behavior.
14981 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
14982 * but will enforce a minimun size so all the items will fit, won't scroll
14983 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
14984 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
14985 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
14989 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
14992 * Get the shrink mode of toolbar @p obj.
14994 * @param obj The toolbar object.
14995 * @return Toolbar's items display behavior.
14997 * @see elm_toolbar_mode_shrink_set() for details.
15001 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15004 * Enable/disable homogenous mode.
15006 * @param obj The toolbar object
15007 * @param homogeneous Assume the items within the toolbar are of the
15008 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15010 * This will enable the homogeneous mode where items are of the same size.
15011 * @see elm_toolbar_homogeneous_get()
15015 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15018 * Get whether the homogenous mode is enabled.
15020 * @param obj The toolbar object.
15021 * @return Assume the items within the toolbar are of the same height
15022 * and width (EINA_TRUE = on, EINA_FALSE = off).
15024 * @see elm_toolbar_homogeneous_set()
15028 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15031 * Enable/disable homogenous mode.
15033 * @param obj The toolbar object
15034 * @param homogeneous Assume the items within the toolbar are of the
15035 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15037 * This will enable the homogeneous mode where items are of the same size.
15038 * @see elm_toolbar_homogeneous_get()
15040 * @deprecated use elm_toolbar_homogeneous_set() instead.
15044 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
15047 * Get whether the homogenous mode is enabled.
15049 * @param obj The toolbar object.
15050 * @return Assume the items within the toolbar are of the same height
15051 * and width (EINA_TRUE = on, EINA_FALSE = off).
15053 * @see elm_toolbar_homogeneous_set()
15054 * @deprecated use elm_toolbar_homogeneous_get() instead.
15058 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15061 * Set the parent object of the toolbar items' menus.
15063 * @param obj The toolbar object.
15064 * @param parent The parent of the menu objects.
15066 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15068 * For more details about setting the parent for toolbar menus, see
15069 * elm_menu_parent_set().
15071 * @see elm_menu_parent_set() for details.
15072 * @see elm_toolbar_item_menu_set() for details.
15076 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15079 * Get the parent object of the toolbar items' menus.
15081 * @param obj The toolbar object.
15082 * @return The parent of the menu objects.
15084 * @see elm_toolbar_menu_parent_set() for details.
15088 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15091 * Set the alignment of the items.
15093 * @param obj The toolbar object.
15094 * @param align The new alignment, a float between <tt> 0.0 </tt>
15095 * and <tt> 1.0 </tt>.
15097 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15098 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15101 * Centered items by default.
15103 * @see elm_toolbar_align_get()
15107 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15110 * Get the alignment of the items.
15112 * @param obj The toolbar object.
15113 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15116 * @see elm_toolbar_align_set() for details.
15120 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15123 * Set whether the toolbar item opens a menu.
15125 * @param item The toolbar item.
15126 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15128 * A toolbar item can be set to be a menu, using this function.
15130 * Once it is set to be a menu, it can be manipulated through the
15131 * menu-like function elm_toolbar_menu_parent_set() and the other
15132 * elm_menu functions, using the Evas_Object @c menu returned by
15133 * elm_toolbar_item_menu_get().
15135 * So, items to be displayed in this item's menu should be added with
15136 * elm_menu_item_add().
15138 * The following code exemplifies the most basic usage:
15140 * tb = elm_toolbar_add(win)
15141 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15142 * elm_toolbar_item_menu_set(item, EINA_TRUE);
15143 * elm_toolbar_menu_parent_set(tb, win);
15144 * menu = elm_toolbar_item_menu_get(item);
15145 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15146 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15150 * @see elm_toolbar_item_menu_get()
15154 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15157 * Get toolbar item's menu.
15159 * @param item The toolbar item.
15160 * @return Item's menu object or @c NULL on failure.
15162 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15163 * this function will set it.
15165 * @see elm_toolbar_item_menu_set() for details.
15169 EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15172 * Add a new state to @p item.
15174 * @param item The item.
15175 * @param icon A string with icon name or the absolute path of an image file.
15176 * @param label The label of the new state.
15177 * @param func The function to call when the item is clicked when this
15178 * state is selected.
15179 * @param data The data to associate with the state.
15180 * @return The toolbar item state, or @c NULL upon failure.
15182 * Toolbar will load icon image from fdo or current theme.
15183 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15184 * If an absolute path is provided it will load it direct from a file.
15186 * States created with this function can be removed with
15187 * elm_toolbar_item_state_del().
15189 * @see elm_toolbar_item_state_del()
15190 * @see elm_toolbar_item_state_sel()
15191 * @see elm_toolbar_item_state_get()
15195 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);
15198 * Delete a previoulsy added state to @p item.
15200 * @param item The toolbar item.
15201 * @param state The state to be deleted.
15202 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15204 * @see elm_toolbar_item_state_add()
15206 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15209 * Set @p state as the current state of @p it.
15211 * @param it The item.
15212 * @param state The state to use.
15213 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15215 * If @p state is @c NULL, it won't select any state and the default item's
15216 * icon and label will be used. It's the same behaviour than
15217 * elm_toolbar_item_state_unser().
15219 * @see elm_toolbar_item_state_unset()
15223 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15226 * Unset the state of @p it.
15228 * @param it The item.
15230 * The default icon and label from this item will be displayed.
15232 * @see elm_toolbar_item_state_set() for more details.
15236 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15239 * Get the current state of @p it.
15241 * @param item The item.
15242 * @return The selected state or @c NULL if none is selected or on failure.
15244 * @see elm_toolbar_item_state_set() for details.
15245 * @see elm_toolbar_item_state_unset()
15246 * @see elm_toolbar_item_state_add()
15250 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15253 * Get the state after selected state in toolbar's @p item.
15255 * @param it The toolbar item to change state.
15256 * @return The state after current state, or @c NULL on failure.
15258 * If last state is selected, this function will return first state.
15260 * @see elm_toolbar_item_state_set()
15261 * @see elm_toolbar_item_state_add()
15265 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15268 * Get the state before selected state in toolbar's @p item.
15270 * @param it The toolbar item to change state.
15271 * @return The state before current state, or @c NULL on failure.
15273 * If first state is selected, this function will return last state.
15275 * @see elm_toolbar_item_state_set()
15276 * @see elm_toolbar_item_state_add()
15280 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15283 * Set the text to be shown in a given toolbar item's tooltips.
15285 * @param item Target item.
15286 * @param text The text to set in the content.
15288 * Setup the text as tooltip to object. The item can have only one tooltip,
15289 * so any previous tooltip data - set with this function or
15290 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15292 * @see elm_object_tooltip_text_set() for more details.
15296 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15299 * Set the content to be shown in the tooltip item.
15301 * Setup the tooltip to item. The item can have only one tooltip,
15302 * so any previous tooltip data is removed. @p func(with @p data) will
15303 * be called every time that need show the tooltip and it should
15304 * return a valid Evas_Object. This object is then managed fully by
15305 * tooltip system and is deleted when the tooltip is gone.
15307 * @param item the toolbar item being attached a tooltip.
15308 * @param func the function used to create the tooltip contents.
15309 * @param data what to provide to @a func as callback data/context.
15310 * @param del_cb called when data is not needed anymore, either when
15311 * another callback replaces @a func, the tooltip is unset with
15312 * elm_toolbar_item_tooltip_unset() or the owner @a item
15313 * dies. This callback receives as the first parameter the
15314 * given @a data, and @c event_info is the item.
15316 * @see elm_object_tooltip_content_cb_set() for more details.
15320 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);
15323 * Unset tooltip from item.
15325 * @param item toolbar item to remove previously set tooltip.
15327 * Remove tooltip from item. The callback provided as del_cb to
15328 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15329 * it is not used anymore.
15331 * @see elm_object_tooltip_unset() for more details.
15332 * @see elm_toolbar_item_tooltip_content_cb_set()
15336 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15339 * Sets a different style for this item tooltip.
15341 * @note before you set a style you should define a tooltip with
15342 * elm_toolbar_item_tooltip_content_cb_set() or
15343 * elm_toolbar_item_tooltip_text_set()
15345 * @param item toolbar item with tooltip already set.
15346 * @param style the theme style to use (default, transparent, ...)
15348 * @see elm_object_tooltip_style_set() for more details.
15352 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15355 * Get the style for this item tooltip.
15357 * @param item toolbar item with tooltip already set.
15358 * @return style the theme style in use, defaults to "default". If the
15359 * object does not have a tooltip set, then NULL is returned.
15361 * @see elm_object_tooltip_style_get() for more details.
15362 * @see elm_toolbar_item_tooltip_style_set()
15366 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15369 * Set the type of mouse pointer/cursor decoration to be shown,
15370 * when the mouse pointer is over the given toolbar widget item
15372 * @param item toolbar item to customize cursor on
15373 * @param cursor the cursor type's name
15375 * This function works analogously as elm_object_cursor_set(), but
15376 * here the cursor's changing area is restricted to the item's
15377 * area, and not the whole widget's. Note that that item cursors
15378 * have precedence over widget cursors, so that a mouse over an
15379 * item with custom cursor set will always show @b that cursor.
15381 * If this function is called twice for an object, a previously set
15382 * cursor will be unset on the second call.
15384 * @see elm_object_cursor_set()
15385 * @see elm_toolbar_item_cursor_get()
15386 * @see elm_toolbar_item_cursor_unset()
15390 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15393 * Get the type of mouse pointer/cursor decoration set to be shown,
15394 * when the mouse pointer is over the given toolbar widget item
15396 * @param item toolbar item with custom cursor set
15397 * @return the cursor type's name or @c NULL, if no custom cursors
15398 * were set to @p item (and on errors)
15400 * @see elm_object_cursor_get()
15401 * @see elm_toolbar_item_cursor_set()
15402 * @see elm_toolbar_item_cursor_unset()
15406 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15409 * Unset any custom mouse pointer/cursor decoration set to be
15410 * shown, when the mouse pointer is over the given toolbar widget
15411 * item, thus making it show the @b default cursor again.
15413 * @param item a toolbar item
15415 * Use this call to undo any custom settings on this item's cursor
15416 * decoration, bringing it back to defaults (no custom style set).
15418 * @see elm_object_cursor_unset()
15419 * @see elm_toolbar_item_cursor_set()
15423 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15426 * Set a different @b style for a given custom cursor set for a
15429 * @param item toolbar item with custom cursor set
15430 * @param style the <b>theme style</b> to use (e.g. @c "default",
15431 * @c "transparent", etc)
15433 * This function only makes sense when one is using custom mouse
15434 * cursor decorations <b>defined in a theme file</b>, which can have,
15435 * given a cursor name/type, <b>alternate styles</b> on it. It
15436 * works analogously as elm_object_cursor_style_set(), but here
15437 * applyed only to toolbar item objects.
15439 * @warning Before you set a cursor style you should have definen a
15440 * custom cursor previously on the item, with
15441 * elm_toolbar_item_cursor_set()
15443 * @see elm_toolbar_item_cursor_engine_only_set()
15444 * @see elm_toolbar_item_cursor_style_get()
15448 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15451 * Get the current @b style set for a given toolbar item's custom
15454 * @param item toolbar item with custom cursor set.
15455 * @return style the cursor style in use. If the object does not
15456 * have a cursor set, then @c NULL is returned.
15458 * @see elm_toolbar_item_cursor_style_set() for more details
15462 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15465 * Set if the (custom)cursor for a given toolbar item should be
15466 * searched in its theme, also, or should only rely on the
15467 * rendering engine.
15469 * @param item item with custom (custom) cursor already set on
15470 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15471 * only on those provided by the rendering engine, @c EINA_FALSE to
15472 * have them searched on the widget's theme, as well.
15474 * @note This call is of use only if you've set a custom cursor
15475 * for toolbar items, with elm_toolbar_item_cursor_set().
15477 * @note By default, cursors will only be looked for between those
15478 * provided by the rendering engine.
15482 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15485 * Get if the (custom) cursor for a given toolbar item is being
15486 * searched in its theme, also, or is only relying on the rendering
15489 * @param item a toolbar item
15490 * @return @c EINA_TRUE, if cursors are being looked for only on
15491 * those provided by the rendering engine, @c EINA_FALSE if they
15492 * are being searched on the widget's theme, as well.
15494 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15498 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15501 * Change a toolbar's orientation
15502 * @param obj The toolbar object
15503 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15504 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15506 * @deprecated use elm_toolbar_horizontal_set() instead.
15508 EINA_DEPRECATED EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15511 * Change a toolbar's orientation
15512 * @param obj The toolbar object
15513 * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15514 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15517 EAPI void elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15520 * Get a toolbar's orientation
15521 * @param obj The toolbar object
15522 * @return If @c EINA_TRUE, the toolbar is vertical
15523 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15525 * @deprecated use elm_toolbar_horizontal_get() instead.
15527 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15530 * Get a toolbar's orientation
15531 * @param obj The toolbar object
15532 * @return If @c EINA_TRUE, the toolbar is horizontal
15533 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15536 EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15542 * @defgroup Tooltips Tooltips
15544 * The Tooltip is an (internal, for now) smart object used to show a
15545 * content in a frame on mouse hover of objects(or widgets), with
15546 * tips/information about them.
15551 EAPI double elm_tooltip_delay_get(void);
15552 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15553 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15554 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15555 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15556 EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15557 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15558 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);
15559 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15560 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15561 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15562 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
15563 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
15570 * @defgroup Cursors Cursors
15572 * The Elementary cursor is an internal smart object used to
15573 * customize the mouse cursor displayed over objects (or
15574 * widgets). In the most common scenario, the cursor decoration
15575 * comes from the graphical @b engine Elementary is running
15576 * on. Those engines may provide different decorations for cursors,
15577 * and Elementary provides functions to choose them (think of X11
15578 * cursors, as an example).
15580 * There's also the possibility of, besides using engine provided
15581 * cursors, also use ones coming from Edje theming files. Both
15582 * globally and per widget, Elementary makes it possible for one to
15583 * make the cursors lookup to be held on engines only or on
15584 * Elementary's theme file, too. To set cursor's hot spot,
15585 * two data items should be added to cursor's theme: "hot_x" and
15586 * "hot_y", that are the offset from upper-left corner of the cursor
15587 * (coordinates 0,0).
15593 * Set the cursor to be shown when mouse is over the object
15595 * Set the cursor that will be displayed when mouse is over the
15596 * object. The object can have only one cursor set to it, so if
15597 * this function is called twice for an object, the previous set
15599 * If using X cursors, a definition of all the valid cursor names
15600 * is listed on Elementary_Cursors.h. If an invalid name is set
15601 * the default cursor will be used.
15603 * @param obj the object being set a cursor.
15604 * @param cursor the cursor name to be used.
15608 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15611 * Get the cursor to be shown when mouse is over the object
15613 * @param obj an object with cursor already set.
15614 * @return the cursor name.
15618 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15621 * Unset cursor for object
15623 * Unset cursor for object, and set the cursor to default if the mouse
15624 * was over this object.
15626 * @param obj Target object
15627 * @see elm_object_cursor_set()
15631 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15634 * Sets a different style for this object cursor.
15636 * @note before you set a style you should define a cursor with
15637 * elm_object_cursor_set()
15639 * @param obj an object with cursor already set.
15640 * @param style the theme style to use (default, transparent, ...)
15644 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15647 * Get the style for this object cursor.
15649 * @param obj an object with cursor already set.
15650 * @return style the theme style in use, defaults to "default". If the
15651 * object does not have a cursor set, then NULL is returned.
15655 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15658 * Set if the cursor set should be searched on the theme or should use
15659 * the provided by the engine, only.
15661 * @note before you set if should look on theme you should define a cursor
15662 * with elm_object_cursor_set(). By default it will only look for cursors
15663 * provided by the engine.
15665 * @param obj an object with cursor already set.
15666 * @param engine_only boolean to define it cursors should be looked only
15667 * between the provided by the engine or searched on widget's theme as well.
15671 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15674 * Get the cursor engine only usage for this object cursor.
15676 * @param obj an object with cursor already set.
15677 * @return engine_only boolean to define it cursors should be
15678 * looked only between the provided by the engine or searched on
15679 * widget's theme as well. If the object does not have a cursor
15680 * set, then EINA_FALSE is returned.
15684 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15687 * Get the configured cursor engine only usage
15689 * This gets the globally configured exclusive usage of engine cursors.
15691 * @return 1 if only engine cursors should be used
15694 EAPI int elm_cursor_engine_only_get(void);
15697 * Set the configured cursor engine only usage
15699 * This sets the globally configured exclusive usage of engine cursors.
15700 * It won't affect cursors set before changing this value.
15702 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15703 * look for them on theme before.
15704 * @return EINA_TRUE if value is valid and setted (0 or 1)
15707 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
15714 * @defgroup Menu Menu
15716 * @image html img/widget/menu/preview-00.png
15717 * @image latex img/widget/menu/preview-00.eps
15719 * A menu is a list of items displayed above its parent. When the menu is
15720 * showing its parent is darkened. Each item can have a sub-menu. The menu
15721 * object can be used to display a menu on a right click event, in a toolbar,
15724 * Signals that you can add callbacks for are:
15725 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15726 * event_info is NULL.
15728 * @see @ref tutorial_menu
15731 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15733 * @brief Add a new menu to the parent
15735 * @param parent The parent object.
15736 * @return The new object or NULL if it cannot be created.
15738 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15740 * @brief Set the parent for the given menu widget
15742 * @param obj The menu object.
15743 * @param parent The new parent.
15745 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15747 * @brief Get the parent for the given menu widget
15749 * @param obj The menu object.
15750 * @return The parent.
15752 * @see elm_menu_parent_set()
15754 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15756 * @brief Move the menu to a new position
15758 * @param obj The menu object.
15759 * @param x The new position.
15760 * @param y The new position.
15762 * Sets the top-left position of the menu to (@p x,@p y).
15764 * @note @p x and @p y coordinates are relative to parent.
15766 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15768 * @brief Close a opened menu
15770 * @param obj the menu object
15773 * Hides the menu and all it's sub-menus.
15775 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15777 * @brief Returns a list of @p item's items.
15779 * @param obj The menu object
15780 * @return An Eina_List* of @p item's items
15782 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15784 * @brief Get the Evas_Object of an Elm_Menu_Item
15786 * @param item The menu item object.
15787 * @return The edje object containing the swallowed content
15789 * @warning Don't manipulate this object!
15791 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15793 * @brief Add an item at the end of the given menu widget
15795 * @param obj The menu object.
15796 * @param parent The parent menu item (optional)
15797 * @param icon A icon display on the item. The icon will be destryed by the menu.
15798 * @param label The label of the item.
15799 * @param func Function called when the user select the item.
15800 * @param data Data sent by the callback.
15801 * @return Returns the new item.
15803 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);
15805 * @brief Add an object swallowed in an item at the end of the given menu
15808 * @param obj The menu object.
15809 * @param parent The parent menu item (optional)
15810 * @param subobj The object to swallow
15811 * @param func Function called when the user select the item.
15812 * @param data Data sent by the callback.
15813 * @return Returns the new item.
15815 * Add an evas object as an item to the menu.
15817 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);
15819 * @brief Set the label of a menu item
15821 * @param item The menu item object.
15822 * @param label The label to set for @p item
15824 * @warning Don't use this funcion on items created with
15825 * elm_menu_item_add_object() or elm_menu_item_separator_add().
15827 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15829 * @brief Get the label of a menu item
15831 * @param item The menu item object.
15832 * @return The label of @p item
15834 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15836 * @brief Set the icon of a menu item to the standard icon with name @p icon
15838 * @param item The menu item object.
15839 * @param icon The icon object to set for the content of @p item
15841 * Once this icon is set, any previously set icon will be deleted.
15843 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15845 * @brief Get the string representation from the icon of a menu item
15847 * @param item The menu item object.
15848 * @return The string representation of @p item's icon or NULL
15850 * @see elm_menu_item_object_icon_name_set()
15852 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15854 * @brief Set the content object of a menu item
15856 * @param item The menu item object
15857 * @param The content object or NULL
15858 * @return EINA_TRUE on success, else EINA_FALSE
15860 * Use this function to change the object swallowed by a menu item, deleting
15861 * any previously swallowed object.
15863 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
15865 * @brief Get the content object of a menu item
15867 * @param item The menu item object
15868 * @return The content object or NULL
15869 * @note If @p item was added with elm_menu_item_add_object, this
15870 * function will return the object passed, else it will return the
15873 * @see elm_menu_item_object_content_set()
15875 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15877 * @brief Set the selected state of @p item.
15879 * @param item The menu item object.
15880 * @param selected The selected/unselected state of the item
15882 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15884 * @brief Get the selected state of @p item.
15886 * @param item The menu item object.
15887 * @return The selected/unselected state of the item
15889 * @see elm_menu_item_selected_set()
15891 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15893 * @brief Set the disabled state of @p item.
15895 * @param item The menu item object.
15896 * @param disabled The enabled/disabled state of the item
15898 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15900 * @brief Get the disabled state of @p item.
15902 * @param item The menu item object.
15903 * @return The enabled/disabled state of the item
15905 * @see elm_menu_item_disabled_set()
15907 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15909 * @brief Add a separator item to menu @p obj under @p parent.
15911 * @param obj The menu object
15912 * @param parent The item to add the separator under
15913 * @return The created item or NULL on failure
15915 * This is item is a @ref Separator.
15917 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
15919 * @brief Returns whether @p item is a separator.
15921 * @param item The item to check
15922 * @return If true, @p item is a separator
15924 * @see elm_menu_item_separator_add()
15926 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15928 * @brief Deletes an item from the menu.
15930 * @param item The item to delete.
15932 * @see elm_menu_item_add()
15934 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15936 * @brief Set the function called when a menu item is deleted.
15938 * @param item The item to set the callback on
15939 * @param func The function called
15941 * @see elm_menu_item_add()
15942 * @see elm_menu_item_del()
15944 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15946 * @brief Returns the data associated with menu item @p item.
15948 * @param item The item
15949 * @return The data associated with @p item or NULL if none was set.
15951 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
15953 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15955 * @brief Sets the data to be associated with menu item @p item.
15957 * @param item The item
15958 * @param data The data to be associated with @p item
15960 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
15962 * @brief Returns a list of @p item's subitems.
15964 * @param item The item
15965 * @return An Eina_List* of @p item's subitems
15967 * @see elm_menu_add()
15969 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15971 * @brief Get the position of a menu item
15973 * @param item The menu item
15974 * @return The item's index
15976 * This function returns the index position of a menu item in a menu.
15977 * For a sub-menu, this number is relative to the first item in the sub-menu.
15979 * @note Index values begin with 0
15981 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
15983 * @brief @brief Return a menu item's owner menu
15985 * @param item The menu item
15986 * @return The menu object owning @p item, or NULL on failure
15988 * Use this function to get the menu object owning an item.
15990 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
15992 * @brief Get the selected item in the menu
15994 * @param obj The menu object
15995 * @return The selected item, or NULL if none
15997 * @see elm_menu_item_selected_get()
15998 * @see elm_menu_item_selected_set()
16000 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16002 * @brief Get the last item in the menu
16004 * @param obj The menu object
16005 * @return The last item, or NULL if none
16007 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16009 * @brief Get the first item in the menu
16011 * @param obj The menu object
16012 * @return The first item, or NULL if none
16014 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16016 * @brief Get the next item in the menu.
16018 * @param item The menu item object.
16019 * @return The item after it, or NULL if none
16021 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16023 * @brief Get the previous item in the menu.
16025 * @param item The menu item object.
16026 * @return The item before it, or NULL if none
16028 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16034 * @defgroup List List
16035 * @ingroup Elementary
16037 * @image html img/widget/list/preview-00.png
16038 * @image latex img/widget/list/preview-00.eps width=\textwidth
16040 * @image html img/list.png
16041 * @image latex img/list.eps width=\textwidth
16043 * A list widget is a container whose children are displayed vertically or
16044 * horizontally, in order, and can be selected.
16045 * The list can accept only one or multiple items selection. Also has many
16046 * modes of items displaying.
16048 * A list is a very simple type of list widget. For more robust
16049 * lists, @ref Genlist should probably be used.
16051 * Smart callbacks one can listen to:
16052 * - @c "activated" - The user has double-clicked or pressed
16053 * (enter|return|spacebar) on an item. The @c event_info parameter
16054 * is the item that was activated.
16055 * - @c "clicked,double" - The user has double-clicked an item.
16056 * The @c event_info parameter is the item that was double-clicked.
16057 * - "selected" - when the user selected an item
16058 * - "unselected" - when the user unselected an item
16059 * - "longpressed" - an item in the list is long-pressed
16060 * - "edge,top" - the list is scrolled until the top edge
16061 * - "edge,bottom" - the list is scrolled until the bottom edge
16062 * - "edge,left" - the list is scrolled until the left edge
16063 * - "edge,right" - the list is scrolled until the right edge
16064 * - "language,changed" - the program's language changed
16066 * Available styles for it:
16069 * List of examples:
16070 * @li @ref list_example_01
16071 * @li @ref list_example_02
16072 * @li @ref list_example_03
16081 * @enum _Elm_List_Mode
16082 * @typedef Elm_List_Mode
16084 * Set list's resize behavior, transverse axis scroll and
16085 * items cropping. See each mode's description for more details.
16087 * @note Default value is #ELM_LIST_SCROLL.
16089 * Values <b> don't </b> work as bitmask, only one can be choosen.
16091 * @see elm_list_mode_set()
16092 * @see elm_list_mode_get()
16096 typedef enum _Elm_List_Mode
16098 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. */
16099 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). */
16100 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. */
16101 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. */
16102 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16105 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(). */
16108 * Add a new list widget to the given parent Elementary
16109 * (container) object.
16111 * @param parent The parent object.
16112 * @return a new list widget handle or @c NULL, on errors.
16114 * This function inserts a new list widget on the canvas.
16118 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16123 * @param obj The list object
16125 * @note Call before running show() on the list object.
16126 * @warning If not called, it won't display the list properly.
16129 * li = elm_list_add(win);
16130 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16131 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16133 * evas_object_show(li);
16138 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16141 * Enable or disable multiple items selection on the list object.
16143 * @param obj The list object
16144 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16147 * Disabled by default. If disabled, the user can select a single item of
16148 * the list each time. Selected items are highlighted on list.
16149 * If enabled, many items can be selected.
16151 * If a selected item is selected again, it will be unselected.
16153 * @see elm_list_multi_select_get()
16157 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16160 * Get a value whether multiple items selection is enabled or not.
16162 * @see elm_list_multi_select_set() for details.
16164 * @param obj The list object.
16165 * @return @c EINA_TRUE means multiple items selection is enabled.
16166 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16167 * @c EINA_FALSE is returned.
16171 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16174 * Set which mode to use for the list object.
16176 * @param obj The list object
16177 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16178 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16180 * Set list's resize behavior, transverse axis scroll and
16181 * items cropping. See each mode's description for more details.
16183 * @note Default value is #ELM_LIST_SCROLL.
16185 * Only one can be set, if a previous one was set, it will be changed
16186 * by the new mode set. Bitmask won't work as well.
16188 * @see elm_list_mode_get()
16192 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16195 * Get the mode the list is at.
16197 * @param obj The list object
16198 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16199 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16201 * @note see elm_list_mode_set() for more information.
16205 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16208 * Enable or disable horizontal mode on the list object.
16210 * @param obj The list object.
16211 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16212 * disable it, i.e., to enable vertical mode.
16214 * @note Vertical mode is set by default.
16216 * On horizontal mode items are displayed on list from left to right,
16217 * instead of from top to bottom. Also, the list will scroll horizontally.
16218 * Each item will presents left icon on top and right icon, or end, at
16221 * @see elm_list_horizontal_get()
16225 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16228 * Get a value whether horizontal mode is enabled or not.
16230 * @param obj The list object.
16231 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16232 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16233 * @c EINA_FALSE is returned.
16235 * @see elm_list_horizontal_set() for details.
16239 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16242 * Enable or disable always select mode on the list object.
16244 * @param obj The list object
16245 * @param always_select @c EINA_TRUE to enable always select mode or
16246 * @c EINA_FALSE to disable it.
16248 * @note Always select mode is disabled by default.
16250 * Default behavior of list items is to only call its callback function
16251 * the first time it's pressed, i.e., when it is selected. If a selected
16252 * item is pressed again, and multi-select is disabled, it won't call
16253 * this function (if multi-select is enabled it will unselect the item).
16255 * If always select is enabled, it will call the callback function
16256 * everytime a item is pressed, so it will call when the item is selected,
16257 * and again when a selected item is pressed.
16259 * @see elm_list_always_select_mode_get()
16260 * @see elm_list_multi_select_set()
16264 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16267 * Get a value whether always select mode is enabled or not, meaning that
16268 * an item will always call its callback function, even if already selected.
16270 * @param obj The list object
16271 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16272 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16273 * @c EINA_FALSE is returned.
16275 * @see elm_list_always_select_mode_set() for details.
16279 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16282 * Set bouncing behaviour when the scrolled content reaches an edge.
16284 * Tell the internal scroller object whether it should bounce or not
16285 * when it reaches the respective edges for each axis.
16287 * @param obj The list object
16288 * @param h_bounce Whether to bounce or not in the horizontal axis.
16289 * @param v_bounce Whether to bounce or not in the vertical axis.
16291 * @see elm_scroller_bounce_set()
16295 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16298 * Get the bouncing behaviour of the internal scroller.
16300 * Get whether the internal scroller should bounce when the edge of each
16301 * axis is reached scrolling.
16303 * @param obj The list object.
16304 * @param h_bounce Pointer where to store the bounce state of the horizontal
16306 * @param v_bounce Pointer where to store the bounce state of the vertical
16309 * @see elm_scroller_bounce_get()
16310 * @see elm_list_bounce_set()
16314 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16317 * Set the scrollbar policy.
16319 * @param obj The list object
16320 * @param policy_h Horizontal scrollbar policy.
16321 * @param policy_v Vertical scrollbar policy.
16323 * This sets the scrollbar visibility policy for the given scroller.
16324 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16325 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16326 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16327 * This applies respectively for the horizontal and vertical scrollbars.
16329 * The both are disabled by default, i.e., are set to
16330 * #ELM_SCROLLER_POLICY_OFF.
16334 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16337 * Get the scrollbar policy.
16339 * @see elm_list_scroller_policy_get() for details.
16341 * @param obj The list object.
16342 * @param policy_h Pointer where to store horizontal scrollbar policy.
16343 * @param policy_v Pointer where to store vertical scrollbar policy.
16347 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);
16350 * Append a new item to the list object.
16352 * @param obj The list object.
16353 * @param label The label of the list item.
16354 * @param icon The icon object to use for the left side of the item. An
16355 * icon can be any Evas object, but usually it is an icon created
16356 * with elm_icon_add().
16357 * @param end The icon object to use for the right side of the item. An
16358 * icon can be any Evas object.
16359 * @param func The function to call when the item is clicked.
16360 * @param data The data to associate with the item for related callbacks.
16362 * @return The created item or @c NULL upon failure.
16364 * A new item will be created and appended to the list, i.e., will
16365 * be set as @b last item.
16367 * Items created with this method can be deleted with
16368 * elm_list_item_del().
16370 * Associated @p data can be properly freed when item is deleted if a
16371 * callback function is set with elm_list_item_del_cb_set().
16373 * If a function is passed as argument, it will be called everytime this item
16374 * is selected, i.e., the user clicks over an unselected item.
16375 * If always select is enabled it will call this function every time
16376 * user clicks over an item (already selected or not).
16377 * If such function isn't needed, just passing
16378 * @c NULL as @p func is enough. The same should be done for @p data.
16380 * Simple example (with no function callback or data associated):
16382 * li = elm_list_add(win);
16383 * ic = elm_icon_add(win);
16384 * elm_icon_file_set(ic, "path/to/image", NULL);
16385 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16386 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16388 * evas_object_show(li);
16391 * @see elm_list_always_select_mode_set()
16392 * @see elm_list_item_del()
16393 * @see elm_list_item_del_cb_set()
16394 * @see elm_list_clear()
16395 * @see elm_icon_add()
16399 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);
16402 * Prepend a new item to the list object.
16404 * @param obj The list object.
16405 * @param label The label of the list item.
16406 * @param icon The icon object to use for the left side of the item. An
16407 * icon can be any Evas object, but usually it is an icon created
16408 * with elm_icon_add().
16409 * @param end The icon object to use for the right side of the item. An
16410 * icon can be any Evas object.
16411 * @param func The function to call when the item is clicked.
16412 * @param data The data to associate with the item for related callbacks.
16414 * @return The created item or @c NULL upon failure.
16416 * A new item will be created and prepended to the list, i.e., will
16417 * be set as @b first item.
16419 * Items created with this method can be deleted with
16420 * elm_list_item_del().
16422 * Associated @p data can be properly freed when item is deleted if a
16423 * callback function is set with elm_list_item_del_cb_set().
16425 * If a function is passed as argument, it will be called everytime this item
16426 * is selected, i.e., the user clicks over an unselected item.
16427 * If always select is enabled it will call this function every time
16428 * user clicks over an item (already selected or not).
16429 * If such function isn't needed, just passing
16430 * @c NULL as @p func is enough. The same should be done for @p data.
16432 * @see elm_list_item_append() for a simple code example.
16433 * @see elm_list_always_select_mode_set()
16434 * @see elm_list_item_del()
16435 * @see elm_list_item_del_cb_set()
16436 * @see elm_list_clear()
16437 * @see elm_icon_add()
16441 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);
16444 * Insert a new item into the list object before item @p before.
16446 * @param obj The list object.
16447 * @param before The list item to insert before.
16448 * @param label The label of the list item.
16449 * @param icon The icon object to use for the left side of the item. An
16450 * icon can be any Evas object, but usually it is an icon created
16451 * with elm_icon_add().
16452 * @param end The icon object to use for the right side of the item. An
16453 * icon can be any Evas object.
16454 * @param func The function to call when the item is clicked.
16455 * @param data The data to associate with the item for related callbacks.
16457 * @return The created item or @c NULL upon failure.
16459 * A new item will be created and added to the list. Its position in
16460 * this list will be just before item @p before.
16462 * Items created with this method can be deleted with
16463 * elm_list_item_del().
16465 * Associated @p data can be properly freed when item is deleted if a
16466 * callback function is set with elm_list_item_del_cb_set().
16468 * If a function is passed as argument, it will be called everytime this item
16469 * is selected, i.e., the user clicks over an unselected item.
16470 * If always select is enabled it will call this function every time
16471 * user clicks over an item (already selected or not).
16472 * If such function isn't needed, just passing
16473 * @c NULL as @p func is enough. The same should be done for @p data.
16475 * @see elm_list_item_append() for a simple code example.
16476 * @see elm_list_always_select_mode_set()
16477 * @see elm_list_item_del()
16478 * @see elm_list_item_del_cb_set()
16479 * @see elm_list_clear()
16480 * @see elm_icon_add()
16484 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);
16487 * Insert a new item into the list object after item @p after.
16489 * @param obj The list object.
16490 * @param after The list item to insert after.
16491 * @param label The label of the list item.
16492 * @param icon The icon object to use for the left side of the item. An
16493 * icon can be any Evas object, but usually it is an icon created
16494 * with elm_icon_add().
16495 * @param end The icon object to use for the right side of the item. An
16496 * icon can be any Evas object.
16497 * @param func The function to call when the item is clicked.
16498 * @param data The data to associate with the item for related callbacks.
16500 * @return The created item or @c NULL upon failure.
16502 * A new item will be created and added to the list. Its position in
16503 * this list will be just after item @p after.
16505 * Items created with this method can be deleted with
16506 * elm_list_item_del().
16508 * Associated @p data can be properly freed when item is deleted if a
16509 * callback function is set with elm_list_item_del_cb_set().
16511 * If a function is passed as argument, it will be called everytime this item
16512 * is selected, i.e., the user clicks over an unselected item.
16513 * If always select is enabled it will call this function every time
16514 * user clicks over an item (already selected or not).
16515 * If such function isn't needed, just passing
16516 * @c NULL as @p func is enough. The same should be done for @p data.
16518 * @see elm_list_item_append() for a simple code example.
16519 * @see elm_list_always_select_mode_set()
16520 * @see elm_list_item_del()
16521 * @see elm_list_item_del_cb_set()
16522 * @see elm_list_clear()
16523 * @see elm_icon_add()
16527 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);
16530 * Insert a new item into the sorted list object.
16532 * @param obj The list object.
16533 * @param label The label of the list item.
16534 * @param icon The icon object to use for the left side of the item. An
16535 * icon can be any Evas object, but usually it is an icon created
16536 * with elm_icon_add().
16537 * @param end The icon object to use for the right side of the item. An
16538 * icon can be any Evas object.
16539 * @param func The function to call when the item is clicked.
16540 * @param data The data to associate with the item for related callbacks.
16541 * @param cmp_func The comparing function to be used to sort list
16542 * items <b>by #Elm_List_Item item handles</b>. This function will
16543 * receive two items and compare them, returning a non-negative integer
16544 * if the second item should be place after the first, or negative value
16545 * if should be placed before.
16547 * @return The created item or @c NULL upon failure.
16549 * @note This function inserts values into a list object assuming it was
16550 * sorted and the result will be sorted.
16552 * A new item will be created and added to the list. Its position in
16553 * this list will be found comparing the new item with previously inserted
16554 * items using function @p cmp_func.
16556 * Items created with this method can be deleted with
16557 * elm_list_item_del().
16559 * Associated @p data can be properly freed when item is deleted if a
16560 * callback function is set with elm_list_item_del_cb_set().
16562 * If a function is passed as argument, it will be called everytime this item
16563 * is selected, i.e., the user clicks over an unselected item.
16564 * If always select is enabled it will call this function every time
16565 * user clicks over an item (already selected or not).
16566 * If such function isn't needed, just passing
16567 * @c NULL as @p func is enough. The same should be done for @p data.
16569 * @see elm_list_item_append() for a simple code example.
16570 * @see elm_list_always_select_mode_set()
16571 * @see elm_list_item_del()
16572 * @see elm_list_item_del_cb_set()
16573 * @see elm_list_clear()
16574 * @see elm_icon_add()
16578 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);
16581 * Remove all list's items.
16583 * @param obj The list object
16585 * @see elm_list_item_del()
16586 * @see elm_list_item_append()
16590 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16593 * Get a list of all the list items.
16595 * @param obj The list object
16596 * @return An @c Eina_List of list items, #Elm_List_Item,
16597 * or @c NULL on failure.
16599 * @see elm_list_item_append()
16600 * @see elm_list_item_del()
16601 * @see elm_list_clear()
16605 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16608 * Get the selected item.
16610 * @param obj The list object.
16611 * @return The selected list item.
16613 * The selected item can be unselected with function
16614 * elm_list_item_selected_set().
16616 * The selected item always will be highlighted on list.
16618 * @see elm_list_selected_items_get()
16622 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16625 * Return a list of the currently selected list items.
16627 * @param obj The list object.
16628 * @return An @c Eina_List of list items, #Elm_List_Item,
16629 * or @c NULL on failure.
16631 * Multiple items can be selected if multi select is enabled. It can be
16632 * done with elm_list_multi_select_set().
16634 * @see elm_list_selected_item_get()
16635 * @see elm_list_multi_select_set()
16639 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16642 * Set the selected state of an item.
16644 * @param item The list item
16645 * @param selected The selected state
16647 * This sets the selected state of the given item @p it.
16648 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16650 * If a new item is selected the previosly selected will be unselected,
16651 * unless multiple selection is enabled with elm_list_multi_select_set().
16652 * Previoulsy selected item can be get with function
16653 * elm_list_selected_item_get().
16655 * Selected items will be highlighted.
16657 * @see elm_list_item_selected_get()
16658 * @see elm_list_selected_item_get()
16659 * @see elm_list_multi_select_set()
16663 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16666 * Get whether the @p item is selected or not.
16668 * @param item The list item.
16669 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16670 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16672 * @see elm_list_selected_item_set() for details.
16673 * @see elm_list_item_selected_get()
16677 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16680 * Set or unset item as a separator.
16682 * @param it The list item.
16683 * @param setting @c EINA_TRUE to set item @p it as separator or
16684 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16686 * Items aren't set as separator by default.
16688 * If set as separator it will display separator theme, so won't display
16691 * @see elm_list_item_separator_get()
16695 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16698 * Get a value whether item is a separator or not.
16700 * @see elm_list_item_separator_set() for details.
16702 * @param it The list item.
16703 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16704 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16708 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16711 * Show @p item in the list view.
16713 * @param item The list item to be shown.
16715 * It won't animate list until item is visible. If such behavior is wanted,
16716 * use elm_list_bring_in() intead.
16720 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16723 * Bring in the given item to list view.
16725 * @param item The item.
16727 * This causes list to jump to the given item @p item and show it
16728 * (by scrolling), if it is not fully visible.
16730 * This may use animation to do so and take a period of time.
16732 * If animation isn't wanted, elm_list_item_show() can be used.
16736 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16739 * Delete them item from the list.
16741 * @param item The item of list to be deleted.
16743 * If deleting all list items is required, elm_list_clear()
16744 * should be used instead of getting items list and deleting each one.
16746 * @see elm_list_clear()
16747 * @see elm_list_item_append()
16748 * @see elm_list_item_del_cb_set()
16752 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16755 * Set the function called when a list item is freed.
16757 * @param item The item to set the callback on
16758 * @param func The function called
16760 * If there is a @p func, then it will be called prior item's memory release.
16761 * That will be called with the following arguments:
16763 * @li item's Evas object;
16766 * This way, a data associated to a list item could be properly freed.
16770 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16773 * Get the data associated to the item.
16775 * @param item The list item
16776 * @return The data associated to @p item
16778 * The return value is a pointer to data associated to @p item when it was
16779 * created, with function elm_list_item_append() or similar. If no data
16780 * was passed as argument, it will return @c NULL.
16782 * @see elm_list_item_append()
16786 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16789 * Get the left side icon associated to the item.
16791 * @param item The list item
16792 * @return The left side icon associated to @p item
16794 * The return value is a pointer to the icon associated to @p item when
16796 * created, with function elm_list_item_append() or similar, or later
16797 * with function elm_list_item_icon_set(). If no icon
16798 * was passed as argument, it will return @c NULL.
16800 * @see elm_list_item_append()
16801 * @see elm_list_item_icon_set()
16805 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16808 * Set the left side icon associated to the item.
16810 * @param item The list item
16811 * @param icon The left side icon object to associate with @p item
16813 * The icon object to use at left side of the item. An
16814 * icon can be any Evas object, but usually it is an icon created
16815 * with elm_icon_add().
16817 * Once the icon object is set, a previously set one will be deleted.
16818 * @warning Setting the same icon for two items will cause the icon to
16819 * dissapear from the first item.
16821 * If an icon was passed as argument on item creation, with function
16822 * elm_list_item_append() or similar, it will be already
16823 * associated to the item.
16825 * @see elm_list_item_append()
16826 * @see elm_list_item_icon_get()
16830 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16833 * Get the right side icon associated to the item.
16835 * @param item The list item
16836 * @return The right side icon associated to @p item
16838 * The return value is a pointer to the icon associated to @p item when
16840 * created, with function elm_list_item_append() or similar, or later
16841 * with function elm_list_item_icon_set(). If no icon
16842 * was passed as argument, it will return @c NULL.
16844 * @see elm_list_item_append()
16845 * @see elm_list_item_icon_set()
16849 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16852 * Set the right side icon associated to the item.
16854 * @param item The list item
16855 * @param end The right side icon object to associate with @p item
16857 * The icon object to use at right side of the item. An
16858 * icon can be any Evas object, but usually it is an icon created
16859 * with elm_icon_add().
16861 * Once the icon object is set, a previously set one will be deleted.
16862 * @warning Setting the same icon for two items will cause the icon to
16863 * dissapear from the first item.
16865 * If an icon was passed as argument on item creation, with function
16866 * elm_list_item_append() or similar, it will be already
16867 * associated to the item.
16869 * @see elm_list_item_append()
16870 * @see elm_list_item_end_get()
16874 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
16877 * Gets the base object of the item.
16879 * @param item The list item
16880 * @return The base object associated with @p item
16882 * Base object is the @c Evas_Object that represents that item.
16886 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16887 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16890 * Get the label of item.
16892 * @param item The item of list.
16893 * @return The label of item.
16895 * The return value is a pointer to the label associated to @p item when
16896 * it was created, with function elm_list_item_append(), or later
16897 * with function elm_list_item_label_set. If no label
16898 * was passed as argument, it will return @c NULL.
16900 * @see elm_list_item_label_set() for more details.
16901 * @see elm_list_item_append()
16905 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16908 * Set the label of item.
16910 * @param item The item of list.
16911 * @param text The label of item.
16913 * The label to be displayed by the item.
16914 * Label will be placed between left and right side icons (if set).
16916 * If a label was passed as argument on item creation, with function
16917 * elm_list_item_append() or similar, it will be already
16918 * displayed by the item.
16920 * @see elm_list_item_label_get()
16921 * @see elm_list_item_append()
16925 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16929 * Get the item before @p it in list.
16931 * @param it The list item.
16932 * @return The item before @p it, or @c NULL if none or on failure.
16934 * @note If it is the first item, @c NULL will be returned.
16936 * @see elm_list_item_append()
16937 * @see elm_list_items_get()
16941 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16944 * Get the item after @p it in list.
16946 * @param it The list item.
16947 * @return The item after @p it, or @c NULL if none or on failure.
16949 * @note If it is the last item, @c NULL will be returned.
16951 * @see elm_list_item_append()
16952 * @see elm_list_items_get()
16956 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16959 * Sets the disabled/enabled state of a list item.
16961 * @param it The item.
16962 * @param disabled The disabled state.
16964 * A disabled item cannot be selected or unselected. It will also
16965 * change its appearance (generally greyed out). This sets the
16966 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
16971 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16974 * Get a value whether list item is disabled or not.
16976 * @param it The item.
16977 * @return The disabled state.
16979 * @see elm_list_item_disabled_set() for more details.
16983 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16986 * Set the text to be shown in a given list item's tooltips.
16988 * @param item Target item.
16989 * @param text The text to set in the content.
16991 * Setup the text as tooltip to object. The item can have only one tooltip,
16992 * so any previous tooltip data - set with this function or
16993 * elm_list_item_tooltip_content_cb_set() - is removed.
16995 * @see elm_object_tooltip_text_set() for more details.
16999 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17003 * @brief Disable size restrictions on an object's tooltip
17004 * @param item The tooltip's anchor object
17005 * @param disable If EINA_TRUE, size restrictions are disabled
17006 * @return EINA_FALSE on failure, EINA_TRUE on success
17008 * This function allows a tooltip to expand beyond its parant window's canvas.
17009 * It will instead be limited only by the size of the display.
17011 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17013 * @brief Retrieve size restriction state of an object's tooltip
17014 * @param obj The tooltip's anchor object
17015 * @return If EINA_TRUE, size restrictions are disabled
17017 * This function returns whether a tooltip is allowed to expand beyond
17018 * its parant window's canvas.
17019 * It will instead be limited only by the size of the display.
17021 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17024 * Set the content to be shown in the tooltip item.
17026 * Setup the tooltip to item. The item can have only one tooltip,
17027 * so any previous tooltip data is removed. @p func(with @p data) will
17028 * be called every time that need show the tooltip and it should
17029 * return a valid Evas_Object. This object is then managed fully by
17030 * tooltip system and is deleted when the tooltip is gone.
17032 * @param item the list item being attached a tooltip.
17033 * @param func the function used to create the tooltip contents.
17034 * @param data what to provide to @a func as callback data/context.
17035 * @param del_cb called when data is not needed anymore, either when
17036 * another callback replaces @a func, the tooltip is unset with
17037 * elm_list_item_tooltip_unset() or the owner @a item
17038 * dies. This callback receives as the first parameter the
17039 * given @a data, and @c event_info is the item.
17041 * @see elm_object_tooltip_content_cb_set() for more details.
17045 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);
17048 * Unset tooltip from item.
17050 * @param item list item to remove previously set tooltip.
17052 * Remove tooltip from item. The callback provided as del_cb to
17053 * elm_list_item_tooltip_content_cb_set() will be called to notify
17054 * it is not used anymore.
17056 * @see elm_object_tooltip_unset() for more details.
17057 * @see elm_list_item_tooltip_content_cb_set()
17061 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17064 * Sets a different style for this item tooltip.
17066 * @note before you set a style you should define a tooltip with
17067 * elm_list_item_tooltip_content_cb_set() or
17068 * elm_list_item_tooltip_text_set()
17070 * @param item list item with tooltip already set.
17071 * @param style the theme style to use (default, transparent, ...)
17073 * @see elm_object_tooltip_style_set() for more details.
17077 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17080 * Get the style for this item tooltip.
17082 * @param item list item with tooltip already set.
17083 * @return style the theme style in use, defaults to "default". If the
17084 * object does not have a tooltip set, then NULL is returned.
17086 * @see elm_object_tooltip_style_get() for more details.
17087 * @see elm_list_item_tooltip_style_set()
17091 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17094 * Set the type of mouse pointer/cursor decoration to be shown,
17095 * when the mouse pointer is over the given list widget item
17097 * @param item list item to customize cursor on
17098 * @param cursor the cursor type's name
17100 * This function works analogously as elm_object_cursor_set(), but
17101 * here the cursor's changing area is restricted to the item's
17102 * area, and not the whole widget's. Note that that item cursors
17103 * have precedence over widget cursors, so that a mouse over an
17104 * item with custom cursor set will always show @b that cursor.
17106 * If this function is called twice for an object, a previously set
17107 * cursor will be unset on the second call.
17109 * @see elm_object_cursor_set()
17110 * @see elm_list_item_cursor_get()
17111 * @see elm_list_item_cursor_unset()
17115 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17118 * Get the type of mouse pointer/cursor decoration set to be shown,
17119 * when the mouse pointer is over the given list widget item
17121 * @param item list item with custom cursor set
17122 * @return the cursor type's name or @c NULL, if no custom cursors
17123 * were set to @p item (and on errors)
17125 * @see elm_object_cursor_get()
17126 * @see elm_list_item_cursor_set()
17127 * @see elm_list_item_cursor_unset()
17131 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17134 * Unset any custom mouse pointer/cursor decoration set to be
17135 * shown, when the mouse pointer is over the given list widget
17136 * item, thus making it show the @b default cursor again.
17138 * @param item a list item
17140 * Use this call to undo any custom settings on this item's cursor
17141 * decoration, bringing it back to defaults (no custom style set).
17143 * @see elm_object_cursor_unset()
17144 * @see elm_list_item_cursor_set()
17148 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17151 * Set a different @b style for a given custom cursor set for a
17154 * @param item list item with custom cursor set
17155 * @param style the <b>theme style</b> to use (e.g. @c "default",
17156 * @c "transparent", etc)
17158 * This function only makes sense when one is using custom mouse
17159 * cursor decorations <b>defined in a theme file</b>, which can have,
17160 * given a cursor name/type, <b>alternate styles</b> on it. It
17161 * works analogously as elm_object_cursor_style_set(), but here
17162 * applyed only to list item objects.
17164 * @warning Before you set a cursor style you should have definen a
17165 * custom cursor previously on the item, with
17166 * elm_list_item_cursor_set()
17168 * @see elm_list_item_cursor_engine_only_set()
17169 * @see elm_list_item_cursor_style_get()
17173 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17176 * Get the current @b style set for a given list item's custom
17179 * @param item list item with custom cursor set.
17180 * @return style the cursor style in use. If the object does not
17181 * have a cursor set, then @c NULL is returned.
17183 * @see elm_list_item_cursor_style_set() for more details
17187 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17190 * Set if the (custom)cursor for a given list item should be
17191 * searched in its theme, also, or should only rely on the
17192 * rendering engine.
17194 * @param item item with custom (custom) cursor already set on
17195 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17196 * only on those provided by the rendering engine, @c EINA_FALSE to
17197 * have them searched on the widget's theme, as well.
17199 * @note This call is of use only if you've set a custom cursor
17200 * for list items, with elm_list_item_cursor_set().
17202 * @note By default, cursors will only be looked for between those
17203 * provided by the rendering engine.
17207 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17210 * Get if the (custom) cursor for a given list item is being
17211 * searched in its theme, also, or is only relying on the rendering
17214 * @param item a list item
17215 * @return @c EINA_TRUE, if cursors are being looked for only on
17216 * those provided by the rendering engine, @c EINA_FALSE if they
17217 * are being searched on the widget's theme, as well.
17219 * @see elm_list_item_cursor_engine_only_set(), for more details
17223 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17230 * @defgroup Slider Slider
17231 * @ingroup Elementary
17233 * @image html img/widget/slider/preview-00.png
17234 * @image latex img/widget/slider/preview-00.eps width=\textwidth
17236 * The slider adds a dragable āsliderā widget for selecting the value of
17237 * something within a range.
17239 * A slider can be horizontal or vertical. It can contain an Icon and has a
17240 * primary label as well as a units label (that is formatted with floating
17241 * point values and thus accepts a printf-style format string, like
17242 * ā%1.2f unitsā. There is also an indicator string that may be somewhere
17243 * else (like on the slider itself) that also accepts a format string like
17244 * units. Label, Icon Unit and Indicator strings/objects are optional.
17246 * A slider may be inverted which means values invert, with high vales being
17247 * on the left or top and low values on the right or bottom (as opposed to
17248 * normally being low on the left or top and high on the bottom and right).
17250 * The slider should have its minimum and maximum values set by the
17251 * application with elm_slider_min_max_set() and value should also be set by
17252 * the application before use with elm_slider_value_set(). The span of the
17253 * slider is its length (horizontally or vertically). This will be scaled by
17254 * the object or applications scaling factor. At any point code can query the
17255 * slider for its value with elm_slider_value_get().
17257 * Smart callbacks one can listen to:
17258 * - "changed" - Whenever the slider value is changed by the user.
17259 * - "slider,drag,start" - dragging the slider indicator around has started.
17260 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17261 * - "delay,changed" - A short time after the value is changed by the user.
17262 * This will be called only when the user stops dragging for
17263 * a very short period or when they release their
17264 * finger/mouse, so it avoids possibly expensive reactions to
17265 * the value change.
17267 * Available styles for it:
17270 * Default contents parts of the slider widget that you can use for are:
17271 * @li "elm.swallow.icon" - A icon of the slider
17272 * @li "elm.swallow.end" - A end part content of the slider
17274 * Here is an example on its usage:
17275 * @li @ref slider_example
17278 #define ELM_SLIDER_CONTENT_ICON "elm.swallow.icon"
17279 #define ELM_SLIDER_CONTENT_END "elm.swallow.end"
17282 * @addtogroup Slider
17287 * Add a new slider widget to the given parent Elementary
17288 * (container) object.
17290 * @param parent The parent object.
17291 * @return a new slider widget handle or @c NULL, on errors.
17293 * This function inserts a new slider widget on the canvas.
17297 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17300 * Set the label of a given slider widget
17302 * @param obj The progress bar object
17303 * @param label The text label string, in UTF-8
17306 * @deprecated use elm_object_text_set() instead.
17308 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17311 * Get the label of a given slider widget
17313 * @param obj The progressbar object
17314 * @return The text label string, in UTF-8
17317 * @deprecated use elm_object_text_get() instead.
17319 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17322 * Set the icon object of the slider object.
17324 * @param obj The slider object.
17325 * @param icon The icon object.
17327 * On horizontal mode, icon is placed at left, and on vertical mode,
17330 * @note Once the icon object is set, a previously set one will be deleted.
17331 * If you want to keep that old content object, use the
17332 * elm_slider_icon_unset() function.
17334 * @warning If the object being set does not have minimum size hints set,
17335 * it won't get properly displayed.
17338 * @deprecated use elm_object_content_set() instead.
17340 EINA_DEPRECATED EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17343 * Unset an icon set on a given slider widget.
17345 * @param obj The slider object.
17346 * @return The icon object that was being used, if any was set, or
17347 * @c NULL, otherwise (and on errors).
17349 * On horizontal mode, icon is placed at left, and on vertical mode,
17352 * This call will unparent and return the icon object which was set
17353 * for this widget, previously, on success.
17355 * @see elm_slider_icon_set() for more details
17356 * @see elm_slider_icon_get()
17357 * @deprecated use elm_object_content_unset() instead.
17361 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17364 * Retrieve the icon object set for a given slider widget.
17366 * @param obj The slider object.
17367 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17368 * otherwise (and on errors).
17370 * On horizontal mode, icon is placed at left, and on vertical mode,
17373 * @see elm_slider_icon_set() for more details
17374 * @see elm_slider_icon_unset()
17376 * @deprecated use elm_object_content_get() instead.
17380 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17383 * Set the end object of the slider object.
17385 * @param obj The slider object.
17386 * @param end The end object.
17388 * On horizontal mode, end is placed at left, and on vertical mode,
17389 * placed at bottom.
17391 * @note Once the icon object is set, a previously set one will be deleted.
17392 * If you want to keep that old content object, use the
17393 * elm_slider_end_unset() function.
17395 * @warning If the object being set does not have minimum size hints set,
17396 * it won't get properly displayed.
17398 * @deprecated use elm_object_content_part_set(obj, "elm.swallow.end", end) instead.
17402 EINA_DEPRECATED EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17405 * Unset an end object set on a given slider widget.
17407 * @param obj The slider object.
17408 * @return The end object that was being used, if any was set, or
17409 * @c NULL, otherwise (and on errors).
17411 * On horizontal mode, end is placed at left, and on vertical mode,
17412 * placed at bottom.
17414 * This call will unparent and return the icon object which was set
17415 * for this widget, previously, on success.
17417 * @see elm_slider_end_set() for more details.
17418 * @see elm_slider_end_get()
17420 * @deprecated use elm_object_content_part_unset(obj, "elm.swallow.end")
17425 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17428 * Retrieve the end object set for a given slider widget.
17430 * @param obj The slider object.
17431 * @return The end object's handle, if @p obj had one set, or @c NULL,
17432 * otherwise (and on errors).
17434 * On horizontal mode, icon is placed at right, and on vertical mode,
17435 * placed at bottom.
17437 * @see elm_slider_end_set() for more details.
17438 * @see elm_slider_end_unset()
17441 * @deprecated use elm_object_content_part_unset(obj, "elm.swallow.end")
17446 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17449 * Set the (exact) length of the bar region of a given slider widget.
17451 * @param obj The slider object.
17452 * @param size The length of the slider's bar region.
17454 * This sets the minimum width (when in horizontal mode) or height
17455 * (when in vertical mode) of the actual bar area of the slider
17456 * @p obj. This in turn affects the object's minimum size. Use
17457 * this when you're not setting other size hints expanding on the
17458 * given direction (like weight and alignment hints) and you would
17459 * like it to have a specific size.
17461 * @note Icon, end, label, indicator and unit text around @p obj
17462 * will require their
17463 * own space, which will make @p obj to require more the @p size,
17466 * @see elm_slider_span_size_get()
17470 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17473 * Get the length set for the bar region of a given slider widget
17475 * @param obj The slider object.
17476 * @return The length of the slider's bar region.
17478 * If that size was not set previously, with
17479 * elm_slider_span_size_set(), this call will return @c 0.
17483 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17486 * Set the format string for the unit label.
17488 * @param obj The slider object.
17489 * @param format The format string for the unit display.
17491 * Unit label is displayed all the time, if set, after slider's bar.
17492 * In horizontal mode, at right and in vertical mode, at bottom.
17494 * If @c NULL, unit label won't be visible. If not it sets the format
17495 * string for the label text. To the label text is provided a floating point
17496 * value, so the label text can display up to 1 floating point value.
17497 * Note that this is optional.
17499 * Use a format string such as "%1.2f meters" for example, and it will
17500 * display values like: "3.14 meters" for a value equal to 3.14159.
17502 * Default is unit label disabled.
17504 * @see elm_slider_indicator_format_get()
17508 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17511 * Get the unit label format of the slider.
17513 * @param obj The slider object.
17514 * @return The unit label format string in UTF-8.
17516 * Unit label is displayed all the time, if set, after slider's bar.
17517 * In horizontal mode, at right and in vertical mode, at bottom.
17519 * @see elm_slider_unit_format_set() for more
17520 * information on how this works.
17524 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17527 * Set the format string for the indicator label.
17529 * @param obj The slider object.
17530 * @param indicator The format string for the indicator display.
17532 * The slider may display its value somewhere else then unit label,
17533 * for example, above the slider knob that is dragged around. This function
17534 * sets the format string used for this.
17536 * If @c NULL, indicator label won't be visible. If not it sets the format
17537 * string for the label text. To the label text is provided a floating point
17538 * value, so the label text can display up to 1 floating point value.
17539 * Note that this is optional.
17541 * Use a format string such as "%1.2f meters" for example, and it will
17542 * display values like: "3.14 meters" for a value equal to 3.14159.
17544 * Default is indicator label disabled.
17546 * @see elm_slider_indicator_format_get()
17550 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17553 * Get the indicator label format of the slider.
17555 * @param obj The slider object.
17556 * @return The indicator label format string in UTF-8.
17558 * The slider may display its value somewhere else then unit label,
17559 * for example, above the slider knob that is dragged around. This function
17560 * gets the format string used for this.
17562 * @see elm_slider_indicator_format_set() for more
17563 * information on how this works.
17567 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17570 * Set the format function pointer for the indicator label
17572 * @param obj The slider object.
17573 * @param func The indicator format function.
17574 * @param free_func The freeing function for the format string.
17576 * Set the callback function to format the indicator string.
17578 * @see elm_slider_indicator_format_set() for more info on how this works.
17582 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);
17585 * Set the format function pointer for the units label
17587 * @param obj The slider object.
17588 * @param func The units format function.
17589 * @param free_func The freeing function for the format string.
17591 * Set the callback function to format the indicator string.
17593 * @see elm_slider_units_format_set() for more info on how this works.
17597 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);
17600 * Set the orientation of a given slider widget.
17602 * @param obj The slider object.
17603 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17604 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17606 * Use this function to change how your slider is to be
17607 * disposed: vertically or horizontally.
17609 * By default it's displayed horizontally.
17611 * @see elm_slider_horizontal_get()
17615 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17618 * Retrieve the orientation of a given slider widget
17620 * @param obj The slider object.
17621 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17622 * @c EINA_FALSE if it's @b vertical (and on errors).
17624 * @see elm_slider_horizontal_set() for more details.
17628 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17631 * Set the minimum and maximum values for the slider.
17633 * @param obj The slider object.
17634 * @param min The minimum value.
17635 * @param max The maximum value.
17637 * Define the allowed range of values to be selected by the user.
17639 * If actual value is less than @p min, it will be updated to @p min. If it
17640 * is bigger then @p max, will be updated to @p max. Actual value can be
17641 * get with elm_slider_value_get().
17643 * By default, min is equal to 0.0, and max is equal to 1.0.
17645 * @warning Maximum must be greater than minimum, otherwise behavior
17648 * @see elm_slider_min_max_get()
17652 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17655 * Get the minimum and maximum values of the slider.
17657 * @param obj The slider object.
17658 * @param min Pointer where to store the minimum value.
17659 * @param max Pointer where to store the maximum value.
17661 * @note If only one value is needed, the other pointer can be passed
17664 * @see elm_slider_min_max_set() for details.
17668 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17671 * Set the value the slider displays.
17673 * @param obj The slider object.
17674 * @param val The value to be displayed.
17676 * Value will be presented on the unit label following format specified with
17677 * elm_slider_unit_format_set() and on indicator with
17678 * elm_slider_indicator_format_set().
17680 * @warning The value must to be between min and max values. This values
17681 * are set by elm_slider_min_max_set().
17683 * @see elm_slider_value_get()
17684 * @see elm_slider_unit_format_set()
17685 * @see elm_slider_indicator_format_set()
17686 * @see elm_slider_min_max_set()
17690 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17693 * Get the value displayed by the spinner.
17695 * @param obj The spinner object.
17696 * @return The value displayed.
17698 * @see elm_spinner_value_set() for details.
17702 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17705 * Invert a given slider widget's displaying values order
17707 * @param obj The slider object.
17708 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17709 * @c EINA_FALSE to bring it back to default, non-inverted values.
17711 * A slider may be @b inverted, in which state it gets its
17712 * values inverted, with high vales being on the left or top and
17713 * low values on the right or bottom, as opposed to normally have
17714 * the low values on the former and high values on the latter,
17715 * respectively, for horizontal and vertical modes.
17717 * @see elm_slider_inverted_get()
17721 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17724 * Get whether a given slider widget's displaying values are
17727 * @param obj The slider object.
17728 * @return @c EINA_TRUE, if @p obj has inverted values,
17729 * @c EINA_FALSE otherwise (and on errors).
17731 * @see elm_slider_inverted_set() for more details.
17735 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17738 * Set whether to enlarge slider indicator (augmented knob) or not.
17740 * @param obj The slider object.
17741 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17742 * let the knob always at default size.
17744 * By default, indicator will be bigger while dragged by the user.
17746 * @warning It won't display values set with
17747 * elm_slider_indicator_format_set() if you disable indicator.
17751 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17754 * Get whether a given slider widget's enlarging indicator or not.
17756 * @param obj The slider object.
17757 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17758 * @c EINA_FALSE otherwise (and on errors).
17760 * @see elm_slider_indicator_show_set() for details.
17764 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17771 * @addtogroup Actionslider Actionslider
17773 * @image html img/widget/actionslider/preview-00.png
17774 * @image latex img/widget/actionslider/preview-00.eps
17776 * An actionslider is a switcher for 2 or 3 labels with customizable magnet
17777 * properties. The user drags and releases the indicator, to choose a label.
17779 * Labels occupy the following positions.
17784 * Positions can be enabled or disabled.
17786 * Magnets can be set on the above positions.
17788 * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
17790 * @note By default all positions are set as enabled.
17792 * Signals that you can add callbacks for are:
17794 * "selected" - when user selects an enabled position (the label is passed
17797 * "pos_changed" - when the indicator reaches any of the positions("left",
17798 * "right" or "center").
17800 * See an example of actionslider usage @ref actionslider_example_page "here"
17803 typedef enum _Elm_Actionslider_Pos
17805 ELM_ACTIONSLIDER_NONE = 0,
17806 ELM_ACTIONSLIDER_LEFT = 1 << 0,
17807 ELM_ACTIONSLIDER_CENTER = 1 << 1,
17808 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
17809 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
17810 } Elm_Actionslider_Pos;
17813 * Add a new actionslider to the parent.
17815 * @param parent The parent object
17816 * @return The new actionslider object or NULL if it cannot be created
17818 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17820 * Set actionslider labels.
17822 * @param obj The actionslider object
17823 * @param left_label The label to be set on the left.
17824 * @param center_label The label to be set on the center.
17825 * @param right_label The label to be set on the right.
17826 * @deprecated use elm_object_text_set() instead.
17828 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);
17830 * Get actionslider labels.
17832 * @param obj The actionslider object
17833 * @param left_label A char** to place the left_label of @p obj into.
17834 * @param center_label A char** to place the center_label of @p obj into.
17835 * @param right_label A char** to place the right_label of @p obj into.
17836 * @deprecated use elm_object_text_set() instead.
17838 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);
17840 * Get actionslider selected label.
17842 * @param obj The actionslider object
17843 * @return The selected label
17845 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17847 * Set actionslider indicator position.
17849 * @param obj The actionslider object.
17850 * @param pos The position of the indicator.
17852 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17854 * Get actionslider indicator position.
17856 * @param obj The actionslider object.
17857 * @return The position of the indicator.
17859 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17861 * Set actionslider magnet position. To make multiple positions magnets @c or
17862 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
17864 * @param obj The actionslider object.
17865 * @param pos Bit mask indicating the magnet positions.
17867 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17869 * Get actionslider magnet position.
17871 * @param obj The actionslider object.
17872 * @return The positions with magnet property.
17874 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17876 * Set actionslider enabled position. To set multiple positions as enabled @c or
17877 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
17879 * @note All the positions are enabled by default.
17881 * @param obj The actionslider object.
17882 * @param pos Bit mask indicating the enabled positions.
17884 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17886 * Get actionslider enabled position.
17888 * @param obj The actionslider object.
17889 * @return The enabled positions.
17891 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17893 * Set the label used on the indicator.
17895 * @param obj The actionslider object
17896 * @param label The label to be set on the indicator.
17897 * @deprecated use elm_object_text_set() instead.
17899 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17901 * Get the label used on the indicator object.
17903 * @param obj The actionslider object
17904 * @return The indicator label
17905 * @deprecated use elm_object_text_get() instead.
17907 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
17913 * @defgroup Genlist Genlist
17915 * @image html img/widget/genlist/preview-00.png
17916 * @image latex img/widget/genlist/preview-00.eps
17917 * @image html img/genlist.png
17918 * @image latex img/genlist.eps
17920 * This widget aims to have more expansive list than the simple list in
17921 * Elementary that could have more flexible items and allow many more entries
17922 * while still being fast and low on memory usage. At the same time it was
17923 * also made to be able to do tree structures. But the price to pay is more
17924 * complexity when it comes to usage. If all you want is a simple list with
17925 * icons and a single label, use the normal @ref List object.
17927 * Genlist has a fairly large API, mostly because it's relatively complex,
17928 * trying to be both expansive, powerful and efficient. First we will begin
17929 * an overview on the theory behind genlist.
17931 * @section Genlist_Item_Class Genlist item classes - creating items
17933 * In order to have the ability to add and delete items on the fly, genlist
17934 * implements a class (callback) system where the application provides a
17935 * structure with information about that type of item (genlist may contain
17936 * multiple different items with different classes, states and styles).
17937 * Genlist will call the functions in this struct (methods) when an item is
17938 * "realized" (i.e., created dynamically, while the user is scrolling the
17939 * grid). All objects will simply be deleted when no longer needed with
17940 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
17941 * following members:
17942 * - @c item_style - This is a constant string and simply defines the name
17943 * of the item style. It @b must be specified and the default should be @c
17946 * - @c func - A struct with pointers to functions that will be called when
17947 * an item is going to be actually created. All of them receive a @c data
17948 * parameter that will point to the same data passed to
17949 * elm_genlist_item_append() and related item creation functions, and a @c
17950 * obj parameter that points to the genlist object itself.
17952 * The function pointers inside @c func are @c label_get, @c icon_get, @c
17953 * state_get and @c del. The 3 first functions also receive a @c part
17954 * parameter described below. A brief description of these functions follows:
17956 * - @c label_get - The @c part parameter is the name string of one of the
17957 * existing text parts in the Edje group implementing the item's theme.
17958 * This function @b must return a strdup'()ed string, as the caller will
17959 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
17960 * - @c content_get - The @c part parameter is the name string of one of the
17961 * existing (content) swallow parts in the Edje group implementing the item's
17962 * theme. It must return @c NULL, when no content is desired, or a valid
17963 * object handle, otherwise. The object will be deleted by the genlist on
17964 * its deletion or when the item is "unrealized". See
17965 * #Elm_Genlist_Item_Icon_Get_Cb.
17966 * - @c func.state_get - The @c part parameter is the name string of one of
17967 * the state parts in the Edje group implementing the item's theme. Return
17968 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
17969 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
17970 * and @c "elm" as "emission" and "source" arguments, respectively, when
17971 * the state is true (the default is false), where @c XXX is the name of
17972 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
17973 * - @c func.del - This is intended for use when genlist items are deleted,
17974 * so any data attached to the item (e.g. its data parameter on creation)
17975 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
17977 * available item styles:
17979 * - default_style - The text part is a textblock
17981 * @image html img/widget/genlist/preview-04.png
17982 * @image latex img/widget/genlist/preview-04.eps
17986 * @image html img/widget/genlist/preview-01.png
17987 * @image latex img/widget/genlist/preview-01.eps
17989 * - icon_top_text_bottom
17991 * @image html img/widget/genlist/preview-02.png
17992 * @image latex img/widget/genlist/preview-02.eps
17996 * @image html img/widget/genlist/preview-03.png
17997 * @image latex img/widget/genlist/preview-03.eps
17999 * @section Genlist_Items Structure of items
18001 * An item in a genlist can have 0 or more text labels (they can be regular
18002 * text or textblock Evas objects - that's up to the style to determine), 0
18003 * or more contents (which are simply objects swallowed into the genlist item's
18004 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18005 * behavior left to the user to define. The Edje part names for each of
18006 * these properties will be looked up, in the theme file for the genlist,
18007 * under the Edje (string) data items named @c "labels", @c "contents" and @c
18008 * "states", respectively. For each of those properties, if more than one
18009 * part is provided, they must have names listed separated by spaces in the
18010 * data fields. For the default genlist item theme, we have @b one label
18011 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18012 * "elm.swallow.end") and @b no state parts.
18014 * A genlist item may be at one of several styles. Elementary provides one
18015 * by default - "default", but this can be extended by system or application
18016 * custom themes/overlays/extensions (see @ref Theme "themes" for more
18019 * @section Genlist_Manipulation Editing and Navigating
18021 * Items can be added by several calls. All of them return a @ref
18022 * Elm_Genlist_Item handle that is an internal member inside the genlist.
18023 * They all take a data parameter that is meant to be used for a handle to
18024 * the applications internal data (eg the struct with the original item
18025 * data). The parent parameter is the parent genlist item this belongs to if
18026 * it is a tree or an indexed group, and NULL if there is no parent. The
18027 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18028 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18029 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18030 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
18031 * is set then this item is group index item that is displayed at the top
18032 * until the next group comes. The func parameter is a convenience callback
18033 * that is called when the item is selected and the data parameter will be
18034 * the func_data parameter, obj be the genlist object and event_info will be
18035 * the genlist item.
18037 * elm_genlist_item_append() adds an item to the end of the list, or if
18038 * there is a parent, to the end of all the child items of the parent.
18039 * elm_genlist_item_prepend() is the same but adds to the beginning of
18040 * the list or children list. elm_genlist_item_insert_before() inserts at
18041 * item before another item and elm_genlist_item_insert_after() inserts after
18042 * the indicated item.
18044 * The application can clear the list with elm_genlist_clear() which deletes
18045 * all the items in the list and elm_genlist_item_del() will delete a specific
18046 * item. elm_genlist_item_subitems_clear() will clear all items that are
18047 * children of the indicated parent item.
18049 * To help inspect list items you can jump to the item at the top of the list
18050 * with elm_genlist_first_item_get() which will return the item pointer, and
18051 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18052 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18053 * and previous items respectively relative to the indicated item. Using
18054 * these calls you can walk the entire item list/tree. Note that as a tree
18055 * the items are flattened in the list, so elm_genlist_item_parent_get() will
18056 * let you know which item is the parent (and thus know how to skip them if
18059 * @section Genlist_Muti_Selection Multi-selection
18061 * If the application wants multiple items to be able to be selected,
18062 * elm_genlist_multi_select_set() can enable this. If the list is
18063 * single-selection only (the default), then elm_genlist_selected_item_get()
18064 * will return the selected item, if any, or NULL I none is selected. If the
18065 * list is multi-select then elm_genlist_selected_items_get() will return a
18066 * list (that is only valid as long as no items are modified (added, deleted,
18067 * selected or unselected)).
18069 * @section Genlist_Usage_Hints Usage hints
18071 * There are also convenience functions. elm_genlist_item_genlist_get() will
18072 * return the genlist object the item belongs to. elm_genlist_item_show()
18073 * will make the scroller scroll to show that specific item so its visible.
18074 * elm_genlist_item_data_get() returns the data pointer set by the item
18075 * creation functions.
18077 * If an item changes (state of boolean changes, label or contents change),
18078 * then use elm_genlist_item_update() to have genlist update the item with
18079 * the new state. Genlist will re-realize the item thus call the functions
18080 * in the _Elm_Genlist_Item_Class for that item.
18082 * To programmatically (un)select an item use elm_genlist_item_selected_set().
18083 * To get its selected state use elm_genlist_item_selected_get(). Similarly
18084 * to expand/contract an item and get its expanded state, use
18085 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18086 * again to make an item disabled (unable to be selected and appear
18087 * differently) use elm_genlist_item_disabled_set() to set this and
18088 * elm_genlist_item_disabled_get() to get the disabled state.
18090 * In general to indicate how the genlist should expand items horizontally to
18091 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18092 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18093 * mode means that if items are too wide to fit, the scroller will scroll
18094 * horizontally. Otherwise items are expanded to fill the width of the
18095 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18096 * to the viewport width and limited to that size. This can be combined with
18097 * a different style that uses edjes' ellipsis feature (cutting text off like
18100 * Items will only call their selection func and callback when first becoming
18101 * selected. Any further clicks will do nothing, unless you enable always
18102 * select with elm_genlist_always_select_mode_set(). This means even if
18103 * selected, every click will make the selected callbacks be called.
18104 * elm_genlist_no_select_mode_set() will turn off the ability to select
18105 * items entirely and they will neither appear selected nor call selected
18106 * callback functions.
18108 * Remember that you can create new styles and add your own theme augmentation
18109 * per application with elm_theme_extension_add(). If you absolutely must
18110 * have a specific style that overrides any theme the user or system sets up
18111 * you can use elm_theme_overlay_add() to add such a file.
18113 * @section Genlist_Implementation Implementation
18115 * Evas tracks every object you create. Every time it processes an event
18116 * (mouse move, down, up etc.) it needs to walk through objects and find out
18117 * what event that affects. Even worse every time it renders display updates,
18118 * in order to just calculate what to re-draw, it needs to walk through many
18119 * many many objects. Thus, the more objects you keep active, the more
18120 * overhead Evas has in just doing its work. It is advisable to keep your
18121 * active objects to the minimum working set you need. Also remember that
18122 * object creation and deletion carries an overhead, so there is a
18123 * middle-ground, which is not easily determined. But don't keep massive lists
18124 * of objects you can't see or use. Genlist does this with list objects. It
18125 * creates and destroys them dynamically as you scroll around. It groups them
18126 * into blocks so it can determine the visibility etc. of a whole block at
18127 * once as opposed to having to walk the whole list. This 2-level list allows
18128 * for very large numbers of items to be in the list (tests have used up to
18129 * 2,000,000 items). Also genlist employs a queue for adding items. As items
18130 * may be different sizes, every item added needs to be calculated as to its
18131 * size and thus this presents a lot of overhead on populating the list, this
18132 * genlist employs a queue. Any item added is queued and spooled off over
18133 * time, actually appearing some time later, so if your list has many members
18134 * you may find it takes a while for them to all appear, with your process
18135 * consuming a lot of CPU while it is busy spooling.
18137 * Genlist also implements a tree structure, but it does so with callbacks to
18138 * the application, with the application filling in tree structures when
18139 * requested (allowing for efficient building of a very deep tree that could
18140 * even be used for file-management). See the above smart signal callbacks for
18143 * @section Genlist_Smart_Events Genlist smart events
18145 * Signals that you can add callbacks for are:
18146 * - @c "activated" - The user has double-clicked or pressed
18147 * (enter|return|spacebar) on an item. The @c event_info parameter is the
18148 * item that was activated.
18149 * - @c "clicked,double" - The user has double-clicked an item. The @c
18150 * event_info parameter is the item that was double-clicked.
18151 * - @c "selected" - This is called when a user has made an item selected.
18152 * The event_info parameter is the genlist item that was selected.
18153 * - @c "unselected" - This is called when a user has made an item
18154 * unselected. The event_info parameter is the genlist item that was
18156 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18157 * called and the item is now meant to be expanded. The event_info
18158 * parameter is the genlist item that was indicated to expand. It is the
18159 * job of this callback to then fill in the child items.
18160 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18161 * called and the item is now meant to be contracted. The event_info
18162 * parameter is the genlist item that was indicated to contract. It is the
18163 * job of this callback to then delete the child items.
18164 * - @c "expand,request" - This is called when a user has indicated they want
18165 * to expand a tree branch item. The callback should decide if the item can
18166 * expand (has any children) and then call elm_genlist_item_expanded_set()
18167 * appropriately to set the state. The event_info parameter is the genlist
18168 * item that was indicated to expand.
18169 * - @c "contract,request" - This is called when a user has indicated they
18170 * want to contract a tree branch item. The callback should decide if the
18171 * item can contract (has any children) and then call
18172 * elm_genlist_item_expanded_set() appropriately to set the state. The
18173 * event_info parameter is the genlist item that was indicated to contract.
18174 * - @c "realized" - This is called when the item in the list is created as a
18175 * real evas object. event_info parameter is the genlist item that was
18176 * created. The object may be deleted at any time, so it is up to the
18177 * caller to not use the object pointer from elm_genlist_item_object_get()
18178 * in a way where it may point to freed objects.
18179 * - @c "unrealized" - This is called just before an item is unrealized.
18180 * After this call content objects provided will be deleted and the item
18181 * object itself delete or be put into a floating cache.
18182 * - @c "drag,start,up" - This is called when the item in the list has been
18183 * dragged (not scrolled) up.
18184 * - @c "drag,start,down" - This is called when the item in the list has been
18185 * dragged (not scrolled) down.
18186 * - @c "drag,start,left" - This is called when the item in the list has been
18187 * dragged (not scrolled) left.
18188 * - @c "drag,start,right" - This is called when the item in the list has
18189 * been dragged (not scrolled) right.
18190 * - @c "drag,stop" - This is called when the item in the list has stopped
18192 * - @c "drag" - This is called when the item in the list is being dragged.
18193 * - @c "longpressed" - This is called when the item is pressed for a certain
18194 * amount of time. By default it's 1 second.
18195 * - @c "scroll,anim,start" - This is called when scrolling animation has
18197 * - @c "scroll,anim,stop" - This is called when scrolling animation has
18199 * - @c "scroll,drag,start" - This is called when dragging the content has
18201 * - @c "scroll,drag,stop" - This is called when dragging the content has
18203 * - @c "edge,top" - This is called when the genlist is scrolled until
18205 * - @c "edge,bottom" - This is called when the genlist is scrolled
18206 * until the bottom edge.
18207 * - @c "edge,left" - This is called when the genlist is scrolled
18208 * until the left edge.
18209 * - @c "edge,right" - This is called when the genlist is scrolled
18210 * until the right edge.
18211 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18213 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18215 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18217 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18219 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18220 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
18221 * multi-touch pinched in.
18222 * - @c "swipe" - This is called when the genlist is swiped.
18223 * - @c "moved" - This is called when a genlist item is moved.
18224 * - @c "language,changed" - This is called when the program's language is
18227 * @section Genlist_Examples Examples
18229 * Here is a list of examples that use the genlist, trying to show some of
18230 * its capabilities:
18231 * - @ref genlist_example_01
18232 * - @ref genlist_example_02
18233 * - @ref genlist_example_03
18234 * - @ref genlist_example_04
18235 * - @ref genlist_example_05
18239 * @addtogroup Genlist
18244 * @enum _Elm_Genlist_Item_Flags
18245 * @typedef Elm_Genlist_Item_Flags
18247 * Defines if the item is of any special type (has subitems or it's the
18248 * index of a group), or is just a simple item.
18252 typedef enum _Elm_Genlist_Item_Flags
18254 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18255 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18256 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18257 } Elm_Genlist_Item_Flags;
18258 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
18259 #define Elm_Genlist_Item_Class Elm_Gen_Item_Class
18260 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18261 #define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18262 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
18263 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
18264 typedef Evas_Object *(*Elm_Genlist_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Content (swallowed object) fetching class function for genlist item classes. */
18265 typedef Eina_Bool (*Elm_Genlist_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for genlist item classes. */
18266 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
18269 * @struct _Elm_Genlist_Item_Class
18271 * Genlist item class definition structs.
18273 * This struct contains the style and fetching functions that will define the
18274 * contents of each item.
18276 * @see @ref Genlist_Item_Class
18278 struct _Elm_Genlist_Item_Class
18280 const char *item_style; /**< style of this class. */
18281 struct Elm_Genlist_Item_Class_Func
18283 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
18284 Elm_Genlist_Item_Content_Get_Cb content_get; /**< Content fetching class function for genlist item classes. */
18285 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
18286 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
18289 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18291 * Add a new genlist widget to the given parent Elementary
18292 * (container) object
18294 * @param parent The parent object
18295 * @return a new genlist widget handle or @c NULL, on errors
18297 * This function inserts a new genlist widget on the canvas.
18299 * @see elm_genlist_item_append()
18300 * @see elm_genlist_item_del()
18301 * @see elm_genlist_clear()
18305 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18307 * Remove all items from a given genlist widget.
18309 * @param obj The genlist object
18311 * This removes (and deletes) all items in @p obj, leaving it empty.
18313 * @see elm_genlist_item_del(), to remove just one item.
18317 EINA_DEPRECATED EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18319 * Enable or disable multi-selection in the genlist
18321 * @param obj The genlist object
18322 * @param multi Multi-select enable/disable. Default is disabled.
18324 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18325 * the list. This allows more than 1 item to be selected. To retrieve the list
18326 * of selected items, use elm_genlist_selected_items_get().
18328 * @see elm_genlist_selected_items_get()
18329 * @see elm_genlist_multi_select_get()
18333 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18335 * Gets if multi-selection in genlist is enabled or disabled.
18337 * @param obj The genlist object
18338 * @return Multi-select enabled/disabled
18339 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18341 * @see elm_genlist_multi_select_set()
18345 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18347 * This sets the horizontal stretching mode.
18349 * @param obj The genlist object
18350 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18352 * This sets the mode used for sizing items horizontally. Valid modes
18353 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18354 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18355 * the scroller will scroll horizontally. Otherwise items are expanded
18356 * to fill the width of the viewport of the scroller. If it is
18357 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18358 * limited to that size.
18360 * @see elm_genlist_horizontal_get()
18364 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18365 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18367 * Gets the horizontal stretching mode.
18369 * @param obj The genlist object
18370 * @return The mode to use
18371 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18373 * @see elm_genlist_horizontal_set()
18377 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18378 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18380 * Set the always select mode.
18382 * @param obj The genlist object
18383 * @param always_select The always select mode (@c EINA_TRUE = on, @c
18384 * EINA_FALSE = off). Default is @c EINA_FALSE.
18386 * Items will only call their selection func and callback when first
18387 * becoming selected. Any further clicks will do nothing, unless you
18388 * enable always select with elm_genlist_always_select_mode_set().
18389 * This means that, even if selected, every click will make the selected
18390 * callbacks be called.
18392 * @see elm_genlist_always_select_mode_get()
18396 EINA_DEPRECATED EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18398 * Get the always select mode.
18400 * @param obj The genlist object
18401 * @return The always select mode
18402 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18404 * @see elm_genlist_always_select_mode_set()
18408 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18410 * Enable/disable the no select mode.
18412 * @param obj The genlist object
18413 * @param no_select The no select mode
18414 * (EINA_TRUE = on, EINA_FALSE = off)
18416 * This will turn off the ability to select items entirely and they
18417 * will neither appear selected nor call selected callback functions.
18419 * @see elm_genlist_no_select_mode_get()
18423 EINA_DEPRECATED EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18425 * Gets whether the no select mode is enabled.
18427 * @param obj The genlist object
18428 * @return The no select mode
18429 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18431 * @see elm_genlist_no_select_mode_set()
18435 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18437 * Enable/disable compress mode.
18439 * @param obj The genlist object
18440 * @param compress The compress mode
18441 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18443 * This will enable the compress mode where items are "compressed"
18444 * horizontally to fit the genlist scrollable viewport width. This is
18445 * special for genlist. Do not rely on
18446 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18447 * work as genlist needs to handle it specially.
18449 * @see elm_genlist_compress_mode_get()
18453 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18455 * Get whether the compress mode is enabled.
18457 * @param obj The genlist object
18458 * @return The compress mode
18459 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18461 * @see elm_genlist_compress_mode_set()
18465 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18467 * Enable/disable height-for-width mode.
18469 * @param obj The genlist object
18470 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18471 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18473 * With height-for-width mode the item width will be fixed (restricted
18474 * to a minimum of) to the list width when calculating its size in
18475 * order to allow the height to be calculated based on it. This allows,
18476 * for instance, text block to wrap lines if the Edje part is
18477 * configured with "text.min: 0 1".
18479 * @note This mode will make list resize slower as it will have to
18480 * recalculate every item height again whenever the list width
18483 * @note When height-for-width mode is enabled, it also enables
18484 * compress mode (see elm_genlist_compress_mode_set()) and
18485 * disables homogeneous (see elm_genlist_homogeneous_set()).
18489 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18491 * Get whether the height-for-width mode is enabled.
18493 * @param obj The genlist object
18494 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18499 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18501 * Enable/disable horizontal and vertical bouncing effect.
18503 * @param obj The genlist object
18504 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18505 * EINA_FALSE = off). Default is @c EINA_FALSE.
18506 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18507 * EINA_FALSE = off). Default is @c EINA_TRUE.
18509 * This will enable or disable the scroller bouncing effect for the
18510 * genlist. See elm_scroller_bounce_set() for details.
18512 * @see elm_scroller_bounce_set()
18513 * @see elm_genlist_bounce_get()
18517 EINA_DEPRECATED EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18519 * Get whether the horizontal and vertical bouncing effect is enabled.
18521 * @param obj The genlist object
18522 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18524 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18527 * @see elm_genlist_bounce_set()
18531 EINA_DEPRECATED EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18533 * Enable/disable homogenous mode.
18535 * @param obj The genlist object
18536 * @param homogeneous Assume the items within the genlist are of the
18537 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18540 * This will enable the homogeneous mode where items are of the same
18541 * height and width so that genlist may do the lazy-loading at its
18542 * maximum (which increases the performance for scrolling the list). This
18543 * implies 'compressed' mode.
18545 * @see elm_genlist_compress_mode_set()
18546 * @see elm_genlist_homogeneous_get()
18550 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18552 * Get whether the homogenous mode is enabled.
18554 * @param obj The genlist object
18555 * @return Assume the items within the genlist are of the same height
18556 * and width (EINA_TRUE = on, EINA_FALSE = off)
18558 * @see elm_genlist_homogeneous_set()
18562 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18564 * Set the maximum number of items within an item block
18566 * @param obj The genlist object
18567 * @param n Maximum number of items within an item block. Default is 32.
18569 * This will configure the block count to tune to the target with
18570 * particular performance matrix.
18572 * A block of objects will be used to reduce the number of operations due to
18573 * many objects in the screen. It can determine the visibility, or if the
18574 * object has changed, it theme needs to be updated, etc. doing this kind of
18575 * calculation to the entire block, instead of per object.
18577 * The default value for the block count is enough for most lists, so unless
18578 * you know you will have a lot of objects visible in the screen at the same
18579 * time, don't try to change this.
18581 * @see elm_genlist_block_count_get()
18582 * @see @ref Genlist_Implementation
18586 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18588 * Get the maximum number of items within an item block
18590 * @param obj The genlist object
18591 * @return Maximum number of items within an item block
18593 * @see elm_genlist_block_count_set()
18597 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18599 * Set the timeout in seconds for the longpress event.
18601 * @param obj The genlist object
18602 * @param timeout timeout in seconds. Default is 1.
18604 * This option will change how long it takes to send an event "longpressed"
18605 * after the mouse down signal is sent to the list. If this event occurs, no
18606 * "clicked" event will be sent.
18608 * @see elm_genlist_longpress_timeout_set()
18612 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18614 * Get the timeout in seconds for the longpress event.
18616 * @param obj The genlist object
18617 * @return timeout in seconds
18619 * @see elm_genlist_longpress_timeout_get()
18623 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18625 * Append a new item in a given genlist widget.
18627 * @param obj The genlist object
18628 * @param itc The item class for the item
18629 * @param data The item data
18630 * @param parent The parent item, or NULL if none
18631 * @param flags Item flags
18632 * @param func Convenience function called when the item is selected
18633 * @param func_data Data passed to @p func above.
18634 * @return A handle to the item added or @c NULL if not possible
18636 * This adds the given item to the end of the list or the end of
18637 * the children list if the @p parent is given.
18639 * @see elm_genlist_item_prepend()
18640 * @see elm_genlist_item_insert_before()
18641 * @see elm_genlist_item_insert_after()
18642 * @see elm_genlist_item_del()
18646 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);
18648 * Prepend a new item in a given genlist widget.
18650 * @param obj The genlist object
18651 * @param itc The item class for the item
18652 * @param data The item data
18653 * @param parent The parent item, or NULL if none
18654 * @param flags Item flags
18655 * @param func Convenience function called when the item is selected
18656 * @param func_data Data passed to @p func above.
18657 * @return A handle to the item added or NULL if not possible
18659 * This adds an item to the beginning of the list or beginning of the
18660 * children of the parent if given.
18662 * @see elm_genlist_item_append()
18663 * @see elm_genlist_item_insert_before()
18664 * @see elm_genlist_item_insert_after()
18665 * @see elm_genlist_item_del()
18669 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);
18671 * Insert an item before another in a genlist widget
18673 * @param obj The genlist object
18674 * @param itc The item class for the item
18675 * @param data The item data
18676 * @param before The item to place this new one before.
18677 * @param flags Item flags
18678 * @param func Convenience function called when the item is selected
18679 * @param func_data Data passed to @p func above.
18680 * @return A handle to the item added or @c NULL if not possible
18682 * This inserts an item before another in the list. It will be in the
18683 * same tree level or group as the item it is inserted before.
18685 * @see elm_genlist_item_append()
18686 * @see elm_genlist_item_prepend()
18687 * @see elm_genlist_item_insert_after()
18688 * @see elm_genlist_item_del()
18692 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);
18694 * Insert an item after another in a genlist widget
18696 * @param obj The genlist object
18697 * @param itc The item class for the item
18698 * @param data The item data
18699 * @param after The item to place this new one after.
18700 * @param flags Item flags
18701 * @param func Convenience function called when the item is selected
18702 * @param func_data Data passed to @p func above.
18703 * @return A handle to the item added or @c NULL if not possible
18705 * This inserts an item after another in the list. It will be in the
18706 * same tree level or group as the item it is inserted after.
18708 * @see elm_genlist_item_append()
18709 * @see elm_genlist_item_prepend()
18710 * @see elm_genlist_item_insert_before()
18711 * @see elm_genlist_item_del()
18715 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);
18717 * Insert a new item into the sorted genlist object
18719 * @param obj The genlist object
18720 * @param itc The item class for the item
18721 * @param data The item data
18722 * @param parent The parent item, or NULL if none
18723 * @param flags Item flags
18724 * @param comp The function called for the sort
18725 * @param func Convenience function called when item selected
18726 * @param func_data Data passed to @p func above.
18727 * @return A handle to the item added or NULL if not possible
18731 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);
18732 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);
18733 /* operations to retrieve existing items */
18735 * Get the selectd item in the genlist.
18737 * @param obj The genlist object
18738 * @return The selected item, or NULL if none is selected.
18740 * This gets the selected item in the list (if multi-selection is enabled, only
18741 * the item that was first selected in the list is returned - which is not very
18742 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18745 * If no item is selected, NULL is returned.
18747 * @see elm_genlist_selected_items_get()
18751 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18753 * Get a list of selected items in the genlist.
18755 * @param obj The genlist object
18756 * @return The list of selected items, or NULL if none are selected.
18758 * It returns a list of the selected items. This list pointer is only valid so
18759 * long as the selection doesn't change (no items are selected or unselected, or
18760 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18761 * pointers. The order of the items in this list is the order which they were
18762 * selected, i.e. the first item in this list is the first item that was
18763 * selected, and so on.
18765 * @note If not in multi-select mode, consider using function
18766 * elm_genlist_selected_item_get() instead.
18768 * @see elm_genlist_multi_select_set()
18769 * @see elm_genlist_selected_item_get()
18773 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18775 * Get the mode item style of items in the genlist
18776 * @param obj The genlist object
18777 * @return The mode item style string, or NULL if none is specified
18779 * This is a constant string and simply defines the name of the
18780 * style that will be used for mode animations. It can be
18781 * @c NULL if you don't plan to use Genlist mode. See
18782 * elm_genlist_item_mode_set() for more info.
18786 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18788 * Set the mode item style of items in the genlist
18789 * @param obj The genlist object
18790 * @param style The mode item style string, or NULL if none is desired
18792 * This is a constant string and simply defines the name of the
18793 * style that will be used for mode animations. It can be
18794 * @c NULL if you don't plan to use Genlist mode. See
18795 * elm_genlist_item_mode_set() for more info.
18799 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
18801 * Get a list of realized items in genlist
18803 * @param obj The genlist object
18804 * @return The list of realized items, nor NULL if none are realized.
18806 * This returns a list of the realized items in the genlist. The list
18807 * contains Elm_Genlist_Item pointers. The list must be freed by the
18808 * caller when done with eina_list_free(). The item pointers in the
18809 * list are only valid so long as those items are not deleted or the
18810 * genlist is not deleted.
18812 * @see elm_genlist_realized_items_update()
18816 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18818 * Get the item that is at the x, y canvas coords.
18820 * @param obj The gelinst object.
18821 * @param x The input x coordinate
18822 * @param y The input y coordinate
18823 * @param posret The position relative to the item returned here
18824 * @return The item at the coordinates or NULL if none
18826 * This returns the item at the given coordinates (which are canvas
18827 * relative, not object-relative). If an item is at that coordinate,
18828 * that item handle is returned, and if @p posret is not NULL, the
18829 * integer pointed to is set to a value of -1, 0 or 1, depending if
18830 * the coordinate is on the upper portion of that item (-1), on the
18831 * middle section (0) or on the lower part (1). If NULL is returned as
18832 * an item (no item found there), then posret may indicate -1 or 1
18833 * based if the coordinate is above or below all items respectively in
18838 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);
18840 * Get the first item in the genlist
18842 * This returns the first item in the list.
18844 * @param obj The genlist object
18845 * @return The first item, or NULL if none
18849 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18851 * Get the last item in the genlist
18853 * This returns the last item in the list.
18855 * @return The last item, or NULL if none
18859 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18861 * Set the scrollbar policy
18863 * @param obj The genlist object
18864 * @param policy_h Horizontal scrollbar policy.
18865 * @param policy_v Vertical scrollbar policy.
18867 * This sets the scrollbar visibility policy for the given genlist
18868 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
18869 * made visible if it is needed, and otherwise kept hidden.
18870 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
18871 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
18872 * respectively for the horizontal and vertical scrollbars. Default is
18873 * #ELM_SMART_SCROLLER_POLICY_AUTO
18875 * @see elm_genlist_scroller_policy_get()
18879 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
18881 * Get the scrollbar policy
18883 * @param obj The genlist object
18884 * @param policy_h Pointer to store the horizontal scrollbar policy.
18885 * @param policy_v Pointer to store the vertical scrollbar policy.
18887 * @see elm_genlist_scroller_policy_set()
18891 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);
18893 * Get the @b next item in a genlist widget's internal list of items,
18894 * given a handle to one of those items.
18896 * @param item The genlist item to fetch next from
18897 * @return The item after @p item, or @c NULL if there's none (and
18900 * This returns the item placed after the @p item, on the container
18903 * @see elm_genlist_item_prev_get()
18907 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18909 * Get the @b previous item in a genlist widget's internal list of items,
18910 * given a handle to one of those items.
18912 * @param item The genlist item to fetch previous from
18913 * @return The item before @p item, or @c NULL if there's none (and
18916 * This returns the item placed before the @p item, on the container
18919 * @see elm_genlist_item_next_get()
18923 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18925 * Get the genlist object's handle which contains a given genlist
18928 * @param item The item to fetch the container from
18929 * @return The genlist (parent) object
18931 * This returns the genlist object itself that an item belongs to.
18935 EINA_DEPRECATED EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18937 * Get the parent item of the given item
18939 * @param it The item
18940 * @return The parent of the item or @c NULL if it has no parent.
18942 * This returns the item that was specified as parent of the item @p it on
18943 * elm_genlist_item_append() and insertion related functions.
18947 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18949 * Remove all sub-items (children) of the given item
18951 * @param it The item
18953 * This removes all items that are children (and their descendants) of the
18954 * given item @p it.
18956 * @see elm_genlist_clear()
18957 * @see elm_genlist_item_del()
18961 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18963 * Set whether a given genlist item is selected or not
18965 * @param it The item
18966 * @param selected Use @c EINA_TRUE, to make it selected, @c
18967 * EINA_FALSE to make it unselected
18969 * This sets the selected state of an item. If multi selection is
18970 * not enabled on the containing genlist and @p selected is @c
18971 * EINA_TRUE, any other previously selected items will get
18972 * unselected in favor of this new one.
18974 * @see elm_genlist_item_selected_get()
18978 EINA_DEPRECATED EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
18980 * Get whether a given genlist item is selected or not
18982 * @param it The item
18983 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
18985 * @see elm_genlist_item_selected_set() for more details
18989 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18991 * Sets the expanded state of an item.
18993 * @param it The item
18994 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
18996 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
18999 * The theme will respond to this change visually, and a signal "expanded" or
19000 * "contracted" will be sent from the genlist with a pointer to the item that
19001 * has been expanded/contracted.
19003 * Calling this function won't show or hide any child of this item (if it is
19004 * a parent). You must manually delete and create them on the callbacks fo
19005 * the "expanded" or "contracted" signals.
19007 * @see elm_genlist_item_expanded_get()
19011 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19013 * Get the expanded state of an item
19015 * @param it The item
19016 * @return The expanded state
19018 * This gets the expanded state of an item.
19020 * @see elm_genlist_item_expanded_set()
19024 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19026 * Get the depth of expanded item
19028 * @param it The genlist item object
19029 * @return The depth of expanded item
19033 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19035 * Set whether a given genlist item is disabled or not.
19037 * @param it The item
19038 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19039 * to enable it back.
19041 * A disabled item cannot be selected or unselected. It will also
19042 * change its appearance, to signal the user it's disabled.
19044 * @see elm_genlist_item_disabled_get()
19048 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19050 * Get whether a given genlist item is disabled or not.
19052 * @param it The item
19053 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19056 * @see elm_genlist_item_disabled_set() for more details
19060 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19062 * Sets the display only state of an item.
19064 * @param it The item
19065 * @param display_only @c EINA_TRUE if the item is display only, @c
19066 * EINA_FALSE otherwise.
19068 * A display only item cannot be selected or unselected. It is for
19069 * display only and not selecting or otherwise clicking, dragging
19070 * etc. by the user, thus finger size rules will not be applied to
19073 * It's good to set group index items to display only state.
19075 * @see elm_genlist_item_display_only_get()
19079 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19081 * Get the display only state of an item
19083 * @param it The item
19084 * @return @c EINA_TRUE if the item is display only, @c
19085 * EINA_FALSE otherwise.
19087 * @see elm_genlist_item_display_only_set()
19091 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19093 * Show the portion of a genlist's internal list containing a given
19094 * item, immediately.
19096 * @param it The item to display
19098 * This causes genlist to jump to the given item @p it and show it (by
19099 * immediately scrolling to that position), if it is not fully visible.
19101 * @see elm_genlist_item_bring_in()
19102 * @see elm_genlist_item_top_show()
19103 * @see elm_genlist_item_middle_show()
19107 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19109 * Animatedly bring in, to the visible are of a genlist, a given
19112 * @param it The item to display
19114 * This causes genlist to jump to the given item @p it and show it (by
19115 * animatedly scrolling), if it is not fully visible. This may use animation
19116 * to do so and take a period of time
19118 * @see elm_genlist_item_show()
19119 * @see elm_genlist_item_top_bring_in()
19120 * @see elm_genlist_item_middle_bring_in()
19124 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19126 * Show the portion of a genlist's internal list containing a given
19127 * item, immediately.
19129 * @param it The item to display
19131 * This causes genlist to jump to the given item @p it and show it (by
19132 * immediately scrolling to that position), if it is not fully visible.
19134 * The item will be positioned at the top of the genlist viewport.
19136 * @see elm_genlist_item_show()
19137 * @see elm_genlist_item_top_bring_in()
19141 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19143 * Animatedly bring in, to the visible are of a genlist, a given
19146 * @param it The item
19148 * This causes genlist to jump to the given item @p it and show it (by
19149 * animatedly scrolling), if it is not fully visible. This may use animation
19150 * to do so and take a period of time
19152 * The item will be positioned at the top of the genlist viewport.
19154 * @see elm_genlist_item_bring_in()
19155 * @see elm_genlist_item_top_show()
19159 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19161 * Show the portion of a genlist's internal list containing a given
19162 * item, immediately.
19164 * @param it The item to display
19166 * This causes genlist to jump to the given item @p it and show it (by
19167 * immediately scrolling to that position), if it is not fully visible.
19169 * The item will be positioned at the middle of the genlist viewport.
19171 * @see elm_genlist_item_show()
19172 * @see elm_genlist_item_middle_bring_in()
19176 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19178 * Animatedly bring in, to the visible are of a genlist, a given
19181 * @param it The item
19183 * This causes genlist to jump to the given item @p it and show it (by
19184 * animatedly scrolling), if it is not fully visible. This may use animation
19185 * to do so and take a period of time
19187 * The item will be positioned at the middle of the genlist viewport.
19189 * @see elm_genlist_item_bring_in()
19190 * @see elm_genlist_item_middle_show()
19194 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19196 * Remove a genlist item from the its parent, deleting it.
19198 * @param item The item to be removed.
19199 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19201 * @see elm_genlist_clear(), to remove all items in a genlist at
19206 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19208 * Return the data associated to a given genlist item
19210 * @param item The genlist item.
19211 * @return the data associated to this item.
19213 * This returns the @c data value passed on the
19214 * elm_genlist_item_append() and related item addition calls.
19216 * @see elm_genlist_item_append()
19217 * @see elm_genlist_item_data_set()
19221 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19223 * Set the data associated to a given genlist item
19225 * @param item The genlist item
19226 * @param data The new data pointer to set on it
19228 * This @b overrides the @c data value passed on the
19229 * elm_genlist_item_append() and related item addition calls. This
19230 * function @b won't call elm_genlist_item_update() automatically,
19231 * so you'd issue it afterwards if you want to hove the item
19232 * updated to reflect the that new data.
19234 * @see elm_genlist_item_data_get()
19238 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19240 * Tells genlist to "orphan" icons fetchs by the item class
19242 * @param it The item
19244 * This instructs genlist to release references to icons in the item,
19245 * meaning that they will no longer be managed by genlist and are
19246 * floating "orphans" that can be re-used elsewhere if the user wants
19251 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19252 EINA_DEPRECATED EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19254 * Get the real Evas object created to implement the view of a
19255 * given genlist item
19257 * @param item The genlist item.
19258 * @return the Evas object implementing this item's view.
19260 * This returns the actual Evas object used to implement the
19261 * specified genlist item's view. This may be @c NULL, as it may
19262 * not have been created or may have been deleted, at any time, by
19263 * the genlist. <b>Do not modify this object</b> (move, resize,
19264 * show, hide, etc.), as the genlist is controlling it. This
19265 * function is for querying, emitting custom signals or hooking
19266 * lower level callbacks for events on that object. Do not delete
19267 * this object under any circumstances.
19269 * @see elm_genlist_item_data_get()
19273 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19275 * Update the contents of an item
19277 * @param it The item
19279 * This updates an item by calling all the item class functions again
19280 * to get the icons, labels and states. Use this when the original
19281 * item data has changed and the changes are desired to be reflected.
19283 * Use elm_genlist_realized_items_update() to update all already realized
19286 * @see elm_genlist_realized_items_update()
19290 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19292 * Update the item class of an item
19294 * @param it The item
19295 * @param itc The item class for the item
19297 * This sets another class fo the item, changing the way that it is
19298 * displayed. After changing the item class, elm_genlist_item_update() is
19299 * called on the item @p it.
19303 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19304 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19306 * Set the text to be shown in a given genlist item's tooltips.
19308 * @param item The genlist item
19309 * @param text The text to set in the content
19311 * This call will setup the text to be used as tooltip to that item
19312 * (analogous to elm_object_tooltip_text_set(), but being item
19313 * tooltips with higher precedence than object tooltips). It can
19314 * have only one tooltip at a time, so any previous tooltip data
19315 * will get removed.
19317 * In order to set an icon or something else as a tooltip, look at
19318 * elm_genlist_item_tooltip_content_cb_set().
19322 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19324 * Set the content to be shown in a given genlist item's tooltips
19326 * @param item The genlist item.
19327 * @param func The function returning the tooltip contents.
19328 * @param data What to provide to @a func as callback data/context.
19329 * @param del_cb Called when data is not needed anymore, either when
19330 * another callback replaces @p func, the tooltip is unset with
19331 * elm_genlist_item_tooltip_unset() or the owner @p item
19332 * dies. This callback receives as its first parameter the
19333 * given @p data, being @c event_info the item handle.
19335 * This call will setup the tooltip's contents to @p item
19336 * (analogous to elm_object_tooltip_content_cb_set(), but being
19337 * item tooltips with higher precedence than object tooltips). It
19338 * can have only one tooltip at a time, so any previous tooltip
19339 * content will get removed. @p func (with @p data) will be called
19340 * every time Elementary needs to show the tooltip and it should
19341 * return a valid Evas object, which will be fully managed by the
19342 * tooltip system, getting deleted when the tooltip is gone.
19344 * In order to set just a text as a tooltip, look at
19345 * elm_genlist_item_tooltip_text_set().
19349 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);
19351 * Unset a tooltip from a given genlist item
19353 * @param item genlist item to remove a previously set tooltip from.
19355 * This call removes any tooltip set on @p item. The callback
19356 * provided as @c del_cb to
19357 * elm_genlist_item_tooltip_content_cb_set() will be called to
19358 * notify it is not used anymore (and have resources cleaned, if
19361 * @see elm_genlist_item_tooltip_content_cb_set()
19365 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19367 * Set a different @b style for a given genlist item's tooltip.
19369 * @param item genlist item with tooltip set
19370 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19371 * "default", @c "transparent", etc)
19373 * Tooltips can have <b>alternate styles</b> to be displayed on,
19374 * which are defined by the theme set on Elementary. This function
19375 * works analogously as elm_object_tooltip_style_set(), but here
19376 * applied only to genlist item objects. The default style for
19377 * tooltips is @c "default".
19379 * @note before you set a style you should define a tooltip with
19380 * elm_genlist_item_tooltip_content_cb_set() or
19381 * elm_genlist_item_tooltip_text_set()
19383 * @see elm_genlist_item_tooltip_style_get()
19387 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19389 * Get the style set a given genlist item's tooltip.
19391 * @param item genlist item with tooltip already set on.
19392 * @return style the theme style in use, which defaults to
19393 * "default". If the object does not have a tooltip set,
19394 * then @c NULL is returned.
19396 * @see elm_genlist_item_tooltip_style_set() for more details
19400 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19402 * @brief Disable size restrictions on an object's tooltip
19403 * @param item The tooltip's anchor object
19404 * @param disable If EINA_TRUE, size restrictions are disabled
19405 * @return EINA_FALSE on failure, EINA_TRUE on success
19407 * This function allows a tooltip to expand beyond its parant window's canvas.
19408 * It will instead be limited only by the size of the display.
19410 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19412 * @brief Retrieve size restriction state of an object's tooltip
19413 * @param item The tooltip's anchor object
19414 * @return If EINA_TRUE, size restrictions are disabled
19416 * This function returns whether a tooltip is allowed to expand beyond
19417 * its parant window's canvas.
19418 * It will instead be limited only by the size of the display.
19420 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19422 * Set the type of mouse pointer/cursor decoration to be shown,
19423 * when the mouse pointer is over the given genlist widget item
19425 * @param item genlist item to customize cursor on
19426 * @param cursor the cursor type's name
19428 * This function works analogously as elm_object_cursor_set(), but
19429 * here the cursor's changing area is restricted to the item's
19430 * area, and not the whole widget's. Note that that item cursors
19431 * have precedence over widget cursors, so that a mouse over @p
19432 * item will always show cursor @p type.
19434 * If this function is called twice for an object, a previously set
19435 * cursor will be unset on the second call.
19437 * @see elm_object_cursor_set()
19438 * @see elm_genlist_item_cursor_get()
19439 * @see elm_genlist_item_cursor_unset()
19443 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19445 * Get the type of mouse pointer/cursor decoration set to be shown,
19446 * when the mouse pointer is over the given genlist widget item
19448 * @param item genlist item with custom cursor set
19449 * @return the cursor type's name or @c NULL, if no custom cursors
19450 * were set to @p item (and on errors)
19452 * @see elm_object_cursor_get()
19453 * @see elm_genlist_item_cursor_set() for more details
19454 * @see elm_genlist_item_cursor_unset()
19458 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19460 * Unset any custom mouse pointer/cursor decoration set to be
19461 * shown, when the mouse pointer is over the given genlist widget
19462 * item, thus making it show the @b default cursor again.
19464 * @param item a genlist item
19466 * Use this call to undo any custom settings on this item's cursor
19467 * decoration, bringing it back to defaults (no custom style set).
19469 * @see elm_object_cursor_unset()
19470 * @see elm_genlist_item_cursor_set() for more details
19474 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19476 * Set a different @b style for a given custom cursor set for a
19479 * @param item genlist item with custom cursor set
19480 * @param style the <b>theme style</b> to use (e.g. @c "default",
19481 * @c "transparent", etc)
19483 * This function only makes sense when one is using custom mouse
19484 * cursor decorations <b>defined in a theme file</b> , which can
19485 * have, given a cursor name/type, <b>alternate styles</b> on
19486 * it. It works analogously as elm_object_cursor_style_set(), but
19487 * here applied only to genlist item objects.
19489 * @warning Before you set a cursor style you should have defined a
19490 * custom cursor previously on the item, with
19491 * elm_genlist_item_cursor_set()
19493 * @see elm_genlist_item_cursor_engine_only_set()
19494 * @see elm_genlist_item_cursor_style_get()
19498 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19500 * Get the current @b style set for a given genlist item's custom
19503 * @param item genlist item with custom cursor set.
19504 * @return style the cursor style in use. If the object does not
19505 * have a cursor set, then @c NULL is returned.
19507 * @see elm_genlist_item_cursor_style_set() for more details
19511 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19513 * Set if the (custom) cursor for a given genlist item should be
19514 * searched in its theme, also, or should only rely on the
19515 * rendering engine.
19517 * @param item item with custom (custom) cursor already set on
19518 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19519 * only on those provided by the rendering engine, @c EINA_FALSE to
19520 * have them searched on the widget's theme, as well.
19522 * @note This call is of use only if you've set a custom cursor
19523 * for genlist items, with elm_genlist_item_cursor_set().
19525 * @note By default, cursors will only be looked for between those
19526 * provided by the rendering engine.
19530 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19532 * Get if the (custom) cursor for a given genlist item is being
19533 * searched in its theme, also, or is only relying on the rendering
19536 * @param item a genlist item
19537 * @return @c EINA_TRUE, if cursors are being looked for only on
19538 * those provided by the rendering engine, @c EINA_FALSE if they
19539 * are being searched on the widget's theme, as well.
19541 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19545 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19547 * Update the contents of all realized items.
19549 * @param obj The genlist object.
19551 * This updates all realized items by calling all the item class functions again
19552 * to get the icons, labels and states. Use this when the original
19553 * item data has changed and the changes are desired to be reflected.
19555 * To update just one item, use elm_genlist_item_update().
19557 * @see elm_genlist_realized_items_get()
19558 * @see elm_genlist_item_update()
19562 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19564 * Activate a genlist mode on an item
19566 * @param item The genlist item
19567 * @param mode Mode name
19568 * @param mode_set Boolean to define set or unset mode.
19570 * A genlist mode is a different way of selecting an item. Once a mode is
19571 * activated on an item, any other selected item is immediately unselected.
19572 * This feature provides an easy way of implementing a new kind of animation
19573 * for selecting an item, without having to entirely rewrite the item style
19574 * theme. However, the elm_genlist_selected_* API can't be used to get what
19575 * item is activate for a mode.
19577 * The current item style will still be used, but applying a genlist mode to
19578 * an item will select it using a different kind of animation.
19580 * The current active item for a mode can be found by
19581 * elm_genlist_mode_item_get().
19583 * The characteristics of genlist mode are:
19584 * - Only one mode can be active at any time, and for only one item.
19585 * - Genlist handles deactivating other items when one item is activated.
19586 * - A mode is defined in the genlist theme (edc), and more modes can easily
19588 * - A mode style and the genlist item style are different things. They
19589 * can be combined to provide a default style to the item, with some kind
19590 * of animation for that item when the mode is activated.
19592 * When a mode is activated on an item, a new view for that item is created.
19593 * The theme of this mode defines the animation that will be used to transit
19594 * the item from the old view to the new view. This second (new) view will be
19595 * active for that item while the mode is active on the item, and will be
19596 * destroyed after the mode is totally deactivated from that item.
19598 * @see elm_genlist_mode_get()
19599 * @see elm_genlist_mode_item_get()
19603 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19605 * Get the last (or current) genlist mode used.
19607 * @param obj The genlist object
19609 * This function just returns the name of the last used genlist mode. It will
19610 * be the current mode if it's still active.
19612 * @see elm_genlist_item_mode_set()
19613 * @see elm_genlist_mode_item_get()
19617 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19619 * Get active genlist mode item
19621 * @param obj The genlist object
19622 * @return The active item for that current mode. Or @c NULL if no item is
19623 * activated with any mode.
19625 * This function returns the item that was activated with a mode, by the
19626 * function elm_genlist_item_mode_set().
19628 * @see elm_genlist_item_mode_set()
19629 * @see elm_genlist_mode_get()
19633 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19638 * @param obj The genlist object
19639 * @param reorder_mode The reorder mode
19640 * (EINA_TRUE = on, EINA_FALSE = off)
19644 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19647 * Get the reorder mode
19649 * @param obj The genlist object
19650 * @return The reorder mode
19651 * (EINA_TRUE = on, EINA_FALSE = off)
19655 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19662 * @defgroup Check Check
19664 * @image html img/widget/check/preview-00.png
19665 * @image latex img/widget/check/preview-00.eps
19666 * @image html img/widget/check/preview-01.png
19667 * @image latex img/widget/check/preview-01.eps
19668 * @image html img/widget/check/preview-02.png
19669 * @image latex img/widget/check/preview-02.eps
19671 * @brief The check widget allows for toggling a value between true and
19674 * Check objects are a lot like radio objects in layout and functionality
19675 * except they do not work as a group, but independently and only toggle the
19676 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19677 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19678 * returns the current state. For convenience, like the radio objects, you
19679 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19680 * for it to modify.
19682 * Signals that you can add callbacks for are:
19683 * "changed" - This is called whenever the user changes the state of one of
19684 * the check object(event_info is NULL).
19686 * Default contents parts of the check widget that you can use for are:
19687 * @li "elm.swallow.content" - A icon of the check
19689 * Default text parts of the check widget that you can use for are:
19690 * @li "elm.text" - Label of the check
19692 * @ref tutorial_check should give you a firm grasp of how to use this widget
19697 * @brief Add a new Check object
19699 * @param parent The parent object
19700 * @return The new object or NULL if it cannot be created
19702 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19704 * @brief Set the text label of the check object
19706 * @param obj The check object
19707 * @param label The text label string in UTF-8
19709 * @deprecated use elm_object_text_set() instead.
19711 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19713 * @brief Get the text label of the check object
19715 * @param obj The check object
19716 * @return The text label string in UTF-8
19718 * @deprecated use elm_object_text_get() instead.
19720 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19722 * @brief Set the icon object of the check object
19724 * @param obj The check object
19725 * @param icon The icon object
19727 * Once the icon object is set, a previously set one will be deleted.
19728 * If you want to keep that old content object, use the
19729 * elm_object_content_unset() function.
19731 * @deprecated use elm_object_content_set() instead.
19734 EINA_DEPRECATED EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19736 * @brief Get the icon object of the check object
19738 * @param obj The check object
19739 * @return The icon object
19741 * @deprecated use elm_object_content_get() instead.
19744 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19746 * @brief Unset the icon used for the check object
19748 * @param obj The check object
19749 * @return The icon object that was being used
19751 * Unparent and return the icon object which was set for this widget.
19753 * @deprecated use elm_object_content_unset() instead.
19756 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19758 * @brief Set the on/off state of the check object
19760 * @param obj The check object
19761 * @param state The state to use (1 == on, 0 == off)
19763 * This sets the state of the check. If set
19764 * with elm_check_state_pointer_set() the state of that variable is also
19765 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19767 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19769 * @brief Get the state of the check object
19771 * @param obj The check object
19772 * @return The boolean state
19774 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19776 * @brief Set a convenience pointer to a boolean to change
19778 * @param obj The check object
19779 * @param statep Pointer to the boolean to modify
19781 * This sets a pointer to a boolean, that, in addition to the check objects
19782 * state will also be modified directly. To stop setting the object pointed
19783 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19784 * then when this is called, the check objects state will also be modified to
19785 * reflect the value of the boolean @p statep points to, just like calling
19786 * elm_check_state_set().
19788 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19789 EINA_DEPRECATED EAPI void elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
19790 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);
19797 * @defgroup Radio Radio
19799 * @image html img/widget/radio/preview-00.png
19800 * @image latex img/widget/radio/preview-00.eps
19802 * @brief Radio is a widget that allows for 1 or more options to be displayed
19803 * and have the user choose only 1 of them.
19805 * A radio object contains an indicator, an optional Label and an optional
19806 * icon object. While it's possible to have a group of only one radio they,
19807 * are normally used in groups of 2 or more. To add a radio to a group use
19808 * elm_radio_group_add(). The radio object(s) will select from one of a set
19809 * of integer values, so any value they are configuring needs to be mapped to
19810 * a set of integers. To configure what value that radio object represents,
19811 * use elm_radio_state_value_set() to set the integer it represents. To set
19812 * the value the whole group(which one is currently selected) is to indicate
19813 * use elm_radio_value_set() on any group member, and to get the groups value
19814 * use elm_radio_value_get(). For convenience the radio objects are also able
19815 * to directly set an integer(int) to the value that is selected. To specify
19816 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19817 * The radio objects will modify this directly. That implies the pointer must
19818 * point to valid memory for as long as the radio objects exist.
19820 * Signals that you can add callbacks for are:
19821 * @li changed - This is called whenever the user changes the state of one of
19822 * the radio objects within the group of radio objects that work together.
19824 * Default contents parts of the radio widget that you can use for are:
19825 * @li "elm.swallow.content" - A icon of the radio
19827 * @ref tutorial_radio show most of this API in action.
19831 * @brief Add a new radio to the parent
19833 * @param parent The parent object
19834 * @return The new object or NULL if it cannot be created
19836 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19838 * @brief Set the text label of the radio object
19840 * @param obj The radio object
19841 * @param label The text label string in UTF-8
19843 * @deprecated use elm_object_text_set() instead.
19845 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19847 * @brief Get the text label of the radio object
19849 * @param obj The radio object
19850 * @return The text label string in UTF-8
19852 * @deprecated use elm_object_text_set() instead.
19854 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19856 * @brief Set the icon object of the radio object
19858 * @param obj The radio object
19859 * @param icon The icon object
19861 * Once the icon object is set, a previously set one will be deleted. If you
19862 * want to keep that old content object, use the elm_radio_icon_unset()
19865 * @deprecated use elm_object_content_set() instead.
19868 EINA_DEPRECATED EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19870 * @brief Get the icon object of the radio object
19872 * @param obj The radio object
19873 * @return The icon object
19875 * @see elm_radio_icon_set()
19877 * @deprecated use elm_object_content_get() instead.
19880 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19882 * @brief Unset the icon used for the radio object
19884 * @param obj The radio object
19885 * @return The icon object that was being used
19887 * Unparent and return the icon object which was set for this widget.
19889 * @see elm_radio_icon_set()
19890 * @deprecated use elm_object_content_unset() instead.
19893 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19895 * @brief Add this radio to a group of other radio objects
19897 * @param obj The radio object
19898 * @param group Any object whose group the @p obj is to join.
19900 * Radio objects work in groups. Each member should have a different integer
19901 * value assigned. In order to have them work as a group, they need to know
19902 * about each other. This adds the given radio object to the group of which
19903 * the group object indicated is a member.
19905 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
19907 * @brief Set the integer value that this radio object represents
19909 * @param obj The radio object
19910 * @param value The value to use if this radio object is selected
19912 * This sets the value of the radio.
19914 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19916 * @brief Get the integer value that this radio object represents
19918 * @param obj The radio object
19919 * @return The value used if this radio object is selected
19921 * This gets the value of the radio.
19923 * @see elm_radio_value_set()
19925 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19927 * @brief Set the value of the radio.
19929 * @param obj The radio object
19930 * @param value The value to use for the group
19932 * This sets the value of the radio group and will also set the value if
19933 * pointed to, to the value supplied, but will not call any callbacks.
19935 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19937 * @brief Get the state of the radio object
19939 * @param obj The radio object
19940 * @return The integer state
19942 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19944 * @brief Set a convenience pointer to a integer to change
19946 * @param obj The radio object
19947 * @param valuep Pointer to the integer to modify
19949 * This sets a pointer to a integer, that, in addition to the radio objects
19950 * state will also be modified directly. To stop setting the object pointed
19951 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
19952 * when this is called, the radio objects state will also be modified to
19953 * reflect the value of the integer valuep points to, just like calling
19954 * elm_radio_value_set().
19956 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
19962 * @defgroup Pager Pager
19964 * @image html img/widget/pager/preview-00.png
19965 * @image latex img/widget/pager/preview-00.eps
19967 * @brief Widget that allows flipping between 1 or more āpagesā of objects.
19969 * The flipping between āpagesā of objects is animated. All content in pager
19970 * is kept in a stack, the last content to be added will be on the top of the
19971 * stack(be visible).
19973 * Objects can be pushed or popped from the stack or deleted as normal.
19974 * Pushes and pops will animate (and a pop will delete the object once the
19975 * animation is finished). Any object already in the pager can be promoted to
19976 * the top(from its current stacking position) through the use of
19977 * elm_pager_content_promote(). Objects are pushed to the top with
19978 * elm_pager_content_push() and when the top item is no longer wanted, simply
19979 * pop it with elm_pager_content_pop() and it will also be deleted. If an
19980 * object is no longer needed and is not the top item, just delete it as
19981 * normal. You can query which objects are the top and bottom with
19982 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
19984 * Signals that you can add callbacks for are:
19985 * "hide,finished" - when the previous page is hided
19987 * This widget has the following styles available:
19990 * @li fade_translucide
19991 * @li fade_invisible
19992 * @note This styles affect only the flipping animations, the appearance when
19993 * not animating is unaffected by styles.
19995 * @ref tutorial_pager gives a good overview of the usage of the API.
19999 * Add a new pager to the parent
20001 * @param parent The parent object
20002 * @return The new object or NULL if it cannot be created
20006 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20008 * @brief Push an object to the top of the pager stack (and show it).
20010 * @param obj The pager object
20011 * @param content The object to push
20013 * The object pushed becomes a child of the pager, it will be controlled and
20014 * deleted when the pager is deleted.
20016 * @note If the content is already in the stack use
20017 * elm_pager_content_promote().
20018 * @warning Using this function on @p content already in the stack results in
20019 * undefined behavior.
20021 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20023 * @brief Pop the object that is on top of the stack
20025 * @param obj The pager object
20027 * This pops the object that is on the top(visible) of the pager, makes it
20028 * disappear, then deletes the object. The object that was underneath it on
20029 * the stack will become visible.
20031 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20033 * @brief Moves an object already in the pager stack to the top of the stack.
20035 * @param obj The pager object
20036 * @param content The object to promote
20038 * This will take the @p content and move it to the top of the stack as
20039 * if it had been pushed there.
20041 * @note If the content isn't already in the stack use
20042 * elm_pager_content_push().
20043 * @warning Using this function on @p content not already in the stack
20044 * results in undefined behavior.
20046 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20048 * @brief Return the object at the bottom of the pager stack
20050 * @param obj The pager object
20051 * @return The bottom object or NULL if none
20053 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20055 * @brief Return the object at the top of the pager stack
20057 * @param obj The pager object
20058 * @return The top object or NULL if none
20060 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20067 * @defgroup Slideshow Slideshow
20069 * @image html img/widget/slideshow/preview-00.png
20070 * @image latex img/widget/slideshow/preview-00.eps
20072 * This widget, as the name indicates, is a pre-made image
20073 * slideshow panel, with API functions acting on (child) image
20074 * items presentation. Between those actions, are:
20075 * - advance to next/previous image
20076 * - select the style of image transition animation
20077 * - set the exhibition time for each image
20078 * - start/stop the slideshow
20080 * The transition animations are defined in the widget's theme,
20081 * consequently new animations can be added without having to
20082 * update the widget's code.
20084 * @section Slideshow_Items Slideshow items
20086 * For slideshow items, just like for @ref Genlist "genlist" ones,
20087 * the user defines a @b classes, specifying functions that will be
20088 * called on the item's creation and deletion times.
20090 * The #Elm_Slideshow_Item_Class structure contains the following
20093 * - @c func.get - When an item is displayed, this function is
20094 * called, and it's where one should create the item object, de
20095 * facto. For example, the object can be a pure Evas image object
20096 * or an Elementary @ref Photocam "photocam" widget. See
20097 * #SlideshowItemGetFunc.
20098 * - @c func.del - When an item is no more displayed, this function
20099 * is called, where the user must delete any data associated to
20100 * the item. See #SlideshowItemDelFunc.
20102 * @section Slideshow_Caching Slideshow caching
20104 * The slideshow provides facilities to have items adjacent to the
20105 * one being displayed <b>already "realized"</b> (i.e. loaded) for
20106 * you, so that the system does not have to decode image data
20107 * anymore at the time it has to actually switch images on its
20108 * viewport. The user is able to set the numbers of items to be
20109 * cached @b before and @b after the current item, in the widget's
20112 * Smart events one can add callbacks for are:
20114 * - @c "changed" - when the slideshow switches its view to a new
20117 * List of examples for the slideshow widget:
20118 * @li @ref slideshow_example
20122 * @addtogroup Slideshow
20126 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20127 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20128 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
20129 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20130 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20133 * @struct _Elm_Slideshow_Item_Class
20135 * Slideshow item class definition. See @ref Slideshow_Items for
20138 struct _Elm_Slideshow_Item_Class
20140 struct _Elm_Slideshow_Item_Class_Func
20142 SlideshowItemGetFunc get;
20143 SlideshowItemDelFunc del;
20145 }; /**< #Elm_Slideshow_Item_Class member definitions */
20148 * Add a new slideshow widget to the given parent Elementary
20149 * (container) object
20151 * @param parent The parent object
20152 * @return A new slideshow widget handle or @c NULL, on errors
20154 * This function inserts a new slideshow widget on the canvas.
20156 * @ingroup Slideshow
20158 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20161 * Add (append) a new item in a given slideshow widget.
20163 * @param obj The slideshow object
20164 * @param itc The item class for the item
20165 * @param data The item's data
20166 * @return A handle to the item added or @c NULL, on errors
20168 * Add a new item to @p obj's internal list of items, appending it.
20169 * The item's class must contain the function really fetching the
20170 * image object to show for this item, which could be an Evas image
20171 * object or an Elementary photo, for example. The @p data
20172 * parameter is going to be passed to both class functions of the
20175 * @see #Elm_Slideshow_Item_Class
20176 * @see elm_slideshow_item_sorted_insert()
20178 * @ingroup Slideshow
20180 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20183 * Insert a new item into the given slideshow widget, using the @p func
20184 * function to sort items (by item handles).
20186 * @param obj The slideshow object
20187 * @param itc The item class for the item
20188 * @param data The item's data
20189 * @param func The comparing function to be used to sort slideshow
20190 * items <b>by #Elm_Slideshow_Item item handles</b>
20191 * @return Returns The slideshow item handle, on success, or
20192 * @c NULL, on errors
20194 * Add a new item to @p obj's internal list of items, in a position
20195 * determined by the @p func comparing function. The item's class
20196 * must contain the function really fetching the image object to
20197 * show for this item, which could be an Evas image object or an
20198 * Elementary photo, for example. The @p data parameter is going to
20199 * be passed to both class functions of the item.
20201 * @see #Elm_Slideshow_Item_Class
20202 * @see elm_slideshow_item_add()
20204 * @ingroup Slideshow
20206 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);
20209 * Display a given slideshow widget's item, programmatically.
20211 * @param obj The slideshow object
20212 * @param item The item to display on @p obj's viewport
20214 * The change between the current item and @p item will use the
20215 * transition @p obj is set to use (@see
20216 * elm_slideshow_transition_set()).
20218 * @ingroup Slideshow
20220 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20223 * Slide to the @b next item, in a given slideshow widget
20225 * @param obj The slideshow object
20227 * The sliding animation @p obj is set to use will be the
20228 * transition effect used, after this call is issued.
20230 * @note If the end of the slideshow's internal list of items is
20231 * reached, it'll wrap around to the list's beginning, again.
20233 * @ingroup Slideshow
20235 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20238 * Slide to the @b previous item, in a given slideshow widget
20240 * @param obj The slideshow object
20242 * The sliding animation @p obj is set to use will be the
20243 * transition effect used, after this call is issued.
20245 * @note If the beginning of the slideshow's internal list of items
20246 * is reached, it'll wrap around to the list's end, again.
20248 * @ingroup Slideshow
20250 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20253 * Returns the list of sliding transition/effect names available, for a
20254 * given slideshow widget.
20256 * @param obj The slideshow object
20257 * @return The list of transitions (list of @b stringshared strings
20260 * The transitions, which come from @p obj's theme, must be an EDC
20261 * data item named @c "transitions" on the theme file, with (prefix)
20262 * names of EDC programs actually implementing them.
20264 * The available transitions for slideshows on the default theme are:
20265 * - @c "fade" - the current item fades out, while the new one
20266 * fades in to the slideshow's viewport.
20267 * - @c "black_fade" - the current item fades to black, and just
20268 * then, the new item will fade in.
20269 * - @c "horizontal" - the current item slides horizontally, until
20270 * it gets out of the slideshow's viewport, while the new item
20271 * comes from the left to take its place.
20272 * - @c "vertical" - the current item slides vertically, until it
20273 * gets out of the slideshow's viewport, while the new item comes
20274 * from the bottom to take its place.
20275 * - @c "square" - the new item starts to appear from the middle of
20276 * the current one, but with a tiny size, growing until its
20277 * target (full) size and covering the old one.
20279 * @warning The stringshared strings get no new references
20280 * exclusive to the user grabbing the list, here, so if you'd like
20281 * to use them out of this call's context, you'd better @c
20282 * eina_stringshare_ref() them.
20284 * @see elm_slideshow_transition_set()
20286 * @ingroup Slideshow
20288 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20291 * Set the current slide transition/effect in use for a given
20294 * @param obj The slideshow object
20295 * @param transition The new transition's name string
20297 * If @p transition is implemented in @p obj's theme (i.e., is
20298 * contained in the list returned by
20299 * elm_slideshow_transitions_get()), this new sliding effect will
20300 * be used on the widget.
20302 * @see elm_slideshow_transitions_get() for more details
20304 * @ingroup Slideshow
20306 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20309 * Get the current slide transition/effect in use for a given
20312 * @param obj The slideshow object
20313 * @return The current transition's name
20315 * @see elm_slideshow_transition_set() for more details
20317 * @ingroup Slideshow
20319 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20322 * Set the interval between each image transition on a given
20323 * slideshow widget, <b>and start the slideshow, itself</b>
20325 * @param obj The slideshow object
20326 * @param timeout The new displaying timeout for images
20328 * After this call, the slideshow widget will start cycling its
20329 * view, sequentially and automatically, with the images of the
20330 * items it has. The time between each new image displayed is going
20331 * to be @p timeout, in @b seconds. If a different timeout was set
20332 * previously and an slideshow was in progress, it will continue
20333 * with the new time between transitions, after this call.
20335 * @note A value less than or equal to 0 on @p timeout will disable
20336 * the widget's internal timer, thus halting any slideshow which
20337 * could be happening on @p obj.
20339 * @see elm_slideshow_timeout_get()
20341 * @ingroup Slideshow
20343 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20346 * Get the interval set for image transitions on a given slideshow
20349 * @param obj The slideshow object
20350 * @return Returns the timeout set on it
20352 * @see elm_slideshow_timeout_set() for more details
20354 * @ingroup Slideshow
20356 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20359 * Set if, after a slideshow is started, for a given slideshow
20360 * widget, its items should be displayed cyclically or not.
20362 * @param obj The slideshow object
20363 * @param loop Use @c EINA_TRUE to make it cycle through items or
20364 * @c EINA_FALSE for it to stop at the end of @p obj's internal
20367 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20368 * ignore what is set by this functions, i.e., they'll @b always
20369 * cycle through items. This affects only the "automatic"
20370 * slideshow, as set by elm_slideshow_timeout_set().
20372 * @see elm_slideshow_loop_get()
20374 * @ingroup Slideshow
20376 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20379 * Get if, after a slideshow is started, for a given slideshow
20380 * widget, its items are to be displayed cyclically or not.
20382 * @param obj The slideshow object
20383 * @return @c EINA_TRUE, if the items in @p obj will be cycled
20384 * through or @c EINA_FALSE, otherwise
20386 * @see elm_slideshow_loop_set() for more details
20388 * @ingroup Slideshow
20390 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20393 * Remove all items from a given slideshow widget
20395 * @param obj The slideshow object
20397 * This removes (and deletes) all items in @p obj, leaving it
20400 * @see elm_slideshow_item_del(), to remove just one item.
20402 * @ingroup Slideshow
20404 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20407 * Get the internal list of items in a given slideshow widget.
20409 * @param obj The slideshow object
20410 * @return The list of items (#Elm_Slideshow_Item as data) or
20411 * @c NULL on errors.
20413 * This list is @b not to be modified in any way and must not be
20414 * freed. Use the list members with functions like
20415 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20417 * @warning This list is only valid until @p obj object's internal
20418 * items list is changed. It should be fetched again with another
20419 * call to this function when changes happen.
20421 * @ingroup Slideshow
20423 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20426 * Delete a given item from a slideshow widget.
20428 * @param item The slideshow item
20430 * @ingroup Slideshow
20432 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20435 * Return the data associated with a given slideshow item
20437 * @param item The slideshow item
20438 * @return Returns the data associated to this item
20440 * @ingroup Slideshow
20442 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20445 * Returns the currently displayed item, in a given slideshow widget
20447 * @param obj The slideshow object
20448 * @return A handle to the item being displayed in @p obj or
20449 * @c NULL, if none is (and on errors)
20451 * @ingroup Slideshow
20453 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20456 * Get the real Evas object created to implement the view of a
20457 * given slideshow item
20459 * @param item The slideshow item.
20460 * @return the Evas object implementing this item's view.
20462 * This returns the actual Evas object used to implement the
20463 * specified slideshow item's view. This may be @c NULL, as it may
20464 * not have been created or may have been deleted, at any time, by
20465 * the slideshow. <b>Do not modify this object</b> (move, resize,
20466 * show, hide, etc.), as the slideshow is controlling it. This
20467 * function is for querying, emitting custom signals or hooking
20468 * lower level callbacks for events on that object. Do not delete
20469 * this object under any circumstances.
20471 * @see elm_slideshow_item_data_get()
20473 * @ingroup Slideshow
20475 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20478 * Get the the item, in a given slideshow widget, placed at
20479 * position @p nth, in its internal items list
20481 * @param obj The slideshow object
20482 * @param nth The number of the item to grab a handle to (0 being
20484 * @return The item stored in @p obj at position @p nth or @c NULL,
20485 * if there's no item with that index (and on errors)
20487 * @ingroup Slideshow
20489 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20492 * Set the current slide layout in use for a given slideshow widget
20494 * @param obj The slideshow object
20495 * @param layout The new layout's name string
20497 * If @p layout is implemented in @p obj's theme (i.e., is contained
20498 * in the list returned by elm_slideshow_layouts_get()), this new
20499 * images layout will be used on the widget.
20501 * @see elm_slideshow_layouts_get() for more details
20503 * @ingroup Slideshow
20505 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20508 * Get the current slide layout in use for a given slideshow widget
20510 * @param obj The slideshow object
20511 * @return The current layout's name
20513 * @see elm_slideshow_layout_set() for more details
20515 * @ingroup Slideshow
20517 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20520 * Returns the list of @b layout names available, for a given
20521 * slideshow widget.
20523 * @param obj The slideshow object
20524 * @return The list of layouts (list of @b stringshared strings
20527 * Slideshow layouts will change how the widget is to dispose each
20528 * image item in its viewport, with regard to cropping, scaling,
20531 * The layouts, which come from @p obj's theme, must be an EDC
20532 * data item name @c "layouts" on the theme file, with (prefix)
20533 * names of EDC programs actually implementing them.
20535 * The available layouts for slideshows on the default theme are:
20536 * - @c "fullscreen" - item images with original aspect, scaled to
20537 * touch top and down slideshow borders or, if the image's heigh
20538 * is not enough, left and right slideshow borders.
20539 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20540 * one, but always leaving 10% of the slideshow's dimensions of
20541 * distance between the item image's borders and the slideshow
20542 * borders, for each axis.
20544 * @warning The stringshared strings get no new references
20545 * exclusive to the user grabbing the list, here, so if you'd like
20546 * to use them out of this call's context, you'd better @c
20547 * eina_stringshare_ref() them.
20549 * @see elm_slideshow_layout_set()
20551 * @ingroup Slideshow
20553 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20556 * Set the number of items to cache, on a given slideshow widget,
20557 * <b>before the current item</b>
20559 * @param obj The slideshow object
20560 * @param count Number of items to cache before the current one
20562 * The default value for this property is @c 2. See
20563 * @ref Slideshow_Caching "slideshow caching" for more details.
20565 * @see elm_slideshow_cache_before_get()
20567 * @ingroup Slideshow
20569 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20572 * Retrieve the number of items to cache, on a given slideshow widget,
20573 * <b>before the current item</b>
20575 * @param obj The slideshow object
20576 * @return The number of items set to be cached before the current one
20578 * @see elm_slideshow_cache_before_set() for more details
20580 * @ingroup Slideshow
20582 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20585 * Set the number of items to cache, on a given slideshow widget,
20586 * <b>after the current item</b>
20588 * @param obj The slideshow object
20589 * @param count Number of items to cache after the current one
20591 * The default value for this property is @c 2. See
20592 * @ref Slideshow_Caching "slideshow caching" for more details.
20594 * @see elm_slideshow_cache_after_get()
20596 * @ingroup Slideshow
20598 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20601 * Retrieve the number of items to cache, on a given slideshow widget,
20602 * <b>after the current item</b>
20604 * @param obj The slideshow object
20605 * @return The number of items set to be cached after the current one
20607 * @see elm_slideshow_cache_after_set() for more details
20609 * @ingroup Slideshow
20611 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20614 * Get the number of items stored in a given slideshow widget
20616 * @param obj The slideshow object
20617 * @return The number of items on @p obj, at the moment of this call
20619 * @ingroup Slideshow
20621 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20628 * @defgroup Fileselector File Selector
20630 * @image html img/widget/fileselector/preview-00.png
20631 * @image latex img/widget/fileselector/preview-00.eps
20633 * A file selector is a widget that allows a user to navigate
20634 * through a file system, reporting file selections back via its
20637 * It contains shortcut buttons for home directory (@c ~) and to
20638 * jump one directory upwards (..), as well as cancel/ok buttons to
20639 * confirm/cancel a given selection. After either one of those two
20640 * former actions, the file selector will issue its @c "done" smart
20643 * There's a text entry on it, too, showing the name of the current
20644 * selection. There's the possibility of making it editable, so it
20645 * is useful on file saving dialogs on applications, where one
20646 * gives a file name to save contents to, in a given directory in
20647 * the system. This custom file name will be reported on the @c
20648 * "done" smart callback (explained in sequence).
20650 * Finally, it has a view to display file system items into in two
20655 * If Elementary is built with support of the Ethumb thumbnailing
20656 * library, the second form of view will display preview thumbnails
20657 * of files which it supports.
20659 * Smart callbacks one can register to:
20661 * - @c "selected" - the user has clicked on a file (when not in
20662 * folders-only mode) or directory (when in folders-only mode)
20663 * - @c "directory,open" - the list has been populated with new
20664 * content (@c event_info is a pointer to the directory's
20665 * path, a @b stringshared string)
20666 * - @c "done" - the user has clicked on the "ok" or "cancel"
20667 * buttons (@c event_info is a pointer to the selection's
20668 * path, a @b stringshared string)
20670 * Here is an example on its usage:
20671 * @li @ref fileselector_example
20675 * @addtogroup Fileselector
20680 * Defines how a file selector widget is to layout its contents
20681 * (file system entries).
20683 typedef enum _Elm_Fileselector_Mode
20685 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20686 ELM_FILESELECTOR_GRID, /**< layout as a grid */
20687 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20688 } Elm_Fileselector_Mode;
20691 * Add a new file selector widget to the given parent Elementary
20692 * (container) object
20694 * @param parent The parent object
20695 * @return a new file selector widget handle or @c NULL, on errors
20697 * This function inserts a new file selector widget on the canvas.
20699 * @ingroup Fileselector
20701 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20704 * Enable/disable the file name entry box where the user can type
20705 * in a name for a file, in a given file selector widget
20707 * @param obj The file selector object
20708 * @param is_save @c EINA_TRUE to make the file selector a "saving
20709 * dialog", @c EINA_FALSE otherwise
20711 * Having the entry editable is useful on file saving dialogs on
20712 * applications, where one gives a file name to save contents to,
20713 * in a given directory in the system. This custom file name will
20714 * be reported on the @c "done" smart callback.
20716 * @see elm_fileselector_is_save_get()
20718 * @ingroup Fileselector
20720 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20723 * Get whether the given file selector is in "saving dialog" mode
20725 * @param obj The file selector object
20726 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20727 * mode, @c EINA_FALSE otherwise (and on errors)
20729 * @see elm_fileselector_is_save_set() for more details
20731 * @ingroup Fileselector
20733 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20736 * Enable/disable folder-only view for a given file selector widget
20738 * @param obj The file selector object
20739 * @param only @c EINA_TRUE to make @p obj only display
20740 * directories, @c EINA_FALSE to make files to be displayed in it
20743 * If enabled, the widget's view will only display folder items,
20746 * @see elm_fileselector_folder_only_get()
20748 * @ingroup Fileselector
20750 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20753 * Get whether folder-only view is set for a given file selector
20756 * @param obj The file selector object
20757 * @return only @c EINA_TRUE if @p obj is only displaying
20758 * directories, @c EINA_FALSE if files are being displayed in it
20759 * too (and on errors)
20761 * @see elm_fileselector_folder_only_get()
20763 * @ingroup Fileselector
20765 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20768 * Enable/disable the "ok" and "cancel" buttons on a given file
20771 * @param obj The file selector object
20772 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20774 * @note A file selector without those buttons will never emit the
20775 * @c "done" smart event, and is only usable if one is just hooking
20776 * to the other two events.
20778 * @see elm_fileselector_buttons_ok_cancel_get()
20780 * @ingroup Fileselector
20782 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20785 * Get whether the "ok" and "cancel" buttons on a given file
20786 * selector widget are being shown.
20788 * @param obj The file selector object
20789 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20790 * otherwise (and on errors)
20792 * @see elm_fileselector_buttons_ok_cancel_set() for more details
20794 * @ingroup Fileselector
20796 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20799 * Enable/disable a tree view in the given file selector widget,
20800 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20802 * @param obj The file selector object
20803 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20806 * In a tree view, arrows are created on the sides of directories,
20807 * allowing them to expand in place.
20809 * @note If it's in other mode, the changes made by this function
20810 * will only be visible when one switches back to "list" mode.
20812 * @see elm_fileselector_expandable_get()
20814 * @ingroup Fileselector
20816 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20819 * Get whether tree view is enabled for the given file selector
20822 * @param obj The file selector object
20823 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20824 * otherwise (and or errors)
20826 * @see elm_fileselector_expandable_set() for more details
20828 * @ingroup Fileselector
20830 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20833 * Set, programmatically, the @b directory that a given file
20834 * selector widget will display contents from
20836 * @param obj The file selector object
20837 * @param path The path to display in @p obj
20839 * This will change the @b directory that @p obj is displaying. It
20840 * will also clear the text entry area on the @p obj object, which
20841 * displays select files' names.
20843 * @see elm_fileselector_path_get()
20845 * @ingroup Fileselector
20847 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20850 * Get the parent directory's path that a given file selector
20851 * widget is displaying
20853 * @param obj The file selector object
20854 * @return The (full) path of the directory the file selector is
20855 * displaying, a @b stringshared string
20857 * @see elm_fileselector_path_set()
20859 * @ingroup Fileselector
20861 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20864 * Set, programmatically, the currently selected file/directory in
20865 * the given file selector widget
20867 * @param obj The file selector object
20868 * @param path The (full) path to a file or directory
20869 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
20870 * latter case occurs if the directory or file pointed to do not
20873 * @see elm_fileselector_selected_get()
20875 * @ingroup Fileselector
20877 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20880 * Get the currently selected item's (full) path, in the given file
20883 * @param obj The file selector object
20884 * @return The absolute path of the selected item, a @b
20885 * stringshared string
20887 * @note Custom editions on @p obj object's text entry, if made,
20888 * will appear on the return string of this function, naturally.
20890 * @see elm_fileselector_selected_set() for more details
20892 * @ingroup Fileselector
20894 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20897 * Set the mode in which a given file selector widget will display
20898 * (layout) file system entries in its view
20900 * @param obj The file selector object
20901 * @param mode The mode of the fileselector, being it one of
20902 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
20903 * first one, naturally, will display the files in a list. The
20904 * latter will make the widget to display its entries in a grid
20907 * @note By using elm_fileselector_expandable_set(), the user may
20908 * trigger a tree view for that list.
20910 * @note If Elementary is built with support of the Ethumb
20911 * thumbnailing library, the second form of view will display
20912 * preview thumbnails of files which it supports. You must have
20913 * elm_need_ethumb() called in your Elementary for thumbnailing to
20916 * @see elm_fileselector_expandable_set().
20917 * @see elm_fileselector_mode_get().
20919 * @ingroup Fileselector
20921 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
20924 * Get the mode in which a given file selector widget is displaying
20925 * (layouting) file system entries in its view
20927 * @param obj The fileselector object
20928 * @return The mode in which the fileselector is at
20930 * @see elm_fileselector_mode_set() for more details
20932 * @ingroup Fileselector
20934 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20941 * @defgroup Progressbar Progress bar
20943 * The progress bar is a widget for visually representing the
20944 * progress status of a given job/task.
20946 * A progress bar may be horizontal or vertical. It may display an
20947 * icon besides it, as well as primary and @b units labels. The
20948 * former is meant to label the widget as a whole, while the
20949 * latter, which is formatted with floating point values (and thus
20950 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
20951 * units"</c>), is meant to label the widget's <b>progress
20952 * value</b>. Label, icon and unit strings/objects are @b optional
20953 * for progress bars.
20955 * A progress bar may be @b inverted, in which state it gets its
20956 * values inverted, with high values being on the left or top and
20957 * low values on the right or bottom, as opposed to normally have
20958 * the low values on the former and high values on the latter,
20959 * respectively, for horizontal and vertical modes.
20961 * The @b span of the progress, as set by
20962 * elm_progressbar_span_size_set(), is its length (horizontally or
20963 * vertically), unless one puts size hints on the widget to expand
20964 * on desired directions, by any container. That length will be
20965 * scaled by the object or applications scaling factor. At any
20966 * point code can query the progress bar for its value with
20967 * elm_progressbar_value_get().
20969 * Available widget styles for progress bars:
20971 * - @c "wheel" (simple style, no text, no progression, only
20972 * "pulse" effect is available)
20974 * Default contents parts of the progressbar widget that you can use for are:
20975 * @li "elm.swallow.content" - A icon of the progressbar
20977 * Here is an example on its usage:
20978 * @li @ref progressbar_example
20982 * Add a new progress bar widget to the given parent Elementary
20983 * (container) object
20985 * @param parent The parent object
20986 * @return a new progress bar widget handle or @c NULL, on errors
20988 * This function inserts a new progress bar widget on the canvas.
20990 * @ingroup Progressbar
20992 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20995 * Set whether a given progress bar widget is at "pulsing mode" or
20998 * @param obj The progress bar object
20999 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21000 * @c EINA_FALSE to put it back to its default one
21002 * By default, progress bars will display values from the low to
21003 * high value boundaries. There are, though, contexts in which the
21004 * state of progression of a given task is @b unknown. For those,
21005 * one can set a progress bar widget to a "pulsing state", to give
21006 * the user an idea that some computation is being held, but
21007 * without exact progress values. In the default theme it will
21008 * animate its bar with the contents filling in constantly and back
21009 * to non-filled, in a loop. To start and stop this pulsing
21010 * animation, one has to explicitly call elm_progressbar_pulse().
21012 * @see elm_progressbar_pulse_get()
21013 * @see elm_progressbar_pulse()
21015 * @ingroup Progressbar
21017 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21020 * Get whether a given progress bar widget is at "pulsing mode" or
21023 * @param obj The progress bar object
21024 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21025 * if it's in the default one (and on errors)
21027 * @ingroup Progressbar
21029 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21032 * Start/stop a given progress bar "pulsing" animation, if its
21035 * @param obj The progress bar object
21036 * @param state @c EINA_TRUE, to @b start the pulsing animation,
21037 * @c EINA_FALSE to @b stop it
21039 * @note This call won't do anything if @p obj is not under "pulsing mode".
21041 * @see elm_progressbar_pulse_set() for more details.
21043 * @ingroup Progressbar
21045 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21048 * Set the progress value (in percentage) on a given progress bar
21051 * @param obj The progress bar object
21052 * @param val The progress value (@b must be between @c 0.0 and @c
21055 * Use this call to set progress bar levels.
21057 * @note If you passes a value out of the specified range for @p
21058 * val, it will be interpreted as the @b closest of the @b boundary
21059 * values in the range.
21061 * @ingroup Progressbar
21063 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21066 * Get the progress value (in percentage) on a given progress bar
21069 * @param obj The progress bar object
21070 * @return The value of the progressbar
21072 * @see elm_progressbar_value_set() for more details
21074 * @ingroup Progressbar
21076 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21079 * Set the label of a given progress bar widget
21081 * @param obj The progress bar object
21082 * @param label The text label string, in UTF-8
21084 * @ingroup Progressbar
21085 * @deprecated use elm_object_text_set() instead.
21087 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21090 * Get the label of a given progress bar widget
21092 * @param obj The progressbar object
21093 * @return The text label string, in UTF-8
21095 * @ingroup Progressbar
21096 * @deprecated use elm_object_text_set() instead.
21098 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21101 * Set the icon object of a given progress bar widget
21103 * @param obj The progress bar object
21104 * @param icon The icon object
21106 * Use this call to decorate @p obj with an icon next to it.
21108 * @note Once the icon object is set, a previously set one will be
21109 * deleted. If you want to keep that old content object, use the
21110 * elm_progressbar_icon_unset() function.
21112 * @see elm_progressbar_icon_get()
21113 * @deprecated use elm_object_content_set() instead.
21115 * @ingroup Progressbar
21117 EINA_DEPRECATED EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21120 * Retrieve the icon object set for a given progress bar widget
21122 * @param obj The progress bar object
21123 * @return The icon object's handle, if @p obj had one set, or @c NULL,
21124 * otherwise (and on errors)
21126 * @see elm_progressbar_icon_set() for more details
21127 * @deprecated use elm_object_content_get() instead.
21129 * @ingroup Progressbar
21131 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21134 * Unset an icon set on a given progress bar widget
21136 * @param obj The progress bar object
21137 * @return The icon object that was being used, if any was set, or
21138 * @c NULL, otherwise (and on errors)
21140 * This call will unparent and return the icon object which was set
21141 * for this widget, previously, on success.
21143 * @see elm_progressbar_icon_set() for more details
21144 * @deprecated use elm_object_content_unset() instead.
21146 * @ingroup Progressbar
21148 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21151 * Set the (exact) length of the bar region of a given progress bar
21154 * @param obj The progress bar object
21155 * @param size The length of the progress bar's bar region
21157 * This sets the minimum width (when in horizontal mode) or height
21158 * (when in vertical mode) of the actual bar area of the progress
21159 * bar @p obj. This in turn affects the object's minimum size. Use
21160 * this when you're not setting other size hints expanding on the
21161 * given direction (like weight and alignment hints) and you would
21162 * like it to have a specific size.
21164 * @note Icon, label and unit text around @p obj will require their
21165 * own space, which will make @p obj to require more the @p size,
21168 * @see elm_progressbar_span_size_get()
21170 * @ingroup Progressbar
21172 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21175 * Get the length set for the bar region of a given progress bar
21178 * @param obj The progress bar object
21179 * @return The length of the progress bar's bar region
21181 * If that size was not set previously, with
21182 * elm_progressbar_span_size_set(), this call will return @c 0.
21184 * @ingroup Progressbar
21186 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21189 * Set the format string for a given progress bar widget's units
21192 * @param obj The progress bar object
21193 * @param format The format string for @p obj's units label
21195 * If @c NULL is passed on @p format, it will make @p obj's units
21196 * area to be hidden completely. If not, it'll set the <b>format
21197 * string</b> for the units label's @b text. The units label is
21198 * provided a floating point value, so the units text is up display
21199 * at most one floating point falue. Note that the units label is
21200 * optional. Use a format string such as "%1.2f meters" for
21203 * @note The default format string for a progress bar is an integer
21204 * percentage, as in @c "%.0f %%".
21206 * @see elm_progressbar_unit_format_get()
21208 * @ingroup Progressbar
21210 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21213 * Retrieve the format string set for a given progress bar widget's
21216 * @param obj The progress bar object
21217 * @return The format set string for @p obj's units label or
21218 * @c NULL, if none was set (and on errors)
21220 * @see elm_progressbar_unit_format_set() for more details
21222 * @ingroup Progressbar
21224 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21227 * Set the orientation of a given progress bar widget
21229 * @param obj The progress bar object
21230 * @param horizontal Use @c EINA_TRUE to make @p obj to be
21231 * @b horizontal, @c EINA_FALSE to make it @b vertical
21233 * Use this function to change how your progress bar is to be
21234 * disposed: vertically or horizontally.
21236 * @see elm_progressbar_horizontal_get()
21238 * @ingroup Progressbar
21240 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21243 * Retrieve the orientation of a given progress bar widget
21245 * @param obj The progress bar object
21246 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21247 * @c EINA_FALSE if it's @b vertical (and on errors)
21249 * @see elm_progressbar_horizontal_set() for more details
21251 * @ingroup Progressbar
21253 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21256 * Invert a given progress bar widget's displaying values order
21258 * @param obj The progress bar object
21259 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21260 * @c EINA_FALSE to bring it back to default, non-inverted values.
21262 * A progress bar may be @b inverted, in which state it gets its
21263 * values inverted, with high values being on the left or top and
21264 * low values on the right or bottom, as opposed to normally have
21265 * the low values on the former and high values on the latter,
21266 * respectively, for horizontal and vertical modes.
21268 * @see elm_progressbar_inverted_get()
21270 * @ingroup Progressbar
21272 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21275 * Get whether a given progress bar widget's displaying values are
21278 * @param obj The progress bar object
21279 * @return @c EINA_TRUE, if @p obj has inverted values,
21280 * @c EINA_FALSE otherwise (and on errors)
21282 * @see elm_progressbar_inverted_set() for more details
21284 * @ingroup Progressbar
21286 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21289 * @defgroup Separator Separator
21291 * @brief Separator is a very thin object used to separate other objects.
21293 * A separator can be vertical or horizontal.
21295 * @ref tutorial_separator is a good example of how to use a separator.
21299 * @brief Add a separator object to @p parent
21301 * @param parent The parent object
21303 * @return The separator object, or NULL upon failure
21305 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21307 * @brief Set the horizontal mode of a separator object
21309 * @param obj The separator object
21310 * @param horizontal If true, the separator is horizontal
21312 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21314 * @brief Get the horizontal mode of a separator object
21316 * @param obj The separator object
21317 * @return If true, the separator is horizontal
21319 * @see elm_separator_horizontal_set()
21321 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21327 * @defgroup Spinner Spinner
21328 * @ingroup Elementary
21330 * @image html img/widget/spinner/preview-00.png
21331 * @image latex img/widget/spinner/preview-00.eps
21333 * A spinner is a widget which allows the user to increase or decrease
21334 * numeric values using arrow buttons, or edit values directly, clicking
21335 * over it and typing the new value.
21337 * By default the spinner will not wrap and has a label
21338 * of "%.0f" (just showing the integer value of the double).
21340 * A spinner has a label that is formatted with floating
21341 * point values and thus accepts a printf-style format string, like
21342 * ā%1.2f unitsā.
21344 * It also allows specific values to be replaced by pre-defined labels.
21346 * Smart callbacks one can register to:
21348 * - "changed" - Whenever the spinner value is changed.
21349 * - "delay,changed" - A short time after the value is changed by the user.
21350 * This will be called only when the user stops dragging for a very short
21351 * period or when they release their finger/mouse, so it avoids possibly
21352 * expensive reactions to the value change.
21354 * Available styles for it:
21356 * - @c "vertical": up/down buttons at the right side and text left aligned.
21358 * Here is an example on its usage:
21359 * @ref spinner_example
21363 * @addtogroup Spinner
21368 * Add a new spinner widget to the given parent Elementary
21369 * (container) object.
21371 * @param parent The parent object.
21372 * @return a new spinner widget handle or @c NULL, on errors.
21374 * This function inserts a new spinner widget on the canvas.
21379 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21382 * Set the format string of the displayed label.
21384 * @param obj The spinner object.
21385 * @param fmt The format string for the label display.
21387 * If @c NULL, this sets the format to "%.0f". If not it sets the format
21388 * string for the label text. The label text is provided a floating point
21389 * value, so the label text can display up to 1 floating point value.
21390 * Note that this is optional.
21392 * Use a format string such as "%1.2f meters" for example, and it will
21393 * display values like: "3.14 meters" for a value equal to 3.14159.
21395 * Default is "%0.f".
21397 * @see elm_spinner_label_format_get()
21401 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21404 * Get the label format of the spinner.
21406 * @param obj The spinner object.
21407 * @return The text label format string in UTF-8.
21409 * @see elm_spinner_label_format_set() for details.
21413 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21416 * Set the minimum and maximum values for the spinner.
21418 * @param obj The spinner object.
21419 * @param min The minimum value.
21420 * @param max The maximum value.
21422 * Define the allowed range of values to be selected by the user.
21424 * If actual value is less than @p min, it will be updated to @p min. If it
21425 * is bigger then @p max, will be updated to @p max. Actual value can be
21426 * get with elm_spinner_value_get().
21428 * By default, min is equal to 0, and max is equal to 100.
21430 * @warning Maximum must be greater than minimum.
21432 * @see elm_spinner_min_max_get()
21436 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21439 * Get the minimum and maximum values of the spinner.
21441 * @param obj The spinner object.
21442 * @param min Pointer where to store the minimum value.
21443 * @param max Pointer where to store the maximum value.
21445 * @note If only one value is needed, the other pointer can be passed
21448 * @see elm_spinner_min_max_set() for details.
21452 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21455 * Set the step used to increment or decrement the spinner value.
21457 * @param obj The spinner object.
21458 * @param step The step value.
21460 * This value will be incremented or decremented to the displayed value.
21461 * It will be incremented while the user keep right or top arrow pressed,
21462 * and will be decremented while the user keep left or bottom arrow pressed.
21464 * The interval to increment / decrement can be set with
21465 * elm_spinner_interval_set().
21467 * By default step value is equal to 1.
21469 * @see elm_spinner_step_get()
21473 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21476 * Get the step used to increment or decrement the spinner value.
21478 * @param obj The spinner object.
21479 * @return The step value.
21481 * @see elm_spinner_step_get() for more details.
21485 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21488 * Set the value the spinner displays.
21490 * @param obj The spinner object.
21491 * @param val The value to be displayed.
21493 * Value will be presented on the label following format specified with
21494 * elm_spinner_format_set().
21496 * @warning The value must to be between min and max values. This values
21497 * are set by elm_spinner_min_max_set().
21499 * @see elm_spinner_value_get().
21500 * @see elm_spinner_format_set().
21501 * @see elm_spinner_min_max_set().
21505 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21508 * Get the value displayed by the spinner.
21510 * @param obj The spinner object.
21511 * @return The value displayed.
21513 * @see elm_spinner_value_set() for details.
21517 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21520 * Set whether the spinner should wrap when it reaches its
21521 * minimum or maximum value.
21523 * @param obj The spinner object.
21524 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21527 * Disabled by default. If disabled, when the user tries to increment the
21529 * but displayed value plus step value is bigger than maximum value,
21531 * won't allow it. The same happens when the user tries to decrement it,
21532 * but the value less step is less than minimum value.
21534 * When wrap is enabled, in such situations it will allow these changes,
21535 * but will get the value that would be less than minimum and subtracts
21536 * from maximum. Or add the value that would be more than maximum to
21540 * @li min value = 10
21541 * @li max value = 50
21542 * @li step value = 20
21543 * @li displayed value = 20
21545 * When the user decrement value (using left or bottom arrow), it will
21546 * displays @c 40, because max - (min - (displayed - step)) is
21547 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21549 * @see elm_spinner_wrap_get().
21553 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21556 * Get whether the spinner should wrap when it reaches its
21557 * minimum or maximum value.
21559 * @param obj The spinner object
21560 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21561 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21563 * @see elm_spinner_wrap_set() for details.
21567 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21570 * Set whether the spinner can be directly edited by the user or not.
21572 * @param obj The spinner object.
21573 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21574 * don't allow users to edit it directly.
21576 * Spinner objects can have edition @b disabled, in which state they will
21577 * be changed only by arrows.
21578 * Useful for contexts
21579 * where you don't want your users to interact with it writting the value.
21581 * when using special values, the user can see real value instead
21582 * of special label on edition.
21584 * It's enabled by default.
21586 * @see elm_spinner_editable_get()
21590 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21593 * Get whether the spinner can be directly edited by the user or not.
21595 * @param obj The spinner object.
21596 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21597 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21599 * @see elm_spinner_editable_set() for details.
21603 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21606 * Set a special string to display in the place of the numerical value.
21608 * @param obj The spinner object.
21609 * @param value The value to be replaced.
21610 * @param label The label to be used.
21612 * It's useful for cases when a user should select an item that is
21613 * better indicated by a label than a value. For example, weekdays or months.
21617 * sp = elm_spinner_add(win);
21618 * elm_spinner_min_max_set(sp, 1, 3);
21619 * elm_spinner_special_value_add(sp, 1, "January");
21620 * elm_spinner_special_value_add(sp, 2, "February");
21621 * elm_spinner_special_value_add(sp, 3, "March");
21622 * evas_object_show(sp);
21627 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21630 * Set the interval on time updates for an user mouse button hold
21631 * on spinner widgets' arrows.
21633 * @param obj The spinner object.
21634 * @param interval The (first) interval value in seconds.
21636 * This interval value is @b decreased while the user holds the
21637 * mouse pointer either incrementing or decrementing spinner's value.
21639 * This helps the user to get to a given value distant from the
21640 * current one easier/faster, as it will start to change quicker and
21641 * quicker on mouse button holds.
21643 * The calculation for the next change interval value, starting from
21644 * the one set with this call, is the previous interval divided by
21645 * @c 1.05, so it decreases a little bit.
21647 * The default starting interval value for automatic changes is
21650 * @see elm_spinner_interval_get()
21654 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21657 * Get the interval on time updates for an user mouse button hold
21658 * on spinner widgets' arrows.
21660 * @param obj The spinner object.
21661 * @return The (first) interval value, in seconds, set on it.
21663 * @see elm_spinner_interval_set() for more details.
21667 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21674 * @defgroup Index Index
21676 * @image html img/widget/index/preview-00.png
21677 * @image latex img/widget/index/preview-00.eps
21679 * An index widget gives you an index for fast access to whichever
21680 * group of other UI items one might have. It's a list of text
21681 * items (usually letters, for alphabetically ordered access).
21683 * Index widgets are by default hidden and just appear when the
21684 * user clicks over it's reserved area in the canvas. In its
21685 * default theme, it's an area one @ref Fingers "finger" wide on
21686 * the right side of the index widget's container.
21688 * When items on the index are selected, smart callbacks get
21689 * called, so that its user can make other container objects to
21690 * show a given area or child object depending on the index item
21691 * selected. You'd probably be using an index together with @ref
21692 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21695 * Smart events one can add callbacks for are:
21696 * - @c "changed" - When the selected index item changes. @c
21697 * event_info is the selected item's data pointer.
21698 * - @c "delay,changed" - When the selected index item changes, but
21699 * after a small idling period. @c event_info is the selected
21700 * item's data pointer.
21701 * - @c "selected" - When the user releases a mouse button and
21702 * selects an item. @c event_info is the selected item's data
21704 * - @c "level,up" - when the user moves a finger from the first
21705 * level to the second level
21706 * - @c "level,down" - when the user moves a finger from the second
21707 * level to the first level
21709 * The @c "delay,changed" event is so that it'll wait a small time
21710 * before actually reporting those events and, moreover, just the
21711 * last event happening on those time frames will actually be
21714 * Here are some examples on its usage:
21715 * @li @ref index_example_01
21716 * @li @ref index_example_02
21720 * @addtogroup Index
21724 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21727 * Add a new index widget to the given parent Elementary
21728 * (container) object
21730 * @param parent The parent object
21731 * @return a new index widget handle or @c NULL, on errors
21733 * This function inserts a new index widget on the canvas.
21737 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21740 * Set whether a given index widget is or not visible,
21743 * @param obj The index object
21744 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21746 * Not to be confused with visible as in @c evas_object_show() --
21747 * visible with regard to the widget's auto hiding feature.
21749 * @see elm_index_active_get()
21753 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21756 * Get whether a given index widget is currently visible or not.
21758 * @param obj The index object
21759 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21761 * @see elm_index_active_set() for more details
21765 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21768 * Set the items level for a given index widget.
21770 * @param obj The index object.
21771 * @param level @c 0 or @c 1, the currently implemented levels.
21773 * @see elm_index_item_level_get()
21777 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21780 * Get the items level set for a given index widget.
21782 * @param obj The index object.
21783 * @return @c 0 or @c 1, which are the levels @p obj might be at.
21785 * @see elm_index_item_level_set() for more information
21789 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21792 * Returns the last selected item's data, for a given index widget.
21794 * @param obj The index object.
21795 * @return The item @b data associated to the last selected item on
21796 * @p obj (or @c NULL, on errors).
21798 * @warning The returned value is @b not an #Elm_Index_Item item
21799 * handle, but the data associated to it (see the @c item parameter
21800 * in elm_index_item_append(), as an example).
21804 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21807 * Append a new item on a given index widget.
21809 * @param obj The index object.
21810 * @param letter Letter under which the item should be indexed
21811 * @param item The item data to set for the index's item
21813 * Despite the most common usage of the @p letter argument is for
21814 * single char strings, one could use arbitrary strings as index
21817 * @c item will be the pointer returned back on @c "changed", @c
21818 * "delay,changed" and @c "selected" smart events.
21822 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21825 * Prepend a new item on a given index widget.
21827 * @param obj The index object.
21828 * @param letter Letter under which the item should be indexed
21829 * @param item The item data to set for the index's item
21831 * Despite the most common usage of the @p letter argument is for
21832 * single char strings, one could use arbitrary strings as index
21835 * @c item will be the pointer returned back on @c "changed", @c
21836 * "delay,changed" and @c "selected" smart events.
21840 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21843 * Append a new item, on a given index widget, <b>after the item
21844 * having @p relative as data</b>.
21846 * @param obj The index object.
21847 * @param letter Letter under which the item should be indexed
21848 * @param item The item data to set for the index's item
21849 * @param relative The item data of the index item to be the
21850 * predecessor of this new one
21852 * Despite the most common usage of the @p letter argument is for
21853 * single char strings, one could use arbitrary strings as index
21856 * @c item will be the pointer returned back on @c "changed", @c
21857 * "delay,changed" and @c "selected" smart events.
21859 * @note If @p relative is @c NULL or if it's not found to be data
21860 * set on any previous item on @p obj, this function will behave as
21861 * elm_index_item_append().
21865 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21868 * Prepend a new item, on a given index widget, <b>after the item
21869 * having @p relative as data</b>.
21871 * @param obj The index object.
21872 * @param letter Letter under which the item should be indexed
21873 * @param item The item data to set for the index's item
21874 * @param relative The item data of the index item to be the
21875 * successor of this new one
21877 * Despite the most common usage of the @p letter argument is for
21878 * single char strings, one could use arbitrary strings as index
21881 * @c item will be the pointer returned back on @c "changed", @c
21882 * "delay,changed" and @c "selected" smart events.
21884 * @note If @p relative is @c NULL or if it's not found to be data
21885 * set on any previous item on @p obj, this function will behave as
21886 * elm_index_item_prepend().
21890 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21893 * Insert a new item into the given index widget, using @p cmp_func
21894 * function to sort items (by item handles).
21896 * @param obj The index object.
21897 * @param letter Letter under which the item should be indexed
21898 * @param item The item data to set for the index's item
21899 * @param cmp_func The comparing function to be used to sort index
21900 * items <b>by #Elm_Index_Item item handles</b>
21901 * @param cmp_data_func A @b fallback function to be called for the
21902 * sorting of index items <b>by item data</b>). It will be used
21903 * when @p cmp_func returns @c 0 (equality), which means an index
21904 * item with provided item data already exists. To decide which
21905 * data item should be pointed to by the index item in question, @p
21906 * cmp_data_func will be used. If @p cmp_data_func returns a
21907 * non-negative value, the previous index item data will be
21908 * replaced by the given @p item pointer. If the previous data need
21909 * to be freed, it should be done by the @p cmp_data_func function,
21910 * because all references to it will be lost. If this function is
21911 * not provided (@c NULL is given), index items will be @b
21912 * duplicated, if @p cmp_func returns @c 0.
21914 * Despite the most common usage of the @p letter argument is for
21915 * single char strings, one could use arbitrary strings as index
21918 * @c item will be the pointer returned back on @c "changed", @c
21919 * "delay,changed" and @c "selected" smart events.
21923 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);
21926 * Remove an item from a given index widget, <b>to be referenced by
21927 * it's data value</b>.
21929 * @param obj The index object
21930 * @param item The item's data pointer for the item to be removed
21933 * If a deletion callback is set, via elm_index_item_del_cb_set(),
21934 * that callback function will be called by this one.
21936 * @warning The item to be removed from @p obj will be found via
21937 * its item data pointer, and not by an #Elm_Index_Item handle.
21941 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21944 * Find a given index widget's item, <b>using item data</b>.
21946 * @param obj The index object
21947 * @param item The item data pointed to by the desired index item
21948 * @return The index item handle, if found, or @c NULL otherwise
21952 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21955 * Removes @b all items from a given index widget.
21957 * @param obj The index object.
21959 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
21960 * that callback function will be called for each item in @p obj.
21964 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21967 * Go to a given items level on a index widget
21969 * @param obj The index object
21970 * @param level The index level (one of @c 0 or @c 1)
21974 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21977 * Return the data associated with a given index widget item
21979 * @param it The index widget item handle
21980 * @return The data associated with @p it
21982 * @see elm_index_item_data_set()
21986 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21989 * Set the data associated with a given index widget item
21991 * @param it The index widget item handle
21992 * @param data The new data pointer to set to @p it
21994 * This sets new item data on @p it.
21996 * @warning The old data pointer won't be touched by this function, so
21997 * the user had better to free that old data himself/herself.
22001 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22004 * Set the function to be called when a given index widget item is freed.
22006 * @param it The item to set the callback on
22007 * @param func The function to call on the item's deletion
22009 * When called, @p func will have both @c data and @c event_info
22010 * arguments with the @p it item's data value and, naturally, the
22011 * @c obj argument with a handle to the parent index widget.
22015 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22018 * Get the letter (string) set on a given index widget item.
22020 * @param it The index item handle
22021 * @return The letter string set on @p it
22025 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22032 * @defgroup Photocam Photocam
22034 * @image html img/widget/photocam/preview-00.png
22035 * @image latex img/widget/photocam/preview-00.eps
22037 * This is a widget specifically for displaying high-resolution digital
22038 * camera photos giving speedy feedback (fast load), low memory footprint
22039 * and zooming and panning as well as fitting logic. It is entirely focused
22040 * on jpeg images, and takes advantage of properties of the jpeg format (via
22041 * evas loader features in the jpeg loader).
22043 * Signals that you can add callbacks for are:
22044 * @li "clicked" - This is called when a user has clicked the photo without
22046 * @li "press" - This is called when a user has pressed down on the photo.
22047 * @li "longpressed" - This is called when a user has pressed down on the
22048 * photo for a long time without dragging around.
22049 * @li "clicked,double" - This is called when a user has double-clicked the
22051 * @li "load" - Photo load begins.
22052 * @li "loaded" - This is called when the image file load is complete for the
22053 * first view (low resolution blurry version).
22054 * @li "load,detail" - Photo detailed data load begins.
22055 * @li "loaded,detail" - This is called when the image file load is complete
22056 * for the detailed image data (full resolution needed).
22057 * @li "zoom,start" - Zoom animation started.
22058 * @li "zoom,stop" - Zoom animation stopped.
22059 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22060 * @li "scroll" - the content has been scrolled (moved)
22061 * @li "scroll,anim,start" - scrolling animation has started
22062 * @li "scroll,anim,stop" - scrolling animation has stopped
22063 * @li "scroll,drag,start" - dragging the contents around has started
22064 * @li "scroll,drag,stop" - dragging the contents around has stopped
22066 * @ref tutorial_photocam shows the API in action.
22070 * @brief Types of zoom available.
22072 typedef enum _Elm_Photocam_Zoom_Mode
22074 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
22075 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22076 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22077 ELM_PHOTOCAM_ZOOM_MODE_LAST
22078 } Elm_Photocam_Zoom_Mode;
22080 * @brief Add a new Photocam object
22082 * @param parent The parent object
22083 * @return The new object or NULL if it cannot be created
22085 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22087 * @brief Set the photo file to be shown
22089 * @param obj The photocam object
22090 * @param file The photo file
22091 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22093 * This sets (and shows) the specified file (with a relative or absolute
22094 * path) and will return a load error (same error that
22095 * evas_object_image_load_error_get() will return). The image will change and
22096 * adjust its size at this point and begin a background load process for this
22097 * photo that at some time in the future will be displayed at the full
22100 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22102 * @brief Returns the path of the current image file
22104 * @param obj The photocam object
22105 * @return Returns the path
22107 * @see elm_photocam_file_set()
22109 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22111 * @brief Set the zoom level of the photo
22113 * @param obj The photocam object
22114 * @param zoom The zoom level to set
22116 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22117 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22118 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22119 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22122 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22124 * @brief Get the zoom level of the photo
22126 * @param obj The photocam object
22127 * @return The current zoom level
22129 * This returns the current zoom level of the photocam object. Note that if
22130 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22131 * (which is the default), the zoom level may be changed at any time by the
22132 * photocam object itself to account for photo size and photocam viewpoer
22135 * @see elm_photocam_zoom_set()
22136 * @see elm_photocam_zoom_mode_set()
22138 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22140 * @brief Set the zoom mode
22142 * @param obj The photocam object
22143 * @param mode The desired mode
22145 * This sets the zoom mode to manual or one of several automatic levels.
22146 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22147 * elm_photocam_zoom_set() and will stay at that level until changed by code
22148 * or until zoom mode is changed. This is the default mode. The Automatic
22149 * modes will allow the photocam object to automatically adjust zoom mode
22150 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22151 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22152 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22153 * pixels within the frame are left unfilled.
22155 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22157 * @brief Get the zoom mode
22159 * @param obj The photocam object
22160 * @return The current zoom mode
22162 * This gets the current zoom mode of the photocam object.
22164 * @see elm_photocam_zoom_mode_set()
22166 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22168 * @brief Get the current image pixel width and height
22170 * @param obj The photocam object
22171 * @param w A pointer to the width return
22172 * @param h A pointer to the height return
22174 * This gets the current photo pixel width and height (for the original).
22175 * The size will be returned in the integers @p w and @p h that are pointed
22178 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22180 * @brief Get the area of the image that is currently shown
22183 * @param x A pointer to the X-coordinate of region
22184 * @param y A pointer to the Y-coordinate of region
22185 * @param w A pointer to the width
22186 * @param h A pointer to the height
22188 * @see elm_photocam_image_region_show()
22189 * @see elm_photocam_image_region_bring_in()
22191 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22193 * @brief Set the viewed portion of the image
22195 * @param obj The photocam object
22196 * @param x X-coordinate of region in image original pixels
22197 * @param y Y-coordinate of region in image original pixels
22198 * @param w Width of region in image original pixels
22199 * @param h Height of region in image original pixels
22201 * This shows the region of the image without using animation.
22203 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22205 * @brief Bring in the viewed portion of the image
22207 * @param obj The photocam object
22208 * @param x X-coordinate of region in image original pixels
22209 * @param y Y-coordinate of region in image original pixels
22210 * @param w Width of region in image original pixels
22211 * @param h Height of region in image original pixels
22213 * This shows the region of the image using animation.
22215 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22217 * @brief Set the paused state for photocam
22219 * @param obj The photocam object
22220 * @param paused The pause state to set
22222 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22223 * photocam. The default is off. This will stop zooming using animation on
22224 * zoom levels changes and change instantly. This will stop any existing
22225 * animations that are running.
22227 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22229 * @brief Get the paused state for photocam
22231 * @param obj The photocam object
22232 * @return The current paused state
22234 * This gets the current paused state for the photocam object.
22236 * @see elm_photocam_paused_set()
22238 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22240 * @brief Get the internal low-res image used for photocam
22242 * @param obj The photocam object
22243 * @return The internal image object handle, or NULL if none exists
22245 * This gets the internal image object inside photocam. Do not modify it. It
22246 * is for inspection only, and hooking callbacks to. Nothing else. It may be
22247 * deleted at any time as well.
22249 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22251 * @brief Set the photocam scrolling bouncing.
22253 * @param obj The photocam object
22254 * @param h_bounce bouncing for horizontal
22255 * @param v_bounce bouncing for vertical
22257 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22259 * @brief Get the photocam scrolling bouncing.
22261 * @param obj The photocam object
22262 * @param h_bounce bouncing for horizontal
22263 * @param v_bounce bouncing for vertical
22265 * @see elm_photocam_bounce_set()
22267 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22273 * @defgroup Map Map
22274 * @ingroup Elementary
22276 * @image html img/widget/map/preview-00.png
22277 * @image latex img/widget/map/preview-00.eps
22279 * This is a widget specifically for displaying a map. It uses basically
22280 * OpenStreetMap provider http://www.openstreetmap.org/,
22281 * but custom providers can be added.
22283 * It supports some basic but yet nice features:
22284 * @li zoom and scroll
22285 * @li markers with content to be displayed when user clicks over it
22286 * @li group of markers
22289 * Smart callbacks one can listen to:
22291 * - "clicked" - This is called when a user has clicked the map without
22293 * - "press" - This is called when a user has pressed down on the map.
22294 * - "longpressed" - This is called when a user has pressed down on the map
22295 * for a long time without dragging around.
22296 * - "clicked,double" - This is called when a user has double-clicked
22298 * - "load,detail" - Map detailed data load begins.
22299 * - "loaded,detail" - This is called when all currently visible parts of
22300 * the map are loaded.
22301 * - "zoom,start" - Zoom animation started.
22302 * - "zoom,stop" - Zoom animation stopped.
22303 * - "zoom,change" - Zoom changed when using an auto zoom mode.
22304 * - "scroll" - the content has been scrolled (moved).
22305 * - "scroll,anim,start" - scrolling animation has started.
22306 * - "scroll,anim,stop" - scrolling animation has stopped.
22307 * - "scroll,drag,start" - dragging the contents around has started.
22308 * - "scroll,drag,stop" - dragging the contents around has stopped.
22309 * - "downloaded" - This is called when all currently required map images
22311 * - "route,load" - This is called when route request begins.
22312 * - "route,loaded" - This is called when route request ends.
22313 * - "name,load" - This is called when name request begins.
22314 * - "name,loaded- This is called when name request ends.
22316 * Available style for map widget:
22319 * Available style for markers:
22324 * Available style for marker bubble:
22327 * List of examples:
22328 * @li @ref map_example_01
22329 * @li @ref map_example_02
22330 * @li @ref map_example_03
22339 * @enum _Elm_Map_Zoom_Mode
22340 * @typedef Elm_Map_Zoom_Mode
22342 * Set map's zoom behavior. It can be set to manual or automatic.
22344 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22346 * Values <b> don't </b> work as bitmask, only one can be choosen.
22348 * @note Valid sizes are 2^zoom, consequently the map may be smaller
22349 * than the scroller view.
22351 * @see elm_map_zoom_mode_set()
22352 * @see elm_map_zoom_mode_get()
22356 typedef enum _Elm_Map_Zoom_Mode
22358 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22359 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22360 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22361 ELM_MAP_ZOOM_MODE_LAST
22362 } Elm_Map_Zoom_Mode;
22365 * @enum _Elm_Map_Route_Sources
22366 * @typedef Elm_Map_Route_Sources
22368 * Set route service to be used. By default used source is
22369 * #ELM_MAP_ROUTE_SOURCE_YOURS.
22371 * @see elm_map_route_source_set()
22372 * @see elm_map_route_source_get()
22376 typedef enum _Elm_Map_Route_Sources
22378 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22379 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. */
22380 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22381 ELM_MAP_ROUTE_SOURCE_LAST
22382 } Elm_Map_Route_Sources;
22384 typedef enum _Elm_Map_Name_Sources
22386 ELM_MAP_NAME_SOURCE_NOMINATIM,
22387 ELM_MAP_NAME_SOURCE_LAST
22388 } Elm_Map_Name_Sources;
22391 * @enum _Elm_Map_Route_Type
22392 * @typedef Elm_Map_Route_Type
22394 * Set type of transport used on route.
22396 * @see elm_map_route_add()
22400 typedef enum _Elm_Map_Route_Type
22402 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22403 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22404 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22405 ELM_MAP_ROUTE_TYPE_LAST
22406 } Elm_Map_Route_Type;
22409 * @enum _Elm_Map_Route_Method
22410 * @typedef Elm_Map_Route_Method
22412 * Set the routing method, what should be priorized, time or distance.
22414 * @see elm_map_route_add()
22418 typedef enum _Elm_Map_Route_Method
22420 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22421 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22422 ELM_MAP_ROUTE_METHOD_LAST
22423 } Elm_Map_Route_Method;
22425 typedef enum _Elm_Map_Name_Method
22427 ELM_MAP_NAME_METHOD_SEARCH,
22428 ELM_MAP_NAME_METHOD_REVERSE,
22429 ELM_MAP_NAME_METHOD_LAST
22430 } Elm_Map_Name_Method;
22432 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(). */
22433 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(). */
22434 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(). */
22435 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(). */
22436 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
22437 typedef struct _Elm_Map_Track Elm_Map_Track;
22439 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. */
22440 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22441 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22442 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22444 typedef char *(*ElmMapModuleSourceFunc) (void);
22445 typedef int (*ElmMapModuleZoomMinFunc) (void);
22446 typedef int (*ElmMapModuleZoomMaxFunc) (void);
22447 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22448 typedef int (*ElmMapModuleRouteSourceFunc) (void);
22449 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22450 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22451 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22452 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22455 * Add a new map widget to the given parent Elementary (container) object.
22457 * @param parent The parent object.
22458 * @return a new map widget handle or @c NULL, on errors.
22460 * This function inserts a new map widget on the canvas.
22464 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22467 * Set the zoom level of the map.
22469 * @param obj The map object.
22470 * @param zoom The zoom level to set.
22472 * This sets the zoom level.
22474 * It will respect limits defined by elm_map_source_zoom_min_set() and
22475 * elm_map_source_zoom_max_set().
22477 * By default these values are 0 (world map) and 18 (maximum zoom).
22479 * This function should be used when zoom mode is set to
22480 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22481 * with elm_map_zoom_mode_set().
22483 * @see elm_map_zoom_mode_set().
22484 * @see elm_map_zoom_get().
22488 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22491 * Get the zoom level of the map.
22493 * @param obj The map object.
22494 * @return The current zoom level.
22496 * This returns the current zoom level of the map object.
22498 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22499 * (which is the default), the zoom level may be changed at any time by the
22500 * map object itself to account for map size and map viewport size.
22502 * @see elm_map_zoom_set() for details.
22506 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22509 * Set the zoom mode used by the map object.
22511 * @param obj The map object.
22512 * @param mode The zoom mode of the map, being it one of
22513 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22514 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22516 * This sets the zoom mode to manual or one of the automatic levels.
22517 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22518 * elm_map_zoom_set() and will stay at that level until changed by code
22519 * or until zoom mode is changed. This is the default mode.
22521 * The Automatic modes will allow the map object to automatically
22522 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22523 * adjust zoom so the map fits inside the scroll frame with no pixels
22524 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22525 * ensure no pixels within the frame are left unfilled. Do not forget that
22526 * the valid sizes are 2^zoom, consequently the map may be smaller than
22527 * the scroller view.
22529 * @see elm_map_zoom_set()
22533 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22536 * Get the zoom mode used by the map object.
22538 * @param obj The map object.
22539 * @return The zoom mode of the map, being it one of
22540 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22541 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22543 * This function returns the current zoom mode used by the map object.
22545 * @see elm_map_zoom_mode_set() for more details.
22549 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22552 * Get the current coordinates of the map.
22554 * @param obj The map object.
22555 * @param lon Pointer where to store longitude.
22556 * @param lat Pointer where to store latitude.
22558 * This gets the current center coordinates of the map object. It can be
22559 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22561 * @see elm_map_geo_region_bring_in()
22562 * @see elm_map_geo_region_show()
22566 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22569 * Animatedly bring in given coordinates to the center of the map.
22571 * @param obj The map object.
22572 * @param lon Longitude to center at.
22573 * @param lat Latitude to center at.
22575 * This causes map to jump to the given @p lat and @p lon coordinates
22576 * and show it (by scrolling) in the center of the viewport, if it is not
22577 * already centered. This will use animation to do so and take a period
22578 * of time to complete.
22580 * @see elm_map_geo_region_show() for a function to avoid animation.
22581 * @see elm_map_geo_region_get()
22585 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22588 * Show the given coordinates at the center of the map, @b immediately.
22590 * @param obj The map object.
22591 * @param lon Longitude to center at.
22592 * @param lat Latitude to center at.
22594 * This causes map to @b redraw its viewport's contents to the
22595 * region contining the given @p lat and @p lon, that will be moved to the
22596 * center of the map.
22598 * @see elm_map_geo_region_bring_in() for a function to move with animation.
22599 * @see elm_map_geo_region_get()
22603 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22606 * Pause or unpause the map.
22608 * @param obj The map object.
22609 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22612 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22615 * The default is off.
22617 * This will stop zooming using animation, changing zoom levels will
22618 * change instantly. This will stop any existing animations that are running.
22620 * @see elm_map_paused_get()
22624 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22627 * Get a value whether map is paused or not.
22629 * @param obj The map object.
22630 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22631 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22633 * This gets the current paused state for the map object.
22635 * @see elm_map_paused_set() for details.
22639 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22642 * Set to show markers during zoom level changes or not.
22644 * @param obj The map object.
22645 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22648 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22651 * The default is off.
22653 * This will stop zooming using animation, changing zoom levels will
22654 * change instantly. This will stop any existing animations that are running.
22656 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22659 * The default is off.
22661 * Enabling it will force the map to stop displaying the markers during
22662 * zoom level changes. Set to on if you have a large number of markers.
22664 * @see elm_map_paused_markers_get()
22668 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22671 * Get a value whether markers will be displayed on zoom level changes or not
22673 * @param obj The map object.
22674 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22675 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22677 * This gets the current markers paused state for the map object.
22679 * @see elm_map_paused_markers_set() for details.
22683 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22686 * Get the information of downloading status.
22688 * @param obj The map object.
22689 * @param try_num Pointer where to store number of tiles being downloaded.
22690 * @param finish_num Pointer where to store number of tiles successfully
22693 * This gets the current downloading status for the map object, the number
22694 * of tiles being downloaded and the number of tiles already downloaded.
22698 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22701 * Convert a pixel coordinate (x,y) into a geographic coordinate
22702 * (longitude, latitude).
22704 * @param obj The map object.
22705 * @param x the coordinate.
22706 * @param y the coordinate.
22707 * @param size the size in pixels of the map.
22708 * The map is a square and generally his size is : pow(2.0, zoom)*256.
22709 * @param lon Pointer where to store the longitude that correspond to x.
22710 * @param lat Pointer where to store the latitude that correspond to y.
22712 * @note Origin pixel point is the top left corner of the viewport.
22713 * Map zoom and size are taken on account.
22715 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22719 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);
22722 * Convert a geographic coordinate (longitude, latitude) into a pixel
22723 * coordinate (x, y).
22725 * @param obj The map object.
22726 * @param lon the longitude.
22727 * @param lat the latitude.
22728 * @param size the size in pixels of the map. The map is a square
22729 * and generally his size is : pow(2.0, zoom)*256.
22730 * @param x Pointer where to store the horizontal pixel coordinate that
22731 * correspond to the longitude.
22732 * @param y Pointer where to store the vertical pixel coordinate that
22733 * correspond to the latitude.
22735 * @note Origin pixel point is the top left corner of the viewport.
22736 * Map zoom and size are taken on account.
22738 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22742 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);
22745 * Convert a geographic coordinate (longitude, latitude) into a name
22748 * @param obj The map object.
22749 * @param lon the longitude.
22750 * @param lat the latitude.
22751 * @return name A #Elm_Map_Name handle for this coordinate.
22753 * To get the string for this address, elm_map_name_address_get()
22756 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22760 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22763 * Convert a name (address) into a geographic coordinate
22764 * (longitude, latitude).
22766 * @param obj The map object.
22767 * @param name The address.
22768 * @return name A #Elm_Map_Name handle for this address.
22770 * To get the longitude and latitude, elm_map_name_region_get()
22773 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22777 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22780 * Convert a pixel coordinate into a rotated pixel coordinate.
22782 * @param obj The map object.
22783 * @param x horizontal coordinate of the point to rotate.
22784 * @param y vertical coordinate of the point to rotate.
22785 * @param cx rotation's center horizontal position.
22786 * @param cy rotation's center vertical position.
22787 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22788 * @param xx Pointer where to store rotated x.
22789 * @param yy Pointer where to store rotated y.
22793 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);
22796 * Add a new marker to the map object.
22798 * @param obj The map object.
22799 * @param lon The longitude of the marker.
22800 * @param lat The latitude of the marker.
22801 * @param clas The class, to use when marker @b isn't grouped to others.
22802 * @param clas_group The class group, to use when marker is grouped to others
22803 * @param data The data passed to the callbacks.
22805 * @return The created marker or @c NULL upon failure.
22807 * A marker will be created and shown in a specific point of the map, defined
22808 * by @p lon and @p lat.
22810 * It will be displayed using style defined by @p class when this marker
22811 * is displayed alone (not grouped). A new class can be created with
22812 * elm_map_marker_class_new().
22814 * If the marker is grouped to other markers, it will be displayed with
22815 * style defined by @p class_group. Markers with the same group are grouped
22816 * if they are close. A new group class can be created with
22817 * elm_map_marker_group_class_new().
22819 * Markers created with this method can be deleted with
22820 * elm_map_marker_remove().
22822 * A marker can have associated content to be displayed by a bubble,
22823 * when a user click over it, as well as an icon. These objects will
22824 * be fetch using class' callback functions.
22826 * @see elm_map_marker_class_new()
22827 * @see elm_map_marker_group_class_new()
22828 * @see elm_map_marker_remove()
22832 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);
22835 * Set the maximum numbers of markers' content to be displayed in a group.
22837 * @param obj The map object.
22838 * @param max The maximum numbers of items displayed in a bubble.
22840 * A bubble will be displayed when the user clicks over the group,
22841 * and will place the content of markers that belong to this group
22844 * A group can have a long list of markers, consequently the creation
22845 * of the content of the bubble can be very slow.
22847 * In order to avoid this, a maximum number of items is displayed
22850 * By default this number is 30.
22852 * Marker with the same group class are grouped if they are close.
22854 * @see elm_map_marker_add()
22858 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
22861 * Remove a marker from the map.
22863 * @param marker The marker to remove.
22865 * @see elm_map_marker_add()
22869 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22872 * Get the current coordinates of the marker.
22874 * @param marker marker.
22875 * @param lat Pointer where to store the marker's latitude.
22876 * @param lon Pointer where to store the marker's longitude.
22878 * These values are set when adding markers, with function
22879 * elm_map_marker_add().
22881 * @see elm_map_marker_add()
22885 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
22888 * Animatedly bring in given marker to the center of the map.
22890 * @param marker The marker to center at.
22892 * This causes map to jump to the given @p marker's coordinates
22893 * and show it (by scrolling) in the center of the viewport, if it is not
22894 * already centered. This will use animation to do so and take a period
22895 * of time to complete.
22897 * @see elm_map_marker_show() for a function to avoid animation.
22898 * @see elm_map_marker_region_get()
22902 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22905 * Show the given marker at the center of the map, @b immediately.
22907 * @param marker The marker to center at.
22909 * This causes map to @b redraw its viewport's contents to the
22910 * region contining the given @p marker's coordinates, that will be
22911 * moved to the center of the map.
22913 * @see elm_map_marker_bring_in() for a function to move with animation.
22914 * @see elm_map_markers_list_show() if more than one marker need to be
22916 * @see elm_map_marker_region_get()
22920 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22923 * Move and zoom the map to display a list of markers.
22925 * @param markers A list of #Elm_Map_Marker handles.
22927 * The map will be centered on the center point of the markers in the list.
22928 * Then the map will be zoomed in order to fit the markers using the maximum
22929 * zoom which allows display of all the markers.
22931 * @warning All the markers should belong to the same map object.
22933 * @see elm_map_marker_show() to show a single marker.
22934 * @see elm_map_marker_bring_in()
22938 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
22941 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
22943 * @param marker The marker wich content should be returned.
22944 * @return Return the evas object if it exists, else @c NULL.
22946 * To set callback function #ElmMapMarkerGetFunc for the marker class,
22947 * elm_map_marker_class_get_cb_set() should be used.
22949 * This content is what will be inside the bubble that will be displayed
22950 * when an user clicks over the marker.
22952 * This returns the actual Evas object used to be placed inside
22953 * the bubble. This may be @c NULL, as it may
22954 * not have been created or may have been deleted, at any time, by
22955 * the map. <b>Do not modify this object</b> (move, resize,
22956 * show, hide, etc.), as the map is controlling it. This
22957 * function is for querying, emitting custom signals or hooking
22958 * lower level callbacks for events on that object. Do not delete
22959 * this object under any circumstances.
22963 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22966 * Update the marker
22968 * @param marker The marker to be updated.
22970 * If a content is set to this marker, it will call function to delete it,
22971 * #ElmMapMarkerDelFunc, and then will fetch the content again with
22972 * #ElmMapMarkerGetFunc.
22974 * These functions are set for the marker class with
22975 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
22979 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22982 * Close all the bubbles opened by the user.
22984 * @param obj The map object.
22986 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
22987 * when the user clicks on a marker.
22989 * This functions is set for the marker class with
22990 * elm_map_marker_class_get_cb_set().
22994 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
22997 * Create a new group class.
22999 * @param obj The map object.
23000 * @return Returns the new group class.
23002 * Each marker must be associated to a group class. Markers in the same
23003 * group are grouped if they are close.
23005 * The group class defines the style of the marker when a marker is grouped
23006 * to others markers. When it is alone, another class will be used.
23008 * A group class will need to be provided when creating a marker with
23009 * elm_map_marker_add().
23011 * Some properties and functions can be set by class, as:
23012 * - style, with elm_map_group_class_style_set()
23013 * - data - to be associated to the group class. It can be set using
23014 * elm_map_group_class_data_set().
23015 * - min zoom to display markers, set with
23016 * elm_map_group_class_zoom_displayed_set().
23017 * - max zoom to group markers, set using
23018 * elm_map_group_class_zoom_grouped_set().
23019 * - visibility - set if markers will be visible or not, set with
23020 * elm_map_group_class_hide_set().
23021 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23022 * It can be set using elm_map_group_class_icon_cb_set().
23024 * @see elm_map_marker_add()
23025 * @see elm_map_group_class_style_set()
23026 * @see elm_map_group_class_data_set()
23027 * @see elm_map_group_class_zoom_displayed_set()
23028 * @see elm_map_group_class_zoom_grouped_set()
23029 * @see elm_map_group_class_hide_set()
23030 * @see elm_map_group_class_icon_cb_set()
23034 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23037 * Set the marker's style of a group class.
23039 * @param clas The group class.
23040 * @param style The style to be used by markers.
23042 * Each marker must be associated to a group class, and will use the style
23043 * defined by such class when grouped to other markers.
23045 * The following styles are provided by default theme:
23046 * @li @c radio - blue circle
23047 * @li @c radio2 - green circle
23050 * @see elm_map_group_class_new() for more details.
23051 * @see elm_map_marker_add()
23055 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23058 * Set the icon callback function of a group class.
23060 * @param clas The group class.
23061 * @param icon_get The callback function that will return the icon.
23063 * Each marker must be associated to a group class, and it can display a
23064 * custom icon. The function @p icon_get must return this icon.
23066 * @see elm_map_group_class_new() for more details.
23067 * @see elm_map_marker_add()
23071 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23074 * Set the data associated to the group class.
23076 * @param clas The group class.
23077 * @param data The new user data.
23079 * This data will be passed for callback functions, like icon get callback,
23080 * that can be set with elm_map_group_class_icon_cb_set().
23082 * If a data was previously set, the object will lose the pointer for it,
23083 * so if needs to be freed, you must do it yourself.
23085 * @see elm_map_group_class_new() for more details.
23086 * @see elm_map_group_class_icon_cb_set()
23087 * @see elm_map_marker_add()
23091 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23094 * Set the minimum zoom from where the markers are displayed.
23096 * @param clas The group class.
23097 * @param zoom The minimum zoom.
23099 * Markers only will be displayed when the map is displayed at @p zoom
23102 * @see elm_map_group_class_new() for more details.
23103 * @see elm_map_marker_add()
23107 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23110 * Set the zoom from where the markers are no more grouped.
23112 * @param clas The group class.
23113 * @param zoom The maximum zoom.
23115 * Markers only will be grouped when the map is displayed at
23116 * less than @p zoom.
23118 * @see elm_map_group_class_new() for more details.
23119 * @see elm_map_marker_add()
23123 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23126 * Set if the markers associated to the group class @clas are hidden or not.
23128 * @param clas The group class.
23129 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23132 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23137 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23140 * Create a new marker class.
23142 * @param obj The map object.
23143 * @return Returns the new group class.
23145 * Each marker must be associated to a class.
23147 * The marker class defines the style of the marker when a marker is
23148 * displayed alone, i.e., not grouped to to others markers. When grouped
23149 * it will use group class style.
23151 * A marker class will need to be provided when creating a marker with
23152 * elm_map_marker_add().
23154 * Some properties and functions can be set by class, as:
23155 * - style, with elm_map_marker_class_style_set()
23156 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23157 * It can be set using elm_map_marker_class_icon_cb_set().
23158 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23159 * Set using elm_map_marker_class_get_cb_set().
23160 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23161 * Set using elm_map_marker_class_del_cb_set().
23163 * @see elm_map_marker_add()
23164 * @see elm_map_marker_class_style_set()
23165 * @see elm_map_marker_class_icon_cb_set()
23166 * @see elm_map_marker_class_get_cb_set()
23167 * @see elm_map_marker_class_del_cb_set()
23171 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23174 * Set the marker's style of a marker class.
23176 * @param clas The marker class.
23177 * @param style The style to be used by markers.
23179 * Each marker must be associated to a marker class, and will use the style
23180 * defined by such class when alone, i.e., @b not grouped to other markers.
23182 * The following styles are provided by default theme:
23187 * @see elm_map_marker_class_new() for more details.
23188 * @see elm_map_marker_add()
23192 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23195 * Set the icon callback function of a marker class.
23197 * @param clas The marker class.
23198 * @param icon_get The callback function that will return the icon.
23200 * Each marker must be associated to a marker class, and it can display a
23201 * custom icon. The function @p icon_get must return this icon.
23203 * @see elm_map_marker_class_new() for more details.
23204 * @see elm_map_marker_add()
23208 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23211 * Set the bubble content callback function of a marker class.
23213 * @param clas The marker class.
23214 * @param get The callback function that will return the content.
23216 * Each marker must be associated to a marker class, and it can display a
23217 * a content on a bubble that opens when the user click over the marker.
23218 * The function @p get must return this content object.
23220 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23223 * @see elm_map_marker_class_new() for more details.
23224 * @see elm_map_marker_class_del_cb_set()
23225 * @see elm_map_marker_add()
23229 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23232 * Set the callback function used to delete bubble content of a marker class.
23234 * @param clas The marker class.
23235 * @param del The callback function that will delete the content.
23237 * Each marker must be associated to a marker class, and it can display a
23238 * a content on a bubble that opens when the user click over the marker.
23239 * The function to return such content can be set with
23240 * elm_map_marker_class_get_cb_set().
23242 * If this content must be freed, a callback function need to be
23243 * set for that task with this function.
23245 * If this callback is defined it will have to delete (or not) the
23246 * object inside, but if the callback is not defined the object will be
23247 * destroyed with evas_object_del().
23249 * @see elm_map_marker_class_new() for more details.
23250 * @see elm_map_marker_class_get_cb_set()
23251 * @see elm_map_marker_add()
23255 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23258 * Get the list of available sources.
23260 * @param obj The map object.
23261 * @return The source names list.
23263 * It will provide a list with all available sources, that can be set as
23264 * current source with elm_map_source_name_set(), or get with
23265 * elm_map_source_name_get().
23267 * Available sources:
23273 * @see elm_map_source_name_set() for more details.
23274 * @see elm_map_source_name_get()
23278 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23281 * Set the source of the map.
23283 * @param obj The map object.
23284 * @param source The source to be used.
23286 * Map widget retrieves images that composes the map from a web service.
23287 * This web service can be set with this method.
23289 * A different service can return a different maps with different
23290 * information and it can use different zoom values.
23292 * The @p source_name need to match one of the names provided by
23293 * elm_map_source_names_get().
23295 * The current source can be get using elm_map_source_name_get().
23297 * @see elm_map_source_names_get()
23298 * @see elm_map_source_name_get()
23303 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23306 * Get the name of currently used source.
23308 * @param obj The map object.
23309 * @return Returns the name of the source in use.
23311 * @see elm_map_source_name_set() for more details.
23315 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23318 * Set the source of the route service to be used by the map.
23320 * @param obj The map object.
23321 * @param source The route service to be used, being it one of
23322 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23323 * and #ELM_MAP_ROUTE_SOURCE_ORS.
23325 * Each one has its own algorithm, so the route retrieved may
23326 * differ depending on the source route. Now, only the default is working.
23328 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23329 * http://www.yournavigation.org/.
23331 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23332 * assumptions. Its routing core is based on Contraction Hierarchies.
23334 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23336 * @see elm_map_route_source_get().
23340 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23343 * Get the current route source.
23345 * @param obj The map object.
23346 * @return The source of the route service used by the map.
23348 * @see elm_map_route_source_set() for details.
23352 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23355 * Set the minimum zoom of the source.
23357 * @param obj The map object.
23358 * @param zoom New minimum zoom value to be used.
23360 * By default, it's 0.
23364 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23367 * Get the minimum zoom of the source.
23369 * @param obj The map object.
23370 * @return Returns the minimum zoom of the source.
23372 * @see elm_map_source_zoom_min_set() for details.
23376 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23379 * Set the maximum zoom of the source.
23381 * @param obj The map object.
23382 * @param zoom New maximum zoom value to be used.
23384 * By default, it's 18.
23388 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23391 * Get the maximum zoom of the source.
23393 * @param obj The map object.
23394 * @return Returns the maximum zoom of the source.
23396 * @see elm_map_source_zoom_min_set() for details.
23400 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23403 * Set the user agent used by the map object to access routing services.
23405 * @param obj The map object.
23406 * @param user_agent The user agent to be used by the map.
23408 * User agent is a client application implementing a network protocol used
23409 * in communications within a clientāserver distributed computing system
23411 * The @p user_agent identification string will transmitted in a header
23412 * field @c User-Agent.
23414 * @see elm_map_user_agent_get()
23418 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23421 * Get the user agent used by the map object.
23423 * @param obj The map object.
23424 * @return The user agent identification string used by the map.
23426 * @see elm_map_user_agent_set() for details.
23430 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23433 * Add a new route to the map object.
23435 * @param obj The map object.
23436 * @param type The type of transport to be considered when tracing a route.
23437 * @param method The routing method, what should be priorized.
23438 * @param flon The start longitude.
23439 * @param flat The start latitude.
23440 * @param tlon The destination longitude.
23441 * @param tlat The destination latitude.
23443 * @return The created route or @c NULL upon failure.
23445 * A route will be traced by point on coordinates (@p flat, @p flon)
23446 * to point on coordinates (@p tlat, @p tlon), using the route service
23447 * set with elm_map_route_source_set().
23449 * It will take @p type on consideration to define the route,
23450 * depending if the user will be walking or driving, the route may vary.
23451 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23452 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23454 * Another parameter is what the route should priorize, the minor distance
23455 * or the less time to be spend on the route. So @p method should be one
23456 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23458 * Routes created with this method can be deleted with
23459 * elm_map_route_remove(), colored with elm_map_route_color_set(),
23460 * and distance can be get with elm_map_route_distance_get().
23462 * @see elm_map_route_remove()
23463 * @see elm_map_route_color_set()
23464 * @see elm_map_route_distance_get()
23465 * @see elm_map_route_source_set()
23469 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);
23472 * Remove a route from the map.
23474 * @param route The route to remove.
23476 * @see elm_map_route_add()
23480 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23483 * Set the route color.
23485 * @param route The route object.
23486 * @param r Red channel value, from 0 to 255.
23487 * @param g Green channel value, from 0 to 255.
23488 * @param b Blue channel value, from 0 to 255.
23489 * @param a Alpha channel value, from 0 to 255.
23491 * It uses an additive color model, so each color channel represents
23492 * how much of each primary colors must to be used. 0 represents
23493 * ausence of this color, so if all of the three are set to 0,
23494 * the color will be black.
23496 * These component values should be integers in the range 0 to 255,
23497 * (single 8-bit byte).
23499 * This sets the color used for the route. By default, it is set to
23500 * solid red (r = 255, g = 0, b = 0, a = 255).
23502 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23504 * @see elm_map_route_color_get()
23508 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23511 * Get the route color.
23513 * @param route The route object.
23514 * @param r Pointer where to store the red channel value.
23515 * @param g Pointer where to store the green channel value.
23516 * @param b Pointer where to store the blue channel value.
23517 * @param a Pointer where to store the alpha channel value.
23519 * @see elm_map_route_color_set() for details.
23523 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23526 * Get the route distance in kilometers.
23528 * @param route The route object.
23529 * @return The distance of route (unit : km).
23533 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23536 * Get the information of route nodes.
23538 * @param route The route object.
23539 * @return Returns a string with the nodes of route.
23543 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23546 * Get the information of route waypoint.
23548 * @param route the route object.
23549 * @return Returns a string with information about waypoint of route.
23553 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23556 * Get the address of the name.
23558 * @param name The name handle.
23559 * @return Returns the address string of @p name.
23561 * This gets the coordinates of the @p name, created with one of the
23562 * conversion functions.
23564 * @see elm_map_utils_convert_name_into_coord()
23565 * @see elm_map_utils_convert_coord_into_name()
23569 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23572 * Get the current coordinates of the name.
23574 * @param name The name handle.
23575 * @param lat Pointer where to store the latitude.
23576 * @param lon Pointer where to store The longitude.
23578 * This gets the coordinates of the @p name, created with one of the
23579 * conversion functions.
23581 * @see elm_map_utils_convert_name_into_coord()
23582 * @see elm_map_utils_convert_coord_into_name()
23586 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23589 * Remove a name from the map.
23591 * @param name The name to remove.
23593 * Basically the struct handled by @p name will be freed, so convertions
23594 * between address and coordinates will be lost.
23596 * @see elm_map_utils_convert_name_into_coord()
23597 * @see elm_map_utils_convert_coord_into_name()
23601 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23606 * @param obj The map object.
23607 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23608 * @param cx Rotation's center horizontal position.
23609 * @param cy Rotation's center vertical position.
23611 * @see elm_map_rotate_get()
23615 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23618 * Get the rotate degree of the map
23620 * @param obj The map object
23621 * @param degree Pointer where to store degrees from 0.0 to 360.0
23622 * to rotate arount Z axis.
23623 * @param cx Pointer where to store rotation's center horizontal position.
23624 * @param cy Pointer where to store rotation's center vertical position.
23626 * @see elm_map_rotate_set() to set map rotation.
23630 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);
23633 * Enable or disable mouse wheel to be used to zoom in / out the map.
23635 * @param obj The map object.
23636 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23639 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23641 * It's disabled by default.
23643 * @see elm_map_wheel_disabled_get()
23647 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23650 * Get a value whether mouse wheel is enabled or not.
23652 * @param obj The map object.
23653 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23654 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23656 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23658 * @see elm_map_wheel_disabled_set() for details.
23662 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23666 * Add a track on the map
23668 * @param obj The map object.
23669 * @param emap The emap route object.
23670 * @return The route object. This is an elm object of type Route.
23672 * @see elm_route_add() for details.
23676 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23680 * Remove a track from the map
23682 * @param obj The map object.
23683 * @param route The track to remove.
23687 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23694 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23696 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23698 EAPI double elm_route_lon_min_get(Evas_Object *obj);
23699 EAPI double elm_route_lat_min_get(Evas_Object *obj);
23700 EAPI double elm_route_lon_max_get(Evas_Object *obj);
23701 EAPI double elm_route_lat_max_get(Evas_Object *obj);
23705 * @defgroup Panel Panel
23707 * @image html img/widget/panel/preview-00.png
23708 * @image latex img/widget/panel/preview-00.eps
23710 * @brief A panel is a type of animated container that contains subobjects.
23711 * It can be expanded or contracted by clicking the button on it's edge.
23713 * Orientations are as follows:
23714 * @li ELM_PANEL_ORIENT_TOP
23715 * @li ELM_PANEL_ORIENT_LEFT
23716 * @li ELM_PANEL_ORIENT_RIGHT
23718 * To set/get/unset the content of the panel, you can use
23719 * elm_object_content_set/get/unset APIs.
23720 * Once the content object is set, a previously set one will be deleted.
23721 * If you want to keep that old content object, use the
23722 * elm_object_content_unset() function
23724 * @ref tutorial_panel shows one way to use this widget.
23727 typedef enum _Elm_Panel_Orient
23729 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23730 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23731 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23732 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23733 } Elm_Panel_Orient;
23735 * @brief Adds a panel object
23737 * @param parent The parent object
23739 * @return The panel object, or NULL on failure
23741 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23743 * @brief Sets the orientation of the panel
23745 * @param parent The parent object
23746 * @param orient The panel orientation. Can be one of the following:
23747 * @li ELM_PANEL_ORIENT_TOP
23748 * @li ELM_PANEL_ORIENT_LEFT
23749 * @li ELM_PANEL_ORIENT_RIGHT
23751 * Sets from where the panel will (dis)appear.
23753 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23755 * @brief Get the orientation of the panel.
23757 * @param obj The panel object
23758 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23760 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23762 * @brief Set the content of the panel.
23764 * @param obj The panel object
23765 * @param content The panel content
23767 * Once the content object is set, a previously set one will be deleted.
23768 * If you want to keep that old content object, use the
23769 * elm_panel_content_unset() function.
23771 * @deprecated use elm_object_content_set() instead
23774 EINA_DEPRECATED EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23776 * @brief Get the content of the panel.
23778 * @param obj The panel object
23779 * @return The content that is being used
23781 * Return the content object which is set for this widget.
23783 * @see elm_panel_content_set()
23785 * @deprecated use elm_object_content_get() instead
23788 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23790 * @brief Unset the content of the panel.
23792 * @param obj The panel object
23793 * @return The content that was being used
23795 * Unparent and return the content object which was set for this widget.
23797 * @see elm_panel_content_set()
23799 * @deprecated use elm_object_content_unset() instead
23802 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23804 * @brief Set the state of the panel.
23806 * @param obj The panel object
23807 * @param hidden If true, the panel will run the animation to contract
23809 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23811 * @brief Get the state of the panel.
23813 * @param obj The panel object
23814 * @param hidden If true, the panel is in the "hide" state
23816 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23818 * @brief Toggle the hidden state of the panel from code
23820 * @param obj The panel object
23822 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23828 * @defgroup Panes Panes
23829 * @ingroup Elementary
23831 * @image html img/widget/panes/preview-00.png
23832 * @image latex img/widget/panes/preview-00.eps width=\textwidth
23834 * @image html img/panes.png
23835 * @image latex img/panes.eps width=\textwidth
23837 * The panes adds a dragable bar between two contents. When dragged
23838 * this bar will resize contents size.
23840 * Panes can be displayed vertically or horizontally, and contents
23841 * size proportion can be customized (homogeneous by default).
23843 * Smart callbacks one can listen to:
23844 * - "press" - The panes has been pressed (button wasn't released yet).
23845 * - "unpressed" - The panes was released after being pressed.
23846 * - "clicked" - The panes has been clicked>
23847 * - "clicked,double" - The panes has been double clicked
23849 * Available styles for it:
23852 * Default contents parts of the panes widget that you can use for are:
23853 * @li "elm.swallow.left" - A leftside content of the panes
23854 * @li "elm.swallow.right" - A rightside content of the panes
23856 * If panes is displayed vertically, left content will be displayed at
23859 * Here is an example on its usage:
23860 * @li @ref panes_example
23863 #define ELM_PANES_CONTENT_LEFT "elm.swallow.left"
23864 #define ELM_PANES_CONTENT_RIGHT "elm.swallow.right"
23867 * @addtogroup Panes
23872 * Add a new panes widget to the given parent Elementary
23873 * (container) object.
23875 * @param parent The parent object.
23876 * @return a new panes widget handle or @c NULL, on errors.
23878 * This function inserts a new panes widget on the canvas.
23882 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23885 * Set the left content of the panes widget.
23887 * @param obj The panes object.
23888 * @param content The new left content object.
23890 * Once the content object is set, a previously set one will be deleted.
23891 * If you want to keep that old content object, use the
23892 * elm_panes_content_left_unset() function.
23894 * If panes is displayed vertically, left content will be displayed at
23897 * @see elm_panes_content_left_get()
23898 * @see elm_panes_content_right_set() to set content on the other side.
23900 * @deprecated use elm_object_content_part_set() instead
23904 EINA_DEPRECATED EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23907 * Set the right content of the panes widget.
23909 * @param obj The panes object.
23910 * @param content The new right content object.
23912 * Once the content object is set, a previously set one will be deleted.
23913 * If you want to keep that old content object, use the
23914 * elm_panes_content_right_unset() function.
23916 * If panes is displayed vertically, left content will be displayed at
23919 * @see elm_panes_content_right_get()
23920 * @see elm_panes_content_left_set() to set content on the other side.
23922 * @deprecated use elm_object_content_part_set() instead
23926 EINA_DEPRECATED EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23929 * Get the left content of the panes.
23931 * @param obj The panes object.
23932 * @return The left content object that is being used.
23934 * Return the left content object which is set for this widget.
23936 * @see elm_panes_content_left_set() for details.
23938 * @deprecated use elm_object_content_part_get() instead
23942 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23945 * Get the right content of the panes.
23947 * @param obj The panes object
23948 * @return The right content object that is being used
23950 * Return the right content object which is set for this widget.
23952 * @see elm_panes_content_right_set() for details.
23954 * @deprecated use elm_object_content_part_get() instead
23958 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23961 * Unset the left content used for the panes.
23963 * @param obj The panes object.
23964 * @return The left content object that was being used.
23966 * Unparent and return the left content object which was set for this widget.
23968 * @see elm_panes_content_left_set() for details.
23969 * @see elm_panes_content_left_get().
23971 * @deprecated use elm_object_content_part_unset() instead
23975 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23978 * Unset the right content used for the panes.
23980 * @param obj The panes object.
23981 * @return The right content object that was being used.
23983 * Unparent and return the right content object which was set for this
23986 * @see elm_panes_content_right_set() for details.
23987 * @see elm_panes_content_right_get().
23989 * @deprecated use elm_object_content_part_unset() instead
23993 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23996 * Get the size proportion of panes widget's left side.
23998 * @param obj The panes object.
23999 * @return float value between 0.0 and 1.0 representing size proportion
24002 * @see elm_panes_content_left_size_set() for more details.
24006 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24009 * Set the size proportion of panes widget's left side.
24011 * @param obj The panes object.
24012 * @param size Value between 0.0 and 1.0 representing size proportion
24015 * By default it's homogeneous, i.e., both sides have the same size.
24017 * If something different is required, it can be set with this function.
24018 * For example, if the left content should be displayed over
24019 * 75% of the panes size, @p size should be passed as @c 0.75.
24020 * This way, right content will be resized to 25% of panes size.
24022 * If displayed vertically, left content is displayed at top, and
24023 * right content at bottom.
24025 * @note This proportion will change when user drags the panes bar.
24027 * @see elm_panes_content_left_size_get()
24031 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24034 * Set the orientation of a given panes widget.
24036 * @param obj The panes object.
24037 * @param horizontal Use @c EINA_TRUE to make @p obj to be
24038 * @b horizontal, @c EINA_FALSE to make it @b vertical.
24040 * Use this function to change how your panes is to be
24041 * disposed: vertically or horizontally.
24043 * By default it's displayed horizontally.
24045 * @see elm_panes_horizontal_get()
24049 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24052 * Retrieve the orientation of a given panes widget.
24054 * @param obj The panes object.
24055 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24056 * @c EINA_FALSE if it's @b vertical (and on errors).
24058 * @see elm_panes_horizontal_set() for more details.
24062 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24063 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24064 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24071 * @defgroup Flip Flip
24073 * @image html img/widget/flip/preview-00.png
24074 * @image latex img/widget/flip/preview-00.eps
24076 * This widget holds 2 content objects(Evas_Object): one on the front and one
24077 * on the back. It allows you to flip from front to back and vice-versa using
24078 * various animations.
24080 * If either the front or back contents are not set the flip will treat that
24081 * as transparent. So if you wore to set the front content but not the back,
24082 * and then call elm_flip_go() you would see whatever is below the flip.
24084 * For a list of supported animations see elm_flip_go().
24086 * Signals that you can add callbacks for are:
24087 * "animate,begin" - when a flip animation was started
24088 * "animate,done" - when a flip animation is finished
24090 * @ref tutorial_flip show how to use most of the API.
24094 typedef enum _Elm_Flip_Mode
24096 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24097 ELM_FLIP_ROTATE_X_CENTER_AXIS,
24098 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24099 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24100 ELM_FLIP_CUBE_LEFT,
24101 ELM_FLIP_CUBE_RIGHT,
24103 ELM_FLIP_CUBE_DOWN,
24104 ELM_FLIP_PAGE_LEFT,
24105 ELM_FLIP_PAGE_RIGHT,
24109 typedef enum _Elm_Flip_Interaction
24111 ELM_FLIP_INTERACTION_NONE,
24112 ELM_FLIP_INTERACTION_ROTATE,
24113 ELM_FLIP_INTERACTION_CUBE,
24114 ELM_FLIP_INTERACTION_PAGE
24115 } Elm_Flip_Interaction;
24116 typedef enum _Elm_Flip_Direction
24118 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24119 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24120 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24121 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24122 } Elm_Flip_Direction;
24124 * @brief Add a new flip to the parent
24126 * @param parent The parent object
24127 * @return The new object or NULL if it cannot be created
24129 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24131 * @brief Set the front content of the flip widget.
24133 * @param obj The flip object
24134 * @param content The new front content object
24136 * Once the content object is set, a previously set one will be deleted.
24137 * If you want to keep that old content object, use the
24138 * elm_flip_content_front_unset() function.
24140 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24142 * @brief Set the back content of the flip widget.
24144 * @param obj The flip object
24145 * @param content The new back content object
24147 * Once the content object is set, a previously set one will be deleted.
24148 * If you want to keep that old content object, use the
24149 * elm_flip_content_back_unset() function.
24151 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24153 * @brief Get the front content used for the flip
24155 * @param obj The flip object
24156 * @return The front content object that is being used
24158 * Return the front content object which is set for this widget.
24160 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24162 * @brief Get the back content used for the flip
24164 * @param obj The flip object
24165 * @return The back content object that is being used
24167 * Return the back content object which is set for this widget.
24169 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24171 * @brief Unset the front content used for the flip
24173 * @param obj The flip object
24174 * @return The front content object that was being used
24176 * Unparent and return the front content object which was set for this widget.
24178 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24180 * @brief Unset the back content used for the flip
24182 * @param obj The flip object
24183 * @return The back content object that was being used
24185 * Unparent and return the back content object which was set for this widget.
24187 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24189 * @brief Get flip front visibility state
24191 * @param obj The flip objct
24192 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24195 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24197 * @brief Set flip perspective
24199 * @param obj The flip object
24200 * @param foc The coordinate to set the focus on
24201 * @param x The X coordinate
24202 * @param y The Y coordinate
24204 * @warning This function currently does nothing.
24206 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24208 * @brief Runs the flip animation
24210 * @param obj The flip object
24211 * @param mode The mode type
24213 * Flips the front and back contents using the @p mode animation. This
24214 * efectively hides the currently visible content and shows the hidden one.
24216 * There a number of possible animations to use for the flipping:
24217 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24218 * around a horizontal axis in the middle of its height, the other content
24219 * is shown as the other side of the flip.
24220 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24221 * around a vertical axis in the middle of its width, the other content is
24222 * shown as the other side of the flip.
24223 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24224 * around a diagonal axis in the middle of its width, the other content is
24225 * shown as the other side of the flip.
24226 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24227 * around a diagonal axis in the middle of its height, the other content is
24228 * shown as the other side of the flip.
24229 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24230 * as if the flip was a cube, the other content is show as the right face of
24232 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24233 * right as if the flip was a cube, the other content is show as the left
24234 * face of the cube.
24235 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24236 * flip was a cube, the other content is show as the bottom face of the cube.
24237 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24238 * the flip was a cube, the other content is show as the upper face of the
24240 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24241 * if the flip was a book, the other content is shown as the page below that.
24242 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24243 * as if the flip was a book, the other content is shown as the page below
24245 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24246 * flip was a book, the other content is shown as the page below that.
24247 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24248 * flip was a book, the other content is shown as the page below that.
24250 * @image html elm_flip.png
24251 * @image latex elm_flip.eps width=\textwidth
24253 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24255 * @brief Set the interactive flip mode
24257 * @param obj The flip object
24258 * @param mode The interactive flip mode to use
24260 * This sets if the flip should be interactive (allow user to click and
24261 * drag a side of the flip to reveal the back page and cause it to flip).
24262 * By default a flip is not interactive. You may also need to set which
24263 * sides of the flip are "active" for flipping and how much space they use
24264 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24265 * and elm_flip_interacton_direction_hitsize_set()
24267 * The four avilable mode of interaction are:
24268 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24269 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24270 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24271 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24273 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24274 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24275 * happen, those can only be acheived with elm_flip_go();
24277 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24279 * @brief Get the interactive flip mode
24281 * @param obj The flip object
24282 * @return The interactive flip mode
24284 * Returns the interactive flip mode set by elm_flip_interaction_set()
24286 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24288 * @brief Set which directions of the flip respond to interactive flip
24290 * @param obj The flip object
24291 * @param dir The direction to change
24292 * @param enabled If that direction is enabled or not
24294 * By default all directions are disabled, so you may want to enable the
24295 * desired directions for flipping if you need interactive flipping. You must
24296 * call this function once for each direction that should be enabled.
24298 * @see elm_flip_interaction_set()
24300 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24302 * @brief Get the enabled state of that flip direction
24304 * @param obj The flip object
24305 * @param dir The direction to check
24306 * @return If that direction is enabled or not
24308 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24310 * @see elm_flip_interaction_set()
24312 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24314 * @brief Set the amount of the flip that is sensitive to interactive flip
24316 * @param obj The flip object
24317 * @param dir The direction to modify
24318 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24320 * Set the amount of the flip that is sensitive to interactive flip, with 0
24321 * representing no area in the flip and 1 representing the entire flip. There
24322 * is however a consideration to be made in that the area will never be
24323 * smaller than the finger size set(as set in your Elementary configuration).
24325 * @see elm_flip_interaction_set()
24327 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24329 * @brief Get the amount of the flip that is sensitive to interactive flip
24331 * @param obj The flip object
24332 * @param dir The direction to check
24333 * @return The size set for that direction
24335 * Returns the amount os sensitive area set by
24336 * elm_flip_interacton_direction_hitsize_set().
24338 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24343 /* scrolledentry */
24344 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24345 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24346 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24347 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24348 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24349 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24350 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24351 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24352 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24353 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24354 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24355 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24356 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24357 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24358 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24359 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24360 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24361 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24362 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24363 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24364 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24365 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24366 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24367 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24368 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24369 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24370 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24371 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24372 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24373 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24374 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24375 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24376 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24377 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24378 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24379 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);
24380 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24381 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24382 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);
24383 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24384 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);
24385 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24386 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24387 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24388 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24389 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24390 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24391 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24392 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24393 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);
24394 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);
24395 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);
24396 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);
24397 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);
24398 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);
24399 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24400 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24401 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24402 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24403 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24404 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24405 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24408 * @defgroup Conformant Conformant
24409 * @ingroup Elementary
24411 * @image html img/widget/conformant/preview-00.png
24412 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24414 * @image html img/conformant.png
24415 * @image latex img/conformant.eps width=\textwidth
24417 * The aim is to provide a widget that can be used in elementary apps to
24418 * account for space taken up by the indicator, virtual keypad & softkey
24419 * windows when running the illume2 module of E17.
24421 * So conformant content will be sized and positioned considering the
24422 * space required for such stuff, and when they popup, as a keyboard
24423 * shows when an entry is selected, conformant content won't change.
24425 * Available styles for it:
24428 * Default contents parts of the conformant widget that you can use for are:
24429 * @li "elm.swallow.content" - A content of the conformant
24431 * See how to use this widget in this example:
24432 * @ref conformant_example
24436 * @addtogroup Conformant
24441 * Add a new conformant widget to the given parent Elementary
24442 * (container) object.
24444 * @param parent The parent object.
24445 * @return A new conformant widget handle or @c NULL, on errors.
24447 * This function inserts a new conformant widget on the canvas.
24449 * @ingroup Conformant
24451 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24454 * Set the content of the conformant widget.
24456 * @param obj The conformant object.
24457 * @param content The content to be displayed by the conformant.
24459 * Content will be sized and positioned considering the space required
24460 * to display a virtual keyboard. So it won't fill all the conformant
24461 * size. This way is possible to be sure that content won't resize
24462 * or be re-positioned after the keyboard is displayed.
24464 * Once the content object is set, a previously set one will be deleted.
24465 * If you want to keep that old content object, use the
24466 * elm_object_content_unset() function.
24468 * @see elm_object_content_unset()
24469 * @see elm_object_content_get()
24471 * @deprecated use elm_object_content_set() instead
24473 * @ingroup Conformant
24475 EINA_DEPRECATED EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24478 * Get the content of the conformant widget.
24480 * @param obj The conformant object.
24481 * @return The content that is being used.
24483 * Return the content object which is set for this widget.
24484 * It won't be unparent from conformant. For that, use
24485 * elm_object_content_unset().
24487 * @see elm_object_content_set().
24488 * @see elm_object_content_unset()
24490 * @deprecated use elm_object_content_get() instead
24492 * @ingroup Conformant
24494 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24497 * Unset the content of the conformant widget.
24499 * @param obj The conformant object.
24500 * @return The content that was being used.
24502 * Unparent and return the content object which was set for this widget.
24504 * @see elm_object_content_set().
24506 * @deprecated use elm_object_content_unset() instead
24508 * @ingroup Conformant
24510 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24513 * Returns the Evas_Object that represents the content area.
24515 * @param obj The conformant object.
24516 * @return The content area of the widget.
24518 * @ingroup Conformant
24520 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24527 * @defgroup Mapbuf Mapbuf
24528 * @ingroup Elementary
24530 * @image html img/widget/mapbuf/preview-00.png
24531 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24533 * This holds one content object and uses an Evas Map of transformation
24534 * points to be later used with this content. So the content will be
24535 * moved, resized, etc as a single image. So it will improve performance
24536 * when you have a complex interafce, with a lot of elements, and will
24537 * need to resize or move it frequently (the content object and its
24540 * To set/get/unset the content of the mapbuf, you can use
24541 * elm_object_content_set/get/unset APIs.
24542 * Once the content object is set, a previously set one will be deleted.
24543 * If you want to keep that old content object, use the
24544 * elm_object_content_unset() function.
24546 * To enable map, elm_mapbuf_enabled_set() should be used.
24548 * See how to use this widget in this example:
24549 * @ref mapbuf_example
24553 * @addtogroup Mapbuf
24558 * Add a new mapbuf widget to the given parent Elementary
24559 * (container) object.
24561 * @param parent The parent object.
24562 * @return A new mapbuf widget handle or @c NULL, on errors.
24564 * This function inserts a new mapbuf widget on the canvas.
24568 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24571 * Set the content of the mapbuf.
24573 * @param obj The mapbuf object.
24574 * @param content The content that will be filled in this mapbuf object.
24576 * Once the content object is set, a previously set one will be deleted.
24577 * If you want to keep that old content object, use the
24578 * elm_mapbuf_content_unset() function.
24580 * To enable map, elm_mapbuf_enabled_set() should be used.
24582 * @deprecated use elm_object_content_set() instead
24586 EINA_DEPRECATED EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24589 * Get the content of the mapbuf.
24591 * @param obj The mapbuf object.
24592 * @return The content that is being used.
24594 * Return the content object which is set for this widget.
24596 * @see elm_mapbuf_content_set() for details.
24598 * @deprecated use elm_object_content_get() instead
24602 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24605 * Unset the content of the mapbuf.
24607 * @param obj The mapbuf object.
24608 * @return The content that was being used.
24610 * Unparent and return the content object which was set for this widget.
24612 * @see elm_mapbuf_content_set() for details.
24614 * @deprecated use elm_object_content_unset() instead
24618 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24621 * Enable or disable the map.
24623 * @param obj The mapbuf object.
24624 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24626 * This enables the map that is set or disables it. On enable, the object
24627 * geometry will be saved, and the new geometry will change (position and
24628 * size) to reflect the map geometry set.
24630 * Also, when enabled, alpha and smooth states will be used, so if the
24631 * content isn't solid, alpha should be enabled, for example, otherwise
24632 * a black retangle will fill the content.
24634 * When disabled, the stored map will be freed and geometry prior to
24635 * enabling the map will be restored.
24637 * It's disabled by default.
24639 * @see elm_mapbuf_alpha_set()
24640 * @see elm_mapbuf_smooth_set()
24644 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24647 * Get a value whether map is enabled or not.
24649 * @param obj The mapbuf object.
24650 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24651 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24653 * @see elm_mapbuf_enabled_set() for details.
24657 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24660 * Enable or disable smooth map rendering.
24662 * @param obj The mapbuf object.
24663 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24666 * This sets smoothing for map rendering. If the object is a type that has
24667 * its own smoothing settings, then both the smooth settings for this object
24668 * and the map must be turned off.
24670 * By default smooth maps are enabled.
24674 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24677 * Get a value whether smooth map rendering is enabled or not.
24679 * @param obj The mapbuf object.
24680 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24681 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24683 * @see elm_mapbuf_smooth_set() for details.
24687 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24690 * Set or unset alpha flag for map rendering.
24692 * @param obj The mapbuf object.
24693 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24696 * This sets alpha flag for map rendering. If the object is a type that has
24697 * its own alpha settings, then this will take precedence. Only image objects
24698 * have this currently. It stops alpha blending of the map area, and is
24699 * useful if you know the object and/or all sub-objects is 100% solid.
24701 * Alpha is enabled by default.
24705 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24708 * Get a value whether alpha blending is enabled or not.
24710 * @param obj The mapbuf object.
24711 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24712 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24714 * @see elm_mapbuf_alpha_set() for details.
24718 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24725 * @defgroup Flipselector Flip Selector
24727 * @image html img/widget/flipselector/preview-00.png
24728 * @image latex img/widget/flipselector/preview-00.eps
24730 * A flip selector is a widget to show a set of @b text items, one
24731 * at a time, with the same sheet switching style as the @ref Clock
24732 * "clock" widget, when one changes the current displaying sheet
24733 * (thus, the "flip" in the name).
24735 * User clicks to flip sheets which are @b held for some time will
24736 * make the flip selector to flip continuosly and automatically for
24737 * the user. The interval between flips will keep growing in time,
24738 * so that it helps the user to reach an item which is distant from
24739 * the current selection.
24741 * Smart callbacks one can register to:
24742 * - @c "selected" - when the widget's selected text item is changed
24743 * - @c "overflowed" - when the widget's current selection is changed
24744 * from the first item in its list to the last
24745 * - @c "underflowed" - when the widget's current selection is changed
24746 * from the last item in its list to the first
24748 * Available styles for it:
24751 * Here is an example on its usage:
24752 * @li @ref flipselector_example
24756 * @addtogroup Flipselector
24760 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24763 * Add a new flip selector widget to the given parent Elementary
24764 * (container) widget
24766 * @param parent The parent object
24767 * @return a new flip selector widget handle or @c NULL, on errors
24769 * This function inserts a new flip selector widget on the canvas.
24771 * @ingroup Flipselector
24773 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24776 * Programmatically select the next item of a flip selector widget
24778 * @param obj The flipselector object
24780 * @note The selection will be animated. Also, if it reaches the
24781 * end of its list of member items, it will continue with the first
24784 * @ingroup Flipselector
24786 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24789 * Programmatically select the previous item of a flip selector
24792 * @param obj The flipselector object
24794 * @note The selection will be animated. Also, if it reaches the
24795 * beginning of its list of member items, it will continue with the
24796 * last one backwards.
24798 * @ingroup Flipselector
24800 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24803 * Append a (text) item to a flip selector widget
24805 * @param obj The flipselector object
24806 * @param label The (text) label of the new item
24807 * @param func Convenience callback function to take place when
24809 * @param data Data passed to @p func, above
24810 * @return A handle to the item added or @c NULL, on errors
24812 * The widget's list of labels to show will be appended with the
24813 * given value. If the user wishes so, a callback function pointer
24814 * can be passed, which will get called when this same item is
24817 * @note The current selection @b won't be modified by appending an
24818 * element to the list.
24820 * @note The maximum length of the text label is going to be
24821 * determined <b>by the widget's theme</b>. Strings larger than
24822 * that value are going to be @b truncated.
24824 * @ingroup Flipselector
24826 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24829 * Prepend a (text) item to a flip selector widget
24831 * @param obj The flipselector object
24832 * @param label The (text) label of the new item
24833 * @param func Convenience callback function to take place when
24835 * @param data Data passed to @p func, above
24836 * @return A handle to the item added or @c NULL, on errors
24838 * The widget's list of labels to show will be prepended with the
24839 * given value. If the user wishes so, a callback function pointer
24840 * can be passed, which will get called when this same item is
24843 * @note The current selection @b won't be modified by prepending
24844 * an element to the list.
24846 * @note The maximum length of the text label is going to be
24847 * determined <b>by the widget's theme</b>. Strings larger than
24848 * that value are going to be @b truncated.
24850 * @ingroup Flipselector
24852 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24855 * Get the internal list of items in a given flip selector widget.
24857 * @param obj The flipselector object
24858 * @return The list of items (#Elm_Flipselector_Item as data) or
24859 * @c NULL on errors.
24861 * This list is @b not to be modified in any way and must not be
24862 * freed. Use the list members with functions like
24863 * elm_flipselector_item_label_set(),
24864 * elm_flipselector_item_label_get(),
24865 * elm_flipselector_item_del(),
24866 * elm_flipselector_item_selected_get(),
24867 * elm_flipselector_item_selected_set().
24869 * @warning This list is only valid until @p obj object's internal
24870 * items list is changed. It should be fetched again with another
24871 * call to this function when changes happen.
24873 * @ingroup Flipselector
24875 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24878 * Get the first item in the given flip selector widget's list of
24881 * @param obj The flipselector object
24882 * @return The first item or @c NULL, if it has no items (and on
24885 * @see elm_flipselector_item_append()
24886 * @see elm_flipselector_last_item_get()
24888 * @ingroup Flipselector
24890 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24893 * Get the last item in the given flip selector widget's list of
24896 * @param obj The flipselector object
24897 * @return The last item or @c NULL, if it has no items (and on
24900 * @see elm_flipselector_item_prepend()
24901 * @see elm_flipselector_first_item_get()
24903 * @ingroup Flipselector
24905 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24908 * Get the currently selected item in a flip selector widget.
24910 * @param obj The flipselector object
24911 * @return The selected item or @c NULL, if the widget has no items
24914 * @ingroup Flipselector
24916 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24919 * Set whether a given flip selector widget's item should be the
24920 * currently selected one.
24922 * @param item The flip selector item
24923 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
24925 * This sets whether @p item is or not the selected (thus, under
24926 * display) one. If @p item is different than one under display,
24927 * the latter will be unselected. If the @p item is set to be
24928 * unselected, on the other hand, the @b first item in the widget's
24929 * internal members list will be the new selected one.
24931 * @see elm_flipselector_item_selected_get()
24933 * @ingroup Flipselector
24935 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24938 * Get whether a given flip selector widget's item is the currently
24941 * @param item The flip selector item
24942 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
24945 * @see elm_flipselector_item_selected_set()
24947 * @ingroup Flipselector
24949 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24952 * Delete a given item from a flip selector widget.
24954 * @param item The item to delete
24956 * @ingroup Flipselector
24958 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24961 * Get the label of a given flip selector widget's item.
24963 * @param item The item to get label from
24964 * @return The text label of @p item or @c NULL, on errors
24966 * @see elm_flipselector_item_label_set()
24968 * @ingroup Flipselector
24970 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24973 * Set the label of a given flip selector widget's item.
24975 * @param item The item to set label on
24976 * @param label The text label string, in UTF-8 encoding
24978 * @see elm_flipselector_item_label_get()
24980 * @ingroup Flipselector
24982 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24985 * Gets the item before @p item in a flip selector widget's
24986 * internal list of items.
24988 * @param item The item to fetch previous from
24989 * @return The item before the @p item, in its parent's list. If
24990 * there is no previous item for @p item or there's an
24991 * error, @c NULL is returned.
24993 * @see elm_flipselector_item_next_get()
24995 * @ingroup Flipselector
24997 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25000 * Gets the item after @p item in a flip selector widget's
25001 * internal list of items.
25003 * @param item The item to fetch next from
25004 * @return The item after the @p item, in its parent's list. If
25005 * there is no next item for @p item or there's an
25006 * error, @c NULL is returned.
25008 * @see elm_flipselector_item_next_get()
25010 * @ingroup Flipselector
25012 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25015 * Set the interval on time updates for an user mouse button hold
25016 * on a flip selector widget.
25018 * @param obj The flip selector object
25019 * @param interval The (first) interval value in seconds
25021 * This interval value is @b decreased while the user holds the
25022 * mouse pointer either flipping up or flipping doww a given flip
25025 * This helps the user to get to a given item distant from the
25026 * current one easier/faster, as it will start to flip quicker and
25027 * quicker on mouse button holds.
25029 * The calculation for the next flip interval value, starting from
25030 * the one set with this call, is the previous interval divided by
25031 * 1.05, so it decreases a little bit.
25033 * The default starting interval value for automatic flips is
25036 * @see elm_flipselector_interval_get()
25038 * @ingroup Flipselector
25040 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25043 * Get the interval on time updates for an user mouse button hold
25044 * on a flip selector widget.
25046 * @param obj The flip selector object
25047 * @return The (first) interval value, in seconds, set on it
25049 * @see elm_flipselector_interval_set() for more details
25051 * @ingroup Flipselector
25053 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25059 * @addtogroup Calendar
25064 * @enum _Elm_Calendar_Mark_Repeat
25065 * @typedef Elm_Calendar_Mark_Repeat
25067 * Event periodicity, used to define if a mark should be repeated
25068 * @b beyond event's day. It's set when a mark is added.
25070 * So, for a mark added to 13th May with periodicity set to WEEKLY,
25071 * there will be marks every week after this date. Marks will be displayed
25072 * at 13th, 20th, 27th, 3rd June ...
25074 * Values don't work as bitmask, only one can be choosen.
25076 * @see elm_calendar_mark_add()
25078 * @ingroup Calendar
25080 typedef enum _Elm_Calendar_Mark_Repeat
25082 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25083 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25084 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25085 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*/
25086 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. */
25087 } Elm_Calendar_Mark_Repeat;
25089 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(). */
25092 * Add a new calendar widget to the given parent Elementary
25093 * (container) object.
25095 * @param parent The parent object.
25096 * @return a new calendar widget handle or @c NULL, on errors.
25098 * This function inserts a new calendar widget on the canvas.
25100 * @ref calendar_example_01
25102 * @ingroup Calendar
25104 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25107 * Get weekdays names displayed by the calendar.
25109 * @param obj The calendar object.
25110 * @return Array of seven strings to be used as weekday names.
25112 * By default, weekdays abbreviations get from system are displayed:
25113 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25114 * The first string is related to Sunday, the second to Monday...
25116 * @see elm_calendar_weekdays_name_set()
25118 * @ref calendar_example_05
25120 * @ingroup Calendar
25122 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25125 * Set weekdays names to be displayed by the calendar.
25127 * @param obj The calendar object.
25128 * @param weekdays Array of seven strings to be used as weekday names.
25129 * @warning It must have 7 elements, or it will access invalid memory.
25130 * @warning The strings must be NULL terminated ('@\0').
25132 * By default, weekdays abbreviations get from system are displayed:
25133 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25135 * The first string should be related to Sunday, the second to Monday...
25137 * The usage should be like this:
25139 * const char *weekdays[] =
25141 * "Sunday", "Monday", "Tuesday", "Wednesday",
25142 * "Thursday", "Friday", "Saturday"
25144 * elm_calendar_weekdays_names_set(calendar, weekdays);
25147 * @see elm_calendar_weekdays_name_get()
25149 * @ref calendar_example_02
25151 * @ingroup Calendar
25153 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25156 * Set the minimum and maximum values for the year
25158 * @param obj The calendar object
25159 * @param min The minimum year, greater than 1901;
25160 * @param max The maximum year;
25162 * Maximum must be greater than minimum, except if you don't wan't to set
25164 * Default values are 1902 and -1.
25166 * If the maximum year is a negative value, it will be limited depending
25167 * on the platform architecture (year 2037 for 32 bits);
25169 * @see elm_calendar_min_max_year_get()
25171 * @ref calendar_example_03
25173 * @ingroup Calendar
25175 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25178 * Get the minimum and maximum values for the year
25180 * @param obj The calendar object.
25181 * @param min The minimum year.
25182 * @param max The maximum year.
25184 * Default values are 1902 and -1.
25186 * @see elm_calendar_min_max_year_get() for more details.
25188 * @ref calendar_example_05
25190 * @ingroup Calendar
25192 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25195 * Enable or disable day selection
25197 * @param obj The calendar object.
25198 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25201 * Enabled by default. If disabled, the user still can select months,
25202 * but not days. Selected days are highlighted on calendar.
25203 * It should be used if you won't need such selection for the widget usage.
25205 * When a day is selected, or month is changed, smart callbacks for
25206 * signal "changed" will be called.
25208 * @see elm_calendar_day_selection_enable_get()
25210 * @ref calendar_example_04
25212 * @ingroup Calendar
25214 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25217 * Get a value whether day selection is enabled or not.
25219 * @see elm_calendar_day_selection_enable_set() for details.
25221 * @param obj The calendar object.
25222 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25223 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25225 * @ref calendar_example_05
25227 * @ingroup Calendar
25229 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25233 * Set selected date to be highlighted on calendar.
25235 * @param obj The calendar object.
25236 * @param selected_time A @b tm struct to represent the selected date.
25238 * Set the selected date, changing the displayed month if needed.
25239 * Selected date changes when the user goes to next/previous month or
25240 * select a day pressing over it on calendar.
25242 * @see elm_calendar_selected_time_get()
25244 * @ref calendar_example_04
25246 * @ingroup Calendar
25248 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25251 * Get selected date.
25253 * @param obj The calendar object
25254 * @param selected_time A @b tm struct to point to selected date
25255 * @return EINA_FALSE means an error ocurred and returned time shouldn't
25258 * Get date selected by the user or set by function
25259 * elm_calendar_selected_time_set().
25260 * Selected date changes when the user goes to next/previous month or
25261 * select a day pressing over it on calendar.
25263 * @see elm_calendar_selected_time_get()
25265 * @ref calendar_example_05
25267 * @ingroup Calendar
25269 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25272 * Set a function to format the string that will be used to display
25275 * @param obj The calendar object
25276 * @param format_function Function to set the month-year string given
25277 * the selected date
25279 * By default it uses strftime with "%B %Y" format string.
25280 * It should allocate the memory that will be used by the string,
25281 * that will be freed by the widget after usage.
25282 * A pointer to the string and a pointer to the time struct will be provided.
25287 * _format_month_year(struct tm *selected_time)
25290 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25291 * return strdup(buf);
25294 * elm_calendar_format_function_set(calendar, _format_month_year);
25297 * @ref calendar_example_02
25299 * @ingroup Calendar
25301 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25304 * Add a new mark to the calendar
25306 * @param obj The calendar object
25307 * @param mark_type A string used to define the type of mark. It will be
25308 * emitted to the theme, that should display a related modification on these
25309 * days representation.
25310 * @param mark_time A time struct to represent the date of inclusion of the
25311 * mark. For marks that repeats it will just be displayed after the inclusion
25312 * date in the calendar.
25313 * @param repeat Repeat the event following this periodicity. Can be a unique
25314 * mark (that don't repeat), daily, weekly, monthly or annually.
25315 * @return The created mark or @p NULL upon failure.
25317 * Add a mark that will be drawn in the calendar respecting the insertion
25318 * time and periodicity. It will emit the type as signal to the widget theme.
25319 * Default theme supports "holiday" and "checked", but it can be extended.
25321 * It won't immediately update the calendar, drawing the marks.
25322 * For this, call elm_calendar_marks_draw(). However, when user selects
25323 * next or previous month calendar forces marks drawn.
25325 * Marks created with this method can be deleted with
25326 * elm_calendar_mark_del().
25330 * struct tm selected_time;
25331 * time_t current_time;
25333 * current_time = time(NULL) + 5 * 84600;
25334 * localtime_r(¤t_time, &selected_time);
25335 * elm_calendar_mark_add(cal, "holiday", selected_time,
25336 * ELM_CALENDAR_ANNUALLY);
25338 * current_time = time(NULL) + 1 * 84600;
25339 * localtime_r(¤t_time, &selected_time);
25340 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25342 * elm_calendar_marks_draw(cal);
25345 * @see elm_calendar_marks_draw()
25346 * @see elm_calendar_mark_del()
25348 * @ref calendar_example_06
25350 * @ingroup Calendar
25352 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);
25355 * Delete mark from the calendar.
25357 * @param mark The mark to be deleted.
25359 * If deleting all calendar marks is required, elm_calendar_marks_clear()
25360 * should be used instead of getting marks list and deleting each one.
25362 * @see elm_calendar_mark_add()
25364 * @ref calendar_example_06
25366 * @ingroup Calendar
25368 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25371 * Remove all calendar's marks
25373 * @param obj The calendar object.
25375 * @see elm_calendar_mark_add()
25376 * @see elm_calendar_mark_del()
25378 * @ingroup Calendar
25380 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25384 * Get a list of all the calendar marks.
25386 * @param obj The calendar object.
25387 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25389 * @see elm_calendar_mark_add()
25390 * @see elm_calendar_mark_del()
25391 * @see elm_calendar_marks_clear()
25393 * @ingroup Calendar
25395 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25398 * Draw calendar marks.
25400 * @param obj The calendar object.
25402 * Should be used after adding, removing or clearing marks.
25403 * It will go through the entire marks list updating the calendar.
25404 * If lots of marks will be added, add all the marks and then call
25407 * When the month is changed, i.e. user selects next or previous month,
25408 * marks will be drawed.
25410 * @see elm_calendar_mark_add()
25411 * @see elm_calendar_mark_del()
25412 * @see elm_calendar_marks_clear()
25414 * @ref calendar_example_06
25416 * @ingroup Calendar
25418 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25421 * Set a day text color to the same that represents Saturdays.
25423 * @param obj The calendar object.
25424 * @param pos The text position. Position is the cell counter, from left
25425 * to right, up to down. It starts on 0 and ends on 41.
25427 * @deprecated use elm_calendar_mark_add() instead like:
25430 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25431 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25434 * @see elm_calendar_mark_add()
25436 * @ingroup Calendar
25438 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25441 * Set a day text color to the same that represents Sundays.
25443 * @param obj The calendar object.
25444 * @param pos The text position. Position is the cell counter, from left
25445 * to right, up to down. It starts on 0 and ends on 41.
25447 * @deprecated use elm_calendar_mark_add() instead like:
25450 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25451 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25454 * @see elm_calendar_mark_add()
25456 * @ingroup Calendar
25458 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25461 * Set a day text color to the same that represents Weekdays.
25463 * @param obj The calendar object
25464 * @param pos The text position. Position is the cell counter, from left
25465 * to right, up to down. It starts on 0 and ends on 41.
25467 * @deprecated use elm_calendar_mark_add() instead like:
25470 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25472 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25473 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25474 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25475 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25476 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25477 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25478 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25479 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25480 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25483 * @see elm_calendar_mark_add()
25485 * @ingroup Calendar
25487 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25490 * Set the interval on time updates for an user mouse button hold
25491 * on calendar widgets' month selection.
25493 * @param obj The calendar object
25494 * @param interval The (first) interval value in seconds
25496 * This interval value is @b decreased while the user holds the
25497 * mouse pointer either selecting next or previous month.
25499 * This helps the user to get to a given month distant from the
25500 * current one easier/faster, as it will start to change quicker and
25501 * quicker on mouse button holds.
25503 * The calculation for the next change interval value, starting from
25504 * the one set with this call, is the previous interval divided by
25505 * 1.05, so it decreases a little bit.
25507 * The default starting interval value for automatic changes is
25510 * @see elm_calendar_interval_get()
25512 * @ingroup Calendar
25514 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25517 * Get the interval on time updates for an user mouse button hold
25518 * on calendar widgets' month selection.
25520 * @param obj The calendar object
25521 * @return The (first) interval value, in seconds, set on it
25523 * @see elm_calendar_interval_set() for more details
25525 * @ingroup Calendar
25527 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25534 * @defgroup Diskselector Diskselector
25535 * @ingroup Elementary
25537 * @image html img/widget/diskselector/preview-00.png
25538 * @image latex img/widget/diskselector/preview-00.eps
25540 * A diskselector is a kind of list widget. It scrolls horizontally,
25541 * and can contain label and icon objects. Three items are displayed
25542 * with the selected one in the middle.
25544 * It can act like a circular list with round mode and labels can be
25545 * reduced for a defined length for side items.
25547 * Smart callbacks one can listen to:
25548 * - "selected" - when item is selected, i.e. scroller stops.
25550 * Available styles for it:
25553 * List of examples:
25554 * @li @ref diskselector_example_01
25555 * @li @ref diskselector_example_02
25559 * @addtogroup Diskselector
25563 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(). */
25566 * Add a new diskselector widget to the given parent Elementary
25567 * (container) object.
25569 * @param parent The parent object.
25570 * @return a new diskselector widget handle or @c NULL, on errors.
25572 * This function inserts a new diskselector widget on the canvas.
25574 * @ingroup Diskselector
25576 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25579 * Enable or disable round mode.
25581 * @param obj The diskselector object.
25582 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25585 * Disabled by default. If round mode is enabled the items list will
25586 * work like a circle list, so when the user reaches the last item,
25587 * the first one will popup.
25589 * @see elm_diskselector_round_get()
25591 * @ingroup Diskselector
25593 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25596 * Get a value whether round mode is enabled or not.
25598 * @see elm_diskselector_round_set() for details.
25600 * @param obj The diskselector object.
25601 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25602 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25604 * @ingroup Diskselector
25606 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25609 * Get the side labels max length.
25611 * @deprecated use elm_diskselector_side_label_length_get() instead:
25613 * @param obj The diskselector object.
25614 * @return The max length defined for side labels, or 0 if not a valid
25617 * @ingroup Diskselector
25619 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25622 * Set the side labels max length.
25624 * @deprecated use elm_diskselector_side_label_length_set() instead:
25626 * @param obj The diskselector object.
25627 * @param len The max length defined for side labels.
25629 * @ingroup Diskselector
25631 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25634 * Get the side labels max length.
25636 * @see elm_diskselector_side_label_length_set() for details.
25638 * @param obj The diskselector object.
25639 * @return The max length defined for side labels, or 0 if not a valid
25642 * @ingroup Diskselector
25644 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25647 * Set the side labels max length.
25649 * @param obj The diskselector object.
25650 * @param len The max length defined for side labels.
25652 * Length is the number of characters of items' label that will be
25653 * visible when it's set on side positions. It will just crop
25654 * the string after defined size. E.g.:
25656 * An item with label "January" would be displayed on side position as
25657 * "Jan" if max length is set to 3, or "Janu", if this property
25660 * When it's selected, the entire label will be displayed, except for
25661 * width restrictions. In this case label will be cropped and "..."
25662 * will be concatenated.
25664 * Default side label max length is 3.
25666 * This property will be applyed over all items, included before or
25667 * later this function call.
25669 * @ingroup Diskselector
25671 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25674 * Set the number of items to be displayed.
25676 * @param obj The diskselector object.
25677 * @param num The number of items the diskselector will display.
25679 * Default value is 3, and also it's the minimun. If @p num is less
25680 * than 3, it will be set to 3.
25682 * Also, it can be set on theme, using data item @c display_item_num
25683 * on group "elm/diskselector/item/X", where X is style set.
25686 * group { name: "elm/diskselector/item/X";
25688 * item: "display_item_num" "5";
25691 * @ingroup Diskselector
25693 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25696 * Get the number of items in the diskselector object.
25698 * @param obj The diskselector object.
25700 * @ingroup Diskselector
25702 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25705 * Set bouncing behaviour when the scrolled content reaches an edge.
25707 * Tell the internal scroller object whether it should bounce or not
25708 * when it reaches the respective edges for each axis.
25710 * @param obj The diskselector object.
25711 * @param h_bounce Whether to bounce or not in the horizontal axis.
25712 * @param v_bounce Whether to bounce or not in the vertical axis.
25714 * @see elm_scroller_bounce_set()
25716 * @ingroup Diskselector
25718 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25721 * Get the bouncing behaviour of the internal scroller.
25723 * Get whether the internal scroller should bounce when the edge of each
25724 * axis is reached scrolling.
25726 * @param obj The diskselector object.
25727 * @param h_bounce Pointer where to store the bounce state of the horizontal
25729 * @param v_bounce Pointer where to store the bounce state of the vertical
25732 * @see elm_scroller_bounce_get()
25733 * @see elm_diskselector_bounce_set()
25735 * @ingroup Diskselector
25737 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25740 * Get the scrollbar policy.
25742 * @see elm_diskselector_scroller_policy_get() for details.
25744 * @param obj The diskselector object.
25745 * @param policy_h Pointer where to store horizontal scrollbar policy.
25746 * @param policy_v Pointer where to store vertical scrollbar policy.
25748 * @ingroup Diskselector
25750 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);
25753 * Set the scrollbar policy.
25755 * @param obj The diskselector object.
25756 * @param policy_h Horizontal scrollbar policy.
25757 * @param policy_v Vertical scrollbar policy.
25759 * This sets the scrollbar visibility policy for the given scroller.
25760 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25761 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25762 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25763 * This applies respectively for the horizontal and vertical scrollbars.
25765 * The both are disabled by default, i.e., are set to
25766 * #ELM_SCROLLER_POLICY_OFF.
25768 * @ingroup Diskselector
25770 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
25773 * Remove all diskselector's items.
25775 * @param obj The diskselector object.
25777 * @see elm_diskselector_item_del()
25778 * @see elm_diskselector_item_append()
25780 * @ingroup Diskselector
25782 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25785 * Get a list of all the diskselector items.
25787 * @param obj The diskselector object.
25788 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
25789 * or @c NULL on failure.
25791 * @see elm_diskselector_item_append()
25792 * @see elm_diskselector_item_del()
25793 * @see elm_diskselector_clear()
25795 * @ingroup Diskselector
25797 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25800 * Appends a new item to the diskselector object.
25802 * @param obj The diskselector object.
25803 * @param label The label of the diskselector item.
25804 * @param icon The icon object to use at left side of the item. An
25805 * icon can be any Evas object, but usually it is an icon created
25806 * with elm_icon_add().
25807 * @param func The function to call when the item is selected.
25808 * @param data The data to associate with the item for related callbacks.
25810 * @return The created item or @c NULL upon failure.
25812 * A new item will be created and appended to the diskselector, i.e., will
25813 * be set as last item. Also, if there is no selected item, it will
25814 * be selected. This will always happens for the first appended item.
25816 * If no icon is set, label will be centered on item position, otherwise
25817 * the icon will be placed at left of the label, that will be shifted
25820 * Items created with this method can be deleted with
25821 * elm_diskselector_item_del().
25823 * Associated @p data can be properly freed when item is deleted if a
25824 * callback function is set with elm_diskselector_item_del_cb_set().
25826 * If a function is passed as argument, it will be called everytime this item
25827 * is selected, i.e., the user stops the diskselector with this
25828 * item on center position. If such function isn't needed, just passing
25829 * @c NULL as @p func is enough. The same should be done for @p data.
25831 * Simple example (with no function callback or data associated):
25833 * disk = elm_diskselector_add(win);
25834 * ic = elm_icon_add(win);
25835 * elm_icon_file_set(ic, "path/to/image", NULL);
25836 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25837 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
25840 * @see elm_diskselector_item_del()
25841 * @see elm_diskselector_item_del_cb_set()
25842 * @see elm_diskselector_clear()
25843 * @see elm_icon_add()
25845 * @ingroup Diskselector
25847 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);
25851 * Delete them item from the diskselector.
25853 * @param it The item of diskselector to be deleted.
25855 * If deleting all diskselector items is required, elm_diskselector_clear()
25856 * should be used instead of getting items list and deleting each one.
25858 * @see elm_diskselector_clear()
25859 * @see elm_diskselector_item_append()
25860 * @see elm_diskselector_item_del_cb_set()
25862 * @ingroup Diskselector
25864 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25867 * Set the function called when a diskselector item is freed.
25869 * @param it The item to set the callback on
25870 * @param func The function called
25872 * If there is a @p func, then it will be called prior item's memory release.
25873 * That will be called with the following arguments:
25875 * @li item's Evas object;
25878 * This way, a data associated to a diskselector item could be properly
25881 * @ingroup Diskselector
25883 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
25886 * Get the data associated to the item.
25888 * @param it The diskselector item
25889 * @return The data associated to @p it
25891 * The return value is a pointer to data associated to @p item when it was
25892 * created, with function elm_diskselector_item_append(). If no data
25893 * was passed as argument, it will return @c NULL.
25895 * @see elm_diskselector_item_append()
25897 * @ingroup Diskselector
25899 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25902 * Set the icon associated to the item.
25904 * @param it The diskselector item
25905 * @param icon The icon object to associate with @p it
25907 * The icon object to use at left side of the item. An
25908 * icon can be any Evas object, but usually it is an icon created
25909 * with elm_icon_add().
25911 * Once the icon object is set, a previously set one will be deleted.
25912 * @warning Setting the same icon for two items will cause the icon to
25913 * dissapear from the first item.
25915 * If an icon was passed as argument on item creation, with function
25916 * elm_diskselector_item_append(), it will be already
25917 * associated to the item.
25919 * @see elm_diskselector_item_append()
25920 * @see elm_diskselector_item_icon_get()
25922 * @ingroup Diskselector
25924 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
25927 * Get the icon associated to the item.
25929 * @param it The diskselector item
25930 * @return The icon associated to @p it
25932 * The return value is a pointer to the icon associated to @p item when it was
25933 * created, with function elm_diskselector_item_append(), or later
25934 * with function elm_diskselector_item_icon_set. If no icon
25935 * was passed as argument, it will return @c NULL.
25937 * @see elm_diskselector_item_append()
25938 * @see elm_diskselector_item_icon_set()
25940 * @ingroup Diskselector
25942 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25945 * Set the label of item.
25947 * @param it The item of diskselector.
25948 * @param label The label of item.
25950 * The label to be displayed by the item.
25952 * If no icon is set, label will be centered on item position, otherwise
25953 * the icon will be placed at left of the label, that will be shifted
25956 * An item with label "January" would be displayed on side position as
25957 * "Jan" if max length is set to 3 with function
25958 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
25961 * When this @p item is selected, the entire label will be displayed,
25962 * except for width restrictions.
25963 * In this case label will be cropped and "..." will be concatenated,
25964 * but only for display purposes. It will keep the entire string, so
25965 * if diskselector is resized the remaining characters will be displayed.
25967 * If a label was passed as argument on item creation, with function
25968 * elm_diskselector_item_append(), it will be already
25969 * displayed by the item.
25971 * @see elm_diskselector_side_label_lenght_set()
25972 * @see elm_diskselector_item_label_get()
25973 * @see elm_diskselector_item_append()
25975 * @ingroup Diskselector
25977 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
25980 * Get the label of item.
25982 * @param it The item of diskselector.
25983 * @return The label of item.
25985 * The return value is a pointer to the label associated to @p item when it was
25986 * created, with function elm_diskselector_item_append(), or later
25987 * with function elm_diskselector_item_label_set. If no label
25988 * was passed as argument, it will return @c NULL.
25990 * @see elm_diskselector_item_label_set() for more details.
25991 * @see elm_diskselector_item_append()
25993 * @ingroup Diskselector
25995 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25998 * Get the selected item.
26000 * @param obj The diskselector object.
26001 * @return The selected diskselector item.
26003 * The selected item can be unselected with function
26004 * elm_diskselector_item_selected_set(), and the first item of
26005 * diskselector will be selected.
26007 * The selected item always will be centered on diskselector, with
26008 * full label displayed, i.e., max lenght set to side labels won't
26009 * apply on the selected item. More details on
26010 * elm_diskselector_side_label_length_set().
26012 * @ingroup Diskselector
26014 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26017 * Set the selected state of an item.
26019 * @param it The diskselector item
26020 * @param selected The selected state
26022 * This sets the selected state of the given item @p it.
26023 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26025 * If a new item is selected the previosly selected will be unselected.
26026 * Previoulsy selected item can be get with function
26027 * elm_diskselector_selected_item_get().
26029 * If the item @p it is unselected, the first item of diskselector will
26032 * Selected items will be visible on center position of diskselector.
26033 * So if it was on another position before selected, or was invisible,
26034 * diskselector will animate items until the selected item reaches center
26037 * @see elm_diskselector_item_selected_get()
26038 * @see elm_diskselector_selected_item_get()
26040 * @ingroup Diskselector
26042 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26045 * Get whether the @p item is selected or not.
26047 * @param it The diskselector item.
26048 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26049 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26051 * @see elm_diskselector_selected_item_set() for details.
26052 * @see elm_diskselector_item_selected_get()
26054 * @ingroup Diskselector
26056 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26059 * Get the first item of the diskselector.
26061 * @param obj The diskselector object.
26062 * @return The first item, or @c NULL if none.
26064 * The list of items follows append order. So it will return the first
26065 * item appended to the widget that wasn't deleted.
26067 * @see elm_diskselector_item_append()
26068 * @see elm_diskselector_items_get()
26070 * @ingroup Diskselector
26072 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26075 * Get the last item of the diskselector.
26077 * @param obj The diskselector object.
26078 * @return The last item, or @c NULL if none.
26080 * The list of items follows append order. So it will return last first
26081 * item appended to the widget that wasn't deleted.
26083 * @see elm_diskselector_item_append()
26084 * @see elm_diskselector_items_get()
26086 * @ingroup Diskselector
26088 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26091 * Get the item before @p item in diskselector.
26093 * @param it The diskselector item.
26094 * @return The item before @p item, or @c NULL if none or on failure.
26096 * The list of items follows append order. So it will return item appended
26097 * just before @p item and that wasn't deleted.
26099 * If it is the first item, @c NULL will be returned.
26100 * First item can be get by elm_diskselector_first_item_get().
26102 * @see elm_diskselector_item_append()
26103 * @see elm_diskselector_items_get()
26105 * @ingroup Diskselector
26107 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26110 * Get the item after @p item in diskselector.
26112 * @param it The diskselector item.
26113 * @return The item after @p item, or @c NULL if none or on failure.
26115 * The list of items follows append order. So it will return item appended
26116 * just after @p item and that wasn't deleted.
26118 * If it is the last item, @c NULL will be returned.
26119 * Last item can be get by elm_diskselector_last_item_get().
26121 * @see elm_diskselector_item_append()
26122 * @see elm_diskselector_items_get()
26124 * @ingroup Diskselector
26126 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26129 * Set the text to be shown in the diskselector item.
26131 * @param item Target item
26132 * @param text The text to set in the content
26134 * Setup the text as tooltip to object. The item can have only one tooltip,
26135 * so any previous tooltip data is removed.
26137 * @see elm_object_tooltip_text_set() for more details.
26139 * @ingroup Diskselector
26141 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26144 * Set the content to be shown in the tooltip item.
26146 * Setup the tooltip to item. The item can have only one tooltip,
26147 * so any previous tooltip data is removed. @p func(with @p data) will
26148 * be called every time that need show the tooltip and it should
26149 * return a valid Evas_Object. This object is then managed fully by
26150 * tooltip system and is deleted when the tooltip is gone.
26152 * @param item the diskselector item being attached a tooltip.
26153 * @param func the function used to create the tooltip contents.
26154 * @param data what to provide to @a func as callback data/context.
26155 * @param del_cb called when data is not needed anymore, either when
26156 * another callback replaces @p func, the tooltip is unset with
26157 * elm_diskselector_item_tooltip_unset() or the owner @a item
26158 * dies. This callback receives as the first parameter the
26159 * given @a data, and @c event_info is the item.
26161 * @see elm_object_tooltip_content_cb_set() for more details.
26163 * @ingroup Diskselector
26165 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);
26168 * Unset tooltip from item.
26170 * @param item diskselector item to remove previously set tooltip.
26172 * Remove tooltip from item. The callback provided as del_cb to
26173 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26174 * it is not used anymore.
26176 * @see elm_object_tooltip_unset() for more details.
26177 * @see elm_diskselector_item_tooltip_content_cb_set()
26179 * @ingroup Diskselector
26181 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26185 * Sets a different style for this item tooltip.
26187 * @note before you set a style you should define a tooltip with
26188 * elm_diskselector_item_tooltip_content_cb_set() or
26189 * elm_diskselector_item_tooltip_text_set()
26191 * @param item diskselector item with tooltip already set.
26192 * @param style the theme style to use (default, transparent, ...)
26194 * @see elm_object_tooltip_style_set() for more details.
26196 * @ingroup Diskselector
26198 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26201 * Get the style for this item tooltip.
26203 * @param item diskselector item with tooltip already set.
26204 * @return style the theme style in use, defaults to "default". If the
26205 * object does not have a tooltip set, then NULL is returned.
26207 * @see elm_object_tooltip_style_get() for more details.
26208 * @see elm_diskselector_item_tooltip_style_set()
26210 * @ingroup Diskselector
26212 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26215 * Set the cursor to be shown when mouse is over the diskselector item
26217 * @param item Target item
26218 * @param cursor the cursor name to be used.
26220 * @see elm_object_cursor_set() for more details.
26222 * @ingroup Diskselector
26224 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26227 * Get the cursor to be shown when mouse is over the diskselector item
26229 * @param item diskselector item with cursor already set.
26230 * @return the cursor name.
26232 * @see elm_object_cursor_get() for more details.
26233 * @see elm_diskselector_cursor_set()
26235 * @ingroup Diskselector
26237 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26241 * Unset the cursor to be shown when mouse is over the diskselector item
26243 * @param item Target item
26245 * @see elm_object_cursor_unset() for more details.
26246 * @see elm_diskselector_cursor_set()
26248 * @ingroup Diskselector
26250 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26253 * Sets a different style for this item cursor.
26255 * @note before you set a style you should define a cursor with
26256 * elm_diskselector_item_cursor_set()
26258 * @param item diskselector item with cursor already set.
26259 * @param style the theme style to use (default, transparent, ...)
26261 * @see elm_object_cursor_style_set() for more details.
26263 * @ingroup Diskselector
26265 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26269 * Get the style for this item cursor.
26271 * @param item diskselector item with cursor already set.
26272 * @return style the theme style in use, defaults to "default". If the
26273 * object does not have a cursor set, then @c NULL is returned.
26275 * @see elm_object_cursor_style_get() for more details.
26276 * @see elm_diskselector_item_cursor_style_set()
26278 * @ingroup Diskselector
26280 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26284 * Set if the cursor set should be searched on the theme or should use
26285 * the provided by the engine, only.
26287 * @note before you set if should look on theme you should define a cursor
26288 * with elm_diskselector_item_cursor_set().
26289 * By default it will only look for cursors provided by the engine.
26291 * @param item widget item with cursor already set.
26292 * @param engine_only boolean to define if cursors set with
26293 * elm_diskselector_item_cursor_set() should be searched only
26294 * between cursors provided by the engine or searched on widget's
26297 * @see elm_object_cursor_engine_only_set() for more details.
26299 * @ingroup Diskselector
26301 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26304 * Get the cursor engine only usage for this item cursor.
26306 * @param item widget item with cursor already set.
26307 * @return engine_only boolean to define it cursors should be looked only
26308 * between the provided by the engine or searched on widget's theme as well.
26309 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26311 * @see elm_object_cursor_engine_only_get() for more details.
26312 * @see elm_diskselector_item_cursor_engine_only_set()
26314 * @ingroup Diskselector
26316 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26323 * @defgroup Colorselector Colorselector
26327 * @image html img/widget/colorselector/preview-00.png
26328 * @image latex img/widget/colorselector/preview-00.eps
26330 * @brief Widget for user to select a color.
26332 * Signals that you can add callbacks for are:
26333 * "changed" - When the color value changes(event_info is NULL).
26335 * See @ref tutorial_colorselector.
26338 * @brief Add a new colorselector to the parent
26340 * @param parent The parent object
26341 * @return The new object or NULL if it cannot be created
26343 * @ingroup Colorselector
26345 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26347 * Set a color for the colorselector
26349 * @param obj Colorselector object
26350 * @param r r-value of color
26351 * @param g g-value of color
26352 * @param b b-value of color
26353 * @param a a-value of color
26355 * @ingroup Colorselector
26357 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26359 * Get a color from the colorselector
26361 * @param obj Colorselector object
26362 * @param r integer pointer for r-value of color
26363 * @param g integer pointer for g-value of color
26364 * @param b integer pointer for b-value of color
26365 * @param a integer pointer for a-value of color
26367 * @ingroup Colorselector
26369 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26375 * @defgroup Ctxpopup Ctxpopup
26377 * @image html img/widget/ctxpopup/preview-00.png
26378 * @image latex img/widget/ctxpopup/preview-00.eps
26380 * @brief Context popup widet.
26382 * A ctxpopup is a widget that, when shown, pops up a list of items.
26383 * It automatically chooses an area inside its parent object's view
26384 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26385 * optimally fit into it. In the default theme, it will also point an
26386 * arrow to it's top left position at the time one shows it. Ctxpopup
26387 * items have a label and/or an icon. It is intended for a small
26388 * number of items (hence the use of list, not genlist).
26390 * @note Ctxpopup is a especialization of @ref Hover.
26392 * Signals that you can add callbacks for are:
26393 * "dismissed" - the ctxpopup was dismissed
26395 * Default contents parts of the ctxpopup widget that you can use for are:
26396 * @li "elm.swallow.content" - A content of the ctxpopup
26398 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26401 typedef enum _Elm_Ctxpopup_Direction
26403 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26405 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26406 the clicked area */
26407 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26408 the clicked area */
26409 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26411 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26412 } Elm_Ctxpopup_Direction;
26415 * @brief Add a new Ctxpopup object to the parent.
26417 * @param parent Parent object
26418 * @return New object or @c NULL, if it cannot be created
26420 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26422 * @brief Set the Ctxpopup's parent
26424 * @param obj The ctxpopup object
26425 * @param area The parent to use
26427 * Set the parent object.
26429 * @note elm_ctxpopup_add() will automatically call this function
26430 * with its @c parent argument.
26432 * @see elm_ctxpopup_add()
26433 * @see elm_hover_parent_set()
26435 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26437 * @brief Get the Ctxpopup's parent
26439 * @param obj The ctxpopup object
26441 * @see elm_ctxpopup_hover_parent_set() for more information
26443 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26445 * @brief Clear all items in the given ctxpopup object.
26447 * @param obj Ctxpopup object
26449 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26451 * @brief Change the ctxpopup's orientation to horizontal or vertical.
26453 * @param obj Ctxpopup object
26454 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26456 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26458 * @brief Get the value of current ctxpopup object's orientation.
26460 * @param obj Ctxpopup object
26461 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26463 * @see elm_ctxpopup_horizontal_set()
26465 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26467 * @brief Add a new item to a ctxpopup object.
26469 * @param obj Ctxpopup object
26470 * @param icon Icon to be set on new item
26471 * @param label The Label of the new item
26472 * @param func Convenience function called when item selected
26473 * @param data Data passed to @p func
26474 * @return A handle to the item added or @c NULL, on errors
26476 * @warning Ctxpopup can't hold both an item list and a content at the same
26477 * time. When an item is added, any previous content will be removed.
26479 * @see elm_ctxpopup_content_set()
26481 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);
26483 * @brief Delete the given item in a ctxpopup object.
26485 * @param it Ctxpopup item to be deleted
26487 * @see elm_ctxpopup_item_append()
26489 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26491 * @brief Set the ctxpopup item's state as disabled or enabled.
26493 * @param it Ctxpopup item to be enabled/disabled
26494 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26496 * When disabled the item is greyed out to indicate it's state.
26498 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26500 * @brief Get the ctxpopup item's disabled/enabled state.
26502 * @param it Ctxpopup item to be enabled/disabled
26503 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26505 * @see elm_ctxpopup_item_disabled_set()
26507 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26509 * @brief Get the icon object for the given ctxpopup item.
26511 * @param it Ctxpopup item
26512 * @return icon object or @c NULL, if the item does not have icon or an error
26515 * @see elm_ctxpopup_item_append()
26516 * @see elm_ctxpopup_item_icon_set()
26518 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26520 * @brief Sets the side icon associated with the ctxpopup item
26522 * @param it Ctxpopup item
26523 * @param icon Icon object to be set
26525 * Once the icon object is set, a previously set one will be deleted.
26526 * @warning Setting the same icon for two items will cause the icon to
26527 * dissapear from the first item.
26529 * @see elm_ctxpopup_item_append()
26531 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26533 * @brief Get the label for the given ctxpopup item.
26535 * @param it Ctxpopup item
26536 * @return label string or @c NULL, if the item does not have label or an
26539 * @see elm_ctxpopup_item_append()
26540 * @see elm_ctxpopup_item_label_set()
26542 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26544 * @brief (Re)set the label on the given ctxpopup item.
26546 * @param it Ctxpopup item
26547 * @param label String to set as label
26549 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26551 * @brief Set an elm widget as the content of the ctxpopup.
26553 * @param obj Ctxpopup object
26554 * @param content Content to be swallowed
26556 * If the content object is already set, a previous one will bedeleted. If
26557 * you want to keep that old content object, use the
26558 * elm_ctxpopup_content_unset() function.
26560 * @deprecated use elm_object_content_set()
26562 * @warning Ctxpopup can't hold both a item list and a content at the same
26563 * time. When a content is set, any previous items will be removed.
26566 * @deprecated use elm_object_content_set() instead
26569 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26571 * @brief Unset the ctxpopup content
26573 * @param obj Ctxpopup object
26574 * @return The content that was being used
26576 * Unparent and return the content object which was set for this widget.
26578 * @deprecated use elm_object_content_unset()
26580 * @see elm_ctxpopup_content_set()
26582 * @deprecated use elm_object_content_unset() instead
26585 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26587 * @brief Set the direction priority of a ctxpopup.
26589 * @param obj Ctxpopup object
26590 * @param first 1st priority of direction
26591 * @param second 2nd priority of direction
26592 * @param third 3th priority of direction
26593 * @param fourth 4th priority of direction
26595 * This functions gives a chance to user to set the priority of ctxpopup
26596 * showing direction. This doesn't guarantee the ctxpopup will appear in the
26597 * requested direction.
26599 * @see Elm_Ctxpopup_Direction
26601 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);
26603 * @brief Get the direction priority of a ctxpopup.
26605 * @param obj Ctxpopup object
26606 * @param first 1st priority of direction to be returned
26607 * @param second 2nd priority of direction to be returned
26608 * @param third 3th priority of direction to be returned
26609 * @param fourth 4th priority of direction to be returned
26611 * @see elm_ctxpopup_direction_priority_set() for more information.
26613 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);
26616 * @brief Get the current direction of a ctxpopup.
26618 * @param obj Ctxpopup object
26619 * @return current direction of a ctxpopup
26621 * @warning Once the ctxpopup showed up, the direction would be determined
26623 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26632 * @defgroup Transit Transit
26633 * @ingroup Elementary
26635 * Transit is designed to apply various animated transition effects to @c
26636 * Evas_Object, such like translation, rotation, etc. For using these
26637 * effects, create an @ref Elm_Transit and add the desired transition effects.
26639 * Once the effects are added into transit, they will be automatically
26640 * managed (their callback will be called until the duration is ended, and
26641 * they will be deleted on completion).
26645 * Elm_Transit *trans = elm_transit_add();
26646 * elm_transit_object_add(trans, obj);
26647 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26648 * elm_transit_duration_set(transit, 1);
26649 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26650 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26651 * elm_transit_repeat_times_set(transit, 3);
26654 * Some transition effects are used to change the properties of objects. They
26656 * @li @ref elm_transit_effect_translation_add
26657 * @li @ref elm_transit_effect_color_add
26658 * @li @ref elm_transit_effect_rotation_add
26659 * @li @ref elm_transit_effect_wipe_add
26660 * @li @ref elm_transit_effect_zoom_add
26661 * @li @ref elm_transit_effect_resizing_add
26663 * Other transition effects are used to make one object disappear and another
26664 * object appear on its old place. These effects are:
26666 * @li @ref elm_transit_effect_flip_add
26667 * @li @ref elm_transit_effect_resizable_flip_add
26668 * @li @ref elm_transit_effect_fade_add
26669 * @li @ref elm_transit_effect_blend_add
26671 * It's also possible to make a transition chain with @ref
26672 * elm_transit_chain_transit_add.
26674 * @warning We strongly recommend to use elm_transit just when edje can not do
26675 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26676 * animations can be manipulated inside the theme.
26678 * List of examples:
26679 * @li @ref transit_example_01_explained
26680 * @li @ref transit_example_02_explained
26681 * @li @ref transit_example_03_c
26682 * @li @ref transit_example_04_c
26688 * @enum Elm_Transit_Tween_Mode
26690 * The type of acceleration used in the transition.
26694 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26695 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26696 over time, then decrease again
26698 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26700 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26702 } Elm_Transit_Tween_Mode;
26705 * @enum Elm_Transit_Effect_Flip_Axis
26707 * The axis where flip effect should be applied.
26711 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26712 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26713 } Elm_Transit_Effect_Flip_Axis;
26715 * @enum Elm_Transit_Effect_Wipe_Dir
26717 * The direction where the wipe effect should occur.
26721 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26722 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26723 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26724 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26725 } Elm_Transit_Effect_Wipe_Dir;
26726 /** @enum Elm_Transit_Effect_Wipe_Type
26728 * Whether the wipe effect should show or hide the object.
26732 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26734 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26736 } Elm_Transit_Effect_Wipe_Type;
26739 * @typedef Elm_Transit
26741 * The Transit created with elm_transit_add(). This type has the information
26742 * about the objects which the transition will be applied, and the
26743 * transition effects that will be used. It also contains info about
26744 * duration, number of repetitions, auto-reverse, etc.
26746 typedef struct _Elm_Transit Elm_Transit;
26747 typedef void Elm_Transit_Effect;
26749 * @typedef Elm_Transit_Effect_Transition_Cb
26751 * Transition callback called for this effect on each transition iteration.
26753 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26755 * Elm_Transit_Effect_End_Cb
26757 * Transition callback called for this effect when the transition is over.
26759 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26762 * Elm_Transit_Del_Cb
26764 * A callback called when the transit is deleted.
26766 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26771 * @note Is not necessary to delete the transit object, it will be deleted at
26772 * the end of its operation.
26773 * @note The transit will start playing when the program enter in the main loop, is not
26774 * necessary to give a start to the transit.
26776 * @return The transit object.
26780 EAPI Elm_Transit *elm_transit_add(void);
26783 * Stops the animation and delete the @p transit object.
26785 * Call this function if you wants to stop the animation before the duration
26786 * time. Make sure the @p transit object is still alive with
26787 * elm_transit_del_cb_set() function.
26788 * All added effects will be deleted, calling its repective data_free_cb
26789 * functions. The function setted by elm_transit_del_cb_set() will be called.
26791 * @see elm_transit_del_cb_set()
26793 * @param transit The transit object to be deleted.
26796 * @warning Just call this function if you are sure the transit is alive.
26798 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26801 * Add a new effect to the transit.
26803 * @note The cb function and the data are the key to the effect. If you try to
26804 * add an already added effect, nothing is done.
26805 * @note After the first addition of an effect in @p transit, if its
26806 * effect list become empty again, the @p transit will be killed by
26807 * elm_transit_del(transit) function.
26811 * Elm_Transit *transit = elm_transit_add();
26812 * elm_transit_effect_add(transit,
26813 * elm_transit_effect_blend_op,
26814 * elm_transit_effect_blend_context_new(),
26815 * elm_transit_effect_blend_context_free);
26818 * @param transit The transit object.
26819 * @param transition_cb The operation function. It is called when the
26820 * animation begins, it is the function that actually performs the animation.
26821 * It is called with the @p data, @p transit and the time progression of the
26822 * animation (a double value between 0.0 and 1.0).
26823 * @param effect The context data of the effect.
26824 * @param end_cb The function to free the context data, it will be called
26825 * at the end of the effect, it must finalize the animation and free the
26829 * @warning The transit free the context data at the and of the transition with
26830 * the data_free_cb function, do not use the context data in another transit.
26832 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);
26835 * Delete an added effect.
26837 * This function will remove the effect from the @p transit, calling the
26838 * data_free_cb to free the @p data.
26840 * @see elm_transit_effect_add()
26842 * @note If the effect is not found, nothing is done.
26843 * @note If the effect list become empty, this function will call
26844 * elm_transit_del(transit), that is, it will kill the @p transit.
26846 * @param transit The transit object.
26847 * @param transition_cb The operation function.
26848 * @param effect The context data of the effect.
26852 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);
26855 * Add new object to apply the effects.
26857 * @note After the first addition of an object in @p transit, if its
26858 * object list become empty again, the @p transit will be killed by
26859 * elm_transit_del(transit) function.
26860 * @note If the @p obj belongs to another transit, the @p obj will be
26861 * removed from it and it will only belong to the @p transit. If the old
26862 * transit stays without objects, it will die.
26863 * @note When you add an object into the @p transit, its state from
26864 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26865 * transit ends, if you change this state whith evas_object_pass_events_set()
26866 * after add the object, this state will change again when @p transit stops to
26869 * @param transit The transit object.
26870 * @param obj Object to be animated.
26873 * @warning It is not allowed to add a new object after transit begins to go.
26875 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26878 * Removes an added object from the transit.
26880 * @note If the @p obj is not in the @p transit, nothing is done.
26881 * @note If the list become empty, this function will call
26882 * elm_transit_del(transit), that is, it will kill the @p transit.
26884 * @param transit The transit object.
26885 * @param obj Object to be removed from @p transit.
26888 * @warning It is not allowed to remove objects after transit begins to go.
26890 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26893 * Get the objects of the transit.
26895 * @param transit The transit object.
26896 * @return a Eina_List with the objects from the transit.
26900 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26903 * Enable/disable keeping up the objects states.
26904 * If it is not kept, the objects states will be reset when transition ends.
26906 * @note @p transit can not be NULL.
26907 * @note One state includes geometry, color, map data.
26909 * @param transit The transit object.
26910 * @param state_keep Keeping or Non Keeping.
26914 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
26917 * Get a value whether the objects states will be reset or not.
26919 * @note @p transit can not be NULL
26921 * @see elm_transit_objects_final_state_keep_set()
26923 * @param transit The transit object.
26924 * @return EINA_TRUE means the states of the objects will be reset.
26925 * If @p transit is NULL, EINA_FALSE is returned
26929 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26932 * Set the event enabled when transit is operating.
26934 * If @p enabled is EINA_TRUE, the objects of the transit will receives
26935 * events from mouse and keyboard during the animation.
26936 * @note When you add an object with elm_transit_object_add(), its state from
26937 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26938 * transit ends, if you change this state with evas_object_pass_events_set()
26939 * after adding the object, this state will change again when @p transit stops
26942 * @param transit The transit object.
26943 * @param enabled Events are received when enabled is @c EINA_TRUE, and
26944 * ignored otherwise.
26948 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26951 * Get the value of event enabled status.
26953 * @see elm_transit_event_enabled_set()
26955 * @param transit The Transit object
26956 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
26957 * EINA_FALSE is returned
26961 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26964 * Set the user-callback function when the transit is deleted.
26966 * @note Using this function twice will overwrite the first function setted.
26967 * @note the @p transit object will be deleted after call @p cb function.
26969 * @param transit The transit object.
26970 * @param cb Callback function pointer. This function will be called before
26971 * the deletion of the transit.
26972 * @param data Callback funtion user data. It is the @p op parameter.
26976 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
26979 * Set reverse effect automatically.
26981 * If auto reverse is setted, after running the effects with the progress
26982 * parameter from 0 to 1, it will call the effecs again with the progress
26983 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
26984 * where the duration was setted with the function elm_transit_add and
26985 * the repeat with the function elm_transit_repeat_times_set().
26987 * @param transit The transit object.
26988 * @param reverse EINA_TRUE means the auto_reverse is on.
26992 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
26995 * Get if the auto reverse is on.
26997 * @see elm_transit_auto_reverse_set()
26999 * @param transit The transit object.
27000 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27001 * EINA_FALSE is returned
27005 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27008 * Set the transit repeat count. Effect will be repeated by repeat count.
27010 * This function sets the number of repetition the transit will run after
27011 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27012 * If the @p repeat is a negative number, it will repeat infinite times.
27014 * @note If this function is called during the transit execution, the transit
27015 * will run @p repeat times, ignoring the times it already performed.
27017 * @param transit The transit object
27018 * @param repeat Repeat count
27022 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27025 * Get the transit repeat count.
27027 * @see elm_transit_repeat_times_set()
27029 * @param transit The Transit object.
27030 * @return The repeat count. If @p transit is NULL
27035 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27038 * Set the transit animation acceleration type.
27040 * This function sets the tween mode of the transit that can be:
27041 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27042 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27043 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27044 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27046 * @param transit The transit object.
27047 * @param tween_mode The tween type.
27051 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27054 * Get the transit animation acceleration type.
27056 * @note @p transit can not be NULL
27058 * @param transit The transit object.
27059 * @return The tween type. If @p transit is NULL
27060 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27064 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27067 * Set the transit animation time
27069 * @note @p transit can not be NULL
27071 * @param transit The transit object.
27072 * @param duration The animation time.
27076 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27079 * Get the transit animation time
27081 * @note @p transit can not be NULL
27083 * @param transit The transit object.
27085 * @return The transit animation time.
27089 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27092 * Starts the transition.
27093 * Once this API is called, the transit begins to measure the time.
27095 * @note @p transit can not be NULL
27097 * @param transit The transit object.
27101 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27104 * Pause/Resume the transition.
27106 * If you call elm_transit_go again, the transit will be started from the
27107 * beginning, and will be unpaused.
27109 * @note @p transit can not be NULL
27111 * @param transit The transit object.
27112 * @param paused Whether the transition should be paused or not.
27116 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27119 * Get the value of paused status.
27121 * @see elm_transit_paused_set()
27123 * @note @p transit can not be NULL
27125 * @param transit The transit object.
27126 * @return EINA_TRUE means transition is paused. If @p transit is NULL
27127 * EINA_FALSE is returned
27131 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27134 * Get the time progression of the animation (a double value between 0.0 and 1.0).
27136 * The value returned is a fraction (current time / total time). It
27137 * represents the progression position relative to the total.
27139 * @note @p transit can not be NULL
27141 * @param transit The transit object.
27143 * @return The time progression value. If @p transit is NULL
27148 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27151 * Makes the chain relationship between two transits.
27153 * @note @p transit can not be NULL. Transit would have multiple chain transits.
27154 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27156 * @param transit The transit object.
27157 * @param chain_transit The chain transit object. This transit will be operated
27158 * after transit is done.
27160 * This function adds @p chain_transit transition to a chain after the @p
27161 * transit, and will be started as soon as @p transit ends. See @ref
27162 * transit_example_02_explained for a full example.
27166 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27169 * Cut off the chain relationship between two transits.
27171 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27172 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27174 * @param transit The transit object.
27175 * @param chain_transit The chain transit object.
27177 * This function remove the @p chain_transit transition from the @p transit.
27181 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27184 * Get the current chain transit list.
27186 * @note @p transit can not be NULL.
27188 * @param transit The transit object.
27189 * @return chain transit list.
27193 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
27196 * Add the Resizing Effect to Elm_Transit.
27198 * @note This API is one of the facades. It creates resizing effect context
27199 * and add it's required APIs to elm_transit_effect_add.
27201 * @see elm_transit_effect_add()
27203 * @param transit Transit object.
27204 * @param from_w Object width size when effect begins.
27205 * @param from_h Object height size when effect begins.
27206 * @param to_w Object width size when effect ends.
27207 * @param to_h Object height size when effect ends.
27208 * @return Resizing effect context data.
27212 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);
27215 * Add the Translation Effect to Elm_Transit.
27217 * @note This API is one of the facades. It creates translation effect context
27218 * and add it's required APIs to elm_transit_effect_add.
27220 * @see elm_transit_effect_add()
27222 * @param transit Transit object.
27223 * @param from_dx X Position variation when effect begins.
27224 * @param from_dy Y Position variation when effect begins.
27225 * @param to_dx X Position variation when effect ends.
27226 * @param to_dy Y Position variation when effect ends.
27227 * @return Translation effect context data.
27230 * @warning It is highly recommended just create a transit with this effect when
27231 * the window that the objects of the transit belongs has already been created.
27232 * This is because this effect needs the geometry information about the objects,
27233 * and if the window was not created yet, it can get a wrong information.
27235 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);
27238 * Add the Zoom Effect to Elm_Transit.
27240 * @note This API is one of the facades. It creates zoom effect context
27241 * and add it's required APIs to elm_transit_effect_add.
27243 * @see elm_transit_effect_add()
27245 * @param transit Transit object.
27246 * @param from_rate Scale rate when effect begins (1 is current rate).
27247 * @param to_rate Scale rate when effect ends.
27248 * @return Zoom effect context data.
27251 * @warning It is highly recommended just create a transit with this effect when
27252 * the window that the objects of the transit belongs has already been created.
27253 * This is because this effect needs the geometry information about the objects,
27254 * and if the window was not created yet, it can get a wrong information.
27256 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27259 * Add the Flip Effect to Elm_Transit.
27261 * @note This API is one of the facades. It creates flip effect context
27262 * and add it's required APIs to elm_transit_effect_add.
27263 * @note This effect is applied to each pair of objects in the order they are listed
27264 * in the transit list of objects. The first object in the pair will be the
27265 * "front" object and the second will be the "back" object.
27267 * @see elm_transit_effect_add()
27269 * @param transit Transit object.
27270 * @param axis Flipping Axis(X or Y).
27271 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27272 * @return Flip effect context data.
27275 * @warning It is highly recommended just create a transit with this effect when
27276 * the window that the objects of the transit belongs has already been created.
27277 * This is because this effect needs the geometry information about the objects,
27278 * and if the window was not created yet, it can get a wrong information.
27280 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27283 * Add the Resizable Flip Effect to Elm_Transit.
27285 * @note This API is one of the facades. It creates resizable flip effect context
27286 * and add it's required APIs to elm_transit_effect_add.
27287 * @note This effect is applied to each pair of objects in the order they are listed
27288 * in the transit list of objects. The first object in the pair will be the
27289 * "front" object and the second will be the "back" object.
27291 * @see elm_transit_effect_add()
27293 * @param transit Transit object.
27294 * @param axis Flipping Axis(X or Y).
27295 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27296 * @return Resizable flip effect context data.
27299 * @warning It is highly recommended just create a transit with this effect when
27300 * the window that the objects of the transit belongs has already been created.
27301 * This is because this effect needs the geometry information about the objects,
27302 * and if the window was not created yet, it can get a wrong information.
27304 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27307 * Add the Wipe Effect to Elm_Transit.
27309 * @note This API is one of the facades. It creates wipe effect context
27310 * and add it's required APIs to elm_transit_effect_add.
27312 * @see elm_transit_effect_add()
27314 * @param transit Transit object.
27315 * @param type Wipe type. Hide or show.
27316 * @param dir Wipe Direction.
27317 * @return Wipe effect context data.
27320 * @warning It is highly recommended just create a transit with this effect when
27321 * the window that the objects of the transit belongs has already been created.
27322 * This is because this effect needs the geometry information about the objects,
27323 * and if the window was not created yet, it can get a wrong information.
27325 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27328 * Add the Color Effect to Elm_Transit.
27330 * @note This API is one of the facades. It creates color effect context
27331 * and add it's required APIs to elm_transit_effect_add.
27333 * @see elm_transit_effect_add()
27335 * @param transit Transit object.
27336 * @param from_r RGB R when effect begins.
27337 * @param from_g RGB G when effect begins.
27338 * @param from_b RGB B when effect begins.
27339 * @param from_a RGB A when effect begins.
27340 * @param to_r RGB R when effect ends.
27341 * @param to_g RGB G when effect ends.
27342 * @param to_b RGB B when effect ends.
27343 * @param to_a RGB A when effect ends.
27344 * @return Color effect context data.
27348 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);
27351 * Add the Fade Effect to Elm_Transit.
27353 * @note This API is one of the facades. It creates fade effect context
27354 * and add it's required APIs to elm_transit_effect_add.
27355 * @note This effect is applied to each pair of objects in the order they are listed
27356 * in the transit list of objects. The first object in the pair will be the
27357 * "before" object and the second will be the "after" object.
27359 * @see elm_transit_effect_add()
27361 * @param transit Transit object.
27362 * @return Fade effect context data.
27365 * @warning It is highly recommended just create a transit with this effect when
27366 * the window that the objects of the transit belongs has already been created.
27367 * This is because this effect needs the color information about the objects,
27368 * and if the window was not created yet, it can get a wrong information.
27370 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27373 * Add the Blend Effect to Elm_Transit.
27375 * @note This API is one of the facades. It creates blend effect context
27376 * and add it's required APIs to elm_transit_effect_add.
27377 * @note This effect is applied to each pair of objects in the order they are listed
27378 * in the transit list of objects. The first object in the pair will be the
27379 * "before" object and the second will be the "after" object.
27381 * @see elm_transit_effect_add()
27383 * @param transit Transit object.
27384 * @return Blend effect context data.
27387 * @warning It is highly recommended just create a transit with this effect when
27388 * the window that the objects of the transit belongs has already been created.
27389 * This is because this effect needs the color information about the objects,
27390 * and if the window was not created yet, it can get a wrong information.
27392 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27395 * Add the Rotation Effect to Elm_Transit.
27397 * @note This API is one of the facades. It creates rotation effect context
27398 * and add it's required APIs to elm_transit_effect_add.
27400 * @see elm_transit_effect_add()
27402 * @param transit Transit object.
27403 * @param from_degree Degree when effect begins.
27404 * @param to_degree Degree when effect is ends.
27405 * @return Rotation effect context data.
27408 * @warning It is highly recommended just create a transit with this effect when
27409 * the window that the objects of the transit belongs has already been created.
27410 * This is because this effect needs the geometry information about the objects,
27411 * and if the window was not created yet, it can get a wrong information.
27413 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27416 * Add the ImageAnimation Effect to Elm_Transit.
27418 * @note This API is one of the facades. It creates image animation effect context
27419 * and add it's required APIs to elm_transit_effect_add.
27420 * The @p images parameter is a list images paths. This list and
27421 * its contents will be deleted at the end of the effect by
27422 * elm_transit_effect_image_animation_context_free() function.
27426 * char buf[PATH_MAX];
27427 * Eina_List *images = NULL;
27428 * Elm_Transit *transi = elm_transit_add();
27430 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27431 * images = eina_list_append(images, eina_stringshare_add(buf));
27433 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27434 * images = eina_list_append(images, eina_stringshare_add(buf));
27435 * elm_transit_effect_image_animation_add(transi, images);
27439 * @see elm_transit_effect_add()
27441 * @param transit Transit object.
27442 * @param images Eina_List of images file paths. This list and
27443 * its contents will be deleted at the end of the effect by
27444 * elm_transit_effect_image_animation_context_free() function.
27445 * @return Image Animation effect context data.
27449 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27454 typedef struct _Elm_Store Elm_Store;
27455 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
27456 typedef struct _Elm_Store_Item Elm_Store_Item;
27457 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
27458 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
27459 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27460 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
27461 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
27462 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
27463 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
27464 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
27466 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27467 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
27468 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
27469 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27473 ELM_STORE_ITEM_MAPPING_NONE = 0,
27474 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27475 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27476 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27477 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27478 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27479 // can add more here as needed by common apps
27480 ELM_STORE_ITEM_MAPPING_LAST
27481 } Elm_Store_Item_Mapping_Type;
27483 struct _Elm_Store_Item_Mapping_Icon
27485 // FIXME: allow edje file icons
27487 Elm_Icon_Lookup_Order lookup_order;
27488 Eina_Bool standard_name : 1;
27489 Eina_Bool no_scale : 1;
27490 Eina_Bool smooth : 1;
27491 Eina_Bool scale_up : 1;
27492 Eina_Bool scale_down : 1;
27495 struct _Elm_Store_Item_Mapping_Empty
27500 struct _Elm_Store_Item_Mapping_Photo
27505 struct _Elm_Store_Item_Mapping_Custom
27507 Elm_Store_Item_Mapping_Cb func;
27510 struct _Elm_Store_Item_Mapping
27512 Elm_Store_Item_Mapping_Type type;
27517 Elm_Store_Item_Mapping_Empty empty;
27518 Elm_Store_Item_Mapping_Icon icon;
27519 Elm_Store_Item_Mapping_Photo photo;
27520 Elm_Store_Item_Mapping_Custom custom;
27521 // add more types here
27525 struct _Elm_Store_Item_Info
27527 Elm_Genlist_Item_Class *item_class;
27528 const Elm_Store_Item_Mapping *mapping;
27533 struct _Elm_Store_Item_Info_Filesystem
27535 Elm_Store_Item_Info base;
27539 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27540 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27542 EAPI void elm_store_free(Elm_Store *st);
27544 EAPI Elm_Store *elm_store_filesystem_new(void);
27545 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27546 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27547 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27549 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27551 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27552 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27553 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27554 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27555 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27556 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27558 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27559 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27560 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27561 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27562 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27563 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27564 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27567 * @defgroup SegmentControl SegmentControl
27568 * @ingroup Elementary
27570 * @image html img/widget/segment_control/preview-00.png
27571 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27573 * @image html img/segment_control.png
27574 * @image latex img/segment_control.eps width=\textwidth
27576 * Segment control widget is a horizontal control made of multiple segment
27577 * items, each segment item functioning similar to discrete two state button.
27578 * A segment control groups the items together and provides compact
27579 * single button with multiple equal size segments.
27581 * Segment item size is determined by base widget
27582 * size and the number of items added.
27583 * Only one segment item can be at selected state. A segment item can display
27584 * combination of Text and any Evas_Object like Images or other widget.
27586 * Smart callbacks one can listen to:
27587 * - "changed" - When the user clicks on a segment item which is not
27588 * previously selected and get selected. The event_info parameter is the
27589 * segment item pointer.
27591 * Available styles for it:
27594 * Here is an example on its usage:
27595 * @li @ref segment_control_example
27599 * @addtogroup SegmentControl
27603 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27606 * Add a new segment control widget to the given parent Elementary
27607 * (container) object.
27609 * @param parent The parent object.
27610 * @return a new segment control widget handle or @c NULL, on errors.
27612 * This function inserts a new segment control widget on the canvas.
27614 * @ingroup SegmentControl
27616 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27619 * Append a new item to the segment control object.
27621 * @param obj The segment control object.
27622 * @param icon The icon object to use for the left side of the item. An
27623 * icon can be any Evas object, but usually it is an icon created
27624 * with elm_icon_add().
27625 * @param label The label of the item.
27626 * Note that, NULL is different from empty string "".
27627 * @return The created item or @c NULL upon failure.
27629 * A new item will be created and appended to the segment control, i.e., will
27630 * be set as @b last item.
27632 * If it should be inserted at another position,
27633 * elm_segment_control_item_insert_at() should be used instead.
27635 * Items created with this function can be deleted with function
27636 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27638 * @note @p label set to @c NULL is different from empty string "".
27640 * only has icon, it will be displayed bigger and centered. If it has
27641 * icon and label, even that an empty string, icon will be smaller and
27642 * positioned at left.
27646 * sc = elm_segment_control_add(win);
27647 * ic = elm_icon_add(win);
27648 * elm_icon_file_set(ic, "path/to/image", NULL);
27649 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27650 * elm_segment_control_item_add(sc, ic, "label");
27651 * evas_object_show(sc);
27654 * @see elm_segment_control_item_insert_at()
27655 * @see elm_segment_control_item_del()
27657 * @ingroup SegmentControl
27659 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27662 * Insert a new item to the segment control object at specified position.
27664 * @param obj The segment control object.
27665 * @param icon The icon object to use for the left side of the item. An
27666 * icon can be any Evas object, but usually it is an icon created
27667 * with elm_icon_add().
27668 * @param label The label of the item.
27669 * @param index Item position. Value should be between 0 and items count.
27670 * @return The created item or @c NULL upon failure.
27672 * Index values must be between @c 0, when item will be prepended to
27673 * segment control, and items count, that can be get with
27674 * elm_segment_control_item_count_get(), case when item will be appended
27675 * to segment control, just like elm_segment_control_item_add().
27677 * Items created with this function can be deleted with function
27678 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27680 * @note @p label set to @c NULL is different from empty string "".
27682 * only has icon, it will be displayed bigger and centered. If it has
27683 * icon and label, even that an empty string, icon will be smaller and
27684 * positioned at left.
27686 * @see elm_segment_control_item_add()
27687 * @see elm_segment_control_item_count_get()
27688 * @see elm_segment_control_item_del()
27690 * @ingroup SegmentControl
27692 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);
27695 * Remove a segment control item from its parent, deleting it.
27697 * @param it The item to be removed.
27699 * Items can be added with elm_segment_control_item_add() or
27700 * elm_segment_control_item_insert_at().
27702 * @ingroup SegmentControl
27704 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27707 * Remove a segment control item at given index from its parent,
27710 * @param obj The segment control object.
27711 * @param index The position of the segment control item to be deleted.
27713 * Items can be added with elm_segment_control_item_add() or
27714 * elm_segment_control_item_insert_at().
27716 * @ingroup SegmentControl
27718 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27721 * Get the Segment items count from segment control.
27723 * @param obj The segment control object.
27724 * @return Segment items count.
27726 * It will just return the number of items added to segment control @p obj.
27728 * @ingroup SegmentControl
27730 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27733 * Get the item placed at specified index.
27735 * @param obj The segment control object.
27736 * @param index The index of the segment item.
27737 * @return The segment control item or @c NULL on failure.
27739 * Index is the position of an item in segment control widget. Its
27740 * range is from @c 0 to <tt> count - 1 </tt>.
27741 * Count is the number of items, that can be get with
27742 * elm_segment_control_item_count_get().
27744 * @ingroup SegmentControl
27746 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27749 * Get the label of item.
27751 * @param obj The segment control object.
27752 * @param index The index of the segment item.
27753 * @return The label of the item at @p index.
27755 * The return value is a pointer to the label associated to the item when
27756 * it was created, with function elm_segment_control_item_add(), or later
27757 * with function elm_segment_control_item_label_set. If no label
27758 * was passed as argument, it will return @c NULL.
27760 * @see elm_segment_control_item_label_set() for more details.
27761 * @see elm_segment_control_item_add()
27763 * @ingroup SegmentControl
27765 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27768 * Set the label of item.
27770 * @param it The item of segment control.
27771 * @param text The label of item.
27773 * The label to be displayed by the item.
27774 * Label will be at right of the icon (if set).
27776 * If a label was passed as argument on item creation, with function
27777 * elm_control_segment_item_add(), it will be already
27778 * displayed by the item.
27780 * @see elm_segment_control_item_label_get()
27781 * @see elm_segment_control_item_add()
27783 * @ingroup SegmentControl
27785 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
27788 * Get the icon associated to the item.
27790 * @param obj The segment control object.
27791 * @param index The index of the segment item.
27792 * @return The left side icon associated to the item at @p index.
27794 * The return value is a pointer to the icon associated to the item when
27795 * it was created, with function elm_segment_control_item_add(), or later
27796 * with function elm_segment_control_item_icon_set(). If no icon
27797 * was passed as argument, it will return @c NULL.
27799 * @see elm_segment_control_item_add()
27800 * @see elm_segment_control_item_icon_set()
27802 * @ingroup SegmentControl
27804 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27807 * Set the icon associated to the item.
27809 * @param it The segment control item.
27810 * @param icon The icon object to associate with @p it.
27812 * The icon object to use at left side of the item. An
27813 * icon can be any Evas object, but usually it is an icon created
27814 * with elm_icon_add().
27816 * Once the icon object is set, a previously set one will be deleted.
27817 * @warning Setting the same icon for two items will cause the icon to
27818 * dissapear from the first item.
27820 * If an icon was passed as argument on item creation, with function
27821 * elm_segment_control_item_add(), it will be already
27822 * associated to the item.
27824 * @see elm_segment_control_item_add()
27825 * @see elm_segment_control_item_icon_get()
27827 * @ingroup SegmentControl
27829 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27832 * Get the index of an item.
27834 * @param it The segment control item.
27835 * @return The position of item in segment control widget.
27837 * Index is the position of an item in segment control widget. Its
27838 * range is from @c 0 to <tt> count - 1 </tt>.
27839 * Count is the number of items, that can be get with
27840 * elm_segment_control_item_count_get().
27842 * @ingroup SegmentControl
27844 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27847 * Get the base object of the item.
27849 * @param it The segment control item.
27850 * @return The base object associated with @p it.
27852 * Base object is the @c Evas_Object that represents that item.
27854 * @ingroup SegmentControl
27856 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27859 * Get the selected item.
27861 * @param obj The segment control object.
27862 * @return The selected item or @c NULL if none of segment items is
27865 * The selected item can be unselected with function
27866 * elm_segment_control_item_selected_set().
27868 * The selected item always will be highlighted on segment control.
27870 * @ingroup SegmentControl
27872 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27875 * Set the selected state of an item.
27877 * @param it The segment control item
27878 * @param select The selected state
27880 * This sets the selected state of the given item @p it.
27881 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27883 * If a new item is selected the previosly selected will be unselected.
27884 * Previoulsy selected item can be get with function
27885 * elm_segment_control_item_selected_get().
27887 * The selected item always will be highlighted on segment control.
27889 * @see elm_segment_control_item_selected_get()
27891 * @ingroup SegmentControl
27893 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
27900 * @defgroup Grid Grid
27902 * The grid is a grid layout widget that lays out a series of children as a
27903 * fixed "grid" of widgets using a given percentage of the grid width and
27904 * height each using the child object.
27906 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
27907 * widgets size itself. The default is 100 x 100, so that means the
27908 * position and sizes of children will effectively be percentages (0 to 100)
27909 * of the width or height of the grid widget
27915 * Add a new grid to the parent
27917 * @param parent The parent object
27918 * @return The new object or NULL if it cannot be created
27922 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
27925 * Set the virtual size of the grid
27927 * @param obj The grid object
27928 * @param w The virtual width of the grid
27929 * @param h The virtual height of the grid
27933 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
27936 * Get the virtual size of the grid
27938 * @param obj The grid object
27939 * @param w Pointer to integer to store the virtual width of the grid
27940 * @param h Pointer to integer to store the virtual height of the grid
27944 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
27947 * Pack child at given position and size
27949 * @param obj The grid object
27950 * @param subobj The child to pack
27951 * @param x The virtual x coord at which to pack it
27952 * @param y The virtual y coord at which to pack it
27953 * @param w The virtual width at which to pack it
27954 * @param h The virtual height at which to pack it
27958 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
27961 * Unpack a child from a grid object
27963 * @param obj The grid object
27964 * @param subobj The child to unpack
27968 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
27971 * Faster way to remove all child objects from a grid object.
27973 * @param obj The grid object
27974 * @param clear If true, it will delete just removed children
27978 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
27981 * Set packing of an existing child at to position and size
27983 * @param subobj The child to set packing of
27984 * @param x The virtual x coord at which to pack it
27985 * @param y The virtual y coord at which to pack it
27986 * @param w The virtual width at which to pack it
27987 * @param h The virtual height at which to pack it
27991 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
27994 * get packing of a child
27996 * @param subobj The child to query
27997 * @param x Pointer to integer to store the virtual x coord
27998 * @param y Pointer to integer to store the virtual y coord
27999 * @param w Pointer to integer to store the virtual width
28000 * @param h Pointer to integer to store the virtual height
28004 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28010 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28011 EINA_DEPRECATED EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28012 EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28013 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28014 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
28015 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
28018 * @defgroup Video Video
28020 * @addtogroup Video
28023 * Elementary comes with two object that help design application that need
28024 * to display video. The main one, Elm_Video, display a video by using Emotion.
28025 * It does embedded the video inside an Edje object, so you can do some
28026 * animation depending on the video state change. It does also implement a
28027 * ressource management policy to remove this burden from the application writer.
28029 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28030 * It take care of updating its content according to Emotion event and provide a
28031 * way to theme itself. It also does automatically raise the priority of the
28032 * linked Elm_Video so it will use the video decoder if available. It also does
28033 * activate the remember function on the linked Elm_Video object.
28035 * Signals that you can add callback for are :
28037 * "forward,clicked" - the user clicked the forward button.
28038 * "info,clicked" - the user clicked the info button.
28039 * "next,clicked" - the user clicked the next button.
28040 * "pause,clicked" - the user clicked the pause button.
28041 * "play,clicked" - the user clicked the play button.
28042 * "prev,clicked" - the user clicked the prev button.
28043 * "rewind,clicked" - the user clicked the rewind button.
28044 * "stop,clicked" - the user clicked the stop button.
28046 * To set the video of the player, you can use elm_object_content_set() API.
28051 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28053 * @param parent The parent object
28054 * @return a new player widget handle or @c NULL, on errors.
28056 * This function inserts a new player widget on the canvas.
28058 * @see elm_object_content_set()
28062 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28065 * @brief Link a Elm_Payer with an Elm_Video object.
28067 * @param player the Elm_Player object.
28068 * @param video The Elm_Video object.
28070 * This mean that action on the player widget will affect the
28071 * video object and the state of the video will be reflected in
28072 * the player itself.
28074 * @see elm_player_add()
28075 * @see elm_video_add()
28076 * @deprecated use elm_object_content_set() instead
28080 EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28083 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28085 * @param parent The parent object
28086 * @return a new video widget handle or @c NULL, on errors.
28088 * This function inserts a new video widget on the canvas.
28090 * @seeelm_video_file_set()
28091 * @see elm_video_uri_set()
28095 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28098 * @brief Define the file that will be the video source.
28100 * @param video The video object to define the file for.
28101 * @param filename The file to target.
28103 * This function will explicitly define a filename as a source
28104 * for the video of the Elm_Video object.
28106 * @see elm_video_uri_set()
28107 * @see elm_video_add()
28108 * @see elm_player_add()
28112 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28115 * @brief Define the uri that will be the video source.
28117 * @param video The video object to define the file for.
28118 * @param uri The uri to target.
28120 * This function will define an uri as a source for the video of the
28121 * Elm_Video object. URI could be remote source of video, like http:// or local source
28122 * like for example WebCam who are most of the time v4l2:// (but that depend and
28123 * you should use Emotion API to request and list the available Webcam on your system).
28125 * @see elm_video_file_set()
28126 * @see elm_video_add()
28127 * @see elm_player_add()
28131 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28134 * @brief Get the underlying Emotion object.
28136 * @param video The video object to proceed the request on.
28137 * @return the underlying Emotion object.
28141 EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28144 * @brief Start to play the video
28146 * @param video The video object to proceed the request on.
28148 * Start to play the video and cancel all suspend state.
28152 EAPI void elm_video_play(Evas_Object *video);
28155 * @brief Pause the video
28157 * @param video The video object to proceed the request on.
28159 * Pause the video and start a timer to trigger suspend mode.
28163 EAPI void elm_video_pause(Evas_Object *video);
28166 * @brief Stop the video
28168 * @param video The video object to proceed the request on.
28170 * Stop the video and put the emotion in deep sleep mode.
28174 EAPI void elm_video_stop(Evas_Object *video);
28177 * @brief Is the video actually playing.
28179 * @param video The video object to proceed the request on.
28180 * @return EINA_TRUE if the video is actually playing.
28182 * You should consider watching event on the object instead of polling
28183 * the object state.
28187 EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28190 * @brief Is it possible to seek inside the video.
28192 * @param video The video object to proceed the request on.
28193 * @return EINA_TRUE if is possible to seek inside the video.
28197 EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28200 * @brief Is the audio muted.
28202 * @param video The video object to proceed the request on.
28203 * @return EINA_TRUE if the audio is muted.
28207 EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28210 * @brief Change the mute state of the Elm_Video object.
28212 * @param video The video object to proceed the request on.
28213 * @param mute The new mute state.
28217 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28220 * @brief Get the audio level of the current video.
28222 * @param video The video object to proceed the request on.
28223 * @return the current audio level.
28227 EAPI double elm_video_audio_level_get(const Evas_Object *video);
28230 * @brief Set the audio level of anElm_Video object.
28232 * @param video The video object to proceed the request on.
28233 * @param volume The new audio volume.
28237 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28239 EAPI double elm_video_play_position_get(const Evas_Object *video);
28240 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28241 EAPI double elm_video_play_length_get(const Evas_Object *video);
28242 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28243 EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28244 EAPI const char *elm_video_title_get(const Evas_Object *video);
28250 * @defgroup Naviframe Naviframe
28251 * @ingroup Elementary
28253 * @brief Naviframe is a kind of view manager for the applications.
28255 * Naviframe provides functions to switch different pages with stack
28256 * mechanism. It means if one page(item) needs to be changed to the new one,
28257 * then naviframe would push the new page to it's internal stack. Of course,
28258 * it can be back to the previous page by popping the top page. Naviframe
28259 * provides some transition effect while the pages are switching (same as
28262 * Since each item could keep the different styles, users could keep the
28263 * same look & feel for the pages or different styles for the items in it's
28266 * Signals that you can add callback for are:
28267 * @li "transition,finished" - When the transition is finished in changing
28269 * @li "title,clicked" - User clicked title area
28271 * Default contents parts of the naviframe items that you can use for are:
28272 * @li "elm.swallow.content" - A main content of the page
28273 * @li "elm.swallow.icon" - A icon in the title area
28274 * @li "elm.swallow.prev_btn" - A button to go to the previous page
28275 * @li "elm.swallow.next_btn" - A button to go to the next page
28277 * Default text parts of the naviframe items that you can use for are:
28278 * @li "elm.text.title" - Title label in the title area
28279 * @li "elm.text.subtitle" - Sub-title label in the title area
28281 * @ref tutorial_naviframe gives a good overview of the usage of the API.
28284 #define ELM_NAVIFRAME_ITEM_CONTENT_ICON "elm.swallow.icon"
28285 #define ELM_NAVIFRAME_ITEM_CONTENT_PREV_BTN "elm.swallow.prev_btn"
28286 #define ELM_NAVIFRAME_ITEM_CONTNET_NEXT_BTN "elm.swallow.next_btn"
28287 #define ELM_NAVIFRAME_ITEM_TEXT_SUBTITLE "elm.text.subtitle"
28290 * @addtogroup Naviframe
28295 * @brief Add a new Naviframe object to the parent.
28297 * @param parent Parent object
28298 * @return New object or @c NULL, if it cannot be created
28300 * @ingroup Naviframe
28302 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28304 * @brief Push a new item to the top of the naviframe stack (and show it).
28306 * @param obj The naviframe object
28307 * @param title_label The label in the title area. The name of the title
28308 * label part is "elm.text.title"
28309 * @param prev_btn The button to go to the previous item. If it is NULL,
28310 * then naviframe will create a back button automatically. The name of
28311 * the prev_btn part is "elm.swallow.prev_btn"
28312 * @param next_btn The button to go to the next item. Or It could be just an
28313 * extra function button. The name of the next_btn part is
28314 * "elm.swallow.next_btn"
28315 * @param content The main content object. The name of content part is
28316 * "elm.swallow.content"
28317 * @param item_style The current item style name. @c NULL would be default.
28318 * @return The created item or @c NULL upon failure.
28320 * The item pushed becomes one page of the naviframe, this item will be
28321 * deleted when it is popped.
28323 * @see also elm_naviframe_item_style_set()
28324 * @see also elm_naviframe_item_insert_before()
28325 * @see also elm_naviframe_item_insert_after()
28327 * The following styles are available for this item:
28330 * @ingroup Naviframe
28332 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);
28334 * @brief Insert a new item into the naviframe before item @p before.
28336 * @param before The naviframe item to insert before.
28337 * @param title_label The label in the title area. The name of the title
28338 * label part is "elm.text.title"
28339 * @param prev_btn The button to go to the previous item. If it is NULL,
28340 * then naviframe will create a back button automatically. The name of
28341 * the prev_btn part is "elm.swallow.prev_btn"
28342 * @param next_btn The button to go to the next item. Or It could be just an
28343 * extra function button. The name of the next_btn part is
28344 * "elm.swallow.next_btn"
28345 * @param content The main content object. The name of content part is
28346 * "elm.swallow.content"
28347 * @param item_style The current item style name. @c NULL would be default.
28348 * @return The created item or @c NULL upon failure.
28350 * The item is inserted into the naviframe straight away without any
28351 * transition operations. This item will be deleted when it is popped.
28353 * @see also elm_naviframe_item_style_set()
28354 * @see also elm_naviframe_item_push()
28355 * @see also elm_naviframe_item_insert_after()
28357 * The following styles are available for this item:
28360 * @ingroup Naviframe
28362 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);
28364 * @brief Insert a new item into the naviframe after item @p after.
28366 * @param after The naviframe item to insert after.
28367 * @param title_label The label in the title area. The name of the title
28368 * label part is "elm.text.title"
28369 * @param prev_btn The button to go to the previous item. If it is NULL,
28370 * then naviframe will create a back button automatically. The name of
28371 * the prev_btn part is "elm.swallow.prev_btn"
28372 * @param next_btn The button to go to the next item. Or It could be just an
28373 * extra function button. The name of the next_btn part is
28374 * "elm.swallow.next_btn"
28375 * @param content The main content object. The name of content part is
28376 * "elm.swallow.content"
28377 * @param item_style The current item style name. @c NULL would be default.
28378 * @return The created item or @c NULL upon failure.
28380 * The item is inserted into the naviframe straight away without any
28381 * transition operations. This item will be deleted when it is popped.
28383 * @see also elm_naviframe_item_style_set()
28384 * @see also elm_naviframe_item_push()
28385 * @see also elm_naviframe_item_insert_before()
28387 * The following styles are available for this item:
28390 * @ingroup Naviframe
28392 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);
28394 * @brief Pop an item that is on top of the stack
28396 * @param obj The naviframe object
28397 * @return @c NULL or the content object(if the
28398 * elm_naviframe_content_preserve_on_pop_get is true).
28400 * This pops an item that is on the top(visible) of the naviframe, makes it
28401 * disappear, then deletes the item. The item that was underneath it on the
28402 * stack will become visible.
28404 * @see also elm_naviframe_content_preserve_on_pop_get()
28406 * @ingroup Naviframe
28408 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28410 * @brief Pop the items between the top and the above one on the given item.
28412 * @param it The naviframe item
28414 * @ingroup Naviframe
28416 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28418 * Promote an item already in the naviframe stack to the top of the stack
28420 * @param it The naviframe item
28422 * This will take the indicated item and promote it to the top of the stack
28423 * as if it had been pushed there. The item must already be inside the
28424 * naviframe stack to work.
28427 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28429 * @brief Delete the given item instantly.
28431 * @param it The naviframe item
28433 * This just deletes the given item from the naviframe item list instantly.
28434 * So this would not emit any signals for view transitions but just change
28435 * the current view if the given item is a top one.
28437 * @ingroup Naviframe
28439 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28441 * @brief preserve the content objects when items are popped.
28443 * @param obj The naviframe object
28444 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28446 * @see also elm_naviframe_content_preserve_on_pop_get()
28448 * @ingroup Naviframe
28450 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28452 * @brief Get a value whether preserve mode is enabled or not.
28454 * @param obj The naviframe object
28455 * @return If @c EINA_TRUE, preserve mode is enabled
28457 * @see also elm_naviframe_content_preserve_on_pop_set()
28459 * @ingroup Naviframe
28461 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28463 * @brief Get a top item on the naviframe stack
28465 * @param obj The naviframe object
28466 * @return The top item on the naviframe stack or @c NULL, if the stack is
28469 * @ingroup Naviframe
28471 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28473 * @brief Get a bottom item on the naviframe stack
28475 * @param obj The naviframe object
28476 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28479 * @ingroup Naviframe
28481 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28483 * @brief Set an item style
28485 * @param obj The naviframe item
28486 * @param item_style The current item style name. @c NULL would be default
28488 * The following styles are available for this item:
28491 * @see also elm_naviframe_item_style_get()
28493 * @ingroup Naviframe
28495 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28497 * @brief Get an item style
28499 * @param obj The naviframe item
28500 * @return The current item style name
28502 * @see also elm_naviframe_item_style_set()
28504 * @ingroup Naviframe
28506 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28508 * @brief Show/Hide the title area
28510 * @param it The naviframe item
28511 * @param visible If @c EINA_TRUE, title area will be visible, hidden
28514 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
28516 * @see also elm_naviframe_item_title_visible_get()
28518 * @ingroup Naviframe
28520 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28522 * @brief Get a value whether title area is visible or not.
28524 * @param it The naviframe item
28525 * @return If @c EINA_TRUE, title area is visible
28527 * @see also elm_naviframe_item_title_visible_set()
28529 * @ingroup Naviframe
28531 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28534 * @brief Set creating prev button automatically or not
28536 * @param obj The naviframe object
28537 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28538 * be created internally when you pass the @c NULL to the prev_btn
28539 * parameter in elm_naviframe_item_push
28541 * @see also elm_naviframe_item_push()
28543 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28545 * @brief Get a value whether prev button(back button) will be auto pushed or
28548 * @param obj The naviframe object
28549 * @return If @c EINA_TRUE, prev button will be auto pushed.
28551 * @see also elm_naviframe_item_push()
28552 * elm_naviframe_prev_btn_auto_pushed_set()
28554 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28556 * @brief Get a list of all the naviframe items.
28558 * @param obj The naviframe object
28559 * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
28560 * or @c NULL on failure.
28562 EAPI Eina_Inlist *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);