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>
342 # ifdef ELM_LIBINTL_H
343 # include <libintl.h>
354 #if defined (ELM_WIN32) || defined (ELM_WINCE)
357 # define alloca _alloca
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"
1982 * @brief Get Elementary's rendering engine in use.
1984 * @return The rendering engine's name
1985 * @note there's no need to free the returned string, here.
1987 * This gets the global rendering engine that is applied to all Elementary
1990 * @see elm_engine_set()
1992 EAPI const char *elm_engine_current_get(void);
1995 * @brief Set Elementary's rendering engine for use.
1997 * @param engine The rendering engine's name
1999 * This sets global rendering engine that is applied to all Elementary
2000 * applications. Note that it will take effect only to Elementary windows
2001 * created after this is called.
2003 * @see elm_win_add()
2005 EAPI void elm_engine_set(const char *engine);
2012 * @defgroup Fonts Elementary Fonts
2014 * These are functions dealing with font rendering, selection and the
2015 * like for Elementary applications. One might fetch which system
2016 * fonts are there to use and set custom fonts for individual classes
2017 * of UI items containing text (text classes).
2022 typedef struct _Elm_Text_Class
2028 typedef struct _Elm_Font_Overlay
2030 const char *text_class;
2032 Evas_Font_Size size;
2035 typedef struct _Elm_Font_Properties
2039 } Elm_Font_Properties;
2042 * Get Elementary's list of supported text classes.
2044 * @return The text classes list, with @c Elm_Text_Class blobs as data.
2047 * Release the list with elm_text_classes_list_free().
2049 EAPI const Eina_List *elm_text_classes_list_get(void);
2052 * Free Elementary's list of supported text classes.
2056 * @see elm_text_classes_list_get().
2058 EAPI void elm_text_classes_list_free(const Eina_List *list);
2061 * Get Elementary's list of font overlays, set with
2062 * elm_font_overlay_set().
2064 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2069 * For each text class, one can set a <b>font overlay</b> for it,
2070 * overriding the default font properties for that class coming from
2071 * the theme in use. There is no need to free this list.
2073 * @see elm_font_overlay_set() and elm_font_overlay_unset().
2075 EAPI const Eina_List *elm_font_overlay_list_get(void);
2078 * Set a font overlay for a given Elementary text class.
2080 * @param text_class Text class name
2081 * @param font Font name and style string
2082 * @param size Font size
2086 * @p font has to be in the format returned by
2087 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2088 * and elm_font_overlay_unset().
2090 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2093 * Unset a font overlay for a given Elementary text class.
2095 * @param text_class Text class name
2099 * This will bring back text elements belonging to text class
2100 * @p text_class back to their default font settings.
2102 EAPI void elm_font_overlay_unset(const char *text_class);
2105 * Apply the changes made with elm_font_overlay_set() and
2106 * elm_font_overlay_unset() on the current Elementary window.
2110 * This applies all font overlays set to all objects in the UI.
2112 EAPI void elm_font_overlay_apply(void);
2115 * Apply the changes made with elm_font_overlay_set() and
2116 * elm_font_overlay_unset() on all Elementary application windows.
2120 * This applies all font overlays set to all objects in the UI.
2122 EAPI void elm_font_overlay_all_apply(void);
2125 * Translate a font (family) name string in fontconfig's font names
2126 * syntax into an @c Elm_Font_Properties struct.
2128 * @param font The font name and styles string
2129 * @return the font properties struct
2133 * @note The reverse translation can be achived with
2134 * elm_font_fontconfig_name_get(), for one style only (single font
2135 * instance, not family).
2137 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2140 * Free font properties return by elm_font_properties_get().
2142 * @param efp the font properties struct
2146 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2149 * Translate a font name, bound to a style, into fontconfig's font names
2152 * @param name The font (family) name
2153 * @param style The given style (may be @c NULL)
2155 * @return the font name and style string
2159 * @note The reverse translation can be achived with
2160 * elm_font_properties_get(), for one style only (single font
2161 * instance, not family).
2163 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2166 * Free the font string return by elm_font_fontconfig_name_get().
2168 * @param efp the font properties struct
2172 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2175 * Create a font hash table of available system fonts.
2177 * One must call it with @p list being the return value of
2178 * evas_font_available_list(). The hash will be indexed by font
2179 * (family) names, being its values @c Elm_Font_Properties blobs.
2181 * @param list The list of available system fonts, as returned by
2182 * evas_font_available_list().
2183 * @return the font hash.
2187 * @note The user is supposed to get it populated at least with 3
2188 * default font families (Sans, Serif, Monospace), which should be
2189 * present on most systems.
2191 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2194 * Free the hash return by elm_font_available_hash_add().
2196 * @param hash the hash to be freed.
2200 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2207 * @defgroup Fingers Fingers
2209 * Elementary is designed to be finger-friendly for touchscreens,
2210 * and so in addition to scaling for display resolution, it can
2211 * also scale based on finger "resolution" (or size). You can then
2212 * customize the granularity of the areas meant to receive clicks
2215 * Different profiles may have pre-set values for finger sizes.
2217 * @ref general_functions_example_page "This" example contemplates
2218 * some of these functions.
2224 * Get the configured "finger size"
2226 * @return The finger size
2228 * This gets the globally configured finger size, <b>in pixels</b>
2232 EAPI Evas_Coord elm_finger_size_get(void);
2235 * Set the configured finger size
2237 * This sets the globally configured finger size in pixels
2239 * @param size The finger size
2242 EAPI void elm_finger_size_set(Evas_Coord size);
2245 * Set the configured finger size for all applications on the display
2247 * This sets the globally configured finger size in pixels for all
2248 * applications on the display
2250 * @param size The finger size
2253 EAPI void elm_finger_size_all_set(Evas_Coord size);
2260 * @defgroup Focus Focus
2262 * An Elementary application has, at all times, one (and only one)
2263 * @b focused object. This is what determines where the input
2264 * events go to within the application's window. Also, focused
2265 * objects can be decorated differently, in order to signal to the
2266 * user where the input is, at a given moment.
2268 * Elementary applications also have the concept of <b>focus
2269 * chain</b>: one can cycle through all the windows' focusable
2270 * objects by input (tab key) or programmatically. The default
2271 * focus chain for an application is the one define by the order in
2272 * which the widgets where added in code. One will cycle through
2273 * top level widgets, and, for each one containg sub-objects, cycle
2274 * through them all, before returning to the level
2275 * above. Elementary also allows one to set @b custom focus chains
2276 * for their applications.
2278 * Besides the focused decoration a widget may exhibit, when it
2279 * gets focus, Elementary has a @b global focus highlight object
2280 * that can be enabled for a window. If one chooses to do so, this
2281 * extra highlight effect will surround the current focused object,
2284 * @note Some Elementary widgets are @b unfocusable, after
2285 * creation, by their very nature: they are not meant to be
2286 * interacted with input events, but are there just for visual
2289 * @ref general_functions_example_page "This" example contemplates
2290 * some of these functions.
2294 * Get the enable status of the focus highlight
2296 * This gets whether the highlight on focused objects is enabled or not
2299 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2302 * Set the enable status of the focus highlight
2304 * Set whether to show or not the highlight on focused objects
2305 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2308 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2311 * Get the enable status of the highlight animation
2313 * Get whether the focus highlight, if enabled, will animate its switch from
2314 * one object to the next
2317 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2320 * Set the enable status of the highlight animation
2322 * Set whether the focus highlight, if enabled, will animate its switch from
2323 * one object to the next
2324 * @param animate Enable animation if EINA_TRUE, disable otherwise
2327 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2330 * Get the whether an Elementary object has the focus or not.
2332 * @param obj The Elementary object to get the information from
2333 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2334 * not (and on errors).
2336 * @see elm_object_focus_set()
2340 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2343 * Set/unset focus to a given Elementary object.
2345 * @param obj The Elementary object to operate on.
2346 * @param enable @c EINA_TRUE Set focus to a given object,
2347 * @c EINA_FALSE Unset focus to a given object.
2349 * @note When you set focus to this object, if it can handle focus, will
2350 * take the focus away from the one who had it previously and will, for
2351 * now on, be the one receiving input events. Unsetting focus will remove
2352 * the focus from @p obj, passing it back to the previous element in the
2355 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2359 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2362 * Make a given Elementary object the focused one.
2364 * @param obj The Elementary object to make focused.
2366 * @note This object, if it can handle focus, will take the focus
2367 * away from the one who had it previously and will, for now on, be
2368 * the one receiving input events.
2370 * @see elm_object_focus_get()
2371 * @deprecated use elm_object_focus_set() instead.
2375 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2378 * Remove the focus from an Elementary object
2380 * @param obj The Elementary to take focus from
2382 * This removes the focus from @p obj, passing it back to the
2383 * previous element in the focus chain list.
2385 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2386 * @deprecated use elm_object_focus_set() instead.
2390 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2393 * Set the ability for an Element object to be focused
2395 * @param obj The Elementary object to operate on
2396 * @param enable @c EINA_TRUE if the object can be focused, @c
2397 * EINA_FALSE if not (and on errors)
2399 * This sets whether the object @p obj is able to take focus or
2400 * not. Unfocusable objects do nothing when programmatically
2401 * focused, being the nearest focusable parent object the one
2402 * really getting focus. Also, when they receive mouse input, they
2403 * will get the event, but not take away the focus from where it
2408 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2411 * Get whether an Elementary object is focusable or not
2413 * @param obj The Elementary object to operate on
2414 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2415 * EINA_FALSE if not (and on errors)
2417 * @note Objects which are meant to be interacted with by input
2418 * events are created able to be focused, by default. All the
2423 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2426 * Set custom focus chain.
2428 * This function overwrites any previous custom focus chain within
2429 * the list of objects. The previous list will be deleted and this list
2430 * will be managed by elementary. After it is set, don't modify it.
2432 * @note On focus cycle, only will be evaluated children of this container.
2434 * @param obj The container object
2435 * @param objs Chain of objects to pass focus
2438 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2441 * Unset a custom focus chain on a given Elementary widget
2443 * @param obj The container object to remove focus chain from
2445 * Any focus chain previously set on @p obj (for its child objects)
2446 * is removed entirely after this call.
2450 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2453 * Get custom focus chain
2455 * @param obj The container object
2458 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2461 * Append object to custom focus chain.
2463 * @note If relative_child equal to NULL or not in custom chain, the object
2464 * will be added in end.
2466 * @note On focus cycle, only will be evaluated children of this container.
2468 * @param obj The container object
2469 * @param child The child to be added in custom chain
2470 * @param relative_child The relative object to position the child
2473 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2476 * Prepend object to custom focus chain.
2478 * @note If relative_child equal to NULL or not in custom chain, the object
2479 * will be added in begin.
2481 * @note On focus cycle, only will be evaluated children of this container.
2483 * @param obj The container object
2484 * @param child The child to be added in custom chain
2485 * @param relative_child The relative object to position the child
2488 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2491 * Give focus to next object in object tree.
2493 * Give focus to next object in focus chain of one object sub-tree.
2494 * If the last object of chain already have focus, the focus will go to the
2495 * first object of chain.
2497 * @param obj The object root of sub-tree
2498 * @param dir Direction to cycle the focus
2502 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2505 * Give focus to near object in one direction.
2507 * Give focus to near object in direction of one object.
2508 * If none focusable object in given direction, the focus will not change.
2510 * @param obj The reference object
2511 * @param x Horizontal component of direction to focus
2512 * @param y Vertical component of direction to focus
2516 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2519 * Make the elementary object and its children to be unfocusable
2522 * @param obj The Elementary object to operate on
2523 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2524 * @c EINA_FALSE for focusable.
2526 * This sets whether the object @p obj and its children objects
2527 * are able to take focus or not. If the tree is set as unfocusable,
2528 * newest focused object which is not in this tree will get focus.
2529 * This API can be helpful for an object to be deleted.
2530 * When an object will be deleted soon, it and its children may not
2531 * want to get focus (by focus reverting or by other focus controls).
2532 * Then, just use this API before deleting.
2534 * @see elm_object_tree_unfocusable_get()
2538 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2541 * Get whether an Elementary object and its children are unfocusable or not.
2543 * @param obj The Elementary object to get the information from
2544 * @return @c EINA_TRUE, if the tree is unfocussable,
2545 * @c EINA_FALSE if not (and on errors).
2547 * @see elm_object_tree_unfocusable_set()
2551 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2554 * @defgroup Scrolling Scrolling
2556 * These are functions setting how scrollable views in Elementary
2557 * widgets should behave on user interaction.
2563 * Get whether scrollers should bounce when they reach their
2564 * viewport's edge during a scroll.
2566 * @return the thumb scroll bouncing state
2568 * This is the default behavior for touch screens, in general.
2569 * @ingroup Scrolling
2571 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2574 * Set whether scrollers should bounce when they reach their
2575 * viewport's edge during a scroll.
2577 * @param enabled the thumb scroll bouncing state
2579 * @see elm_thumbscroll_bounce_enabled_get()
2580 * @ingroup Scrolling
2582 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2585 * Set whether scrollers should bounce when they reach their
2586 * viewport's edge during a scroll, for all Elementary application
2589 * @param enabled the thumb scroll bouncing state
2591 * @see elm_thumbscroll_bounce_enabled_get()
2592 * @ingroup Scrolling
2594 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2597 * Get the amount of inertia a scroller will impose at bounce
2600 * @return the thumb scroll bounce friction
2602 * @ingroup Scrolling
2604 EAPI double elm_scroll_bounce_friction_get(void);
2607 * Set the amount of inertia a scroller will impose at bounce
2610 * @param friction the thumb scroll bounce friction
2612 * @see elm_thumbscroll_bounce_friction_get()
2613 * @ingroup Scrolling
2615 EAPI void elm_scroll_bounce_friction_set(double friction);
2618 * Set the amount of inertia a scroller will impose at bounce
2619 * animations, for all Elementary application windows.
2621 * @param friction the thumb scroll bounce friction
2623 * @see elm_thumbscroll_bounce_friction_get()
2624 * @ingroup Scrolling
2626 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2629 * Get the amount of inertia a <b>paged</b> scroller will impose at
2630 * page fitting animations.
2632 * @return the page scroll friction
2634 * @ingroup Scrolling
2636 EAPI double elm_scroll_page_scroll_friction_get(void);
2639 * Set the amount of inertia a <b>paged</b> scroller will impose at
2640 * page fitting animations.
2642 * @param friction the page scroll friction
2644 * @see elm_thumbscroll_page_scroll_friction_get()
2645 * @ingroup Scrolling
2647 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2650 * Set the amount of inertia a <b>paged</b> scroller will impose at
2651 * page fitting animations, for all Elementary application windows.
2653 * @param friction the page scroll friction
2655 * @see elm_thumbscroll_page_scroll_friction_get()
2656 * @ingroup Scrolling
2658 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2661 * Get the amount of inertia a scroller will impose at region bring
2664 * @return the bring in scroll friction
2666 * @ingroup Scrolling
2668 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2671 * Set the amount of inertia a scroller will impose at region bring
2674 * @param friction the bring in scroll friction
2676 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2677 * @ingroup Scrolling
2679 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2682 * Set the amount of inertia a scroller will impose at region bring
2683 * animations, for all Elementary application windows.
2685 * @param friction the bring in scroll friction
2687 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2688 * @ingroup Scrolling
2690 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2693 * Get the amount of inertia scrollers will impose at animations
2694 * triggered by Elementary widgets' zooming API.
2696 * @return the zoom friction
2698 * @ingroup Scrolling
2700 EAPI double elm_scroll_zoom_friction_get(void);
2703 * Set the amount of inertia scrollers will impose at animations
2704 * triggered by Elementary widgets' zooming API.
2706 * @param friction the zoom friction
2708 * @see elm_thumbscroll_zoom_friction_get()
2709 * @ingroup Scrolling
2711 EAPI void elm_scroll_zoom_friction_set(double friction);
2714 * Set the amount of inertia scrollers will impose at animations
2715 * triggered by Elementary widgets' zooming API, for all Elementary
2716 * application windows.
2718 * @param friction the zoom friction
2720 * @see elm_thumbscroll_zoom_friction_get()
2721 * @ingroup Scrolling
2723 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2726 * Get whether scrollers should be draggable from any point in their
2729 * @return the thumb scroll state
2731 * @note This is the default behavior for touch screens, in general.
2732 * @note All other functions namespaced with "thumbscroll" will only
2733 * have effect if this mode is enabled.
2735 * @ingroup Scrolling
2737 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2740 * Set whether scrollers should be draggable from any point in their
2743 * @param enabled the thumb scroll state
2745 * @see elm_thumbscroll_enabled_get()
2746 * @ingroup Scrolling
2748 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2751 * Set whether scrollers should be draggable from any point in their
2752 * views, for all Elementary application windows.
2754 * @param enabled the thumb scroll state
2756 * @see elm_thumbscroll_enabled_get()
2757 * @ingroup Scrolling
2759 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2762 * Get the number of pixels one should travel while dragging a
2763 * scroller's view to actually trigger scrolling.
2765 * @return the thumb scroll threshould
2767 * One would use higher values for touch screens, in general, because
2768 * of their inherent imprecision.
2769 * @ingroup Scrolling
2771 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2774 * Set the number of pixels one should travel while dragging a
2775 * scroller's view to actually trigger scrolling.
2777 * @param threshold the thumb scroll threshould
2779 * @see elm_thumbscroll_threshould_get()
2780 * @ingroup Scrolling
2782 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2785 * Set the number of pixels one should travel while dragging a
2786 * scroller's view to actually trigger scrolling, for all Elementary
2787 * application windows.
2789 * @param threshold the thumb scroll threshould
2791 * @see elm_thumbscroll_threshould_get()
2792 * @ingroup Scrolling
2794 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2797 * Get the minimum speed of mouse cursor movement which will trigger
2798 * list self scrolling animation after a mouse up event
2801 * @return the thumb scroll momentum threshould
2803 * @ingroup Scrolling
2805 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2808 * Set the minimum speed of mouse cursor movement which will trigger
2809 * list self scrolling animation after a mouse up event
2812 * @param threshold the thumb scroll momentum threshould
2814 * @see elm_thumbscroll_momentum_threshould_get()
2815 * @ingroup Scrolling
2817 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2820 * Set the minimum speed of mouse cursor movement which will trigger
2821 * list self scrolling animation after a mouse up event
2822 * (pixels/second), for all Elementary application windows.
2824 * @param threshold the thumb scroll momentum threshould
2826 * @see elm_thumbscroll_momentum_threshould_get()
2827 * @ingroup Scrolling
2829 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2832 * Get the amount of inertia a scroller will impose at self scrolling
2835 * @return the thumb scroll friction
2837 * @ingroup Scrolling
2839 EAPI double elm_scroll_thumbscroll_friction_get(void);
2842 * Set the amount of inertia a scroller will impose at self scrolling
2845 * @param friction the thumb scroll friction
2847 * @see elm_thumbscroll_friction_get()
2848 * @ingroup Scrolling
2850 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
2853 * Set the amount of inertia a scroller will impose at self scrolling
2854 * animations, for all Elementary application windows.
2856 * @param friction the thumb scroll friction
2858 * @see elm_thumbscroll_friction_get()
2859 * @ingroup Scrolling
2861 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
2864 * Get the amount of lag between your actual mouse cursor dragging
2865 * movement and a scroller's view movement itself, while pushing it
2866 * into bounce state manually.
2868 * @return the thumb scroll border friction
2870 * @ingroup Scrolling
2872 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2875 * Set the amount of lag between your actual mouse cursor dragging
2876 * movement and a scroller's view movement itself, while pushing it
2877 * into bounce state manually.
2879 * @param friction the thumb scroll border friction. @c 0.0 for
2880 * perfect synchrony between two movements, @c 1.0 for maximum
2883 * @see elm_thumbscroll_border_friction_get()
2884 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2886 * @ingroup Scrolling
2888 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
2891 * Set the amount of lag between your actual mouse cursor dragging
2892 * movement and a scroller's view movement itself, while pushing it
2893 * into bounce state manually, for all Elementary application windows.
2895 * @param friction the thumb scroll border friction. @c 0.0 for
2896 * perfect synchrony between two movements, @c 1.0 for maximum
2899 * @see elm_thumbscroll_border_friction_get()
2900 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2902 * @ingroup Scrolling
2904 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
2907 * Get the sensitivity amount which is be multiplied by the length of
2910 * @return the thumb scroll sensitivity friction
2912 * @ingroup Scrolling
2914 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
2917 * Set the sensitivity amount which is be multiplied by the length of
2920 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2921 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2924 * @see elm_thumbscroll_sensitivity_friction_get()
2925 * @note parameter value will get bound to 0.1 - 1.0 interval, always
2927 * @ingroup Scrolling
2929 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
2932 * Set the sensitivity amount which is be multiplied by the length of
2933 * mouse dragging, for all Elementary application windows.
2935 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2936 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2939 * @see elm_thumbscroll_sensitivity_friction_get()
2940 * @note parameter value will get bound to 0.1 - 1.0 interval, always
2942 * @ingroup Scrolling
2944 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
2951 * @defgroup Scrollhints Scrollhints
2953 * Objects when inside a scroller can scroll, but this may not always be
2954 * desirable in certain situations. This allows an object to hint to itself
2955 * and parents to "not scroll" in one of 2 ways. If any child object of a
2956 * scroller has pushed a scroll freeze or hold then it affects all parent
2957 * scrollers until all children have released them.
2959 * 1. To hold on scrolling. This means just flicking and dragging may no
2960 * longer scroll, but pressing/dragging near an edge of the scroller will
2961 * still scroll. This is automatically used by the entry object when
2964 * 2. To totally freeze scrolling. This means it stops. until
2971 * Push the scroll hold by 1
2973 * This increments the scroll hold count by one. If it is more than 0 it will
2974 * take effect on the parents of the indicated object.
2976 * @param obj The object
2977 * @ingroup Scrollhints
2979 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2982 * Pop the scroll hold by 1
2984 * This decrements the scroll hold count by one. If it is more than 0 it will
2985 * take effect on the parents of the indicated object.
2987 * @param obj The object
2988 * @ingroup Scrollhints
2990 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2993 * Push the scroll freeze by 1
2995 * This increments the scroll freeze count by one. If it is more
2996 * than 0 it will take effect on the parents of the indicated
2999 * @param obj The object
3000 * @ingroup Scrollhints
3002 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3005 * Pop the scroll freeze by 1
3007 * This decrements the scroll freeze count by one. If it is more
3008 * than 0 it will take effect on the parents of the indicated
3011 * @param obj The object
3012 * @ingroup Scrollhints
3014 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3017 * Lock the scrolling of the given widget (and thus all parents)
3019 * This locks the given object from scrolling in the X axis (and implicitly
3020 * also locks all parent scrollers too from doing the same).
3022 * @param obj The object
3023 * @param lock The lock state (1 == locked, 0 == unlocked)
3024 * @ingroup Scrollhints
3026 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3029 * Lock the scrolling of the given widget (and thus all parents)
3031 * This locks the given object from scrolling in the Y axis (and implicitly
3032 * also locks all parent scrollers too from doing the same).
3034 * @param obj The object
3035 * @param lock The lock state (1 == locked, 0 == unlocked)
3036 * @ingroup Scrollhints
3038 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3041 * Get the scrolling lock of the given widget
3043 * This gets the lock for X axis scrolling.
3045 * @param obj The object
3046 * @ingroup Scrollhints
3048 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3051 * Get the scrolling lock of the given widget
3053 * This gets the lock for X axis scrolling.
3055 * @param obj The object
3056 * @ingroup Scrollhints
3058 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3065 * Send a signal to the widget edje object.
3067 * This function sends a signal to the edje object of the obj. An
3068 * edje program can respond to a signal by specifying matching
3069 * 'signal' and 'source' fields.
3071 * @param obj The object
3072 * @param emission The signal's name.
3073 * @param source The signal's source.
3076 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3079 * Add a callback for a signal emitted by widget edje object.
3081 * This function connects a callback function to a signal emitted by the
3082 * edje object of the obj.
3083 * Globs can occur in either the emission or source name.
3085 * @param obj The object
3086 * @param emission The signal's name.
3087 * @param source The signal's source.
3088 * @param func The callback function to be executed when the signal is
3090 * @param data A pointer to data to pass in to the callback function.
3093 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);
3096 * Remove a signal-triggered callback from a widget edje object.
3098 * This function removes a callback, previoulsy attached to a
3099 * signal emitted by the edje object of the obj. The parameters
3100 * emission, source and func must match exactly those passed to a
3101 * previous call to elm_object_signal_callback_add(). The data
3102 * pointer that was passed to this call will be returned.
3104 * @param obj The object
3105 * @param emission The signal's name.
3106 * @param source The signal's source.
3107 * @param func The callback function to be executed when the signal is
3109 * @return The data pointer
3112 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);
3115 * Add a callback for input events (key up, key down, mouse wheel)
3116 * on a given Elementary widget
3118 * @param obj The widget to add an event callback on
3119 * @param func The callback function to be executed when the event
3121 * @param data Data to pass in to @p func
3123 * Every widget in an Elementary interface set to receive focus,
3124 * with elm_object_focus_allow_set(), will propagate @b all of its
3125 * key up, key down and mouse wheel input events up to its parent
3126 * object, and so on. All of the focusable ones in this chain which
3127 * had an event callback set, with this call, will be able to treat
3128 * those events. There are two ways of making the propagation of
3129 * these event upwards in the tree of widgets to @b cease:
3130 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3131 * the event was @b not processed, so the propagation will go on.
3132 * - The @c event_info pointer passed to @p func will contain the
3133 * event's structure and, if you OR its @c event_flags inner
3134 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3135 * one has already handled it, thus killing the event's
3138 * @note Your event callback will be issued on those events taking
3139 * place only if no other child widget of @obj has consumed the
3142 * @note Not to be confused with @c
3143 * evas_object_event_callback_add(), which will add event callbacks
3144 * per type on general Evas objects (no event propagation
3145 * infrastructure taken in account).
3147 * @note Not to be confused with @c
3148 * elm_object_signal_callback_add(), which will add callbacks to @b
3149 * signals coming from a widget's theme, not input events.
3151 * @note Not to be confused with @c
3152 * edje_object_signal_callback_add(), which does the same as
3153 * elm_object_signal_callback_add(), but directly on an Edje
3156 * @note Not to be confused with @c
3157 * evas_object_smart_callback_add(), which adds callbacks to smart
3158 * objects' <b>smart events</b>, and not input events.
3160 * @see elm_object_event_callback_del()
3164 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3167 * Remove an event callback from a widget.
3169 * This function removes a callback, previoulsy attached to event emission
3171 * The parameters func and data must match exactly those passed to
3172 * a previous call to elm_object_event_callback_add(). The data pointer that
3173 * was passed to this call will be returned.
3175 * @param obj The object
3176 * @param func The callback function to be executed when the event is
3178 * @param data Data to pass in to the callback function.
3179 * @return The data pointer
3182 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3185 * Adjust size of an element for finger usage.
3187 * @param times_w How many fingers should fit horizontally
3188 * @param w Pointer to the width size to adjust
3189 * @param times_h How many fingers should fit vertically
3190 * @param h Pointer to the height size to adjust
3192 * This takes width and height sizes (in pixels) as input and a
3193 * size multiple (which is how many fingers you want to place
3194 * within the area, being "finger" the size set by
3195 * elm_finger_size_set()), and adjusts the size to be large enough
3196 * to accommodate the resulting size -- if it doesn't already
3197 * accommodate it. On return the @p w and @p h sizes pointed to by
3198 * these parameters will be modified, on those conditions.
3200 * @note This is kind of a low level Elementary call, most useful
3201 * on size evaluation times for widgets. An external user wouldn't
3202 * be calling, most of the time.
3206 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3209 * Get the duration for occuring long press event.
3211 * @return Timeout for long press event
3212 * @ingroup Longpress
3214 EAPI double elm_longpress_timeout_get(void);
3217 * Set the duration for occuring long press event.
3219 * @param lonpress_timeout Timeout for long press event
3220 * @ingroup Longpress
3222 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3225 * @defgroup Debug Debug
3226 * don't use it unless you are sure
3232 * Print Tree object hierarchy in stdout
3234 * @param obj The root object
3237 EAPI void elm_object_tree_dump(const Evas_Object *top);
3240 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3242 * @param obj The root object
3243 * @param file The path of output file
3246 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3253 * @defgroup Theme Theme
3255 * Elementary uses Edje to theme its widgets, naturally. But for the most
3256 * part this is hidden behind a simpler interface that lets the user set
3257 * extensions and choose the style of widgets in a much easier way.
3259 * Instead of thinking in terms of paths to Edje files and their groups
3260 * each time you want to change the appearance of a widget, Elementary
3261 * works so you can add any theme file with extensions or replace the
3262 * main theme at one point in the application, and then just set the style
3263 * of widgets with elm_object_style_set() and related functions. Elementary
3264 * will then look in its list of themes for a matching group and apply it,
3265 * and when the theme changes midway through the application, all widgets
3266 * will be updated accordingly.
3268 * There are three concepts you need to know to understand how Elementary
3269 * theming works: default theme, extensions and overlays.
3271 * Default theme, obviously enough, is the one that provides the default
3272 * look of all widgets. End users can change the theme used by Elementary
3273 * by setting the @c ELM_THEME environment variable before running an
3274 * application, or globally for all programs using the @c elementary_config
3275 * utility. Applications can change the default theme using elm_theme_set(),
3276 * but this can go against the user wishes, so it's not an adviced practice.
3278 * Ideally, applications should find everything they need in the already
3279 * provided theme, but there may be occasions when that's not enough and
3280 * custom styles are required to correctly express the idea. For this
3281 * cases, Elementary has extensions.
3283 * Extensions allow the application developer to write styles of its own
3284 * to apply to some widgets. This requires knowledge of how each widget
3285 * is themed, as extensions will always replace the entire group used by
3286 * the widget, so important signals and parts need to be there for the
3287 * object to behave properly (see documentation of Edje for details).
3288 * Once the theme for the extension is done, the application needs to add
3289 * it to the list of themes Elementary will look into, using
3290 * elm_theme_extension_add(), and set the style of the desired widgets as
3291 * he would normally with elm_object_style_set().
3293 * Overlays, on the other hand, can replace the look of all widgets by
3294 * overriding the default style. Like extensions, it's up to the application
3295 * developer to write the theme for the widgets it wants, the difference
3296 * being that when looking for the theme, Elementary will check first the
3297 * list of overlays, then the set theme and lastly the list of extensions,
3298 * so with overlays it's possible to replace the default view and every
3299 * widget will be affected. This is very much alike to setting the whole
3300 * theme for the application and will probably clash with the end user
3301 * options, not to mention the risk of ending up with not matching styles
3302 * across the program. Unless there's a very special reason to use them,
3303 * overlays should be avoided for the resons exposed before.
3305 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3306 * keeps one default internally and every function that receives one of
3307 * these can be called with NULL to refer to this default (except for
3308 * elm_theme_free()). It's possible to create a new instance of a
3309 * ::Elm_Theme to set other theme for a specific widget (and all of its
3310 * children), but this is as discouraged, if not even more so, than using
3311 * overlays. Don't use this unless you really know what you are doing.
3313 * But to be less negative about things, you can look at the following
3315 * @li @ref theme_example_01 "Using extensions"
3316 * @li @ref theme_example_02 "Using overlays"
3321 * @typedef Elm_Theme
3323 * Opaque handler for the list of themes Elementary looks for when
3324 * rendering widgets.
3326 * Stay out of this unless you really know what you are doing. For most
3327 * cases, sticking to the default is all a developer needs.
3329 typedef struct _Elm_Theme Elm_Theme;
3332 * Create a new specific theme
3334 * This creates an empty specific theme that only uses the default theme. A
3335 * specific theme has its own private set of extensions and overlays too
3336 * (which are empty by default). Specific themes do not fall back to themes
3337 * of parent objects. They are not intended for this use. Use styles, overlays
3338 * and extensions when needed, but avoid specific themes unless there is no
3339 * other way (example: you want to have a preview of a new theme you are
3340 * selecting in a "theme selector" window. The preview is inside a scroller
3341 * and should display what the theme you selected will look like, but not
3342 * actually apply it yet. The child of the scroller will have a specific
3343 * theme set to show this preview before the user decides to apply it to all
3346 EAPI Elm_Theme *elm_theme_new(void);
3348 * Free a specific theme
3350 * @param th The theme to free
3352 * This frees a theme created with elm_theme_new().
3354 EAPI void elm_theme_free(Elm_Theme *th);
3356 * Copy the theme fom the source to the destination theme
3358 * @param th The source theme to copy from
3359 * @param thdst The destination theme to copy data to
3361 * This makes a one-time static copy of all the theme config, extensions
3362 * and overlays from @p th to @p thdst. If @p th references a theme, then
3363 * @p thdst is also set to reference it, with all the theme settings,
3364 * overlays and extensions that @p th had.
3366 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3368 * Tell the source theme to reference the ref theme
3370 * @param th The theme that will do the referencing
3371 * @param thref The theme that is the reference source
3373 * This clears @p th to be empty and then sets it to refer to @p thref
3374 * so @p th acts as an override to @p thref, but where its overrides
3375 * don't apply, it will fall through to @p thref for configuration.
3377 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3379 * Return the theme referred to
3381 * @param th The theme to get the reference from
3382 * @return The referenced theme handle
3384 * This gets the theme set as the reference theme by elm_theme_ref_set().
3385 * If no theme is set as a reference, NULL is returned.
3387 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3389 * Return the default theme
3391 * @return The default theme handle
3393 * This returns the internal default theme setup handle that all widgets
3394 * use implicitly unless a specific theme is set. This is also often use
3395 * as a shorthand of NULL.
3397 EAPI Elm_Theme *elm_theme_default_get(void);
3399 * Prepends a theme overlay to the list of overlays
3401 * @param th The theme to add to, or if NULL, the default theme
3402 * @param item The Edje file path to be used
3404 * Use this if your application needs to provide some custom overlay theme
3405 * (An Edje file that replaces some default styles of widgets) where adding
3406 * new styles, or changing system theme configuration is not possible. Do
3407 * NOT use this instead of a proper system theme configuration. Use proper
3408 * configuration files, profiles, environment variables etc. to set a theme
3409 * so that the theme can be altered by simple confiugration by a user. Using
3410 * this call to achieve that effect is abusing the API and will create lots
3413 * @see elm_theme_extension_add()
3415 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3417 * Delete a theme overlay from the list of overlays
3419 * @param th The theme to delete from, or if NULL, the default theme
3420 * @param item The name of the theme overlay
3422 * @see elm_theme_overlay_add()
3424 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3426 * Appends a theme extension to the list of extensions.
3428 * @param th The theme to add to, or if NULL, the default theme
3429 * @param item The Edje file path to be used
3431 * This is intended when an application needs more styles of widgets or new
3432 * widget themes that the default does not provide (or may not provide). The
3433 * application has "extended" usage by coming up with new custom style names
3434 * for widgets for specific uses, but as these are not "standard", they are
3435 * not guaranteed to be provided by a default theme. This means the
3436 * application is required to provide these extra elements itself in specific
3437 * Edje files. This call adds one of those Edje files to the theme search
3438 * path to be search after the default theme. The use of this call is
3439 * encouraged when default styles do not meet the needs of the application.
3440 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3442 * @see elm_object_style_set()
3444 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3446 * Deletes a theme extension from the list of extensions.
3448 * @param th The theme to delete from, or if NULL, the default theme
3449 * @param item The name of the theme extension
3451 * @see elm_theme_extension_add()
3453 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3455 * Set the theme search order for the given theme
3457 * @param th The theme to set the search order, or if NULL, the default theme
3458 * @param theme Theme search string
3460 * This sets the search string for the theme in path-notation from first
3461 * theme to search, to last, delimited by the : character. Example:
3463 * "shiny:/path/to/file.edj:default"
3465 * See the ELM_THEME environment variable for more information.
3467 * @see elm_theme_get()
3468 * @see elm_theme_list_get()
3470 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3472 * Return the theme search order
3474 * @param th The theme to get the search order, or if NULL, the default theme
3475 * @return The internal search order path
3477 * This function returns a colon separated string of theme elements as
3478 * returned by elm_theme_list_get().
3480 * @see elm_theme_set()
3481 * @see elm_theme_list_get()
3483 EAPI const char *elm_theme_get(Elm_Theme *th);
3485 * Return a list of theme elements to be used in a theme.
3487 * @param th Theme to get the list of theme elements from.
3488 * @return The internal list of theme elements
3490 * This returns the internal list of theme elements (will only be valid as
3491 * long as the theme is not modified by elm_theme_set() or theme is not
3492 * freed by elm_theme_free(). This is a list of strings which must not be
3493 * altered as they are also internal. If @p th is NULL, then the default
3494 * theme element list is returned.
3496 * A theme element can consist of a full or relative path to a .edj file,
3497 * or a name, without extension, for a theme to be searched in the known
3498 * theme paths for Elemementary.
3500 * @see elm_theme_set()
3501 * @see elm_theme_get()
3503 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3505 * Return the full patrh for a theme element
3507 * @param f The theme element name
3508 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3509 * @return The full path to the file found.
3511 * This returns a string you should free with free() on success, NULL on
3512 * failure. This will search for the given theme element, and if it is a
3513 * full or relative path element or a simple searchable name. The returned
3514 * path is the full path to the file, if searched, and the file exists, or it
3515 * is simply the full path given in the element or a resolved path if
3516 * relative to home. The @p in_search_path boolean pointed to is set to
3517 * EINA_TRUE if the file was a searchable file andis in the search path,
3518 * and EINA_FALSE otherwise.
3520 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3522 * Flush the current theme.
3524 * @param th Theme to flush
3526 * This flushes caches that let elementary know where to find theme elements
3527 * in the given theme. If @p th is NULL, then the default theme is flushed.
3528 * Call this function if source theme data has changed in such a way as to
3529 * make any caches Elementary kept invalid.
3531 EAPI void elm_theme_flush(Elm_Theme *th);
3533 * This flushes all themes (default and specific ones).
3535 * This will flush all themes in the current application context, by calling
3536 * elm_theme_flush() on each of them.
3538 EAPI void elm_theme_full_flush(void);
3540 * Set the theme for all elementary using applications on the current display
3542 * @param theme The name of the theme to use. Format same as the ELM_THEME
3543 * environment variable.
3545 EAPI void elm_theme_all_set(const char *theme);
3547 * Return a list of theme elements in the theme search path
3549 * @return A list of strings that are the theme element names.
3551 * This lists all available theme files in the standard Elementary search path
3552 * for theme elements, and returns them in alphabetical order as theme
3553 * element names in a list of strings. Free this with
3554 * elm_theme_name_available_list_free() when you are done with the list.
3556 EAPI Eina_List *elm_theme_name_available_list_new(void);
3558 * Free the list returned by elm_theme_name_available_list_new()
3560 * This frees the list of themes returned by
3561 * elm_theme_name_available_list_new(). Once freed the list should no longer
3562 * be used. a new list mys be created.
3564 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3566 * Set a specific theme to be used for this object and its children
3568 * @param obj The object to set the theme on
3569 * @param th The theme to set
3571 * This sets a specific theme that will be used for the given object and any
3572 * child objects it has. If @p th is NULL then the theme to be used is
3573 * cleared and the object will inherit its theme from its parent (which
3574 * ultimately will use the default theme if no specific themes are set).
3576 * Use special themes with great care as this will annoy users and make
3577 * configuration difficult. Avoid any custom themes at all if it can be
3580 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3582 * Get the specific theme to be used
3584 * @param obj The object to get the specific theme from
3585 * @return The specifc theme set.
3587 * This will return a specific theme set, or NULL if no specific theme is
3588 * set on that object. It will not return inherited themes from parents, only
3589 * the specific theme set for that specific object. See elm_object_theme_set()
3590 * for more information.
3592 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3595 * Get a data item from a theme
3597 * @param th The theme, or NULL for default theme
3598 * @param key The data key to search with
3599 * @return The data value, or NULL on failure
3601 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3602 * It works the same way as edje_file_data_get() except that the return is stringshared.
3604 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3610 /** @defgroup Win Win
3612 * @image html img/widget/win/preview-00.png
3613 * @image latex img/widget/win/preview-00.eps
3615 * The window class of Elementary. Contains functions to manipulate
3616 * windows. The Evas engine used to render the window contents is specified
3617 * in the system or user elementary config files (whichever is found last),
3618 * and can be overridden with the ELM_ENGINE environment variable for
3619 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3620 * compilation setup and modules actually installed at runtime) are (listed
3621 * in order of best supported and most likely to be complete and work to
3624 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3625 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3627 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3629 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3631 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3633 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3634 * rendering using SDL as the buffer)
3635 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3636 * GDI with software)
3637 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3638 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3639 * grayscale using dedicated 8bit software engine in X11)
3640 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3641 * X11 using 16bit software engine)
3642 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3643 * (Windows CE rendering via GDI with 16bit software renderer)
3644 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3645 * buffer with 16bit software renderer)
3646 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3648 * All engines use a simple string to select the engine to render, EXCEPT
3649 * the "shot" engine. This actually encodes the output of the virtual
3650 * screenshot and how long to delay in the engine string. The engine string
3651 * is encoded in the following way:
3653 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3655 * Where options are separated by a ":" char if more than one option is
3656 * given, with delay, if provided being the first option and file the last
3657 * (order is important). The delay specifies how long to wait after the
3658 * window is shown before doing the virtual "in memory" rendering and then
3659 * save the output to the file specified by the file option (and then exit).
3660 * If no delay is given, the default is 0.5 seconds. If no file is given the
3661 * default output file is "out.png". Repeat option is for continous
3662 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3663 * fixed to "out001.png" Some examples of using the shot engine:
3665 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3666 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3667 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3668 * ELM_ENGINE="shot:delay=2.0" elementary_test
3669 * ELM_ENGINE="shot:" elementary_test
3671 * Signals that you can add callbacks for are:
3673 * @li "delete,request": the user requested to close the window. See
3674 * elm_win_autodel_set().
3675 * @li "focus,in": window got focus
3676 * @li "focus,out": window lost focus
3677 * @li "moved": window that holds the canvas was moved
3680 * @li @ref win_example_01
3685 * Defines the types of window that can be created
3687 * These are hints set on the window so that a running Window Manager knows
3688 * how the window should be handled and/or what kind of decorations it
3691 * Currently, only the X11 backed engines use them.
3693 typedef enum _Elm_Win_Type
3695 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3696 window. Almost every window will be created with this
3698 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3699 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3700 window holding desktop icons. */
3701 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3702 be kept on top of any other window by the Window
3704 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3706 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3707 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3709 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3710 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3711 entry in a menubar is clicked. Typically used
3712 with elm_win_override_set(). This hint exists
3713 for completion only, as the EFL way of
3714 implementing a menu would not normally use a
3715 separate window for its contents. */
3716 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3717 triggered by right-clicking an object. */
3718 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3719 explanatory text that typically appear after the
3720 mouse cursor hovers over an object for a while.
3721 Typically used with elm_win_override_set() and also
3722 not very commonly used in the EFL. */
3723 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3724 battery life or a new E-Mail received. */
3725 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3726 usually used in the EFL. */
3727 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3728 object being dragged across different windows, or even
3729 applications. Typically used with
3730 elm_win_override_set(). */
3731 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3732 buffer. No actual window is created for this
3733 type, instead the window and all of its
3734 contents will be rendered to an image buffer.
3735 This allows to have children window inside a
3736 parent one just like any other object would
3737 be, and do other things like applying @c
3738 Evas_Map effects to it. This is the only type
3739 of window that requires the @c parent
3740 parameter of elm_win_add() to be a valid @c
3745 * The differents layouts that can be requested for the virtual keyboard.
3747 * When the application window is being managed by Illume, it may request
3748 * any of the following layouts for the virtual keyboard.
3750 typedef enum _Elm_Win_Keyboard_Mode
3752 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3753 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3754 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3755 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3756 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3757 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3758 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3759 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3760 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3761 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3762 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3763 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3764 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3765 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3766 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3767 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3768 } Elm_Win_Keyboard_Mode;
3771 * Available commands that can be sent to the Illume manager.
3773 * When running under an Illume session, a window may send commands to the
3774 * Illume manager to perform different actions.
3776 typedef enum _Elm_Illume_Command
3778 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3780 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3782 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3784 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3785 } Elm_Illume_Command;
3788 * Adds a window object. If this is the first window created, pass NULL as
3791 * @param parent Parent object to add the window to, or NULL
3792 * @param name The name of the window
3793 * @param type The window type, one of #Elm_Win_Type.
3795 * The @p parent paramter can be @c NULL for every window @p type except
3796 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3797 * which the image object will be created.
3799 * @return The created object, or NULL on failure
3801 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3803 * Adds a window object with standard setup
3805 * @param name The name of the window
3806 * @param title The title for the window
3808 * This creates a window like elm_win_add() but also puts in a standard
3809 * background with elm_bg_add(), as well as setting the window title to
3810 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
3811 * as the parent widget.
3813 * @return The created object, or NULL on failure
3815 * @see elm_win_add()
3817 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
3819 * Add @p subobj as a resize object of window @p obj.
3822 * Setting an object as a resize object of the window means that the
3823 * @p subobj child's size and position will be controlled by the window
3824 * directly. That is, the object will be resized to match the window size
3825 * and should never be moved or resized manually by the developer.
3827 * In addition, resize objects of the window control what the minimum size
3828 * of it will be, as well as whether it can or not be resized by the user.
3830 * For the end user to be able to resize a window by dragging the handles
3831 * or borders provided by the Window Manager, or using any other similar
3832 * mechanism, all of the resize objects in the window should have their
3833 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3835 * @param obj The window object
3836 * @param subobj The resize object to add
3838 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3840 * Delete @p subobj as a resize object of window @p obj.
3842 * This function removes the object @p subobj from the resize objects of
3843 * the window @p obj. It will not delete the object itself, which will be
3844 * left unmanaged and should be deleted by the developer, manually handled
3845 * or set as child of some other container.
3847 * @param obj The window object
3848 * @param subobj The resize object to add
3850 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3852 * Set the title of the window
3854 * @param obj The window object
3855 * @param title The title to set
3857 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3859 * Get the title of the window
3861 * The returned string is an internal one and should not be freed or
3862 * modified. It will also be rendered invalid if a new title is set or if
3863 * the window is destroyed.
3865 * @param obj The window object
3868 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3870 * Set the window's autodel state.
3872 * When closing the window in any way outside of the program control, like
3873 * pressing the X button in the titlebar or using a command from the
3874 * Window Manager, a "delete,request" signal is emitted to indicate that
3875 * this event occurred and the developer can take any action, which may
3876 * include, or not, destroying the window object.
3878 * When the @p autodel parameter is set, the window will be automatically
3879 * destroyed when this event occurs, after the signal is emitted.
3880 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3881 * and is up to the program to do so when it's required.
3883 * @param obj The window object
3884 * @param autodel If true, the window will automatically delete itself when
3887 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3889 * Get the window's autodel state.
3891 * @param obj The window object
3892 * @return If the window will automatically delete itself when closed
3894 * @see elm_win_autodel_set()
3896 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3898 * Activate a window object.
3900 * This function sends a request to the Window Manager to activate the
3901 * window pointed by @p obj. If honored by the WM, the window will receive
3902 * the keyboard focus.
3904 * @note This is just a request that a Window Manager may ignore, so calling
3905 * this function does not ensure in any way that the window will be the
3906 * active one after it.
3908 * @param obj The window object
3910 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3912 * Lower a window object.
3914 * Places the window pointed by @p obj at the bottom of the stack, so that
3915 * no other window is covered by it.
3917 * If elm_win_override_set() is not set, the Window Manager may ignore this
3920 * @param obj The window object
3922 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3924 * Raise a window object.
3926 * Places the window pointed by @p obj at the top of the stack, so that it's
3927 * not covered by any other window.
3929 * If elm_win_override_set() is not set, the Window Manager may ignore this
3932 * @param obj The window object
3934 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3936 * Set the borderless state of a window.
3938 * This function requests the Window Manager to not draw any decoration
3939 * around the window.
3941 * @param obj The window object
3942 * @param borderless If true, the window is borderless
3944 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3946 * Get the borderless state of a window.
3948 * @param obj The window object
3949 * @return If true, the window is borderless
3951 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3953 * Set the shaped state of a window.
3955 * Shaped windows, when supported, will render the parts of the window that
3956 * has no content, transparent.
3958 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3959 * background object or cover the entire window in any other way, or the
3960 * parts of the canvas that have no data will show framebuffer artifacts.
3962 * @param obj The window object
3963 * @param shaped If true, the window is shaped
3965 * @see elm_win_alpha_set()
3967 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3969 * Get the shaped state of a window.
3971 * @param obj The window object
3972 * @return If true, the window is shaped
3974 * @see elm_win_shaped_set()
3976 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3978 * Set the alpha channel state of a window.
3980 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3981 * possibly making parts of the window completely or partially transparent.
3982 * This is also subject to the underlying system supporting it, like for
3983 * example, running under a compositing manager. If no compositing is
3984 * available, enabling this option will instead fallback to using shaped
3985 * windows, with elm_win_shaped_set().
3987 * @param obj The window object
3988 * @param alpha If true, the window has an alpha channel
3990 * @see elm_win_alpha_set()
3992 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3994 * Get the transparency state of a window.
3996 * @param obj The window object
3997 * @return If true, the window is transparent
3999 * @see elm_win_transparent_set()
4001 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4003 * Set the transparency state of a window.
4005 * Use elm_win_alpha_set() instead.
4007 * @param obj The window object
4008 * @param transparent If true, the window is transparent
4010 * @see elm_win_alpha_set()
4012 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4014 * Get the alpha channel state of a window.
4016 * @param obj The window object
4017 * @return If true, the window has an alpha channel
4019 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4021 * Set the override state of a window.
4023 * A window with @p override set to EINA_TRUE will not be managed by the
4024 * Window Manager. This means that no decorations of any kind will be shown
4025 * for it, moving and resizing must be handled by the application, as well
4026 * as the window visibility.
4028 * This should not be used for normal windows, and even for not so normal
4029 * ones, it should only be used when there's a good reason and with a lot
4030 * of care. Mishandling override windows may result situations that
4031 * disrupt the normal workflow of the end user.
4033 * @param obj The window object
4034 * @param override If true, the window is overridden
4036 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4038 * Get the override state of a window.
4040 * @param obj The window object
4041 * @return If true, the window is overridden
4043 * @see elm_win_override_set()
4045 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4047 * Set the fullscreen state of a window.
4049 * @param obj The window object
4050 * @param fullscreen If true, the window is fullscreen
4052 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4054 * Get the fullscreen state of a window.
4056 * @param obj The window object
4057 * @return If true, the window is fullscreen
4059 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4061 * Set the maximized state of a window.
4063 * @param obj The window object
4064 * @param maximized If true, the window is maximized
4066 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4068 * Get the maximized state of a window.
4070 * @param obj The window object
4071 * @return If true, the window is maximized
4073 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4075 * Set the iconified state of a window.
4077 * @param obj The window object
4078 * @param iconified If true, the window is iconified
4080 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4082 * Get the iconified state of a window.
4084 * @param obj The window object
4085 * @return If true, the window is iconified
4087 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4089 * Set the layer of the window.
4091 * What this means exactly will depend on the underlying engine used.
4093 * In the case of X11 backed engines, the value in @p layer has the
4094 * following meanings:
4095 * @li < 3: The window will be placed below all others.
4096 * @li > 5: The window will be placed above all others.
4097 * @li other: The window will be placed in the default layer.
4099 * @param obj The window object
4100 * @param layer The layer of the window
4102 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4104 * Get the layer of the window.
4106 * @param obj The window object
4107 * @return The layer of the window
4109 * @see elm_win_layer_set()
4111 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4113 * Set the rotation of the window.
4115 * Most engines only work with multiples of 90.
4117 * This function is used to set the orientation of the window @p obj to
4118 * match that of the screen. The window itself will be resized to adjust
4119 * to the new geometry of its contents. If you want to keep the window size,
4120 * see elm_win_rotation_with_resize_set().
4122 * @param obj The window object
4123 * @param rotation The rotation of the window, in degrees (0-360),
4124 * counter-clockwise.
4126 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4128 * Rotates the window and resizes it.
4130 * Like elm_win_rotation_set(), but it also resizes the window's contents so
4131 * that they fit inside the current window geometry.
4133 * @param obj The window object
4134 * @param layer The rotation of the window in degrees (0-360),
4135 * counter-clockwise.
4137 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4139 * Get the rotation of the window.
4141 * @param obj The window object
4142 * @return The rotation of the window in degrees (0-360)
4144 * @see elm_win_rotation_set()
4145 * @see elm_win_rotation_with_resize_set()
4147 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4149 * Set the sticky state of the window.
4151 * Hints the Window Manager that the window in @p obj should be left fixed
4152 * at its position even when the virtual desktop it's on moves or changes.
4154 * @param obj The window object
4155 * @param sticky If true, the window's sticky state is enabled
4157 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4159 * Get the sticky state of the window.
4161 * @param obj The window object
4162 * @return If true, the window's sticky state is enabled
4164 * @see elm_win_sticky_set()
4166 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4168 * Set if this window is an illume conformant window
4170 * @param obj The window object
4171 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4173 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4175 * Get if this window is an illume conformant window
4177 * @param obj The window object
4178 * @return A boolean if this window is illume conformant or not
4180 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4182 * Set a window to be an illume quickpanel window
4184 * By default window objects are not quickpanel windows.
4186 * @param obj The window object
4187 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4189 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4191 * Get if this window is a quickpanel or not
4193 * @param obj The window object
4194 * @return A boolean if this window is a quickpanel or not
4196 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4198 * Set the major priority of a quickpanel window
4200 * @param obj The window object
4201 * @param priority The major priority for this quickpanel
4203 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4205 * Get the major priority of a quickpanel window
4207 * @param obj The window object
4208 * @return The major priority of this quickpanel
4210 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4212 * Set the minor priority of a quickpanel window
4214 * @param obj The window object
4215 * @param priority The minor priority for this quickpanel
4217 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4219 * Get the minor priority of a quickpanel window
4221 * @param obj The window object
4222 * @return The minor priority of this quickpanel
4224 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4226 * Set which zone this quickpanel should appear in
4228 * @param obj The window object
4229 * @param zone The requested zone for this quickpanel
4231 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4233 * Get which zone this quickpanel should appear in
4235 * @param obj The window object
4236 * @return The requested zone for this quickpanel
4238 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4240 * Set the window to be skipped by keyboard focus
4242 * This sets the window to be skipped by normal keyboard input. This means
4243 * a window manager will be asked to not focus this window as well as omit
4244 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4246 * Call this and enable it on a window BEFORE you show it for the first time,
4247 * otherwise it may have no effect.
4249 * Use this for windows that have only output information or might only be
4250 * interacted with by the mouse or fingers, and never for typing input.
4251 * Be careful that this may have side-effects like making the window
4252 * non-accessible in some cases unless the window is specially handled. Use
4255 * @param obj The window object
4256 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4258 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4260 * Send a command to the windowing environment
4262 * This is intended to work in touchscreen or small screen device
4263 * environments where there is a more simplistic window management policy in
4264 * place. This uses the window object indicated to select which part of the
4265 * environment to control (the part that this window lives in), and provides
4266 * a command and an optional parameter structure (use NULL for this if not
4269 * @param obj The window object that lives in the environment to control
4270 * @param command The command to send
4271 * @param params Optional parameters for the command
4273 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4275 * Get the inlined image object handle
4277 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4278 * then the window is in fact an evas image object inlined in the parent
4279 * canvas. You can get this object (be careful to not manipulate it as it
4280 * is under control of elementary), and use it to do things like get pixel
4281 * data, save the image to a file, etc.
4283 * @param obj The window object to get the inlined image from
4284 * @return The inlined image object, or NULL if none exists
4286 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4288 * Set the enabled status for the focus highlight in a window
4290 * This function will enable or disable the focus highlight only for the
4291 * given window, regardless of the global setting for it
4293 * @param obj The window where to enable the highlight
4294 * @param enabled The enabled value for the highlight
4296 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4298 * Get the enabled value of the focus highlight for this window
4300 * @param obj The window in which to check if the focus highlight is enabled
4302 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4304 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4306 * Set the style for the focus highlight on this window
4308 * Sets the style to use for theming the highlight of focused objects on
4309 * the given window. If @p style is NULL, the default will be used.
4311 * @param obj The window where to set the style
4312 * @param style The style to set
4314 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4316 * Get the style set for the focus highlight object
4318 * Gets the style set for this windows highilght object, or NULL if none
4321 * @param obj The window to retrieve the highlights style from
4323 * @return The style set or NULL if none was. Default is used in that case.
4325 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4327 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4328 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4329 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4330 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4331 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4332 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4333 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4335 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4336 * (blank mouse, private mouse obj, defaultmouse)
4340 * Sets the keyboard mode of the window.
4342 * @param obj The window object
4343 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4345 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4347 * Gets the keyboard mode of the window.
4349 * @param obj The window object
4350 * @return The mode, one of #Elm_Win_Keyboard_Mode
4352 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4354 * Sets whether the window is a keyboard.
4356 * @param obj The window object
4357 * @param is_keyboard If true, the window is a virtual keyboard
4359 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4361 * Gets whether the window is a keyboard.
4363 * @param obj The window object
4364 * @return If the window is a virtual keyboard
4366 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4369 * Get the screen position of a window.
4371 * @param obj The window object
4372 * @param x The int to store the x coordinate to
4373 * @param y The int to store the y coordinate to
4375 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4381 * @defgroup Inwin Inwin
4383 * @image html img/widget/inwin/preview-00.png
4384 * @image latex img/widget/inwin/preview-00.eps
4385 * @image html img/widget/inwin/preview-01.png
4386 * @image latex img/widget/inwin/preview-01.eps
4387 * @image html img/widget/inwin/preview-02.png
4388 * @image latex img/widget/inwin/preview-02.eps
4390 * An inwin is a window inside a window that is useful for a quick popup.
4391 * It does not hover.
4393 * It works by creating an object that will occupy the entire window, so it
4394 * must be created using an @ref Win "elm_win" as parent only. The inwin
4395 * object can be hidden or restacked below every other object if it's
4396 * needed to show what's behind it without destroying it. If this is done,
4397 * the elm_win_inwin_activate() function can be used to bring it back to
4398 * full visibility again.
4400 * There are three styles available in the default theme. These are:
4401 * @li default: The inwin is sized to take over most of the window it's
4403 * @li minimal: The size of the inwin will be the minimum necessary to show
4405 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4406 * possible, but it's sized vertically the most it needs to fit its\
4409 * Some examples of Inwin can be found in the following:
4410 * @li @ref inwin_example_01
4415 * Adds an inwin to the current window
4417 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4418 * Never call this function with anything other than the top-most window
4419 * as its parameter, unless you are fond of undefined behavior.
4421 * After creating the object, the widget will set itself as resize object
4422 * for the window with elm_win_resize_object_add(), so when shown it will
4423 * appear to cover almost the entire window (how much of it depends on its
4424 * content and the style used). It must not be added into other container
4425 * objects and it needs not be moved or resized manually.
4427 * @param parent The parent object
4428 * @return The new object or NULL if it cannot be created
4430 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4432 * Activates an inwin object, ensuring its visibility
4434 * This function will make sure that the inwin @p obj is completely visible
4435 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4436 * to the front. It also sets the keyboard focus to it, which will be passed
4439 * The object's theme will also receive the signal "elm,action,show" with
4442 * @param obj The inwin to activate
4444 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4446 * Set the content of an inwin object.
4448 * Once the content object is set, a previously set one will be deleted.
4449 * If you want to keep that old content object, use the
4450 * elm_win_inwin_content_unset() function.
4452 * @param obj The inwin object
4453 * @param content The object to set as content
4455 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4457 * Get the content of an inwin object.
4459 * Return the content object which is set for this widget.
4461 * The returned object is valid as long as the inwin is still alive and no
4462 * other content is set on it. Deleting the object will notify the inwin
4463 * about it and this one will be left empty.
4465 * If you need to remove an inwin's content to be reused somewhere else,
4466 * see elm_win_inwin_content_unset().
4468 * @param obj The inwin object
4469 * @return The content that is being used
4471 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4473 * Unset the content of an inwin object.
4475 * Unparent and return the content object which was set for this widget.
4477 * @param obj The inwin object
4478 * @return The content that was being used
4480 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4484 /* X specific calls - won't work on non-x engines (return 0) */
4487 * Get the Ecore_X_Window of an Evas_Object
4489 * @param obj The object
4491 * @return The Ecore_X_Window of @p obj
4495 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4497 /* smart callbacks called:
4498 * "delete,request" - the user requested to delete the window
4499 * "focus,in" - window got focus
4500 * "focus,out" - window lost focus
4501 * "moved" - window that holds the canvas was moved
4507 * @image html img/widget/bg/preview-00.png
4508 * @image latex img/widget/bg/preview-00.eps
4510 * @brief Background object, used for setting a solid color, image or Edje
4511 * group as background to a window or any container object.
4513 * The bg object is used for setting a solid background to a window or
4514 * packing into any container object. It works just like an image, but has
4515 * some properties useful to a background, like setting it to tiled,
4516 * centered, scaled or stretched.
4518 * Default contents parts of the bg widget that you can use for are:
4519 * @li "elm.swallow.content" - overlay of the bg
4521 * Here is some sample code using it:
4522 * @li @ref bg_01_example_page
4523 * @li @ref bg_02_example_page
4524 * @li @ref bg_03_example_page
4528 typedef enum _Elm_Bg_Option
4530 ELM_BG_OPTION_CENTER, /**< center the background */
4531 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4532 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4533 ELM_BG_OPTION_TILE /**< tile background at its original size */
4537 * Add a new background to the parent
4539 * @param parent The parent object
4540 * @return The new object or NULL if it cannot be created
4544 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4547 * Set the file (image or edje) used for the background
4549 * @param obj The bg object
4550 * @param file The file path
4551 * @param group Optional key (group in Edje) within the file
4553 * This sets the image file used in the background object. The image (or edje)
4554 * will be stretched (retaining aspect if its an image file) to completely fill
4555 * the bg object. This may mean some parts are not visible.
4557 * @note Once the image of @p obj is set, a previously set one will be deleted,
4558 * even if @p file is NULL.
4562 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4565 * Get the file (image or edje) used for the background
4567 * @param obj The bg object
4568 * @param file The file path
4569 * @param group Optional key (group in Edje) within the file
4573 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4576 * Set the option used for the background image
4578 * @param obj The bg object
4579 * @param option The desired background option (TILE, SCALE)
4581 * This sets the option used for manipulating the display of the background
4582 * image. The image can be tiled or scaled.
4586 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4589 * Get the option used for the background image
4591 * @param obj The bg object
4592 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4596 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4598 * Set the option used for the background color
4600 * @param obj The bg object
4605 * This sets the color used for the background rectangle. Its range goes
4610 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4612 * Get the option used for the background color
4614 * @param obj The bg object
4621 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4624 * Set the overlay object used for the background object.
4626 * @param obj The bg object
4627 * @param overlay The overlay object
4629 * This provides a way for elm_bg to have an 'overlay' that will be on top
4630 * of the bg. Once the over object is set, a previously set one will be
4631 * deleted, even if you set the new one to NULL. If you want to keep that
4632 * old content object, use the elm_bg_overlay_unset() function.
4637 EINA_DEPRECATED EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4640 * Get the overlay object used for the background object.
4642 * @param obj The bg object
4643 * @return The content that is being used
4645 * Return the content object which is set for this widget
4649 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4652 * Get the overlay object used for the background object.
4654 * @param obj The bg object
4655 * @return The content that was being used
4657 * Unparent and return the overlay object which was set for this widget
4661 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4664 * Set the size of the pixmap representation of the image.
4666 * This option just makes sense if an image is going to be set in the bg.
4668 * @param obj The bg object
4669 * @param w The new width of the image pixmap representation.
4670 * @param h The new height of the image pixmap representation.
4672 * This function sets a new size for pixmap representation of the given bg
4673 * image. It allows the image to be loaded already in the specified size,
4674 * reducing the memory usage and load time when loading a big image with load
4675 * size set to a smaller size.
4677 * NOTE: this is just a hint, the real size of the pixmap may differ
4678 * depending on the type of image being loaded, being bigger than requested.
4682 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4683 /* smart callbacks called:
4687 * @defgroup Icon Icon
4689 * @image html img/widget/icon/preview-00.png
4690 * @image latex img/widget/icon/preview-00.eps
4692 * An object that provides standard icon images (delete, edit, arrows, etc.)
4693 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4695 * The icon image requested can be in the elementary theme, or in the
4696 * freedesktop.org paths. It's possible to set the order of preference from
4697 * where the image will be used.
4699 * This API is very similar to @ref Image, but with ready to use images.
4701 * Default images provided by the theme are described below.
4703 * The first list contains icons that were first intended to be used in
4704 * toolbars, but can be used in many other places too:
4720 * Now some icons that were designed to be used in menus (but again, you can
4721 * use them anywhere else):
4726 * @li menu/arrow_down
4727 * @li menu/arrow_left
4728 * @li menu/arrow_right
4737 * And here we have some media player specific icons:
4738 * @li media_player/forward
4739 * @li media_player/info
4740 * @li media_player/next
4741 * @li media_player/pause
4742 * @li media_player/play
4743 * @li media_player/prev
4744 * @li media_player/rewind
4745 * @li media_player/stop
4747 * Signals that you can add callbacks for are:
4749 * "clicked" - This is called when a user has clicked the icon
4751 * An example of usage for this API follows:
4752 * @li @ref tutorial_icon
4760 typedef enum _Elm_Icon_Type
4767 * @enum _Elm_Icon_Lookup_Order
4768 * @typedef Elm_Icon_Lookup_Order
4770 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4771 * theme, FDO paths, or both?
4775 typedef enum _Elm_Icon_Lookup_Order
4777 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4778 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4779 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4780 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4781 } Elm_Icon_Lookup_Order;
4784 * Add a new icon object to the parent.
4786 * @param parent The parent object
4787 * @return The new object or NULL if it cannot be created
4789 * @see elm_icon_file_set()
4793 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4795 * Set the file that will be used as icon.
4797 * @param obj The icon object
4798 * @param file The path to file that will be used as icon image
4799 * @param group The group that the icon belongs to an edje file
4801 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4803 * @note The icon image set by this function can be changed by
4804 * elm_icon_standard_set().
4806 * @see elm_icon_file_get()
4810 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4812 * Set a location in memory to be used as an icon
4814 * @param obj The icon object
4815 * @param img The binary data that will be used as an image
4816 * @param size The size of binary data @p img
4817 * @param format Optional format of @p img to pass to the image loader
4818 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4820 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4822 * @note The icon image set by this function can be changed by
4823 * elm_icon_standard_set().
4827 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);
4829 * Get the file that will be used as icon.
4831 * @param obj The icon object
4832 * @param file The path to file that will be used as the icon image
4833 * @param group The group that the icon belongs to, in edje file
4835 * @see elm_icon_file_set()
4839 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4840 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4842 * Set the icon by icon standards names.
4844 * @param obj The icon object
4845 * @param name The icon name
4847 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4849 * For example, freedesktop.org defines standard icon names such as "home",
4850 * "network", etc. There can be different icon sets to match those icon
4851 * keys. The @p name given as parameter is one of these "keys", and will be
4852 * used to look in the freedesktop.org paths and elementary theme. One can
4853 * change the lookup order with elm_icon_order_lookup_set().
4855 * If name is not found in any of the expected locations and it is the
4856 * absolute path of an image file, this image will be used.
4858 * @note The icon image set by this function can be changed by
4859 * elm_icon_file_set().
4861 * @see elm_icon_standard_get()
4862 * @see elm_icon_file_set()
4866 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4868 * Get the icon name set by icon standard names.
4870 * @param obj The icon object
4871 * @return The icon name
4873 * If the icon image was set using elm_icon_file_set() instead of
4874 * elm_icon_standard_set(), then this function will return @c NULL.
4876 * @see elm_icon_standard_set()
4880 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4882 * Set the smooth scaling for an icon object.
4884 * @param obj The icon object
4885 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4886 * otherwise. Default is @c EINA_TRUE.
4888 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4889 * scaling provides a better resulting image, but is slower.
4891 * The smooth scaling should be disabled when making animations that change
4892 * the icon size, since they will be faster. Animations that don't require
4893 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4894 * is already scaled, since the scaled icon image will be cached).
4896 * @see elm_icon_smooth_get()
4900 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4902 * Get whether smooth scaling is enabled for an icon object.
4904 * @param obj The icon object
4905 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4907 * @see elm_icon_smooth_set()
4911 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4913 * Disable scaling of this object.
4915 * @param obj The icon object.
4916 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4917 * otherwise. Default is @c EINA_FALSE.
4919 * This function disables scaling of the icon object through the function
4920 * elm_object_scale_set(). However, this does not affect the object
4921 * size/resize in any way. For that effect, take a look at
4922 * elm_icon_scale_set().
4924 * @see elm_icon_no_scale_get()
4925 * @see elm_icon_scale_set()
4926 * @see elm_object_scale_set()
4930 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4932 * Get whether scaling is disabled on the object.
4934 * @param obj The icon object
4935 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4937 * @see elm_icon_no_scale_set()
4941 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4943 * Set if the object is (up/down) resizable.
4945 * @param obj The icon object
4946 * @param scale_up A bool to set if the object is resizable up. Default is
4948 * @param scale_down A bool to set if the object is resizable down. Default
4951 * This function limits the icon object resize ability. If @p scale_up is set to
4952 * @c EINA_FALSE, the object can't have its height or width resized to a value
4953 * higher than the original icon size. Same is valid for @p scale_down.
4955 * @see elm_icon_scale_get()
4959 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4961 * Get if the object is (up/down) resizable.
4963 * @param obj The icon object
4964 * @param scale_up A bool to set if the object is resizable up
4965 * @param scale_down A bool to set if the object is resizable down
4967 * @see elm_icon_scale_set()
4971 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4973 * Get the object's image size
4975 * @param obj The icon object
4976 * @param w A pointer to store the width in
4977 * @param h A pointer to store the height in
4981 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4983 * Set if the icon fill the entire object area.
4985 * @param obj The icon object
4986 * @param fill_outside @c EINA_TRUE if the object is filled outside,
4987 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4989 * When the icon object is resized to a different aspect ratio from the
4990 * original icon image, the icon image will still keep its aspect. This flag
4991 * tells how the image should fill the object's area. They are: keep the
4992 * entire icon inside the limits of height and width of the object (@p
4993 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4994 * of the object, and the icon will fill the entire object (@p fill_outside
4997 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4998 * retain property to false. Thus, the icon image will always keep its
4999 * original aspect ratio.
5001 * @see elm_icon_fill_outside_get()
5002 * @see elm_image_fill_outside_set()
5006 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5008 * Get if the object is filled outside.
5010 * @param obj The icon object
5011 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5013 * @see elm_icon_fill_outside_set()
5017 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5019 * Set the prescale size for the icon.
5021 * @param obj The icon object
5022 * @param size The prescale size. This value is used for both width and
5025 * This function sets a new size for pixmap representation of the given
5026 * icon. It allows the icon to be loaded already in the specified size,
5027 * reducing the memory usage and load time when loading a big icon with load
5028 * size set to a smaller size.
5030 * It's equivalent to the elm_bg_load_size_set() function for bg.
5032 * @note this is just a hint, the real size of the pixmap may differ
5033 * depending on the type of icon being loaded, being bigger than requested.
5035 * @see elm_icon_prescale_get()
5036 * @see elm_bg_load_size_set()
5040 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5042 * Get the prescale size for the icon.
5044 * @param obj The icon object
5045 * @return The prescale size
5047 * @see elm_icon_prescale_set()
5051 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5053 * Sets the icon lookup order used by elm_icon_standard_set().
5055 * @param obj The icon object
5056 * @param order The icon lookup order (can be one of
5057 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5058 * or ELM_ICON_LOOKUP_THEME)
5060 * @see elm_icon_order_lookup_get()
5061 * @see Elm_Icon_Lookup_Order
5065 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5067 * Gets the icon lookup order.
5069 * @param obj The icon object
5070 * @return The icon lookup order
5072 * @see elm_icon_order_lookup_set()
5073 * @see Elm_Icon_Lookup_Order
5077 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5079 * Get if the icon supports animation or not.
5081 * @param obj The icon object
5082 * @return @c EINA_TRUE if the icon supports animation,
5083 * @c EINA_FALSE otherwise.
5085 * Return if this elm icon's image can be animated. Currently Evas only
5086 * supports gif animation. If the return value is EINA_FALSE, other
5087 * elm_icon_animated_XXX APIs won't work.
5090 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5092 * Set animation mode of the icon.
5094 * @param obj The icon object
5095 * @param anim @c EINA_TRUE if the object do animation job,
5096 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5098 * Since the default animation mode is set to EINA_FALSE,
5099 * the icon is shown without animation.
5100 * This might be desirable when the application developer wants to show
5101 * a snapshot of the animated icon.
5102 * Set it to EINA_TRUE when the icon needs to be animated.
5105 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5107 * Get animation mode of the icon.
5109 * @param obj The icon object
5110 * @return The animation mode of the icon object
5111 * @see elm_icon_animated_set
5114 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5116 * Set animation play mode of the icon.
5118 * @param obj The icon object
5119 * @param play @c EINA_TRUE the object play animation images,
5120 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5122 * To play elm icon's animation, set play to EINA_TURE.
5123 * For example, you make gif player using this set/get API and click event.
5125 * 1. Click event occurs
5126 * 2. Check play flag using elm_icon_animaged_play_get
5127 * 3. If elm icon was playing, set play to EINA_FALSE.
5128 * Then animation will be stopped and vice versa
5131 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5133 * Get animation play mode of the icon.
5135 * @param obj The icon object
5136 * @return The play mode of the icon object
5138 * @see elm_icon_animated_play_get
5141 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5148 * @defgroup Image Image
5150 * @image html img/widget/image/preview-00.png
5151 * @image latex img/widget/image/preview-00.eps
5154 * An object that allows one to load an image file to it. It can be used
5155 * anywhere like any other elementary widget.
5157 * This widget provides most of the functionality provided from @ref Bg or @ref
5158 * Icon, but with a slightly different API (use the one that fits better your
5161 * The features not provided by those two other image widgets are:
5162 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5163 * @li change the object orientation with elm_image_orient_set();
5164 * @li and turning the image editable with elm_image_editable_set().
5166 * Signals that you can add callbacks for are:
5168 * @li @c "clicked" - This is called when a user has clicked the image
5170 * An example of usage for this API follows:
5171 * @li @ref tutorial_image
5180 * @enum _Elm_Image_Orient
5181 * @typedef Elm_Image_Orient
5183 * Possible orientation options for elm_image_orient_set().
5185 * @image html elm_image_orient_set.png
5186 * @image latex elm_image_orient_set.eps width=\textwidth
5190 typedef enum _Elm_Image_Orient
5192 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5193 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5194 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5195 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5196 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5197 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5198 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5199 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5203 * Add a new image to the parent.
5205 * @param parent The parent object
5206 * @return The new object or NULL if it cannot be created
5208 * @see elm_image_file_set()
5212 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5214 * Set the file that will be used as image.
5216 * @param obj The image object
5217 * @param file The path to file that will be used as image
5218 * @param group The group that the image belongs in edje file (if it's an
5221 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5223 * @see elm_image_file_get()
5227 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5229 * Get the file that will be used as image.
5231 * @param obj The image object
5232 * @param file The path to file
5233 * @param group The group that the image belongs in edje file
5235 * @see elm_image_file_set()
5239 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5241 * Set the smooth effect for an image.
5243 * @param obj The image object
5244 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5245 * otherwise. Default is @c EINA_TRUE.
5247 * Set the scaling algorithm to be used when scaling the image. Smooth
5248 * scaling provides a better resulting image, but is slower.
5250 * The smooth scaling should be disabled when making animations that change
5251 * the image size, since it will be faster. Animations that don't require
5252 * resizing of the image can keep the smooth scaling enabled (even if the
5253 * image is already scaled, since the scaled image will be cached).
5255 * @see elm_image_smooth_get()
5259 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5261 * Get the smooth effect for an image.
5263 * @param obj The image object
5264 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5266 * @see elm_image_smooth_get()
5270 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5273 * Gets the current size of the image.
5275 * @param obj The image object.
5276 * @param w Pointer to store width, or NULL.
5277 * @param h Pointer to store height, or NULL.
5279 * This is the real size of the image, not the size of the object.
5281 * On error, neither w or h will be written.
5285 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5287 * Disable scaling of this object.
5289 * @param obj The image object.
5290 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5291 * otherwise. Default is @c EINA_FALSE.
5293 * This function disables scaling of the elm_image widget through the
5294 * function elm_object_scale_set(). However, this does not affect the widget
5295 * size/resize in any way. For that effect, take a look at
5296 * elm_image_scale_set().
5298 * @see elm_image_no_scale_get()
5299 * @see elm_image_scale_set()
5300 * @see elm_object_scale_set()
5304 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5306 * Get whether scaling is disabled on the object.
5308 * @param obj The image object
5309 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5311 * @see elm_image_no_scale_set()
5315 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5317 * Set if the object is (up/down) resizable.
5319 * @param obj The image object
5320 * @param scale_up A bool to set if the object is resizable up. Default is
5322 * @param scale_down A bool to set if the object is resizable down. Default
5325 * This function limits the image resize ability. If @p scale_up is set to
5326 * @c EINA_FALSE, the object can't have its height or width resized to a value
5327 * higher than the original image size. Same is valid for @p scale_down.
5329 * @see elm_image_scale_get()
5333 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5335 * Get if the object is (up/down) resizable.
5337 * @param obj The image object
5338 * @param scale_up A bool to set if the object is resizable up
5339 * @param scale_down A bool to set if the object is resizable down
5341 * @see elm_image_scale_set()
5345 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5347 * Set if the image fills the entire object area, when keeping the aspect ratio.
5349 * @param obj The image object
5350 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5351 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5353 * When the image should keep its aspect ratio even if resized to another
5354 * aspect ratio, there are two possibilities to resize it: keep the entire
5355 * image inside the limits of height and width of the object (@p fill_outside
5356 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5357 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5359 * @note This option will have no effect if
5360 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5362 * @see elm_image_fill_outside_get()
5363 * @see elm_image_aspect_ratio_retained_set()
5367 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5369 * Get if the object is filled outside
5371 * @param obj The image object
5372 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5374 * @see elm_image_fill_outside_set()
5378 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5380 * Set the prescale size for the image
5382 * @param obj The image object
5383 * @param size The prescale size. This value is used for both width and
5386 * This function sets a new size for pixmap representation of the given
5387 * image. It allows the image to be loaded already in the specified size,
5388 * reducing the memory usage and load time when loading a big image with load
5389 * size set to a smaller size.
5391 * It's equivalent to the elm_bg_load_size_set() function for bg.
5393 * @note this is just a hint, the real size of the pixmap may differ
5394 * depending on the type of image being loaded, being bigger than requested.
5396 * @see elm_image_prescale_get()
5397 * @see elm_bg_load_size_set()
5401 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5403 * Get the prescale size for the image
5405 * @param obj The image object
5406 * @return The prescale size
5408 * @see elm_image_prescale_set()
5412 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5414 * Set the image orientation.
5416 * @param obj The image object
5417 * @param orient The image orientation @ref Elm_Image_Orient
5418 * Default is #ELM_IMAGE_ORIENT_NONE.
5420 * This function allows to rotate or flip the given image.
5422 * @see elm_image_orient_get()
5423 * @see @ref Elm_Image_Orient
5427 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5429 * Get the image orientation.
5431 * @param obj The image object
5432 * @return The image orientation @ref Elm_Image_Orient
5434 * @see elm_image_orient_set()
5435 * @see @ref Elm_Image_Orient
5439 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5441 * Make the image 'editable'.
5443 * @param obj Image object.
5444 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5446 * This means the image is a valid drag target for drag and drop, and can be
5447 * cut or pasted too.
5451 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5453 * Check if the image 'editable'.
5455 * @param obj Image object.
5456 * @return Editability.
5458 * A return value of EINA_TRUE means the image is a valid drag target
5459 * for drag and drop, and can be cut or pasted too.
5463 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5465 * Get the basic Evas_Image object from this object (widget).
5467 * @param obj The image object to get the inlined image from
5468 * @return The inlined image object, or NULL if none exists
5470 * This function allows one to get the underlying @c Evas_Object of type
5471 * Image from this elementary widget. It can be useful to do things like get
5472 * the pixel data, save the image to a file, etc.
5474 * @note Be careful to not manipulate it, as it is under control of
5479 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5481 * Set whether the original aspect ratio of the image should be kept on resize.
5483 * @param obj The image object.
5484 * @param retained @c EINA_TRUE if the image should retain the aspect,
5485 * @c EINA_FALSE otherwise.
5487 * The original aspect ratio (width / height) of the image is usually
5488 * distorted to match the object's size. Enabling this option will retain
5489 * this original aspect, and the way that the image is fit into the object's
5490 * area depends on the option set by elm_image_fill_outside_set().
5492 * @see elm_image_aspect_ratio_retained_get()
5493 * @see elm_image_fill_outside_set()
5497 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5499 * Get if the object retains the original aspect ratio.
5501 * @param obj The image object.
5502 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5507 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5514 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5516 typedef enum _Elm_GLView_Mode
5518 ELM_GLVIEW_ALPHA = 1,
5519 ELM_GLVIEW_DEPTH = 2,
5520 ELM_GLVIEW_STENCIL = 4
5524 * Defines a policy for the glview resizing.
5526 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5528 typedef enum _Elm_GLView_Resize_Policy
5530 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5531 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5532 } Elm_GLView_Resize_Policy;
5534 typedef enum _Elm_GLView_Render_Policy
5536 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5537 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5538 } Elm_GLView_Render_Policy;
5543 * A simple GLView widget that allows GL rendering.
5545 * Signals that you can add callbacks for are:
5551 * Add a new glview to the parent
5553 * @param parent The parent object
5554 * @return The new object or NULL if it cannot be created
5558 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5561 * Sets the size of the glview
5563 * @param obj The glview object
5564 * @param width width of the glview object
5565 * @param height height of the glview object
5569 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5572 * Gets the size of the glview.
5574 * @param obj The glview object
5575 * @param width width of the glview object
5576 * @param height height of the glview object
5578 * Note that this function returns the actual image size of the
5579 * glview. This means that when the scale policy is set to
5580 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5585 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5588 * Gets the gl api struct for gl rendering
5590 * @param obj The glview object
5591 * @return The api object or NULL if it cannot be created
5595 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5598 * Set the mode of the GLView. Supports Three simple modes.
5600 * @param obj The glview object
5601 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5602 * @return True if set properly.
5606 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5609 * Set the resize policy for the glview object.
5611 * @param obj The glview object.
5612 * @param policy The scaling policy.
5614 * By default, the resize policy is set to
5615 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5616 * destroys the previous surface and recreates the newly specified
5617 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5618 * however, glview only scales the image object and not the underlying
5623 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5626 * Set the render policy for the glview object.
5628 * @param obj The glview object.
5629 * @param policy The render policy.
5631 * By default, the render policy is set to
5632 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5633 * that during the render loop, glview is only redrawn if it needs
5634 * to be redrawn. (i.e. When it is visible) If the policy is set to
5635 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5636 * whether it is visible/need redrawing or not.
5640 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5643 * Set the init function that runs once in the main loop.
5645 * @param obj The glview object.
5646 * @param func The init function to be registered.
5648 * The registered init function gets called once during the render loop.
5652 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5655 * Set the render function that runs in the main loop.
5657 * @param obj The glview object.
5658 * @param func The delete function to be registered.
5660 * The registered del function gets called when GLView object is deleted.
5664 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5667 * Set the resize function that gets called when resize happens.
5669 * @param obj The glview object.
5670 * @param func The resize function to be registered.
5674 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5677 * Set the render function that runs in the main loop.
5679 * @param obj The glview object.
5680 * @param func The render function to be registered.
5684 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5687 * Notifies that there has been changes in the GLView.
5689 * @param obj The glview object.
5693 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5703 * @image html img/widget/box/preview-00.png
5704 * @image latex img/widget/box/preview-00.eps width=\textwidth
5706 * @image html img/box.png
5707 * @image latex img/box.eps width=\textwidth
5709 * A box arranges objects in a linear fashion, governed by a layout function
5710 * that defines the details of this arrangement.
5712 * By default, the box will use an internal function to set the layout to
5713 * a single row, either vertical or horizontal. This layout is affected
5714 * by a number of parameters, such as the homogeneous flag set by
5715 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5716 * elm_box_align_set() and the hints set to each object in the box.
5718 * For this default layout, it's possible to change the orientation with
5719 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5720 * placing its elements ordered from top to bottom. When horizontal is set,
5721 * the order will go from left to right. If the box is set to be
5722 * homogeneous, every object in it will be assigned the same space, that
5723 * of the largest object. Padding can be used to set some spacing between
5724 * the cell given to each object. The alignment of the box, set with
5725 * elm_box_align_set(), determines how the bounding box of all the elements
5726 * will be placed within the space given to the box widget itself.
5728 * The size hints of each object also affect how they are placed and sized
5729 * within the box. evas_object_size_hint_min_set() will give the minimum
5730 * size the object can have, and the box will use it as the basis for all
5731 * latter calculations. Elementary widgets set their own minimum size as
5732 * needed, so there's rarely any need to use it manually.
5734 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5735 * used to tell whether the object will be allocated the minimum size it
5736 * needs or if the space given to it should be expanded. It's important
5737 * to realize that expanding the size given to the object is not the same
5738 * thing as resizing the object. It could very well end being a small
5739 * widget floating in a much larger empty space. If not set, the weight
5740 * for objects will normally be 0.0 for both axis, meaning the widget will
5741 * not be expanded. To take as much space possible, set the weight to
5742 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5744 * Besides how much space each object is allocated, it's possible to control
5745 * how the widget will be placed within that space using
5746 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5747 * for both axis, meaning the object will be centered, but any value from
5748 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5749 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5750 * is -1.0, means the object will be resized to fill the entire space it
5753 * In addition, customized functions to define the layout can be set, which
5754 * allow the application developer to organize the objects within the box
5755 * in any number of ways.
5757 * The special elm_box_layout_transition() function can be used
5758 * to switch from one layout to another, animating the motion of the
5759 * children of the box.
5761 * @note Objects should not be added to box objects using _add() calls.
5763 * Some examples on how to use boxes follow:
5764 * @li @ref box_example_01
5765 * @li @ref box_example_02
5770 * @typedef Elm_Box_Transition
5772 * Opaque handler containing the parameters to perform an animated
5773 * transition of the layout the box uses.
5775 * @see elm_box_transition_new()
5776 * @see elm_box_layout_set()
5777 * @see elm_box_layout_transition()
5779 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5782 * Add a new box to the parent
5784 * By default, the box will be in vertical mode and non-homogeneous.
5786 * @param parent The parent object
5787 * @return The new object or NULL if it cannot be created
5789 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5791 * Set the horizontal orientation
5793 * By default, box object arranges their contents vertically from top to
5795 * By calling this function with @p horizontal as EINA_TRUE, the box will
5796 * become horizontal, arranging contents from left to right.
5798 * @note This flag is ignored if a custom layout function is set.
5800 * @param obj The box object
5801 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5802 * EINA_FALSE = vertical)
5804 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5806 * Get the horizontal orientation
5808 * @param obj The box object
5809 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5811 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5813 * Set the box to arrange its children homogeneously
5815 * If enabled, homogeneous layout makes all items the same size, according
5816 * to the size of the largest of its children.
5818 * @note This flag is ignored if a custom layout function is set.
5820 * @param obj The box object
5821 * @param homogeneous The homogeneous flag
5823 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5825 * Get whether the box is using homogeneous mode or not
5827 * @param obj The box object
5828 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5830 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5831 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5832 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5834 * Add an object to the beginning of the pack list
5836 * Pack @p subobj into the box @p obj, placing it first in the list of
5837 * children objects. The actual position the object will get on screen
5838 * depends on the layout used. If no custom layout is set, it will be at
5839 * the top or left, depending if the box is vertical or horizontal,
5842 * @param obj The box object
5843 * @param subobj The object to add to the box
5845 * @see elm_box_pack_end()
5846 * @see elm_box_pack_before()
5847 * @see elm_box_pack_after()
5848 * @see elm_box_unpack()
5849 * @see elm_box_unpack_all()
5850 * @see elm_box_clear()
5852 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5854 * Add an object at the end of the pack list
5856 * Pack @p subobj into the box @p obj, placing it last in the list of
5857 * children objects. The actual position the object will get on screen
5858 * depends on the layout used. If no custom layout is set, it will be at
5859 * the bottom or right, depending if the box is vertical or horizontal,
5862 * @param obj The box object
5863 * @param subobj The object to add to the box
5865 * @see elm_box_pack_start()
5866 * @see elm_box_pack_before()
5867 * @see elm_box_pack_after()
5868 * @see elm_box_unpack()
5869 * @see elm_box_unpack_all()
5870 * @see elm_box_clear()
5872 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5874 * Adds an object to the box before the indicated object
5876 * This will add the @p subobj to the box indicated before the object
5877 * indicated with @p before. If @p before is not already in the box, results
5878 * are undefined. Before means either to the left of the indicated object or
5879 * above it depending on orientation.
5881 * @param obj The box object
5882 * @param subobj The object to add to the box
5883 * @param before The object before which to add it
5885 * @see elm_box_pack_start()
5886 * @see elm_box_pack_end()
5887 * @see elm_box_pack_after()
5888 * @see elm_box_unpack()
5889 * @see elm_box_unpack_all()
5890 * @see elm_box_clear()
5892 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5894 * Adds an object to the box after the indicated object
5896 * This will add the @p subobj to the box indicated after the object
5897 * indicated with @p after. If @p after is not already in the box, results
5898 * are undefined. After means either to the right of the indicated object or
5899 * below it depending on orientation.
5901 * @param obj The box object
5902 * @param subobj The object to add to the box
5903 * @param after The object after which to add it
5905 * @see elm_box_pack_start()
5906 * @see elm_box_pack_end()
5907 * @see elm_box_pack_before()
5908 * @see elm_box_unpack()
5909 * @see elm_box_unpack_all()
5910 * @see elm_box_clear()
5912 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5914 * Clear the box of all children
5916 * Remove all the elements contained by the box, deleting the respective
5919 * @param obj The box object
5921 * @see elm_box_unpack()
5922 * @see elm_box_unpack_all()
5924 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5928 * Remove the object given by @p subobj from the box @p obj without
5931 * @param obj The box object
5933 * @see elm_box_unpack_all()
5934 * @see elm_box_clear()
5936 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5938 * Remove all items from the box, without deleting them
5940 * Clear the box from all children, but don't delete the respective objects.
5941 * If no other references of the box children exist, the objects will never
5942 * be deleted, and thus the application will leak the memory. Make sure
5943 * when using this function that you hold a reference to all the objects
5944 * in the box @p obj.
5946 * @param obj The box object
5948 * @see elm_box_clear()
5949 * @see elm_box_unpack()
5951 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5953 * Retrieve a list of the objects packed into the box
5955 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5956 * The order of the list corresponds to the packing order the box uses.
5958 * You must free this list with eina_list_free() once you are done with it.
5960 * @param obj The box object
5962 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5964 * Set the space (padding) between the box's elements.
5966 * Extra space in pixels that will be added between a box child and its
5967 * neighbors after its containing cell has been calculated. This padding
5968 * is set for all elements in the box, besides any possible padding that
5969 * individual elements may have through their size hints.
5971 * @param obj The box object
5972 * @param horizontal The horizontal space between elements
5973 * @param vertical The vertical space between elements
5975 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5977 * Get the space (padding) between the box's elements.
5979 * @param obj The box object
5980 * @param horizontal The horizontal space between elements
5981 * @param vertical The vertical space between elements
5983 * @see elm_box_padding_set()
5985 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5987 * Set the alignment of the whole bouding box of contents.
5989 * Sets how the bounding box containing all the elements of the box, after
5990 * their sizes and position has been calculated, will be aligned within
5991 * the space given for the whole box widget.
5993 * @param obj The box object
5994 * @param horizontal The horizontal alignment of elements
5995 * @param vertical The vertical alignment of elements
5997 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5999 * Get the alignment of the whole bouding box of contents.
6001 * @param obj The box object
6002 * @param horizontal The horizontal alignment of elements
6003 * @param vertical The vertical alignment of elements
6005 * @see elm_box_align_set()
6007 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6010 * Force the box to recalculate its children packing.
6012 * If any children was added or removed, box will not calculate the
6013 * values immediately rather leaving it to the next main loop
6014 * iteration. While this is great as it would save lots of
6015 * recalculation, whenever you need to get the position of a just
6016 * added item you must force recalculate before doing so.
6018 * @param obj The box object.
6020 EAPI void elm_box_recalculate(Evas_Object *obj);
6023 * Set the layout defining function to be used by the box
6025 * Whenever anything changes that requires the box in @p obj to recalculate
6026 * the size and position of its elements, the function @p cb will be called
6027 * to determine what the layout of the children will be.
6029 * Once a custom function is set, everything about the children layout
6030 * is defined by it. The flags set by elm_box_horizontal_set() and
6031 * elm_box_homogeneous_set() no longer have any meaning, and the values
6032 * given by elm_box_padding_set() and elm_box_align_set() are up to this
6033 * layout function to decide if they are used and how. These last two
6034 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6035 * passed to @p cb. The @c Evas_Object the function receives is not the
6036 * Elementary widget, but the internal Evas Box it uses, so none of the
6037 * functions described here can be used on it.
6039 * Any of the layout functions in @c Evas can be used here, as well as the
6040 * special elm_box_layout_transition().
6042 * The final @p data argument received by @p cb is the same @p data passed
6043 * here, and the @p free_data function will be called to free it
6044 * whenever the box is destroyed or another layout function is set.
6046 * Setting @p cb to NULL will revert back to the default layout function.
6048 * @param obj The box object
6049 * @param cb The callback function used for layout
6050 * @param data Data that will be passed to layout function
6051 * @param free_data Function called to free @p data
6053 * @see elm_box_layout_transition()
6055 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);
6057 * Special layout function that animates the transition from one layout to another
6059 * Normally, when switching the layout function for a box, this will be
6060 * reflected immediately on screen on the next render, but it's also
6061 * possible to do this through an animated transition.
6063 * This is done by creating an ::Elm_Box_Transition and setting the box
6064 * layout to this function.
6068 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6069 * evas_object_box_layout_vertical, // start
6070 * NULL, // data for initial layout
6071 * NULL, // free function for initial data
6072 * evas_object_box_layout_horizontal, // end
6073 * NULL, // data for final layout
6074 * NULL, // free function for final data
6075 * anim_end, // will be called when animation ends
6076 * NULL); // data for anim_end function\
6077 * elm_box_layout_set(box, elm_box_layout_transition, t,
6078 * elm_box_transition_free);
6081 * @note This function can only be used with elm_box_layout_set(). Calling
6082 * it directly will not have the expected results.
6084 * @see elm_box_transition_new
6085 * @see elm_box_transition_free
6086 * @see elm_box_layout_set
6088 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6090 * Create a new ::Elm_Box_Transition to animate the switch of layouts
6092 * If you want to animate the change from one layout to another, you need
6093 * to set the layout function of the box to elm_box_layout_transition(),
6094 * passing as user data to it an instance of ::Elm_Box_Transition with the
6095 * necessary information to perform this animation. The free function to
6096 * set for the layout is elm_box_transition_free().
6098 * The parameters to create an ::Elm_Box_Transition sum up to how long
6099 * will it be, in seconds, a layout function to describe the initial point,
6100 * another for the final position of the children and one function to be
6101 * called when the whole animation ends. This last function is useful to
6102 * set the definitive layout for the box, usually the same as the end
6103 * layout for the animation, but could be used to start another transition.
6105 * @param start_layout The layout function that will be used to start the animation
6106 * @param start_layout_data The data to be passed the @p start_layout function
6107 * @param start_layout_free_data Function to free @p start_layout_data
6108 * @param end_layout The layout function that will be used to end the animation
6109 * @param end_layout_free_data The data to be passed the @p end_layout function
6110 * @param end_layout_free_data Function to free @p end_layout_data
6111 * @param transition_end_cb Callback function called when animation ends
6112 * @param transition_end_data Data to be passed to @p transition_end_cb
6113 * @return An instance of ::Elm_Box_Transition
6115 * @see elm_box_transition_new
6116 * @see elm_box_layout_transition
6118 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);
6120 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6122 * This function is mostly useful as the @c free_data parameter in
6123 * elm_box_layout_set() when elm_box_layout_transition().
6125 * @param data The Elm_Box_Transition instance to be freed.
6127 * @see elm_box_transition_new
6128 * @see elm_box_layout_transition
6130 EAPI void elm_box_transition_free(void *data);
6137 * @defgroup Button Button
6139 * @image html img/widget/button/preview-00.png
6140 * @image latex img/widget/button/preview-00.eps
6141 * @image html img/widget/button/preview-01.png
6142 * @image latex img/widget/button/preview-01.eps
6143 * @image html img/widget/button/preview-02.png
6144 * @image latex img/widget/button/preview-02.eps
6146 * This is a push-button. Press it and run some function. It can contain
6147 * a simple label and icon object and it also has an autorepeat feature.
6149 * This widgets emits the following signals:
6150 * @li "clicked": the user clicked the button (press/release).
6151 * @li "repeated": the user pressed the button without releasing it.
6152 * @li "pressed": button was pressed.
6153 * @li "unpressed": button was released after being pressed.
6154 * In all three cases, the @c event parameter of the callback will be
6157 * Also, defined in the default theme, the button has the following styles
6159 * @li default: a normal button.
6160 * @li anchor: Like default, but the button fades away when the mouse is not
6161 * over it, leaving only the text or icon.
6162 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6163 * continuous look across its options.
6164 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6166 * Default contents parts of the button widget that you can use for are:
6167 * @li "elm.swallow.content" - A icon of the button
6169 * Default text parts of the button widget that you can use for are:
6170 * @li "elm.text" - Label of the button
6172 * Follow through a complete example @ref button_example_01 "here".
6176 * Add a new button to the parent's canvas
6178 * @param parent The parent object
6179 * @return The new object or NULL if it cannot be created
6181 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6183 * Set the label used in the button
6185 * The passed @p label can be NULL to clean any existing text in it and
6186 * leave the button as an icon only object.
6188 * @param obj The button object
6189 * @param label The text will be written on the button
6190 * @deprecated use elm_object_text_set() instead.
6192 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6194 * Get the label set for the button
6196 * The string returned is an internal pointer and should not be freed or
6197 * altered. It will also become invalid when the button is destroyed.
6198 * The string returned, if not NULL, is a stringshare, so if you need to
6199 * keep it around even after the button is destroyed, you can use
6200 * eina_stringshare_ref().
6202 * @param obj The button object
6203 * @return The text set to the label, or NULL if nothing is set
6204 * @deprecated use elm_object_text_set() instead.
6206 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6208 * Set the icon used for the button
6210 * Setting a new icon will delete any other that was previously set, making
6211 * any reference to them invalid. If you need to maintain the previous
6212 * object alive, unset it first with elm_button_icon_unset().
6214 * @param obj The button object
6215 * @param icon The icon object for the button
6217 EINA_DEPRECATED EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6219 * Get the icon used for the button
6221 * Return the icon object which is set for this widget. If the button is
6222 * destroyed or another icon is set, the returned object will be deleted
6223 * and any reference to it will be invalid.
6225 * @param obj The button object
6226 * @return The icon object that is being used
6228 * @see elm_button_icon_unset()
6230 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6232 * Remove the icon set without deleting it and return the object
6234 * This function drops the reference the button holds of the icon object
6235 * and returns this last object. It is used in case you want to remove any
6236 * icon, or set another one, without deleting the actual object. The button
6237 * will be left without an icon set.
6239 * @param obj The button object
6240 * @return The icon object that was being used
6242 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6244 * Turn on/off the autorepeat event generated when the button is kept pressed
6246 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6247 * signal when they are clicked.
6249 * When on, keeping a button pressed will continuously emit a @c repeated
6250 * signal until the button is released. The time it takes until it starts
6251 * emitting the signal is given by
6252 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6253 * new emission by elm_button_autorepeat_gap_timeout_set().
6255 * @param obj The button object
6256 * @param on A bool to turn on/off the event
6258 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6260 * Get whether the autorepeat feature is enabled
6262 * @param obj The button object
6263 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6265 * @see elm_button_autorepeat_set()
6267 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6269 * Set the initial timeout before the autorepeat event is generated
6271 * Sets the timeout, in seconds, since the button is pressed until the
6272 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6273 * won't be any delay and the even will be fired the moment the button is
6276 * @param obj The button object
6277 * @param t Timeout in seconds
6279 * @see elm_button_autorepeat_set()
6280 * @see elm_button_autorepeat_gap_timeout_set()
6282 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6284 * Get the initial timeout before the autorepeat event is generated
6286 * @param obj The button object
6287 * @return Timeout in seconds
6289 * @see elm_button_autorepeat_initial_timeout_set()
6291 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6293 * Set the interval between each generated autorepeat event
6295 * After the first @c repeated event is fired, all subsequent ones will
6296 * follow after a delay of @p t seconds for each.
6298 * @param obj The button object
6299 * @param t Interval in seconds
6301 * @see elm_button_autorepeat_initial_timeout_set()
6303 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6305 * Get the interval between each generated autorepeat event
6307 * @param obj The button object
6308 * @return Interval in seconds
6310 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6316 * @defgroup File_Selector_Button File Selector Button
6318 * @image html img/widget/fileselector_button/preview-00.png
6319 * @image latex img/widget/fileselector_button/preview-00.eps
6320 * @image html img/widget/fileselector_button/preview-01.png
6321 * @image latex img/widget/fileselector_button/preview-01.eps
6322 * @image html img/widget/fileselector_button/preview-02.png
6323 * @image latex img/widget/fileselector_button/preview-02.eps
6325 * This is a button that, when clicked, creates an Elementary
6326 * window (or inner window) <b> with a @ref Fileselector "file
6327 * selector widget" within</b>. When a file is chosen, the (inner)
6328 * window is closed and the button emits a signal having the
6329 * selected file as it's @c event_info.
6331 * This widget encapsulates operations on its internal file
6332 * selector on its own API. There is less control over its file
6333 * selector than that one would have instatiating one directly.
6335 * The following styles are available for this button:
6338 * @li @c "hoversel_vertical"
6339 * @li @c "hoversel_vertical_entry"
6341 * Smart callbacks one can register to:
6342 * - @c "file,chosen" - the user has selected a path, whose string
6343 * pointer comes as the @c event_info data (a stringshared
6346 * Here is an example on its usage:
6347 * @li @ref fileselector_button_example
6349 * @see @ref File_Selector_Entry for a similar widget.
6354 * Add a new file selector button widget to the given parent
6355 * Elementary (container) object
6357 * @param parent The parent object
6358 * @return a new file selector button widget handle or @c NULL, on
6361 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6364 * Set the label for a given file selector button widget
6366 * @param obj The file selector button widget
6367 * @param label The text label to be displayed on @p obj
6369 * @deprecated use elm_object_text_set() instead.
6371 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6374 * Get the label set for a given file selector button widget
6376 * @param obj The file selector button widget
6377 * @return The button label
6379 * @deprecated use elm_object_text_set() instead.
6381 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6384 * Set the icon on a given file selector button widget
6386 * @param obj The file selector button widget
6387 * @param icon The icon object for the button
6389 * Once the icon object is set, a previously set one will be
6390 * deleted. If you want to keep the latter, use the
6391 * elm_fileselector_button_icon_unset() function.
6393 * @see elm_fileselector_button_icon_get()
6395 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6398 * Get the icon set for a given file selector button widget
6400 * @param obj The file selector button widget
6401 * @return The icon object currently set on @p obj or @c NULL, if
6404 * @see elm_fileselector_button_icon_set()
6406 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6409 * Unset the icon used in a given file selector button widget
6411 * @param obj The file selector button widget
6412 * @return The icon object that was being used on @p obj or @c
6415 * Unparent and return the icon object which was set for this
6418 * @see elm_fileselector_button_icon_set()
6420 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6423 * Set the title for a given file selector button widget's window
6425 * @param obj The file selector button widget
6426 * @param title The title string
6428 * This will change the window's title, when the file selector pops
6429 * out after a click on the button. Those windows have the default
6430 * (unlocalized) value of @c "Select a file" as titles.
6432 * @note It will only take any effect if the file selector
6433 * button widget is @b not under "inwin mode".
6435 * @see elm_fileselector_button_window_title_get()
6437 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6440 * Get the title set for a given file selector button widget's
6443 * @param obj The file selector button widget
6444 * @return Title of the file selector button's window
6446 * @see elm_fileselector_button_window_title_get() for more details
6448 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6451 * Set the size of a given file selector button widget's window,
6452 * holding the file selector itself.
6454 * @param obj The file selector button widget
6455 * @param width The window's width
6456 * @param height The window's height
6458 * @note it will only take any effect if the file selector button
6459 * widget is @b not under "inwin mode". The default size for the
6460 * window (when applicable) is 400x400 pixels.
6462 * @see elm_fileselector_button_window_size_get()
6464 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6467 * Get the size of a given file selector button widget's window,
6468 * holding the file selector itself.
6470 * @param obj The file selector button widget
6471 * @param width Pointer into which to store the width value
6472 * @param height Pointer into which to store the height value
6474 * @note Use @c NULL pointers on the size values you're not
6475 * interested in: they'll be ignored by the function.
6477 * @see elm_fileselector_button_window_size_set(), for more details
6479 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6482 * Set the initial file system path for a given file selector
6485 * @param obj The file selector button widget
6486 * @param path The path string
6488 * It must be a <b>directory</b> path, which will have the contents
6489 * displayed initially in the file selector's view, when invoked
6490 * from @p obj. The default initial path is the @c "HOME"
6491 * environment variable's value.
6493 * @see elm_fileselector_button_path_get()
6495 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6498 * Get the initial file system path set for a given file selector
6501 * @param obj The file selector button widget
6502 * @return path The path string
6504 * @see elm_fileselector_button_path_set() for more details
6506 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6509 * Enable/disable a tree view in the given file selector button
6510 * widget's internal file selector
6512 * @param obj The file selector button widget
6513 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6516 * This has the same effect as elm_fileselector_expandable_set(),
6517 * but now applied to a file selector button's internal file
6520 * @note There's no way to put a file selector button's internal
6521 * file selector in "grid mode", as one may do with "pure" file
6524 * @see elm_fileselector_expandable_get()
6526 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6529 * Get whether tree view is enabled for the given file selector
6530 * button widget's internal file selector
6532 * @param obj The file selector button widget
6533 * @return @c EINA_TRUE if @p obj widget's internal file selector
6534 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6536 * @see elm_fileselector_expandable_set() for more details
6538 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6541 * Set whether a given file selector button widget's internal file
6542 * selector is to display folders only or the directory contents,
6545 * @param obj The file selector button widget
6546 * @param only @c EINA_TRUE to make @p obj widget's internal file
6547 * selector only display directories, @c EINA_FALSE to make files
6548 * to be displayed in it too
6550 * This has the same effect as elm_fileselector_folder_only_set(),
6551 * but now applied to a file selector button's internal file
6554 * @see elm_fileselector_folder_only_get()
6556 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6559 * Get whether a given file selector button widget's internal file
6560 * selector is displaying folders only or the directory contents,
6563 * @param obj The file selector button widget
6564 * @return @c EINA_TRUE if @p obj widget's internal file
6565 * selector is only displaying directories, @c EINA_FALSE if files
6566 * are being displayed in it too (and on errors)
6568 * @see elm_fileselector_button_folder_only_set() for more details
6570 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6573 * Enable/disable the file name entry box where the user can type
6574 * in a name for a file, in a given file selector button widget's
6575 * internal file selector.
6577 * @param obj The file selector button widget
6578 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6579 * file selector a "saving dialog", @c EINA_FALSE otherwise
6581 * This has the same effect as elm_fileselector_is_save_set(),
6582 * but now applied to a file selector button's internal file
6585 * @see elm_fileselector_is_save_get()
6587 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6590 * Get whether the given file selector button widget's internal
6591 * file selector is in "saving dialog" mode
6593 * @param obj The file selector button widget
6594 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6595 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6598 * @see elm_fileselector_button_is_save_set() for more details
6600 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6603 * Set whether a given file selector button widget's internal file
6604 * selector will raise an Elementary "inner window", instead of a
6605 * dedicated Elementary window. By default, it won't.
6607 * @param obj The file selector button widget
6608 * @param value @c EINA_TRUE to make it use an inner window, @c
6609 * EINA_TRUE to make it use a dedicated window
6611 * @see elm_win_inwin_add() for more information on inner windows
6612 * @see elm_fileselector_button_inwin_mode_get()
6614 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6617 * Get whether a given file selector button widget's internal file
6618 * selector will raise an Elementary "inner window", instead of a
6619 * dedicated Elementary window.
6621 * @param obj The file selector button widget
6622 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6623 * if it will use a dedicated window
6625 * @see elm_fileselector_button_inwin_mode_set() for more details
6627 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6634 * @defgroup File_Selector_Entry File Selector Entry
6636 * @image html img/widget/fileselector_entry/preview-00.png
6637 * @image latex img/widget/fileselector_entry/preview-00.eps
6639 * This is an entry made to be filled with or display a <b>file
6640 * system path string</b>. Besides the entry itself, the widget has
6641 * a @ref File_Selector_Button "file selector button" on its side,
6642 * which will raise an internal @ref Fileselector "file selector widget",
6643 * when clicked, for path selection aided by file system
6646 * This file selector may appear in an Elementary window or in an
6647 * inner window. When a file is chosen from it, the (inner) window
6648 * is closed and the selected file's path string is exposed both as
6649 * an smart event and as the new text on the entry.
6651 * This widget encapsulates operations on its internal file
6652 * selector on its own API. There is less control over its file
6653 * selector than that one would have instatiating one directly.
6655 * Smart callbacks one can register to:
6656 * - @c "changed" - The text within the entry was changed
6657 * - @c "activated" - The entry has had editing finished and
6658 * changes are to be "committed"
6659 * - @c "press" - The entry has been clicked
6660 * - @c "longpressed" - The entry has been clicked (and held) for a
6662 * - @c "clicked" - The entry has been clicked
6663 * - @c "clicked,double" - The entry has been double clicked
6664 * - @c "focused" - The entry has received focus
6665 * - @c "unfocused" - The entry has lost focus
6666 * - @c "selection,paste" - A paste action has occurred on the
6668 * - @c "selection,copy" - A copy action has occurred on the entry
6669 * - @c "selection,cut" - A cut action has occurred on the entry
6670 * - @c "unpressed" - The file selector entry's button was released
6671 * after being pressed.
6672 * - @c "file,chosen" - The user has selected a path via the file
6673 * selector entry's internal file selector, whose string pointer
6674 * comes as the @c event_info data (a stringshared string)
6676 * Here is an example on its usage:
6677 * @li @ref fileselector_entry_example
6679 * @see @ref File_Selector_Button for a similar widget.
6684 * Add a new file selector entry widget to the given parent
6685 * Elementary (container) object
6687 * @param parent The parent object
6688 * @return a new file selector entry widget handle or @c NULL, on
6691 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6694 * Set the label for a given file selector entry widget's button
6696 * @param obj The file selector entry widget
6697 * @param label The text label to be displayed on @p obj widget's
6700 * @deprecated use elm_object_text_set() instead.
6702 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6705 * Get the label set for a given file selector entry widget's button
6707 * @param obj The file selector entry widget
6708 * @return The widget button's label
6710 * @deprecated use elm_object_text_set() instead.
6712 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6715 * Set the icon on a given file selector entry widget's button
6717 * @param obj The file selector entry widget
6718 * @param icon The icon object for the entry's button
6720 * Once the icon object is set, a previously set one will be
6721 * deleted. If you want to keep the latter, use the
6722 * elm_fileselector_entry_button_icon_unset() function.
6724 * @see elm_fileselector_entry_button_icon_get()
6726 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6729 * Get the icon set for a given file selector entry widget's button
6731 * @param obj The file selector entry widget
6732 * @return The icon object currently set on @p obj widget's button
6733 * or @c NULL, if none is
6735 * @see elm_fileselector_entry_button_icon_set()
6737 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6740 * Unset the icon used in a given file selector entry widget's
6743 * @param obj The file selector entry widget
6744 * @return The icon object that was being used on @p obj widget's
6745 * button or @c NULL, on errors
6747 * Unparent and return the icon object which was set for this
6750 * @see elm_fileselector_entry_button_icon_set()
6752 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6755 * Set the title for a given file selector entry widget's window
6757 * @param obj The file selector entry widget
6758 * @param title The title string
6760 * This will change the window's title, when the file selector pops
6761 * out after a click on the entry's button. Those windows have the
6762 * default (unlocalized) value of @c "Select a file" as titles.
6764 * @note It will only take any effect if the file selector
6765 * entry widget is @b not under "inwin mode".
6767 * @see elm_fileselector_entry_window_title_get()
6769 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6772 * Get the title set for a given file selector entry widget's
6775 * @param obj The file selector entry widget
6776 * @return Title of the file selector entry's window
6778 * @see elm_fileselector_entry_window_title_get() for more details
6780 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6783 * Set the size of a given file selector entry widget's window,
6784 * holding the file selector itself.
6786 * @param obj The file selector entry widget
6787 * @param width The window's width
6788 * @param height The window's height
6790 * @note it will only take any effect if the file selector entry
6791 * widget is @b not under "inwin mode". The default size for the
6792 * window (when applicable) is 400x400 pixels.
6794 * @see elm_fileselector_entry_window_size_get()
6796 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6799 * Get the size of a given file selector entry widget's window,
6800 * holding the file selector itself.
6802 * @param obj The file selector entry widget
6803 * @param width Pointer into which to store the width value
6804 * @param height Pointer into which to store the height value
6806 * @note Use @c NULL pointers on the size values you're not
6807 * interested in: they'll be ignored by the function.
6809 * @see elm_fileselector_entry_window_size_set(), for more details
6811 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6814 * Set the initial file system path and the entry's path string for
6815 * a given file selector entry widget
6817 * @param obj The file selector entry widget
6818 * @param path The path string
6820 * It must be a <b>directory</b> path, which will have the contents
6821 * displayed initially in the file selector's view, when invoked
6822 * from @p obj. The default initial path is the @c "HOME"
6823 * environment variable's value.
6825 * @see elm_fileselector_entry_path_get()
6827 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6830 * Get the entry's path string for a given file selector entry
6833 * @param obj The file selector entry widget
6834 * @return path The path string
6836 * @see elm_fileselector_entry_path_set() for more details
6838 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6841 * Enable/disable a tree view in the given file selector entry
6842 * widget's internal file selector
6844 * @param obj The file selector entry widget
6845 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6848 * This has the same effect as elm_fileselector_expandable_set(),
6849 * but now applied to a file selector entry's internal file
6852 * @note There's no way to put a file selector entry's internal
6853 * file selector in "grid mode", as one may do with "pure" file
6856 * @see elm_fileselector_expandable_get()
6858 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6861 * Get whether tree view is enabled for the given file selector
6862 * entry widget's internal file selector
6864 * @param obj The file selector entry widget
6865 * @return @c EINA_TRUE if @p obj widget's internal file selector
6866 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6868 * @see elm_fileselector_expandable_set() for more details
6870 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6873 * Set whether a given file selector entry widget's internal file
6874 * selector is to display folders only or the directory contents,
6877 * @param obj The file selector entry widget
6878 * @param only @c EINA_TRUE to make @p obj widget's internal file
6879 * selector only display directories, @c EINA_FALSE to make files
6880 * to be displayed in it too
6882 * This has the same effect as elm_fileselector_folder_only_set(),
6883 * but now applied to a file selector entry's internal file
6886 * @see elm_fileselector_folder_only_get()
6888 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6891 * Get whether a given file selector entry widget's internal file
6892 * selector is displaying folders only or the directory contents,
6895 * @param obj The file selector entry widget
6896 * @return @c EINA_TRUE if @p obj widget's internal file
6897 * selector is only displaying directories, @c EINA_FALSE if files
6898 * are being displayed in it too (and on errors)
6900 * @see elm_fileselector_entry_folder_only_set() for more details
6902 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6905 * Enable/disable the file name entry box where the user can type
6906 * in a name for a file, in a given file selector entry widget's
6907 * internal file selector.
6909 * @param obj The file selector entry widget
6910 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6911 * file selector a "saving dialog", @c EINA_FALSE otherwise
6913 * This has the same effect as elm_fileselector_is_save_set(),
6914 * but now applied to a file selector entry's internal file
6917 * @see elm_fileselector_is_save_get()
6919 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6922 * Get whether the given file selector entry widget's internal
6923 * file selector is in "saving dialog" mode
6925 * @param obj The file selector entry widget
6926 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6927 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6930 * @see elm_fileselector_entry_is_save_set() for more details
6932 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6935 * Set whether a given file selector entry widget's internal file
6936 * selector will raise an Elementary "inner window", instead of a
6937 * dedicated Elementary window. By default, it won't.
6939 * @param obj The file selector entry widget
6940 * @param value @c EINA_TRUE to make it use an inner window, @c
6941 * EINA_TRUE to make it use a dedicated window
6943 * @see elm_win_inwin_add() for more information on inner windows
6944 * @see elm_fileselector_entry_inwin_mode_get()
6946 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6949 * Get whether a given file selector entry widget's internal file
6950 * selector will raise an Elementary "inner window", instead of a
6951 * dedicated Elementary window.
6953 * @param obj The file selector entry widget
6954 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6955 * if it will use a dedicated window
6957 * @see elm_fileselector_entry_inwin_mode_set() for more details
6959 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6962 * Set the initial file system path for a given file selector entry
6965 * @param obj The file selector entry widget
6966 * @param path The path string
6968 * It must be a <b>directory</b> path, which will have the contents
6969 * displayed initially in the file selector's view, when invoked
6970 * from @p obj. The default initial path is the @c "HOME"
6971 * environment variable's value.
6973 * @see elm_fileselector_entry_path_get()
6975 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6978 * Get the parent directory's path to the latest file selection on
6979 * a given filer selector entry widget
6981 * @param obj The file selector object
6982 * @return The (full) path of the directory of the last selection
6983 * on @p obj widget, a @b stringshared string
6985 * @see elm_fileselector_entry_path_set()
6987 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6994 * @defgroup Scroller Scroller
6996 * A scroller holds a single object and "scrolls it around". This means that
6997 * it allows the user to use a scrollbar (or a finger) to drag the viewable
6998 * region around, allowing to move through a much larger object that is
6999 * contained in the scroller. The scroller will always have a small minimum
7000 * size by default as it won't be limited by the contents of the scroller.
7002 * Signals that you can add callbacks for are:
7003 * @li "edge,left" - the left edge of the content has been reached
7004 * @li "edge,right" - the right edge of the content has been reached
7005 * @li "edge,top" - the top edge of the content has been reached
7006 * @li "edge,bottom" - the bottom edge of the content has been reached
7007 * @li "scroll" - the content has been scrolled (moved)
7008 * @li "scroll,anim,start" - scrolling animation has started
7009 * @li "scroll,anim,stop" - scrolling animation has stopped
7010 * @li "scroll,drag,start" - dragging the contents around has started
7011 * @li "scroll,drag,stop" - dragging the contents around has stopped
7012 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7015 * @note When Elemementary is in embedded mode the scrollbars will not be
7016 * dragable, they appear merely as indicators of how much has been scrolled.
7017 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7018 * fingerscroll) won't work.
7020 * In @ref tutorial_scroller you'll find an example of how to use most of
7025 * @brief Type that controls when scrollbars should appear.
7027 * @see elm_scroller_policy_set()
7029 typedef enum _Elm_Scroller_Policy
7031 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7032 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7033 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7034 ELM_SCROLLER_POLICY_LAST
7035 } Elm_Scroller_Policy;
7037 * @brief Add a new scroller to the parent
7039 * @param parent The parent object
7040 * @return The new object or NULL if it cannot be created
7042 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7044 * @brief Set the content of the scroller widget (the object to be scrolled around).
7046 * @param obj The scroller object
7047 * @param content The new content object
7049 * Once the content object is set, a previously set one will be deleted.
7050 * If you want to keep that old content object, use the
7051 * elm_scroller_content_unset() function.
7053 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7055 * @brief Get the content of the scroller widget
7057 * @param obj The slider object
7058 * @return The content that is being used
7060 * Return the content object which is set for this widget
7062 * @see elm_scroller_content_set()
7064 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7066 * @brief Unset the content of the scroller widget
7068 * @param obj The slider object
7069 * @return The content that was being used
7071 * Unparent and return the content object which was set for this widget
7073 * @see elm_scroller_content_set()
7075 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7077 * @brief Set custom theme elements for the scroller
7079 * @param obj The scroller object
7080 * @param widget The widget name to use (default is "scroller")
7081 * @param base The base name to use (default is "base")
7083 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7085 * @brief Make the scroller minimum size limited to the minimum size of the content
7087 * @param obj The scroller object
7088 * @param w Enable limiting minimum size horizontally
7089 * @param h Enable limiting minimum size vertically
7091 * By default the scroller will be as small as its design allows,
7092 * irrespective of its content. This will make the scroller minimum size the
7093 * right size horizontally and/or vertically to perfectly fit its content in
7096 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7098 * @brief Show a specific virtual region within the scroller content object
7100 * @param obj The scroller object
7101 * @param x X coordinate of the region
7102 * @param y Y coordinate of the region
7103 * @param w Width of the region
7104 * @param h Height of the region
7106 * This will ensure all (or part if it does not fit) of the designated
7107 * region in the virtual content object (0, 0 starting at the top-left of the
7108 * virtual content object) is shown within the scroller.
7110 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);
7112 * @brief Set the scrollbar visibility policy
7114 * @param obj The scroller object
7115 * @param policy_h Horizontal scrollbar policy
7116 * @param policy_v Vertical scrollbar policy
7118 * This sets the scrollbar visibility policy for the given scroller.
7119 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7120 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7121 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7122 * respectively for the horizontal and vertical scrollbars.
7124 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7126 * @brief Gets scrollbar visibility policy
7128 * @param obj The scroller object
7129 * @param policy_h Horizontal scrollbar policy
7130 * @param policy_v Vertical scrollbar policy
7132 * @see elm_scroller_policy_set()
7134 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7136 * @brief Get the currently visible content region
7138 * @param obj The scroller object
7139 * @param x X coordinate of the region
7140 * @param y Y coordinate of the region
7141 * @param w Width of the region
7142 * @param h Height of the region
7144 * This gets the current region in the content object that is visible through
7145 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7146 * w, @p h values pointed to.
7148 * @note All coordinates are relative to the content.
7150 * @see elm_scroller_region_show()
7152 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);
7154 * @brief Get the size of the content object
7156 * @param obj The scroller object
7157 * @param w Width of the content object.
7158 * @param h Height of the content object.
7160 * This gets the size of the content object of the scroller.
7162 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7164 * @brief Set bouncing behavior
7166 * @param obj The scroller object
7167 * @param h_bounce Allow bounce horizontally
7168 * @param v_bounce Allow bounce vertically
7170 * When scrolling, the scroller may "bounce" when reaching an edge of the
7171 * content object. This is a visual way to indicate the end has been reached.
7172 * This is enabled by default for both axis. This API will set if it is enabled
7173 * for the given axis with the boolean parameters for each axis.
7175 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7177 * @brief Get the bounce behaviour
7179 * @param obj The Scroller object
7180 * @param h_bounce Will the scroller bounce horizontally or not
7181 * @param v_bounce Will the scroller bounce vertically or not
7183 * @see elm_scroller_bounce_set()
7185 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7187 * @brief Set scroll page size relative to viewport size.
7189 * @param obj The scroller object
7190 * @param h_pagerel The horizontal page relative size
7191 * @param v_pagerel The vertical page relative size
7193 * The scroller is capable of limiting scrolling by the user to "pages". That
7194 * is to jump by and only show a "whole page" at a time as if the continuous
7195 * area of the scroller content is split into page sized pieces. This sets
7196 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7197 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7198 * axis. This is mutually exclusive with page size
7199 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7200 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7201 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7204 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7206 * @brief Set scroll page size.
7208 * @param obj The scroller object
7209 * @param h_pagesize The horizontal page size
7210 * @param v_pagesize The vertical page size
7212 * This sets the page size to an absolute fixed value, with 0 turning it off
7215 * @see elm_scroller_page_relative_set()
7217 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7219 * @brief Get scroll current page number.
7221 * @param obj The scroller object
7222 * @param h_pagenumber The horizontal page number
7223 * @param v_pagenumber The vertical page number
7225 * The page number starts from 0. 0 is the first page.
7226 * Current page means the page which meets the top-left of the viewport.
7227 * If there are two or more pages in the viewport, it returns the number of the page
7228 * which meets the top-left of the viewport.
7230 * @see elm_scroller_last_page_get()
7231 * @see elm_scroller_page_show()
7232 * @see elm_scroller_page_brint_in()
7234 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7236 * @brief Get scroll last page number.
7238 * @param obj The scroller object
7239 * @param h_pagenumber The horizontal page number
7240 * @param v_pagenumber The vertical page number
7242 * The page number starts from 0. 0 is the first page.
7243 * This returns the last page number among the pages.
7245 * @see elm_scroller_current_page_get()
7246 * @see elm_scroller_page_show()
7247 * @see elm_scroller_page_brint_in()
7249 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7251 * Show a specific virtual region within the scroller content object by page number.
7253 * @param obj The scroller object
7254 * @param h_pagenumber The horizontal page number
7255 * @param v_pagenumber The vertical page number
7257 * 0, 0 of the indicated page is located at the top-left of the viewport.
7258 * This will jump to the page directly without animation.
7263 * sc = elm_scroller_add(win);
7264 * elm_scroller_content_set(sc, content);
7265 * elm_scroller_page_relative_set(sc, 1, 0);
7266 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7267 * elm_scroller_page_show(sc, h_page + 1, v_page);
7270 * @see elm_scroller_page_bring_in()
7272 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7274 * Show a specific virtual region within the scroller content object by page number.
7276 * @param obj The scroller object
7277 * @param h_pagenumber The horizontal page number
7278 * @param v_pagenumber The vertical page number
7280 * 0, 0 of the indicated page is located at the top-left of the viewport.
7281 * This will slide to the page with animation.
7286 * sc = elm_scroller_add(win);
7287 * elm_scroller_content_set(sc, content);
7288 * elm_scroller_page_relative_set(sc, 1, 0);
7289 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7290 * elm_scroller_page_bring_in(sc, h_page, v_page);
7293 * @see elm_scroller_page_show()
7295 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7297 * @brief Show a specific virtual region within the scroller content object.
7299 * @param obj The scroller object
7300 * @param x X coordinate of the region
7301 * @param y Y coordinate of the region
7302 * @param w Width of the region
7303 * @param h Height of the region
7305 * This will ensure all (or part if it does not fit) of the designated
7306 * region in the virtual content object (0, 0 starting at the top-left of the
7307 * virtual content object) is shown within the scroller. Unlike
7308 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7309 * to this location (if configuration in general calls for transitions). It
7310 * may not jump immediately to the new location and make take a while and
7311 * show other content along the way.
7313 * @see elm_scroller_region_show()
7315 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);
7317 * @brief Set event propagation on a scroller
7319 * @param obj The scroller object
7320 * @param propagation If propagation is enabled or not
7322 * This enables or disabled event propagation from the scroller content to
7323 * the scroller and its parent. By default event propagation is disabled.
7325 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7327 * @brief Get event propagation for a scroller
7329 * @param obj The scroller object
7330 * @return The propagation state
7332 * This gets the event propagation for a scroller.
7334 * @see elm_scroller_propagate_events_set()
7336 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7338 * @brief Set scrolling gravity on a scroller
7340 * @param obj The scroller object
7341 * @param x The scrolling horizontal gravity
7342 * @param y The scrolling vertical gravity
7344 * The gravity, defines how the scroller will adjust its view
7345 * when the size of the scroller contents increase.
7347 * The scroller will adjust the view to glue itself as follows.
7349 * x=0.0, for showing the left most region of the content.
7350 * x=1.0, for showing the right most region of the content.
7351 * y=0.0, for showing the bottom most region of the content.
7352 * y=1.0, for showing the top most region of the content.
7354 * Default values for x and y are 0.0
7356 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7358 * @brief Get scrolling gravity values for a scroller
7360 * @param obj The scroller object
7361 * @param x The scrolling horizontal gravity
7362 * @param y The scrolling vertical gravity
7364 * This gets gravity values for a scroller.
7366 * @see elm_scroller_gravity_set()
7369 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7375 * @defgroup Label Label
7377 * @image html img/widget/label/preview-00.png
7378 * @image latex img/widget/label/preview-00.eps
7380 * @brief Widget to display text, with simple html-like markup.
7382 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7383 * text doesn't fit the geometry of the label it will be ellipsized or be
7384 * cut. Elementary provides several themes for this widget:
7385 * @li default - No animation
7386 * @li marker - Centers the text in the label and make it bold by default
7387 * @li slide_long - The entire text appears from the right of the screen and
7388 * slides until it disappears in the left of the screen(reappering on the
7390 * @li slide_short - The text appears in the left of the label and slides to
7391 * the right to show the overflow. When all of the text has been shown the
7392 * position is reset.
7393 * @li slide_bounce - The text appears in the left of the label and slides to
7394 * the right to show the overflow. When all of the text has been shown the
7395 * animation reverses, moving the text to the left.
7397 * Custom themes can of course invent new markup tags and style them any way
7400 * The following signals may be emitted by the label widget:
7401 * @li "language,changed": The program's language changed.
7403 * See @ref tutorial_label for a demonstration of how to use a label widget.
7407 * @brief Add a new label to the parent
7409 * @param parent The parent object
7410 * @return The new object or NULL if it cannot be created
7412 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7414 * @brief Set the label on the label object
7416 * @param obj The label object
7417 * @param label The label will be used on the label object
7418 * @deprecated See elm_object_text_set()
7420 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 */
7422 * @brief Get the label used on the label object
7424 * @param obj The label object
7425 * @return The string inside the label
7426 * @deprecated See elm_object_text_get()
7428 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7430 * @brief Set the wrapping behavior of the label
7432 * @param obj The label object
7433 * @param wrap To wrap text or not
7435 * By default no wrapping is done. Possible values for @p wrap are:
7436 * @li ELM_WRAP_NONE - No wrapping
7437 * @li ELM_WRAP_CHAR - wrap between characters
7438 * @li ELM_WRAP_WORD - wrap between words
7439 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7441 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7443 * @brief Get the wrapping behavior of the label
7445 * @param obj The label object
7448 * @see elm_label_line_wrap_set()
7450 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7452 * @brief Set wrap width of the label
7454 * @param obj The label object
7455 * @param w The wrap width in pixels at a minimum where words need to wrap
7457 * This function sets the maximum width size hint of the label.
7459 * @warning This is only relevant if the label is inside a container.
7461 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7463 * @brief Get wrap width of the label
7465 * @param obj The label object
7466 * @return The wrap width in pixels at a minimum where words need to wrap
7468 * @see elm_label_wrap_width_set()
7470 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7472 * @brief Set wrap height of the label
7474 * @param obj The label object
7475 * @param h The wrap height in pixels at a minimum where words need to wrap
7477 * This function sets the maximum height size hint of the label.
7479 * @warning This is only relevant if the label is inside a container.
7481 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7483 * @brief get wrap width of the label
7485 * @param obj The label object
7486 * @return The wrap height in pixels at a minimum where words need to wrap
7488 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7490 * @brief Set the font size on the label object.
7492 * @param obj The label object
7493 * @param size font size
7495 * @warning NEVER use this. It is for hyper-special cases only. use styles
7496 * instead. e.g. "big", "medium", "small" - or better name them by use:
7497 * "title", "footnote", "quote" etc.
7499 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7501 * @brief Set the text color on the label object
7503 * @param obj The label object
7504 * @param r Red property background color of The label object
7505 * @param g Green property background color of The label object
7506 * @param b Blue property background color of The label object
7507 * @param a Alpha property background color of The label object
7509 * @warning NEVER use this. It is for hyper-special cases only. use styles
7510 * instead. e.g. "big", "medium", "small" - or better name them by use:
7511 * "title", "footnote", "quote" etc.
7513 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);
7515 * @brief Set the text align on the label object
7517 * @param obj The label object
7518 * @param align align mode ("left", "center", "right")
7520 * @warning NEVER use this. It is for hyper-special cases only. use styles
7521 * instead. e.g. "big", "medium", "small" - or better name them by use:
7522 * "title", "footnote", "quote" etc.
7524 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7526 * @brief Set background color of the label
7528 * @param obj The label object
7529 * @param r Red property background color of The label object
7530 * @param g Green property background color of The label object
7531 * @param b Blue property background color of The label object
7532 * @param a Alpha property background alpha of The label object
7534 * @warning NEVER use this. It is for hyper-special cases only. use styles
7535 * instead. e.g. "big", "medium", "small" - or better name them by use:
7536 * "title", "footnote", "quote" etc.
7538 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);
7540 * @brief Set the ellipsis behavior of the label
7542 * @param obj The label object
7543 * @param ellipsis To ellipsis text or not
7545 * If set to true and the text doesn't fit in the label an ellipsis("...")
7546 * will be shown at the end of the widget.
7548 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7549 * choosen wrap method was ELM_WRAP_WORD.
7551 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7553 * @brief Set the text slide of the label
7555 * @param obj The label object
7556 * @param slide To start slide or stop
7558 * If set to true the text of the label will slide throught the length of
7561 * @warning This only work with the themes "slide_short", "slide_long" and
7564 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7566 * @brief Get the text slide mode of the label
7568 * @param obj The label object
7569 * @return slide slide mode value
7571 * @see elm_label_slide_set()
7573 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7575 * @brief Set the slide duration(speed) of the label
7577 * @param obj The label object
7578 * @return The duration in seconds in moving text from slide begin position
7579 * to slide end position
7581 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7583 * @brief Get the slide duration(speed) of the label
7585 * @param obj The label object
7586 * @return The duration time in moving text from slide begin position to slide end position
7588 * @see elm_label_slide_duration_set()
7590 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7596 * @defgroup Toggle Toggle
7598 * @image html img/widget/toggle/preview-00.png
7599 * @image latex img/widget/toggle/preview-00.eps
7601 * @brief A toggle is a slider which can be used to toggle between
7602 * two values. It has two states: on and off.
7604 * This widget is deprecated. Please use elm_check_add() instead using the
7605 * toggle style like:
7608 * obj = elm_check_add(parent);
7609 * elm_object_style_set(obj, "toggle");
7610 * elm_object_text_part_set(obj, "on", "ON");
7611 * elm_object_text_part_set(obj, "off", "OFF");
7614 * Signals that you can add callbacks for are:
7615 * @li "changed" - Whenever the toggle value has been changed. Is not called
7616 * until the toggle is released by the cursor (assuming it
7617 * has been triggered by the cursor in the first place).
7619 * @ref tutorial_toggle show how to use a toggle.
7623 * @brief Add a toggle to @p parent.
7625 * @param parent The parent object
7627 * @return The toggle object
7629 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7631 * @brief Sets the label to be displayed with the toggle.
7633 * @param obj The toggle object
7634 * @param label The label to be displayed
7636 * @deprecated use elm_object_text_set() instead.
7638 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7640 * @brief Gets the label of the toggle
7642 * @param obj toggle object
7643 * @return The label of the toggle
7645 * @deprecated use elm_object_text_get() instead.
7647 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7649 * @brief Set the icon used for the toggle
7651 * @param obj The toggle object
7652 * @param icon The icon object for the button
7654 * Once the icon object is set, a previously set one will be deleted
7655 * If you want to keep that old content object, use the
7656 * elm_toggle_icon_unset() function.
7658 * @deprecated use elm_object_content_set() instead.
7660 EINA_DEPRECATED EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7662 * @brief Get the icon used for the toggle
7664 * @param obj The toggle object
7665 * @return The icon object that is being used
7667 * Return the icon object which is set for this widget.
7669 * @see elm_toggle_icon_set()
7671 * @deprecated use elm_object_content_get() instead.
7673 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7675 * @brief Unset the icon used for the toggle
7677 * @param obj The toggle object
7678 * @return The icon object that was being used
7680 * Unparent and return the icon object which was set for this widget.
7682 * @see elm_toggle_icon_set()
7684 * @deprecated use elm_object_content_unset() instead.
7686 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7688 * @brief Sets the labels to be associated with the on and off states of the toggle.
7690 * @param obj The toggle object
7691 * @param onlabel The label displayed when the toggle is in the "on" state
7692 * @param offlabel The label displayed when the toggle is in the "off" state
7694 * @deprecated use elm_object_text_part_set() for "on" and "off" parts
7697 EINA_DEPRECATED EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7699 * @brief Gets the labels associated with the on and off states of the
7702 * @param obj The toggle object
7703 * @param onlabel A char** to place the onlabel of @p obj into
7704 * @param offlabel A char** to place the offlabel of @p obj into
7706 * @deprecated use elm_object_text_part_get() for "on" and "off" parts
7709 EINA_DEPRECATED EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7711 * @brief Sets the state of the toggle to @p state.
7713 * @param obj The toggle object
7714 * @param state The state of @p obj
7716 * @deprecated use elm_check_state_set() instead.
7718 EINA_DEPRECATED EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7720 * @brief Gets the state of the toggle to @p state.
7722 * @param obj The toggle object
7723 * @return The state of @p obj
7725 * @deprecated use elm_check_state_get() instead.
7727 EINA_DEPRECATED EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7729 * @brief Sets the state pointer of the toggle to @p statep.
7731 * @param obj The toggle object
7732 * @param statep The state pointer of @p obj
7734 * @deprecated use elm_check_state_pointer_set() instead.
7736 EINA_DEPRECATED EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7742 * @defgroup Frame Frame
7744 * @image html img/widget/frame/preview-00.png
7745 * @image latex img/widget/frame/preview-00.eps
7747 * @brief Frame is a widget that holds some content and has a title.
7749 * The default look is a frame with a title, but Frame supports multple
7757 * @li outdent_bottom
7759 * Of all this styles only default shows the title. Frame emits no signals.
7761 * Default contents parts of the frame widget that you can use for are:
7762 * @li "elm.swallow.content" - A content of the frame
7764 * Default text parts of the frame widget that you can use for are:
7765 * @li "elm.text" - Label of the frame
7767 * For a detailed example see the @ref tutorial_frame.
7772 * @brief Add a new frame to the parent
7774 * @param parent The parent object
7775 * @return The new object or NULL if it cannot be created
7777 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7779 * @brief Set the frame label
7781 * @param obj The frame object
7782 * @param label The label of this frame object
7784 * @deprecated use elm_object_text_set() instead.
7786 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7788 * @brief Get the frame label
7790 * @param obj The frame object
7792 * @return The label of this frame objet or NULL if unable to get frame
7794 * @deprecated use elm_object_text_get() instead.
7796 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7798 * @brief Set the content of the frame widget
7800 * Once the content object is set, a previously set one will be deleted.
7801 * If you want to keep that old content object, use the
7802 * elm_frame_content_unset() function.
7804 * @param obj The frame object
7805 * @param content The content will be filled in this frame object
7807 EINA_DEPRECATED EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7809 * @brief Get the content of the frame widget
7811 * Return the content object which is set for this widget
7813 * @param obj The frame object
7814 * @return The content that is being used
7816 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7818 * @brief Unset the content of the frame widget
7820 * Unparent and return the content object which was set for this widget
7822 * @param obj The frame object
7823 * @return The content that was being used
7825 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7831 * @defgroup Table Table
7833 * A container widget to arrange other widgets in a table where items can
7834 * also span multiple columns or rows - even overlap (and then be raised or
7835 * lowered accordingly to adjust stacking if they do overlap).
7837 * The followin are examples of how to use a table:
7838 * @li @ref tutorial_table_01
7839 * @li @ref tutorial_table_02
7844 * @brief Add a new table to the parent
7846 * @param parent The parent object
7847 * @return The new object or NULL if it cannot be created
7849 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7851 * @brief Set the homogeneous layout in the table
7853 * @param obj The layout object
7854 * @param homogeneous A boolean to set if the layout is homogeneous in the
7855 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7857 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7859 * @brief Get the current table homogeneous mode.
7861 * @param obj The table object
7862 * @return A boolean to indicating if the layout is homogeneous in the table
7863 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7865 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7867 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7869 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7871 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7873 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7875 * @brief Set padding between cells.
7877 * @param obj The layout object.
7878 * @param horizontal set the horizontal padding.
7879 * @param vertical set the vertical padding.
7881 * Default value is 0.
7883 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7885 * @brief Get padding between cells.
7887 * @param obj The layout object.
7888 * @param horizontal set the horizontal padding.
7889 * @param vertical set the vertical padding.
7891 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7893 * @brief Add a subobject on the table with the coordinates passed
7895 * @param obj The table object
7896 * @param subobj The subobject to be added to the table
7897 * @param x Row number
7898 * @param y Column number
7902 * @note All positioning inside the table is relative to rows and columns, so
7903 * a value of 0 for x and y, means the top left cell of the table, and a
7904 * value of 1 for w and h means @p subobj only takes that 1 cell.
7906 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7908 * @brief Remove child from table.
7910 * @param obj The table object
7911 * @param subobj The subobject
7913 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7915 * @brief Faster way to remove all child objects from a table object.
7917 * @param obj The table object
7918 * @param clear If true, will delete children, else just remove from table.
7920 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7922 * @brief Set the packing location of an existing child of the table
7924 * @param subobj The subobject to be modified in the table
7925 * @param x Row number
7926 * @param y Column number
7930 * Modifies the position of an object already in the table.
7932 * @note All positioning inside the table is relative to rows and columns, so
7933 * a value of 0 for x and y, means the top left cell of the table, and a
7934 * value of 1 for w and h means @p subobj only takes that 1 cell.
7936 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7938 * @brief Get the packing location of an existing child of the table
7940 * @param subobj The subobject to be modified in the table
7941 * @param x Row number
7942 * @param y Column number
7946 * @see elm_table_pack_set()
7948 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7953 /* TEMPORARY: DOCS WILL BE FILLED IN WITH CNP/SED */
7954 typedef struct Elm_Gen_Item Elm_Gen_Item;
7955 typedef struct _Elm_Gen_Item_Class Elm_Gen_Item_Class;
7956 typedef struct _Elm_Gen_Item_Class_Func Elm_Gen_Item_Class_Func; /**< Class functions for gen item classes. */
7957 typedef char *(*Elm_Gen_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gen item classes. */
7958 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. */
7959 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. */
7960 typedef void (*Elm_Gen_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gen item classes. */
7961 struct _Elm_Gen_Item_Class
7963 const char *item_style;
7964 struct _Elm_Gen_Item_Class_Func
7966 Elm_Gen_Item_Label_Get_Cb label_get;
7967 Elm_Gen_Item_Content_Get_Cb content_get;
7968 Elm_Gen_Item_State_Get_Cb state_get;
7969 Elm_Gen_Item_Del_Cb del;
7972 EAPI void elm_gen_clear(Evas_Object *obj);
7973 EAPI void elm_gen_item_selected_set(Elm_Gen_Item *it, Eina_Bool selected);
7974 EAPI Eina_Bool elm_gen_item_selected_get(const Elm_Gen_Item *it);
7975 EAPI void elm_gen_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
7976 EAPI Eina_Bool elm_gen_always_select_mode_get(const Evas_Object *obj);
7977 EAPI void elm_gen_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
7978 EAPI Eina_Bool elm_gen_no_select_mode_get(const Evas_Object *obj);
7979 EAPI void elm_gen_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
7980 EAPI void elm_gen_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
7981 EAPI void elm_gen_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
7982 EAPI void elm_gen_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
7983 EAPI void elm_gen_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
7984 EAPI void elm_gen_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
7985 EAPI void elm_gen_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
7986 EAPI void elm_gen_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
7987 EAPI void elm_gen_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
7988 EAPI Elm_Gen_Item *elm_gen_first_item_get(const Evas_Object *obj);
7989 EAPI Elm_Gen_Item *elm_gen_last_item_get(const Evas_Object *obj);
7990 EAPI Elm_Gen_Item *elm_gen_item_next_get(const Elm_Gen_Item *it);
7991 EAPI Elm_Gen_Item *elm_gen_item_prev_get(const Elm_Gen_Item *it);
7992 EAPI Evas_Object *elm_gen_item_widget_get(const Elm_Gen_Item *it);
7995 * @defgroup Gengrid Gengrid (Generic grid)
7997 * This widget aims to position objects in a grid layout while
7998 * actually creating and rendering only the visible ones, using the
7999 * same idea as the @ref Genlist "genlist": the user defines a @b
8000 * class for each item, specifying functions that will be called at
8001 * object creation, deletion, etc. When those items are selected by
8002 * the user, a callback function is issued. Users may interact with
8003 * a gengrid via the mouse (by clicking on items to select them and
8004 * clicking on the grid's viewport and swiping to pan the whole
8005 * view) or via the keyboard, navigating through item with the
8008 * @section Gengrid_Layouts Gengrid layouts
8010 * Gengrids may layout its items in one of two possible layouts:
8014 * When in "horizontal mode", items will be placed in @b columns,
8015 * from top to bottom and, when the space for a column is filled,
8016 * another one is started on the right, thus expanding the grid
8017 * horizontally, making for horizontal scrolling. When in "vertical
8018 * mode" , though, items will be placed in @b rows, from left to
8019 * right and, when the space for a row is filled, another one is
8020 * started below, thus expanding the grid vertically (and making
8021 * for vertical scrolling).
8023 * @section Gengrid_Items Gengrid items
8025 * An item in a gengrid can have 0 or more text labels (they can be
8026 * regular text or textblock Evas objects - that's up to the style
8027 * to determine), 0 or more icons (which are simply objects
8028 * swallowed into the gengrid item's theming Edje object) and 0 or
8029 * more <b>boolean states</b>, which have the behavior left to the
8030 * user to define. The Edje part names for each of these properties
8031 * will be looked up, in the theme file for the gengrid, under the
8032 * Edje (string) data items named @c "labels", @c "icons" and @c
8033 * "states", respectively. For each of those properties, if more
8034 * than one part is provided, they must have names listed separated
8035 * by spaces in the data fields. For the default gengrid item
8036 * theme, we have @b one label part (@c "elm.text"), @b two icon
8037 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8040 * A gengrid item may be at one of several styles. Elementary
8041 * provides one by default - "default", but this can be extended by
8042 * system or application custom themes/overlays/extensions (see
8043 * @ref Theme "themes" for more details).
8045 * @section Gengrid_Item_Class Gengrid item classes
8047 * In order to have the ability to add and delete items on the fly,
8048 * gengrid implements a class (callback) system where the
8049 * application provides a structure with information about that
8050 * type of item (gengrid may contain multiple different items with
8051 * different classes, states and styles). Gengrid will call the
8052 * functions in this struct (methods) when an item is "realized"
8053 * (i.e., created dynamically, while the user is scrolling the
8054 * grid). All objects will simply be deleted when no longer needed
8055 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8056 * contains the following members:
8057 * - @c item_style - This is a constant string and simply defines
8058 * the name of the item style. It @b must be specified and the
8059 * default should be @c "default".
8060 * - @c func.label_get - This function is called when an item
8061 * object is actually created. The @c data parameter will point to
8062 * the same data passed to elm_gengrid_item_append() and related
8063 * item creation functions. The @c obj parameter is the gengrid
8064 * object itself, while the @c part one is the name string of one
8065 * of the existing text parts in the Edje group implementing the
8066 * item's theme. This function @b must return a strdup'()ed string,
8067 * as the caller will free() it when done. See
8068 * #Elm_Gengrid_Item_Label_Get_Cb.
8069 * - @c func.content_get - This function is called when an item object
8070 * is actually created. The @c data parameter will point to the
8071 * same data passed to elm_gengrid_item_append() and related item
8072 * creation functions. The @c obj parameter is the gengrid object
8073 * itself, while the @c part one is the name string of one of the
8074 * existing (content) swallow parts in the Edje group implementing the
8075 * item's theme. It must return @c NULL, when no content is desired,
8076 * or a valid object handle, otherwise. The object will be deleted
8077 * by the gengrid on its deletion or when the item is "unrealized".
8078 * See #Elm_Gengrid_Item_Content_Get_Cb.
8079 * - @c func.state_get - This function is called when an item
8080 * object is actually created. The @c data parameter will point to
8081 * the same data passed to elm_gengrid_item_append() and related
8082 * item creation functions. The @c obj parameter is the gengrid
8083 * object itself, while the @c part one is the name string of one
8084 * of the state parts in the Edje group implementing the item's
8085 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8086 * true/on. Gengrids will emit a signal to its theming Edje object
8087 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8088 * "source" arguments, respectively, when the state is true (the
8089 * default is false), where @c XXX is the name of the (state) part.
8090 * See #Elm_Gengrid_Item_State_Get_Cb.
8091 * - @c func.del - This is called when elm_gengrid_item_del() is
8092 * called on an item or elm_gengrid_clear() is called on the
8093 * gengrid. This is intended for use when gengrid items are
8094 * deleted, so any data attached to the item (e.g. its data
8095 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8097 * @section Gengrid_Usage_Hints Usage hints
8099 * If the user wants to have multiple items selected at the same
8100 * time, elm_gengrid_multi_select_set() will permit it. If the
8101 * gengrid is single-selection only (the default), then
8102 * elm_gengrid_select_item_get() will return the selected item or
8103 * @c NULL, if none is selected. If the gengrid is under
8104 * multi-selection, then elm_gengrid_selected_items_get() will
8105 * return a list (that is only valid as long as no items are
8106 * modified (added, deleted, selected or unselected) of child items
8109 * If an item changes (internal (boolean) state, label or content
8110 * changes), then use elm_gengrid_item_update() to have gengrid
8111 * update the item with the new state. A gengrid will re-"realize"
8112 * the item, thus calling the functions in the
8113 * #Elm_Gengrid_Item_Class set for that item.
8115 * To programmatically (un)select an item, use
8116 * elm_gengrid_item_selected_set(). To get its selected state use
8117 * elm_gengrid_item_selected_get(). To make an item disabled
8118 * (unable to be selected and appear differently) use
8119 * elm_gengrid_item_disabled_set() to set this and
8120 * elm_gengrid_item_disabled_get() to get the disabled state.
8122 * Grid cells will only have their selection smart callbacks called
8123 * when firstly getting selected. Any further clicks will do
8124 * nothing, unless you enable the "always select mode", with
8125 * elm_gengrid_always_select_mode_set(), thus making every click to
8126 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8127 * turn off the ability to select items entirely in the widget and
8128 * they will neither appear selected nor call the selection smart
8131 * Remember that you can create new styles and add your own theme
8132 * augmentation per application with elm_theme_extension_add(). If
8133 * you absolutely must have a specific style that overrides any
8134 * theme the user or system sets up you can use
8135 * elm_theme_overlay_add() to add such a file.
8137 * @section Gengrid_Smart_Events Gengrid smart events
8139 * Smart events that you can add callbacks for are:
8140 * - @c "activated" - The user has double-clicked or pressed
8141 * (enter|return|spacebar) on an item. The @c event_info parameter
8142 * is the gengrid item that was activated.
8143 * - @c "clicked,double" - The user has double-clicked an item.
8144 * The @c event_info parameter is the gengrid item that was double-clicked.
8145 * - @c "longpressed" - This is called when the item is pressed for a certain
8146 * amount of time. By default it's 1 second.
8147 * - @c "selected" - The user has made an item selected. The
8148 * @c event_info parameter is the gengrid item that was selected.
8149 * - @c "unselected" - The user has made an item unselected. The
8150 * @c event_info parameter is the gengrid item that was unselected.
8151 * - @c "realized" - This is called when the item in the gengrid
8152 * has its implementing Evas object instantiated, de facto. @c
8153 * event_info is the gengrid item that was created. The object
8154 * may be deleted at any time, so it is highly advised to the
8155 * caller @b not to use the object pointer returned from
8156 * elm_gengrid_item_object_get(), because it may point to freed
8158 * - @c "unrealized" - This is called when the implementing Evas
8159 * object for this item is deleted. @c event_info is the gengrid
8160 * item that was deleted.
8161 * - @c "changed" - Called when an item is added, removed, resized
8162 * or moved and when the gengrid is resized or gets "horizontal"
8164 * - @c "scroll,anim,start" - This is called when scrolling animation has
8166 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8168 * - @c "drag,start,up" - Called when the item in the gengrid has
8169 * been dragged (not scrolled) up.
8170 * - @c "drag,start,down" - Called when the item in the gengrid has
8171 * been dragged (not scrolled) down.
8172 * - @c "drag,start,left" - Called when the item in the gengrid has
8173 * been dragged (not scrolled) left.
8174 * - @c "drag,start,right" - Called when the item in the gengrid has
8175 * been dragged (not scrolled) right.
8176 * - @c "drag,stop" - Called when the item in the gengrid has
8177 * stopped being dragged.
8178 * - @c "drag" - Called when the item in the gengrid is being
8180 * - @c "scroll" - called when the content has been scrolled
8182 * - @c "scroll,drag,start" - called when dragging the content has
8184 * - @c "scroll,drag,stop" - called when dragging the content has
8186 * - @c "edge,top" - This is called when the gengrid is scrolled until
8188 * - @c "edge,bottom" - This is called when the gengrid is scrolled
8189 * until the bottom edge.
8190 * - @c "edge,left" - This is called when the gengrid is scrolled
8191 * until the left edge.
8192 * - @c "edge,right" - This is called when the gengrid is scrolled
8193 * until the right edge.
8195 * List of gengrid examples:
8196 * @li @ref gengrid_example
8200 * @addtogroup Gengrid
8204 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8205 #define Elm_Gengrid_Item_Class Elm_Gen_Item_Class
8206 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8207 #define Elm_Gengrid_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
8208 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8209 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
8210 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. */
8211 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. */
8212 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
8215 * @struct _Elm_Gengrid_Item_Class
8217 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8220 struct _Elm_Gengrid_Item_Class
8222 const char *item_style;
8223 struct _Elm_Gengrid_Item_Class_Func
8225 Elm_Gengrid_Item_Label_Get_Cb label_get;
8226 Elm_Gengrid_Item_Content_Get_Cb content_get;
8227 Elm_Gengrid_Item_State_Get_Cb state_get;
8228 Elm_Gengrid_Item_Del_Cb del;
8230 }; /**< #Elm_Gengrid_Item_Class member definitions */
8231 #define Elm_Gengrid_Item_Class_Func Elm_Gen_Item_Class_Func
8233 * Add a new gengrid widget to the given parent Elementary
8234 * (container) object
8236 * @param parent The parent object
8237 * @return a new gengrid widget handle or @c NULL, on errors
8239 * This function inserts a new gengrid widget on the canvas.
8241 * @see elm_gengrid_item_size_set()
8242 * @see elm_gengrid_group_item_size_set()
8243 * @see elm_gengrid_horizontal_set()
8244 * @see elm_gengrid_item_append()
8245 * @see elm_gengrid_item_del()
8246 * @see elm_gengrid_clear()
8250 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8253 * Set the size for the items of a given gengrid widget
8255 * @param obj The gengrid object.
8256 * @param w The items' width.
8257 * @param h The items' height;
8259 * A gengrid, after creation, has still no information on the size
8260 * to give to each of its cells. So, you most probably will end up
8261 * with squares one @ref Fingers "finger" wide, the default
8262 * size. Use this function to force a custom size for you items,
8263 * making them as big as you wish.
8265 * @see elm_gengrid_item_size_get()
8269 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8272 * Get the size set for the items of a given gengrid widget
8274 * @param obj The gengrid object.
8275 * @param w Pointer to a variable where to store the items' width.
8276 * @param h Pointer to a variable where to store the items' height.
8278 * @note Use @c NULL pointers on the size values you're not
8279 * interested in: they'll be ignored by the function.
8281 * @see elm_gengrid_item_size_get() for more details
8285 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8288 * Set the size for the group items of a given gengrid widget
8290 * @param obj The gengrid object.
8291 * @param w The group items' width.
8292 * @param h The group items' height;
8294 * A gengrid, after creation, has still no information on the size
8295 * to give to each of its cells. So, you most probably will end up
8296 * with squares one @ref Fingers "finger" wide, the default
8297 * size. Use this function to force a custom size for you group items,
8298 * making them as big as you wish.
8300 * @see elm_gengrid_group_item_size_get()
8304 EAPI void elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8307 * Get the size set for the group items of a given gengrid widget
8309 * @param obj The gengrid object.
8310 * @param w Pointer to a variable where to store the group items' width.
8311 * @param h Pointer to a variable where to store the group items' height.
8313 * @note Use @c NULL pointers on the size values you're not
8314 * interested in: they'll be ignored by the function.
8316 * @see elm_gengrid_group_item_size_get() for more details
8320 EAPI void elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8323 * Set the items grid's alignment within a given gengrid widget
8325 * @param obj The gengrid object.
8326 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8327 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8329 * This sets the alignment of the whole grid of items of a gengrid
8330 * within its given viewport. By default, those values are both
8331 * 0.5, meaning that the gengrid will have its items grid placed
8332 * exactly in the middle of its viewport.
8334 * @note If given alignment values are out of the cited ranges,
8335 * they'll be changed to the nearest boundary values on the valid
8338 * @see elm_gengrid_align_get()
8342 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8345 * Get the items grid's alignment values within a given gengrid
8348 * @param obj The gengrid object.
8349 * @param align_x Pointer to a variable where to store the
8350 * horizontal alignment.
8351 * @param align_y Pointer to a variable where to store the vertical
8354 * @note Use @c NULL pointers on the alignment values you're not
8355 * interested in: they'll be ignored by the function.
8357 * @see elm_gengrid_align_set() for more details
8361 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8364 * Set whether a given gengrid widget is or not able have items
8367 * @param obj The gengrid object
8368 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8369 * @c EINA_FALSE to turn it off
8371 * If a gengrid is set to allow reordering, a click held for more
8372 * than 0.5 over a given item will highlight it specially,
8373 * signalling the gengrid has entered the reordering state. From
8374 * that time on, the user will be able to, while still holding the
8375 * mouse button down, move the item freely in the gengrid's
8376 * viewport, replacing to said item to the locations it goes to.
8377 * The replacements will be animated and, whenever the user
8378 * releases the mouse button, the item being replaced gets a new
8379 * definitive place in the grid.
8381 * @see elm_gengrid_reorder_mode_get()
8385 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8388 * Get whether a given gengrid widget is or not able have items
8391 * @param obj The gengrid object
8392 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8395 * @see elm_gengrid_reorder_mode_set() for more details
8399 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8402 * Append a new item in a given gengrid widget.
8404 * @param obj The gengrid object.
8405 * @param gic The item class for the item.
8406 * @param data The item data.
8407 * @param func Convenience function called when the item is
8409 * @param func_data Data to be passed to @p func.
8410 * @return A handle to the item added or @c NULL, on errors.
8412 * This adds an item to the beginning of the gengrid.
8414 * @see elm_gengrid_item_prepend()
8415 * @see elm_gengrid_item_insert_before()
8416 * @see elm_gengrid_item_insert_after()
8417 * @see elm_gengrid_item_del()
8421 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);
8424 * Prepend a new item in a given gengrid widget.
8426 * @param obj The gengrid object.
8427 * @param gic The item class for the item.
8428 * @param data The item data.
8429 * @param func Convenience function called when the item is
8431 * @param func_data Data to be passed to @p func.
8432 * @return A handle to the item added or @c NULL, on errors.
8434 * This adds an item to the end of the gengrid.
8436 * @see elm_gengrid_item_append()
8437 * @see elm_gengrid_item_insert_before()
8438 * @see elm_gengrid_item_insert_after()
8439 * @see elm_gengrid_item_del()
8443 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);
8446 * Insert an item before another in a gengrid widget
8448 * @param obj The gengrid object.
8449 * @param gic The item class for the item.
8450 * @param data The item data.
8451 * @param relative The item to place this new one before.
8452 * @param func Convenience function called when the item is
8454 * @param func_data Data to be passed to @p func.
8455 * @return A handle to the item added or @c NULL, on errors.
8457 * This inserts an item before another in the gengrid.
8459 * @see elm_gengrid_item_append()
8460 * @see elm_gengrid_item_prepend()
8461 * @see elm_gengrid_item_insert_after()
8462 * @see elm_gengrid_item_del()
8466 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);
8469 * Insert an item after another in a gengrid widget
8471 * @param obj The gengrid object.
8472 * @param gic The item class for the item.
8473 * @param data The item data.
8474 * @param relative The item to place this new one after.
8475 * @param func Convenience function called when the item is
8477 * @param func_data Data to be passed to @p func.
8478 * @return A handle to the item added or @c NULL, on errors.
8480 * This inserts an item after another in the gengrid.
8482 * @see elm_gengrid_item_append()
8483 * @see elm_gengrid_item_prepend()
8484 * @see elm_gengrid_item_insert_after()
8485 * @see elm_gengrid_item_del()
8489 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);
8491 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);
8493 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);
8496 * Set whether items on a given gengrid widget are to get their
8497 * selection callbacks issued for @b every subsequent selection
8498 * click on them or just for the first click.
8500 * @param obj The gengrid object
8501 * @param always_select @c EINA_TRUE to make items "always
8502 * selected", @c EINA_FALSE, otherwise
8504 * By default, grid items will only call their selection callback
8505 * function when firstly getting selected, any subsequent further
8506 * clicks will do nothing. With this call, you make those
8507 * subsequent clicks also to issue the selection callbacks.
8509 * @note <b>Double clicks</b> will @b always be reported on items.
8511 * @see elm_gengrid_always_select_mode_get()
8515 EINA_DEPRECATED EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8518 * Get whether items on a given gengrid widget have their selection
8519 * callbacks issued for @b every subsequent selection click on them
8520 * or just for the first click.
8522 * @param obj The gengrid object.
8523 * @return @c EINA_TRUE if the gengrid items are "always selected",
8524 * @c EINA_FALSE, otherwise
8526 * @see elm_gengrid_always_select_mode_set() for more details
8530 EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8533 * Set whether items on a given gengrid widget can be selected or not.
8535 * @param obj The gengrid object
8536 * @param no_select @c EINA_TRUE to make items selectable,
8537 * @c EINA_FALSE otherwise
8539 * This will make items in @p obj selectable or not. In the latter
8540 * case, any user interaction on the gengrid items will neither make
8541 * them appear selected nor them call their selection callback
8544 * @see elm_gengrid_no_select_mode_get()
8548 EINA_DEPRECATED EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8551 * Get whether items on a given gengrid widget can be selected or
8554 * @param obj The gengrid object
8555 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8558 * @see elm_gengrid_no_select_mode_set() for more details
8562 EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8565 * Enable or disable multi-selection in a given gengrid widget
8567 * @param obj The gengrid object.
8568 * @param multi @c EINA_TRUE, to enable multi-selection,
8569 * @c EINA_FALSE to disable it.
8571 * Multi-selection is the ability for one to have @b more than one
8572 * item selected, on a given gengrid, simultaneously. When it is
8573 * enabled, a sequence of clicks on different items will make them
8574 * all selected, progressively. A click on an already selected item
8575 * will unselect it. If interecting via the keyboard,
8576 * multi-selection is enabled while holding the "Shift" key.
8578 * @note By default, multi-selection is @b disabled on gengrids
8580 * @see elm_gengrid_multi_select_get()
8584 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8587 * Get whether multi-selection is enabled or disabled for a given
8590 * @param obj The gengrid object.
8591 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8592 * EINA_FALSE otherwise
8594 * @see elm_gengrid_multi_select_set() for more details
8598 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8601 * Enable or disable bouncing effect for a given gengrid widget
8603 * @param obj The gengrid object
8604 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8605 * @c EINA_FALSE to disable it
8606 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8607 * @c EINA_FALSE to disable it
8609 * The bouncing effect occurs whenever one reaches the gengrid's
8610 * edge's while panning it -- it will scroll past its limits a
8611 * little bit and return to the edge again, in a animated for,
8614 * @note By default, gengrids have bouncing enabled on both axis
8616 * @see elm_gengrid_bounce_get()
8620 EINA_DEPRECATED EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8623 * Get whether bouncing effects are enabled or disabled, for a
8624 * given gengrid widget, on each axis
8626 * @param obj The gengrid object
8627 * @param h_bounce Pointer to a variable where to store the
8628 * horizontal bouncing flag.
8629 * @param v_bounce Pointer to a variable where to store the
8630 * vertical bouncing flag.
8632 * @see elm_gengrid_bounce_set() for more details
8636 EINA_DEPRECATED EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8639 * Set a given gengrid widget's scrolling page size, relative to
8640 * its viewport size.
8642 * @param obj The gengrid object
8643 * @param h_pagerel The horizontal page (relative) size
8644 * @param v_pagerel The vertical page (relative) size
8646 * The gengrid's scroller is capable of binding scrolling by the
8647 * user to "pages". It means that, while scrolling and, specially
8648 * after releasing the mouse button, the grid will @b snap to the
8649 * nearest displaying page's area. When page sizes are set, the
8650 * grid's continuous content area is split into (equal) page sized
8653 * This function sets the size of a page <b>relatively to the
8654 * viewport dimensions</b> of the gengrid, for each axis. A value
8655 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8656 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8657 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8658 * 1.0. Values beyond those will make it behave behave
8659 * inconsistently. If you only want one axis to snap to pages, use
8660 * the value @c 0.0 for the other one.
8662 * There is a function setting page size values in @b absolute
8663 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8664 * is mutually exclusive to this one.
8666 * @see elm_gengrid_page_relative_get()
8670 EINA_DEPRECATED EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8673 * Get a given gengrid widget's scrolling page size, relative to
8674 * its viewport size.
8676 * @param obj The gengrid object
8677 * @param h_pagerel Pointer to a variable where to store the
8678 * horizontal page (relative) size
8679 * @param v_pagerel Pointer to a variable where to store the
8680 * vertical page (relative) size
8682 * @see elm_gengrid_page_relative_set() for more details
8686 EINA_DEPRECATED EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8689 * Set a given gengrid widget's scrolling page size
8691 * @param obj The gengrid object
8692 * @param h_pagerel The horizontal page size, in pixels
8693 * @param v_pagerel The vertical page size, in pixels
8695 * The gengrid's scroller is capable of binding scrolling by the
8696 * user to "pages". It means that, while scrolling and, specially
8697 * after releasing the mouse button, the grid will @b snap to the
8698 * nearest displaying page's area. When page sizes are set, the
8699 * grid's continuous content area is split into (equal) page sized
8702 * This function sets the size of a page of the gengrid, in pixels,
8703 * for each axis. Sane usable values are, between @c 0 and the
8704 * dimensions of @p obj, for each axis. Values beyond those will
8705 * make it behave behave inconsistently. If you only want one axis
8706 * to snap to pages, use the value @c 0 for the other one.
8708 * There is a function setting page size values in @b relative
8709 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8710 * use is mutually exclusive to this one.
8714 EINA_DEPRECATED EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8717 * @brief Get gengrid current page number.
8719 * @param obj The gengrid object
8720 * @param h_pagenumber The horizontal page number
8721 * @param v_pagenumber The vertical page number
8723 * The page number starts from 0. 0 is the first page.
8724 * Current page means the page which meet the top-left of the viewport.
8725 * If there are two or more pages in the viewport, it returns the number of page
8726 * which meet the top-left of the viewport.
8728 * @see elm_gengrid_last_page_get()
8729 * @see elm_gengrid_page_show()
8730 * @see elm_gengrid_page_brint_in()
8732 EINA_DEPRECATED EAPI void elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8735 * @brief Get scroll last page number.
8737 * @param obj The gengrid object
8738 * @param h_pagenumber The horizontal page number
8739 * @param v_pagenumber The vertical page number
8741 * The page number starts from 0. 0 is the first page.
8742 * This returns the last page number among the pages.
8744 * @see elm_gengrid_current_page_get()
8745 * @see elm_gengrid_page_show()
8746 * @see elm_gengrid_page_brint_in()
8748 EINA_DEPRECATED EAPI void elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8751 * Show a specific virtual region within the gengrid content object by page number.
8753 * @param obj The gengrid object
8754 * @param h_pagenumber The horizontal page number
8755 * @param v_pagenumber The vertical page number
8757 * 0, 0 of the indicated page is located at the top-left of the viewport.
8758 * This will jump to the page directly without animation.
8763 * sc = elm_gengrid_add(win);
8764 * elm_gengrid_content_set(sc, content);
8765 * elm_gengrid_page_relative_set(sc, 1, 0);
8766 * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8767 * elm_gengrid_page_show(sc, h_page + 1, v_page);
8770 * @see elm_gengrid_page_bring_in()
8772 EINA_DEPRECATED EAPI void elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8775 * Show a specific virtual region within the gengrid content object by page number.
8777 * @param obj The gengrid object
8778 * @param h_pagenumber The horizontal page number
8779 * @param v_pagenumber The vertical page number
8781 * 0, 0 of the indicated page is located at the top-left of the viewport.
8782 * This will slide to the page with animation.
8787 * sc = elm_gengrid_add(win);
8788 * elm_gengrid_content_set(sc, content);
8789 * elm_gengrid_page_relative_set(sc, 1, 0);
8790 * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8791 * elm_gengrid_page_bring_in(sc, h_page, v_page);
8794 * @see elm_gengrid_page_show()
8796 EINA_DEPRECATED EAPI void elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8799 * Set for what direction a given gengrid widget will expand while
8800 * placing its items.
8802 * @param obj The gengrid object.
8803 * @param setting @c EINA_TRUE to make the gengrid expand
8804 * horizontally, @c EINA_FALSE to expand vertically.
8806 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8807 * in @b columns, from top to bottom and, when the space for a
8808 * column is filled, another one is started on the right, thus
8809 * expanding the grid horizontally. When in "vertical mode"
8810 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8811 * to right and, when the space for a row is filled, another one is
8812 * started below, thus expanding the grid vertically.
8814 * @see elm_gengrid_horizontal_get()
8818 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8821 * Get for what direction a given gengrid widget will expand while
8822 * placing its items.
8824 * @param obj The gengrid object.
8825 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8826 * @c EINA_FALSE if it's set to expand vertically.
8828 * @see elm_gengrid_horizontal_set() for more detais
8832 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8835 * Get the first item in a given gengrid widget
8837 * @param obj The gengrid object
8838 * @return The first item's handle or @c NULL, if there are no
8839 * items in @p obj (and on errors)
8841 * This returns the first item in the @p obj's internal list of
8844 * @see elm_gengrid_last_item_get()
8848 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8851 * Get the last item in a given gengrid widget
8853 * @param obj The gengrid object
8854 * @return The last item's handle or @c NULL, if there are no
8855 * items in @p obj (and on errors)
8857 * This returns the last item in the @p obj's internal list of
8860 * @see elm_gengrid_first_item_get()
8864 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8867 * Get the @b next item in a gengrid widget's internal list of items,
8868 * given a handle to one of those items.
8870 * @param item The gengrid item to fetch next from
8871 * @return The item after @p item, or @c NULL if there's none (and
8874 * This returns the item placed after the @p item, on the container
8877 * @see elm_gengrid_item_prev_get()
8881 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8884 * Get the @b previous item in a gengrid widget's internal list of items,
8885 * given a handle to one of those items.
8887 * @param item The gengrid item to fetch previous from
8888 * @return The item before @p item, or @c NULL if there's none (and
8891 * This returns the item placed before the @p item, on the container
8894 * @see elm_gengrid_item_next_get()
8898 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8901 * Get the gengrid object's handle which contains a given gengrid
8904 * @param item The item to fetch the container from
8905 * @return The gengrid (parent) object
8907 * This returns the gengrid object itself that an item belongs to.
8911 EINA_DEPRECATED EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8914 * Remove a gengrid item from the its parent, deleting it.
8916 * @param item The item to be removed.
8917 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8919 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8924 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8927 * Update the contents of a given gengrid item
8929 * @param item The gengrid item
8931 * This updates an item by calling all the item class functions
8932 * again to get the contents, labels and states. Use this when the
8933 * original item data has changed and you want thta changes to be
8938 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8939 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8940 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8943 * Return the data associated to a given gengrid item
8945 * @param item The gengrid item.
8946 * @return the data associated to this item.
8948 * This returns the @c data value passed on the
8949 * elm_gengrid_item_append() and related item addition calls.
8951 * @see elm_gengrid_item_append()
8952 * @see elm_gengrid_item_data_set()
8956 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8959 * Set the data associated to a given gengrid item
8961 * @param item The gengrid item
8962 * @param data The new data pointer to set on it
8964 * This @b overrides the @c data value passed on the
8965 * elm_gengrid_item_append() and related item addition calls. This
8966 * function @b won't call elm_gengrid_item_update() automatically,
8967 * so you'd issue it afterwards if you want to hove the item
8968 * updated to reflect the that new data.
8970 * @see elm_gengrid_item_data_get()
8974 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8977 * Get a given gengrid item's position, relative to the whole
8978 * gengrid's grid area.
8980 * @param item The Gengrid item.
8981 * @param x Pointer to variable where to store the item's <b>row
8983 * @param y Pointer to variable where to store the item's <b>column
8986 * This returns the "logical" position of the item whithin the
8987 * gengrid. For example, @c (0, 1) would stand for first row,
8992 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8995 * Set whether a given gengrid item is selected or not
8997 * @param item The gengrid item
8998 * @param selected Use @c EINA_TRUE, to make it selected, @c
8999 * EINA_FALSE to make it unselected
9001 * This sets the selected state of an item. If multi selection is
9002 * not enabled on the containing gengrid and @p selected is @c
9003 * EINA_TRUE, any other previously selected items will get
9004 * unselected in favor of this new one.
9006 * @see elm_gengrid_item_selected_get()
9010 EINA_DEPRECATED EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9013 * Get whether a given gengrid item is selected or not
9015 * @param item The gengrid item
9016 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9018 * @see elm_gengrid_item_selected_set() for more details
9022 EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9025 * Get the real Evas object created to implement the view of a
9026 * given gengrid item
9028 * @param item The gengrid item.
9029 * @return the Evas object implementing this item's view.
9031 * This returns the actual Evas object used to implement the
9032 * specified gengrid item's view. This may be @c NULL, as it may
9033 * not have been created or may have been deleted, at any time, by
9034 * the gengrid. <b>Do not modify this object</b> (move, resize,
9035 * show, hide, etc.), as the gengrid is controlling it. This
9036 * function is for querying, emitting custom signals or hooking
9037 * lower level callbacks for events on that object. Do not delete
9038 * this object under any circumstances.
9040 * @see elm_gengrid_item_data_get()
9044 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9047 * Show the portion of a gengrid's internal grid containing a given
9048 * item, @b immediately.
9050 * @param item The item to display
9052 * This causes gengrid to @b redraw its viewport's contents to the
9053 * region contining the given @p item item, if it is not fully
9056 * @see elm_gengrid_item_bring_in()
9060 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9063 * Animatedly bring in, to the visible are of a gengrid, a given
9066 * @param item The gengrid item to display
9068 * This causes gengrig to jump to the given @p item item and show
9069 * it (by scrolling), if it is not fully visible. This will use
9070 * animation to do so and take a period of time to complete.
9072 * @see elm_gengrid_item_show()
9076 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9079 * Set whether a given gengrid item is disabled or not.
9081 * @param item The gengrid item
9082 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9083 * to enable it back.
9085 * A disabled item cannot be selected or unselected. It will also
9086 * change its appearance, to signal the user it's disabled.
9088 * @see elm_gengrid_item_disabled_get()
9092 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9095 * Get whether a given gengrid item is disabled or not.
9097 * @param item The gengrid item
9098 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9101 * @see elm_gengrid_item_disabled_set() for more details
9105 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9108 * Set the text to be shown in a given gengrid item's tooltips.
9110 * @param item The gengrid item
9111 * @param text The text to set in the content
9113 * This call will setup the text to be used as tooltip to that item
9114 * (analogous to elm_object_tooltip_text_set(), but being item
9115 * tooltips with higher precedence than object tooltips). It can
9116 * have only one tooltip at a time, so any previous tooltip data
9121 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9124 * Set the content to be shown in a given gengrid item's tooltips
9126 * @param item The gengrid item.
9127 * @param func The function returning the tooltip contents.
9128 * @param data What to provide to @a func as callback data/context.
9129 * @param del_cb Called when data is not needed anymore, either when
9130 * another callback replaces @p func, the tooltip is unset with
9131 * elm_gengrid_item_tooltip_unset() or the owner @p item
9132 * dies. This callback receives as its first parameter the
9133 * given @p data, being @c event_info the item handle.
9135 * This call will setup the tooltip's contents to @p item
9136 * (analogous to elm_object_tooltip_content_cb_set(), but being
9137 * item tooltips with higher precedence than object tooltips). It
9138 * can have only one tooltip at a time, so any previous tooltip
9139 * content will get removed. @p func (with @p data) will be called
9140 * every time Elementary needs to show the tooltip and it should
9141 * return a valid Evas object, which will be fully managed by the
9142 * tooltip system, getting deleted when the tooltip is gone.
9146 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);
9149 * Unset a tooltip from a given gengrid item
9151 * @param item gengrid item to remove a previously set tooltip from.
9153 * This call removes any tooltip set on @p item. The callback
9154 * provided as @c del_cb to
9155 * elm_gengrid_item_tooltip_content_cb_set() will be called to
9156 * notify it is not used anymore (and have resources cleaned, if
9159 * @see elm_gengrid_item_tooltip_content_cb_set()
9163 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9166 * Set a different @b style for a given gengrid item's tooltip.
9168 * @param item gengrid item with tooltip set
9169 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9170 * "default", @c "transparent", etc)
9172 * Tooltips can have <b>alternate styles</b> to be displayed on,
9173 * which are defined by the theme set on Elementary. This function
9174 * works analogously as elm_object_tooltip_style_set(), but here
9175 * applied only to gengrid item objects. The default style for
9176 * tooltips is @c "default".
9178 * @note before you set a style you should define a tooltip with
9179 * elm_gengrid_item_tooltip_content_cb_set() or
9180 * elm_gengrid_item_tooltip_text_set()
9182 * @see elm_gengrid_item_tooltip_style_get()
9186 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9189 * Get the style set a given gengrid item's tooltip.
9191 * @param item gengrid item with tooltip already set on.
9192 * @return style the theme style in use, which defaults to
9193 * "default". If the object does not have a tooltip set,
9194 * then @c NULL is returned.
9196 * @see elm_gengrid_item_tooltip_style_set() for more details
9200 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9202 * @brief Disable size restrictions on an object's tooltip
9203 * @param item The tooltip's anchor object
9204 * @param disable If EINA_TRUE, size restrictions are disabled
9205 * @return EINA_FALSE on failure, EINA_TRUE on success
9207 * This function allows a tooltip to expand beyond its parant window's canvas.
9208 * It will instead be limited only by the size of the display.
9210 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9212 * @brief Retrieve size restriction state of an object's tooltip
9213 * @param item The tooltip's anchor object
9214 * @return If EINA_TRUE, size restrictions are disabled
9216 * This function returns whether a tooltip is allowed to expand beyond
9217 * its parant window's canvas.
9218 * It will instead be limited only by the size of the display.
9220 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9222 * Set the type of mouse pointer/cursor decoration to be shown,
9223 * when the mouse pointer is over the given gengrid widget item
9225 * @param item gengrid item to customize cursor on
9226 * @param cursor the cursor type's name
9228 * This function works analogously as elm_object_cursor_set(), but
9229 * here the cursor's changing area is restricted to the item's
9230 * area, and not the whole widget's. Note that that item cursors
9231 * have precedence over widget cursors, so that a mouse over @p
9232 * item will always show cursor @p type.
9234 * If this function is called twice for an object, a previously set
9235 * cursor will be unset on the second call.
9237 * @see elm_object_cursor_set()
9238 * @see elm_gengrid_item_cursor_get()
9239 * @see elm_gengrid_item_cursor_unset()
9243 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9246 * Get the type of mouse pointer/cursor decoration set to be shown,
9247 * when the mouse pointer is over the given gengrid widget item
9249 * @param item gengrid item with custom cursor set
9250 * @return the cursor type's name or @c NULL, if no custom cursors
9251 * were set to @p item (and on errors)
9253 * @see elm_object_cursor_get()
9254 * @see elm_gengrid_item_cursor_set() for more details
9255 * @see elm_gengrid_item_cursor_unset()
9259 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9262 * Unset any custom mouse pointer/cursor decoration set to be
9263 * shown, when the mouse pointer is over the given gengrid widget
9264 * item, thus making it show the @b default cursor again.
9266 * @param item a gengrid item
9268 * Use this call to undo any custom settings on this item's cursor
9269 * decoration, bringing it back to defaults (no custom style set).
9271 * @see elm_object_cursor_unset()
9272 * @see elm_gengrid_item_cursor_set() for more details
9276 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9279 * Set a different @b style for a given custom cursor set for a
9282 * @param item gengrid item with custom cursor set
9283 * @param style the <b>theme style</b> to use (e.g. @c "default",
9284 * @c "transparent", etc)
9286 * This function only makes sense when one is using custom mouse
9287 * cursor decorations <b>defined in a theme file</b> , which can
9288 * have, given a cursor name/type, <b>alternate styles</b> on
9289 * it. It works analogously as elm_object_cursor_style_set(), but
9290 * here applied only to gengrid item objects.
9292 * @warning Before you set a cursor style you should have defined a
9293 * custom cursor previously on the item, with
9294 * elm_gengrid_item_cursor_set()
9296 * @see elm_gengrid_item_cursor_engine_only_set()
9297 * @see elm_gengrid_item_cursor_style_get()
9301 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9304 * Get the current @b style set for a given gengrid item's custom
9307 * @param item gengrid item with custom cursor set.
9308 * @return style the cursor style in use. If the object does not
9309 * have a cursor set, then @c NULL is returned.
9311 * @see elm_gengrid_item_cursor_style_set() for more details
9315 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9318 * Set if the (custom) cursor for a given gengrid item should be
9319 * searched in its theme, also, or should only rely on the
9322 * @param item item with custom (custom) cursor already set on
9323 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9324 * only on those provided by the rendering engine, @c EINA_FALSE to
9325 * have them searched on the widget's theme, as well.
9327 * @note This call is of use only if you've set a custom cursor
9328 * for gengrid items, with elm_gengrid_item_cursor_set().
9330 * @note By default, cursors will only be looked for between those
9331 * provided by the rendering engine.
9335 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9338 * Get if the (custom) cursor for a given gengrid item is being
9339 * searched in its theme, also, or is only relying on the rendering
9342 * @param item a gengrid item
9343 * @return @c EINA_TRUE, if cursors are being looked for only on
9344 * those provided by the rendering engine, @c EINA_FALSE if they
9345 * are being searched on the widget's theme, as well.
9347 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9351 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9354 * Remove all items from a given gengrid widget
9356 * @param obj The gengrid object.
9358 * This removes (and deletes) all items in @p obj, leaving it
9361 * @see elm_gengrid_item_del(), to remove just one item.
9365 EINA_DEPRECATED EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9368 * Get the selected item in a given gengrid widget
9370 * @param obj The gengrid object.
9371 * @return The selected item's handleor @c NULL, if none is
9372 * selected at the moment (and on errors)
9374 * This returns the selected item in @p obj. If multi selection is
9375 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9376 * the first item in the list is selected, which might not be very
9377 * useful. For that case, see elm_gengrid_selected_items_get().
9381 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9384 * Get <b>a list</b> of selected items in a given gengrid
9386 * @param obj The gengrid object.
9387 * @return The list of selected items or @c NULL, if none is
9388 * selected at the moment (and on errors)
9390 * This returns a list of the selected items, in the order that
9391 * they appear in the grid. This list is only valid as long as no
9392 * more items are selected or unselected (or unselected implictly
9393 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9396 * @see elm_gengrid_selected_item_get()
9400 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9407 * @defgroup Clock Clock
9409 * @image html img/widget/clock/preview-00.png
9410 * @image latex img/widget/clock/preview-00.eps
9412 * This is a @b digital clock widget. In its default theme, it has a
9413 * vintage "flipping numbers clock" appearance, which will animate
9414 * sheets of individual algarisms individually as time goes by.
9416 * A newly created clock will fetch system's time (already
9417 * considering local time adjustments) to start with, and will tick
9418 * accondingly. It may or may not show seconds.
9420 * Clocks have an @b edition mode. When in it, the sheets will
9421 * display extra arrow indications on the top and bottom and the
9422 * user may click on them to raise or lower the time values. After
9423 * it's told to exit edition mode, it will keep ticking with that
9424 * new time set (it keeps the difference from local time).
9426 * Also, when under edition mode, user clicks on the cited arrows
9427 * which are @b held for some time will make the clock to flip the
9428 * sheet, thus editing the time, continuosly and automatically for
9429 * the user. The interval between sheet flips will keep growing in
9430 * time, so that it helps the user to reach a time which is distant
9433 * The time display is, by default, in military mode (24h), but an
9434 * am/pm indicator may be optionally shown, too, when it will
9437 * Smart callbacks one can register to:
9438 * - "changed" - the clock's user changed the time
9440 * Here is an example on its usage:
9441 * @li @ref clock_example
9450 * Identifiers for which clock digits should be editable, when a
9451 * clock widget is in edition mode. Values may be ORed together to
9452 * make a mask, naturally.
9454 * @see elm_clock_edit_set()
9455 * @see elm_clock_digit_edit_set()
9457 typedef enum _Elm_Clock_Digedit
9459 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9460 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9461 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9462 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9463 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9464 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9465 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9466 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9467 } Elm_Clock_Digedit;
9470 * Add a new clock widget to the given parent Elementary
9471 * (container) object
9473 * @param parent The parent object
9474 * @return a new clock widget handle or @c NULL, on errors
9476 * This function inserts a new clock widget on the canvas.
9480 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9483 * Set a clock widget's time, programmatically
9485 * @param obj The clock widget object
9486 * @param hrs The hours to set
9487 * @param min The minutes to set
9488 * @param sec The secondes to set
9490 * This function updates the time that is showed by the clock
9493 * Values @b must be set within the following ranges:
9494 * - 0 - 23, for hours
9495 * - 0 - 59, for minutes
9496 * - 0 - 59, for seconds,
9498 * even if the clock is not in "military" mode.
9500 * @warning The behavior for values set out of those ranges is @b
9505 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9508 * Get a clock widget's time values
9510 * @param obj The clock object
9511 * @param[out] hrs Pointer to the variable to get the hours value
9512 * @param[out] min Pointer to the variable to get the minutes value
9513 * @param[out] sec Pointer to the variable to get the seconds value
9515 * This function gets the time set for @p obj, returning
9516 * it on the variables passed as the arguments to function
9518 * @note Use @c NULL pointers on the time values you're not
9519 * interested in: they'll be ignored by the function.
9523 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9526 * Set whether a given clock widget is under <b>edition mode</b> or
9527 * under (default) displaying-only mode.
9529 * @param obj The clock object
9530 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9531 * put it back to "displaying only" mode
9533 * This function makes a clock's time to be editable or not <b>by
9534 * user interaction</b>. When in edition mode, clocks @b stop
9535 * ticking, until one brings them back to canonical mode. The
9536 * elm_clock_digit_edit_set() function will influence which digits
9537 * of the clock will be editable. By default, all of them will be
9538 * (#ELM_CLOCK_NONE).
9540 * @note am/pm sheets, if being shown, will @b always be editable
9541 * under edition mode.
9543 * @see elm_clock_edit_get()
9547 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9550 * Retrieve whether a given clock widget is under <b>edition
9551 * mode</b> or under (default) displaying-only mode.
9553 * @param obj The clock object
9554 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9557 * This function retrieves whether the clock's time can be edited
9558 * or not by user interaction.
9560 * @see elm_clock_edit_set() for more details
9564 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9567 * Set what digits of the given clock widget should be editable
9568 * when in edition mode.
9570 * @param obj The clock object
9571 * @param digedit Bit mask indicating the digits to be editable
9572 * (values in #Elm_Clock_Digedit).
9574 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9575 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9578 * @see elm_clock_digit_edit_get()
9582 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9585 * Retrieve what digits of the given clock widget should be
9586 * editable when in edition mode.
9588 * @param obj The clock object
9589 * @return Bit mask indicating the digits to be editable
9590 * (values in #Elm_Clock_Digedit).
9592 * @see elm_clock_digit_edit_set() for more details
9596 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9599 * Set if the given clock widget must show hours in military or
9602 * @param obj The clock object
9603 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9606 * This function sets if the clock must show hours in military or
9607 * am/pm mode. In some countries like Brazil the military mode
9608 * (00-24h-format) is used, in opposition to the USA, where the
9609 * am/pm mode is more commonly used.
9611 * @see elm_clock_show_am_pm_get()
9615 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9618 * Get if the given clock widget shows hours in military or am/pm
9621 * @param obj The clock object
9622 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9625 * This function gets if the clock shows hours in military or am/pm
9628 * @see elm_clock_show_am_pm_set() for more details
9632 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9635 * Set if the given clock widget must show time with seconds or not
9637 * @param obj The clock object
9638 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9640 * This function sets if the given clock must show or not elapsed
9641 * seconds. By default, they are @b not shown.
9643 * @see elm_clock_show_seconds_get()
9647 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9650 * Get whether the given clock widget is showing time with seconds
9653 * @param obj The clock object
9654 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9656 * This function gets whether @p obj is showing or not the elapsed
9659 * @see elm_clock_show_seconds_set()
9663 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9666 * Set the interval on time updates for an user mouse button hold
9667 * on clock widgets' time edition.
9669 * @param obj The clock object
9670 * @param interval The (first) interval value in seconds
9672 * This interval value is @b decreased while the user holds the
9673 * mouse pointer either incrementing or decrementing a given the
9674 * clock digit's value.
9676 * This helps the user to get to a given time distant from the
9677 * current one easier/faster, as it will start to flip quicker and
9678 * quicker on mouse button holds.
9680 * The calculation for the next flip interval value, starting from
9681 * the one set with this call, is the previous interval divided by
9682 * 1.05, so it decreases a little bit.
9684 * The default starting interval value for automatic flips is
9687 * @see elm_clock_interval_get()
9691 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9694 * Get the interval on time updates for an user mouse button hold
9695 * on clock widgets' time edition.
9697 * @param obj The clock object
9698 * @return The (first) interval value, in seconds, set on it
9700 * @see elm_clock_interval_set() for more details
9704 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9711 * @defgroup Layout Layout
9713 * @image html img/widget/layout/preview-00.png
9714 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9716 * @image html img/layout-predefined.png
9717 * @image latex img/layout-predefined.eps width=\textwidth
9719 * This is a container widget that takes a standard Edje design file and
9720 * wraps it very thinly in a widget.
9722 * An Edje design (theme) file has a very wide range of possibilities to
9723 * describe the behavior of elements added to the Layout. Check out the Edje
9724 * documentation and the EDC reference to get more information about what can
9725 * be done with Edje.
9727 * Just like @ref List, @ref Box, and other container widgets, any
9728 * object added to the Layout will become its child, meaning that it will be
9729 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9731 * The Layout widget can contain as many Contents, Boxes or Tables as
9732 * described in its theme file. For instance, objects can be added to
9733 * different Tables by specifying the respective Table part names. The same
9734 * is valid for Content and Box.
9736 * The objects added as child of the Layout will behave as described in the
9737 * part description where they were added. There are 3 possible types of
9738 * parts where a child can be added:
9740 * @section secContent Content (SWALLOW part)
9742 * Only one object can be added to the @c SWALLOW part (but you still can
9743 * have many @c SWALLOW parts and one object on each of them). Use the @c
9744 * elm_object_content_set/get/unset functions to set, retrieve and unset
9745 * objects as content of the @c SWALLOW. After being set to this part, the
9746 * object size, position, visibility, clipping and other description
9747 * properties will be totally controled by the description of the given part
9748 * (inside the Edje theme file).
9750 * One can use @c evas_object_size_hint_* functions on the child to have some
9751 * kind of control over its behavior, but the resulting behavior will still
9752 * depend heavily on the @c SWALLOW part description.
9754 * The Edje theme also can change the part description, based on signals or
9755 * scripts running inside the theme. This change can also be animated. All of
9756 * this will affect the child object set as content accordingly. The object
9757 * size will be changed if the part size is changed, it will animate move if
9758 * the part is moving, and so on.
9760 * The following picture demonstrates a Layout widget with a child object
9761 * added to its @c SWALLOW:
9763 * @image html layout_swallow.png
9764 * @image latex layout_swallow.eps width=\textwidth
9766 * @section secBox Box (BOX part)
9768 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9769 * allows one to add objects to the box and have them distributed along its
9770 * area, accordingly to the specified @a layout property (now by @a layout we
9771 * mean the chosen layouting design of the Box, not the Layout widget
9774 * A similar effect for having a box with its position, size and other things
9775 * controled by the Layout theme would be to create an Elementary @ref Box
9776 * widget and add it as a Content in the @c SWALLOW part.
9778 * The main difference of using the Layout Box is that its behavior, the box
9779 * properties like layouting format, padding, align, etc. will be all
9780 * controled by the theme. This means, for example, that a signal could be
9781 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9782 * handled the signal by changing the box padding, or align, or both. Using
9783 * the Elementary @ref Box widget is not necessarily harder or easier, it
9784 * just depends on the circunstances and requirements.
9786 * The Layout Box can be used through the @c elm_layout_box_* set of
9789 * The following picture demonstrates a Layout widget with many child objects
9790 * added to its @c BOX part:
9792 * @image html layout_box.png
9793 * @image latex layout_box.eps width=\textwidth
9795 * @section secTable Table (TABLE part)
9797 * Just like the @ref secBox, the Layout Table is very similar to the
9798 * Elementary @ref Table widget. It allows one to add objects to the Table
9799 * specifying the row and column where the object should be added, and any
9800 * column or row span if necessary.
9802 * Again, we could have this design by adding a @ref Table widget to the @c
9803 * SWALLOW part using elm_object_content_part_set(). The same difference happens
9804 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9805 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9807 * The Layout Table can be used through the @c elm_layout_table_* set of
9810 * The following picture demonstrates a Layout widget with many child objects
9811 * added to its @c TABLE part:
9813 * @image html layout_table.png
9814 * @image latex layout_table.eps width=\textwidth
9816 * @section secPredef Predefined Layouts
9818 * Another interesting thing about the Layout widget is that it offers some
9819 * predefined themes that come with the default Elementary theme. These
9820 * themes can be set by the call elm_layout_theme_set(), and provide some
9821 * basic functionality depending on the theme used.
9823 * Most of them already send some signals, some already provide a toolbar or
9824 * back and next buttons.
9826 * These are available predefined theme layouts. All of them have class = @c
9827 * layout, group = @c application, and style = one of the following options:
9829 * @li @c toolbar-content - application with toolbar and main content area
9830 * @li @c toolbar-content-back - application with toolbar and main content
9831 * area with a back button and title area
9832 * @li @c toolbar-content-back-next - application with toolbar and main
9833 * content area with a back and next buttons and title area
9834 * @li @c content-back - application with a main content area with a back
9835 * button and title area
9836 * @li @c content-back-next - application with a main content area with a
9837 * back and next buttons and title area
9838 * @li @c toolbar-vbox - application with toolbar and main content area as a
9840 * @li @c toolbar-table - application with toolbar and main content area as a
9843 * @section secExamples Examples
9845 * Some examples of the Layout widget can be found here:
9846 * @li @ref layout_example_01
9847 * @li @ref layout_example_02
9848 * @li @ref layout_example_03
9849 * @li @ref layout_example_edc
9854 * Add a new layout to the parent
9856 * @param parent The parent object
9857 * @return The new object or NULL if it cannot be created
9859 * @see elm_layout_file_set()
9860 * @see elm_layout_theme_set()
9864 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9866 * Set the file that will be used as layout
9868 * @param obj The layout object
9869 * @param file The path to file (edj) that will be used as layout
9870 * @param group The group that the layout belongs in edje file
9872 * @return (1 = success, 0 = error)
9876 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9878 * Set the edje group from the elementary theme that will be used as layout
9880 * @param obj The layout object
9881 * @param clas the clas of the group
9882 * @param group the group
9883 * @param style the style to used
9885 * @return (1 = success, 0 = error)
9889 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9891 * Set the layout content.
9893 * @param obj The layout object
9894 * @param swallow The swallow part name in the edje file
9895 * @param content The child that will be added in this layout object
9897 * Once the content object is set, a previously set one will be deleted.
9898 * If you want to keep that old content object, use the
9899 * elm_object_content_part_unset() function.
9901 * @note In an Edje theme, the part used as a content container is called @c
9902 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9903 * expected to be a part name just like the second parameter of
9904 * elm_layout_box_append().
9906 * @see elm_layout_box_append()
9907 * @see elm_object_content_part_get()
9908 * @see elm_object_content_part_unset()
9913 EINA_DEPRECATED EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9915 * Get the child object in the given content part.
9917 * @param obj The layout object
9918 * @param swallow The SWALLOW part to get its content
9920 * @return The swallowed object or NULL if none or an error occurred
9922 * @see elm_object_content_part_set()
9926 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9928 * Unset the layout content.
9930 * @param obj The layout object
9931 * @param swallow The swallow part name in the edje file
9932 * @return The content that was being used
9934 * Unparent and return the content object which was set for this part.
9936 * @see elm_object_content_part_set()
9940 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9942 * Set the text of the given part
9944 * @param obj The layout object
9945 * @param part The TEXT part where to set the text
9946 * @param text The text to set
9949 * @deprecated use elm_object_text_* instead.
9951 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9953 * Get the text set in the given part
9955 * @param obj The layout object
9956 * @param part The TEXT part to retrieve the text off
9958 * @return The text set in @p part
9961 * @deprecated use elm_object_text_* instead.
9963 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9965 * Append child to layout box part.
9967 * @param obj the layout object
9968 * @param part the box part to which the object will be appended.
9969 * @param child the child object to append to box.
9971 * Once the object is appended, it will become child of the layout. Its
9972 * lifetime will be bound to the layout, whenever the layout dies the child
9973 * will be deleted automatically. One should use elm_layout_box_remove() to
9974 * make this layout forget about the object.
9976 * @see elm_layout_box_prepend()
9977 * @see elm_layout_box_insert_before()
9978 * @see elm_layout_box_insert_at()
9979 * @see elm_layout_box_remove()
9983 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9985 * Prepend child to layout box part.
9987 * @param obj the layout object
9988 * @param part the box part to prepend.
9989 * @param child the child object to prepend to box.
9991 * Once the object is prepended, it will become child of the layout. Its
9992 * lifetime will be bound to the layout, whenever the layout dies the child
9993 * will be deleted automatically. One should use elm_layout_box_remove() to
9994 * make this layout forget about the object.
9996 * @see elm_layout_box_append()
9997 * @see elm_layout_box_insert_before()
9998 * @see elm_layout_box_insert_at()
9999 * @see elm_layout_box_remove()
10003 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10005 * Insert child to layout box part before a reference object.
10007 * @param obj the layout object
10008 * @param part the box part to insert.
10009 * @param child the child object to insert into box.
10010 * @param reference another reference object to insert before in box.
10012 * Once the object is inserted, it will become child of the layout. Its
10013 * lifetime will be bound to the layout, whenever the layout dies the child
10014 * will be deleted automatically. One should use elm_layout_box_remove() to
10015 * make this layout forget about the object.
10017 * @see elm_layout_box_append()
10018 * @see elm_layout_box_prepend()
10019 * @see elm_layout_box_insert_before()
10020 * @see elm_layout_box_remove()
10024 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10026 * Insert child to layout box part at a given position.
10028 * @param obj the layout object
10029 * @param part the box part to insert.
10030 * @param child the child object to insert into box.
10031 * @param pos the numeric position >=0 to insert the child.
10033 * Once the object is inserted, it will become child of the layout. Its
10034 * lifetime will be bound to the layout, whenever the layout dies the child
10035 * will be deleted automatically. One should use elm_layout_box_remove() to
10036 * make this layout forget about the object.
10038 * @see elm_layout_box_append()
10039 * @see elm_layout_box_prepend()
10040 * @see elm_layout_box_insert_before()
10041 * @see elm_layout_box_remove()
10045 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10047 * Remove a child of the given part box.
10049 * @param obj The layout object
10050 * @param part The box part name to remove child.
10051 * @param child The object to remove from box.
10052 * @return The object that was being used, or NULL if not found.
10054 * The object will be removed from the box part and its lifetime will
10055 * not be handled by the layout anymore. This is equivalent to
10056 * elm_object_content_part_unset() for box.
10058 * @see elm_layout_box_append()
10059 * @see elm_layout_box_remove_all()
10063 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10065 * Remove all child of the given part box.
10067 * @param obj The layout object
10068 * @param part The box part name to remove child.
10069 * @param clear If EINA_TRUE, then all objects will be deleted as
10070 * well, otherwise they will just be removed and will be
10071 * dangling on the canvas.
10073 * The objects will be removed from the box part and their lifetime will
10074 * not be handled by the layout anymore. This is equivalent to
10075 * elm_layout_box_remove() for all box children.
10077 * @see elm_layout_box_append()
10078 * @see elm_layout_box_remove()
10082 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10084 * Insert child to layout table part.
10086 * @param obj the layout object
10087 * @param part the box part to pack child.
10088 * @param child_obj the child object to pack into table.
10089 * @param col the column to which the child should be added. (>= 0)
10090 * @param row the row to which the child should be added. (>= 0)
10091 * @param colspan how many columns should be used to store this object. (>=
10093 * @param rowspan how many rows should be used to store this object. (>= 1)
10095 * Once the object is inserted, it will become child of the table. Its
10096 * lifetime will be bound to the layout, and whenever the layout dies the
10097 * child will be deleted automatically. One should use
10098 * elm_layout_table_remove() to make this layout forget about the object.
10100 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10101 * more space than a single cell. For instance, the following code:
10103 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10106 * Would result in an object being added like the following picture:
10108 * @image html layout_colspan.png
10109 * @image latex layout_colspan.eps width=\textwidth
10111 * @see elm_layout_table_unpack()
10112 * @see elm_layout_table_clear()
10116 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);
10118 * Unpack (remove) a child of the given part table.
10120 * @param obj The layout object
10121 * @param part The table part name to remove child.
10122 * @param child_obj The object to remove from table.
10123 * @return The object that was being used, or NULL if not found.
10125 * The object will be unpacked from the table part and its lifetime
10126 * will not be handled by the layout anymore. This is equivalent to
10127 * elm_object_content_part_unset() for table.
10129 * @see elm_layout_table_pack()
10130 * @see elm_layout_table_clear()
10134 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10136 * Remove all child of the given part table.
10138 * @param obj The layout object
10139 * @param part The table part name to remove child.
10140 * @param clear If EINA_TRUE, then all objects will be deleted as
10141 * well, otherwise they will just be removed and will be
10142 * dangling on the canvas.
10144 * The objects will be removed from the table part and their lifetime will
10145 * not be handled by the layout anymore. This is equivalent to
10146 * elm_layout_table_unpack() for all table children.
10148 * @see elm_layout_table_pack()
10149 * @see elm_layout_table_unpack()
10153 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10155 * Get the edje layout
10157 * @param obj The layout object
10159 * @return A Evas_Object with the edje layout settings loaded
10160 * with function elm_layout_file_set
10162 * This returns the edje object. It is not expected to be used to then
10163 * swallow objects via edje_object_part_swallow() for example. Use
10164 * elm_object_content_part_set() instead so child object handling and sizing is
10167 * @note This function should only be used if you really need to call some
10168 * low level Edje function on this edje object. All the common stuff (setting
10169 * text, emitting signals, hooking callbacks to signals, etc.) can be done
10170 * with proper elementary functions.
10172 * @see elm_object_signal_callback_add()
10173 * @see elm_object_signal_emit()
10174 * @see elm_object_text_part_set()
10175 * @see elm_object_content_part_set()
10176 * @see elm_layout_box_append()
10177 * @see elm_layout_table_pack()
10178 * @see elm_layout_data_get()
10182 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10184 * Get the edje data from the given layout
10186 * @param obj The layout object
10187 * @param key The data key
10189 * @return The edje data string
10191 * This function fetches data specified inside the edje theme of this layout.
10192 * This function return NULL if data is not found.
10194 * In EDC this comes from a data block within the group block that @p
10195 * obj was loaded from. E.g.
10202 * item: "key1" "value1";
10203 * item: "key2" "value2";
10211 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10215 * @param obj The layout object
10217 * Manually forces a sizing re-evaluation. This is useful when the minimum
10218 * size required by the edje theme of this layout has changed. The change on
10219 * the minimum size required by the edje theme is not immediately reported to
10220 * the elementary layout, so one needs to call this function in order to tell
10221 * the widget (layout) that it needs to reevaluate its own size.
10223 * The minimum size of the theme is calculated based on minimum size of
10224 * parts, the size of elements inside containers like box and table, etc. All
10225 * of this can change due to state changes, and that's when this function
10226 * should be called.
10228 * Also note that a standard signal of "size,eval" "elm" emitted from the
10229 * edje object will cause this to happen too.
10233 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10236 * Sets a specific cursor for an edje part.
10238 * @param obj The layout object.
10239 * @param part_name a part from loaded edje group.
10240 * @param cursor cursor name to use, see Elementary_Cursor.h
10242 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10243 * part not exists or it has "mouse_events: 0".
10247 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10250 * Get the cursor to be shown when mouse is over an edje part
10252 * @param obj The layout object.
10253 * @param part_name a part from loaded edje group.
10254 * @return the cursor name.
10258 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10261 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10263 * @param obj The layout object.
10264 * @param part_name a part from loaded edje group, that had a cursor set
10265 * with elm_layout_part_cursor_set().
10269 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10272 * Sets a specific cursor style for an edje part.
10274 * @param obj The layout object.
10275 * @param part_name a part from loaded edje group.
10276 * @param style the theme style to use (default, transparent, ...)
10278 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10279 * part not exists or it did not had a cursor set.
10283 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10286 * Gets a specific cursor style for an edje part.
10288 * @param obj The layout object.
10289 * @param part_name a part from loaded edje group.
10291 * @return the theme style in use, defaults to "default". If the
10292 * object does not have a cursor set, then NULL is returned.
10296 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10299 * Sets if the cursor set should be searched on the theme or should use
10300 * the provided by the engine, only.
10302 * @note before you set if should look on theme you should define a
10303 * cursor with elm_layout_part_cursor_set(). By default it will only
10304 * look for cursors provided by the engine.
10306 * @param obj The layout object.
10307 * @param part_name a part from loaded edje group.
10308 * @param engine_only if cursors should be just provided by the engine
10309 * or should also search on widget's theme as well
10311 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10312 * part not exists or it did not had a cursor set.
10316 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);
10319 * Gets a specific cursor engine_only for an edje part.
10321 * @param obj The layout object.
10322 * @param part_name a part from loaded edje group.
10324 * @return whenever the cursor is just provided by engine or also from theme.
10328 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10331 * @def elm_layout_icon_set
10332 * Convienience macro to set the icon object in a layout that follows the
10333 * Elementary naming convention for its parts.
10337 #define elm_layout_icon_set(_ly, _obj) \
10340 elm_object_content_part_set((_ly), "elm.swallow.icon", (_obj)); \
10341 if ((_obj)) sig = "elm,state,icon,visible"; \
10342 else sig = "elm,state,icon,hidden"; \
10343 elm_object_signal_emit((_ly), sig, "elm"); \
10347 * @def elm_layout_icon_get
10348 * Convienience macro to get the icon object from a layout that follows the
10349 * Elementary naming convention for its parts.
10353 #define elm_layout_icon_get(_ly) \
10354 elm_object_content_part_get((_ly), "elm.swallow.icon")
10357 * @def elm_layout_end_set
10358 * Convienience macro to set the end object in a layout that follows the
10359 * Elementary naming convention for its parts.
10363 #define elm_layout_end_set(_ly, _obj) \
10366 elm_object_content_part_set((_ly), "elm.swallow.end", (_obj)); \
10367 if ((_obj)) sig = "elm,state,end,visible"; \
10368 else sig = "elm,state,end,hidden"; \
10369 elm_object_signal_emit((_ly), sig, "elm"); \
10373 * @def elm_layout_end_get
10374 * Convienience macro to get the end object in a layout that follows the
10375 * Elementary naming convention for its parts.
10379 #define elm_layout_end_get(_ly) \
10380 elm_object_content_part_get((_ly), "elm.swallow.end")
10383 * @def elm_layout_label_set
10384 * Convienience macro to set the label in a layout that follows the
10385 * Elementary naming convention for its parts.
10388 * @deprecated use elm_object_text_* instead.
10390 #define elm_layout_label_set(_ly, _txt) \
10391 elm_layout_text_set((_ly), "elm.text", (_txt))
10394 * @def elm_layout_label_get
10395 * Convienience macro to get the label in a layout that follows the
10396 * Elementary naming convention for its parts.
10399 * @deprecated use elm_object_text_* instead.
10401 #define elm_layout_label_get(_ly) \
10402 elm_layout_text_get((_ly), "elm.text")
10404 /* smart callbacks called:
10405 * "theme,changed" - when elm theme is changed.
10409 * @defgroup Notify Notify
10411 * @image html img/widget/notify/preview-00.png
10412 * @image latex img/widget/notify/preview-00.eps
10414 * Display a container in a particular region of the parent(top, bottom,
10415 * etc. A timeout can be set to automatically hide the notify. This is so
10416 * that, after an evas_object_show() on a notify object, if a timeout was set
10417 * on it, it will @b automatically get hidden after that time.
10419 * Signals that you can add callbacks for are:
10420 * @li "timeout" - when timeout happens on notify and it's hidden
10421 * @li "block,clicked" - when a click outside of the notify happens
10423 * Default contents parts of the notify widget that you can use for are:
10424 * @li "elm.swallow.content" - A content of the notify
10426 * @ref tutorial_notify show usage of the API.
10431 * @brief Possible orient values for notify.
10433 * This values should be used in conjunction to elm_notify_orient_set() to
10434 * set the position in which the notify should appear(relative to its parent)
10435 * and in conjunction with elm_notify_orient_get() to know where the notify
10438 typedef enum _Elm_Notify_Orient
10440 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10441 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10442 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10443 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10444 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10445 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10446 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10447 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10448 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10449 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10450 } Elm_Notify_Orient;
10452 * @brief Add a new notify to the parent
10454 * @param parent The parent object
10455 * @return The new object or NULL if it cannot be created
10457 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10459 * @brief Set the content of the notify widget
10461 * @param obj The notify object
10462 * @param content The content will be filled in this notify object
10464 * Once the content object is set, a previously set one will be deleted. If
10465 * you want to keep that old content object, use the
10466 * elm_notify_content_unset() function.
10468 EINA_DEPRECATED EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10470 * @brief Unset the content of the notify widget
10472 * @param obj The notify object
10473 * @return The content that was being used
10475 * Unparent and return the content object which was set for this widget
10477 * @see elm_notify_content_set()
10479 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10481 * @brief Return the content of the notify widget
10483 * @param obj The notify object
10484 * @return The content that is being used
10486 * @see elm_notify_content_set()
10488 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10490 * @brief Set the notify parent
10492 * @param obj The notify object
10493 * @param content The new parent
10495 * Once the parent object is set, a previously set one will be disconnected
10498 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10500 * @brief Get the notify parent
10502 * @param obj The notify object
10503 * @return The parent
10505 * @see elm_notify_parent_set()
10507 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10509 * @brief Set the orientation
10511 * @param obj The notify object
10512 * @param orient The new orientation
10514 * Sets the position in which the notify will appear in its parent.
10516 * @see @ref Elm_Notify_Orient for possible values.
10518 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10520 * @brief Return the orientation
10521 * @param obj The notify object
10522 * @return The orientation of the notification
10524 * @see elm_notify_orient_set()
10525 * @see Elm_Notify_Orient
10527 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10529 * @brief Set the time interval after which the notify window is going to be
10532 * @param obj The notify object
10533 * @param time The timeout in seconds
10535 * This function sets a timeout and starts the timer controlling when the
10536 * notify is hidden. Since calling evas_object_show() on a notify restarts
10537 * the timer controlling when the notify is hidden, setting this before the
10538 * notify is shown will in effect mean starting the timer when the notify is
10541 * @note Set a value <= 0.0 to disable a running timer.
10543 * @note If the value > 0.0 and the notify is previously visible, the
10544 * timer will be started with this value, canceling any running timer.
10546 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10548 * @brief Return the timeout value (in seconds)
10549 * @param obj the notify object
10551 * @see elm_notify_timeout_set()
10553 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10555 * @brief Sets whether events should be passed to by a click outside
10558 * @param obj The notify object
10559 * @param repeats EINA_TRUE Events are repeats, else no
10561 * When true if the user clicks outside the window the events will be caught
10562 * by the others widgets, else the events are blocked.
10564 * @note The default value is EINA_TRUE.
10566 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10568 * @brief Return true if events are repeat below the notify object
10569 * @param obj the notify object
10571 * @see elm_notify_repeat_events_set()
10573 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10579 * @defgroup Hover Hover
10581 * @image html img/widget/hover/preview-00.png
10582 * @image latex img/widget/hover/preview-00.eps
10584 * A Hover object will hover over its @p parent object at the @p target
10585 * location. Anything in the background will be given a darker coloring to
10586 * indicate that the hover object is on top (at the default theme). When the
10587 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10588 * clicked that @b doesn't cause the hover to be dismissed.
10590 * A Hover object has two parents. One parent that owns it during creation
10591 * and the other parent being the one over which the hover object spans.
10594 * @note The hover object will take up the entire space of @p target
10597 * Elementary has the following styles for the hover widget:
10601 * @li hoversel_vertical
10603 * The following are the available position for content:
10615 * Signals that you can add callbacks for are:
10616 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10617 * @li "smart,changed" - a content object placed under the "smart"
10618 * policy was replaced to a new slot direction.
10620 * See @ref tutorial_hover for more information.
10624 typedef enum _Elm_Hover_Axis
10626 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10627 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10628 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10629 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10632 * @brief Adds a hover object to @p parent
10634 * @param parent The parent object
10635 * @return The hover object or NULL if one could not be created
10637 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10639 * @brief Sets the target object for the hover.
10641 * @param obj The hover object
10642 * @param target The object to center the hover onto. The hover
10644 * This function will cause the hover to be centered on the target object.
10646 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10648 * @brief Gets the target object for the hover.
10650 * @param obj The hover object
10651 * @param parent The object to locate the hover over.
10653 * @see elm_hover_target_set()
10655 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10657 * @brief Sets the parent object for the hover.
10659 * @param obj The hover object
10660 * @param parent The object to locate the hover over.
10662 * This function will cause the hover to take up the entire space that the
10663 * parent object fills.
10665 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10667 * @brief Gets the parent object for the hover.
10669 * @param obj The hover object
10670 * @return The parent object to locate the hover over.
10672 * @see elm_hover_parent_set()
10674 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10676 * @brief Sets the content of the hover object and the direction in which it
10679 * @param obj The hover object
10680 * @param swallow The direction that the object will be displayed
10681 * at. Accepted values are "left", "top-left", "top", "top-right",
10682 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10684 * @param content The content to place at @p swallow
10686 * Once the content object is set for a given direction, a previously
10687 * set one (on the same direction) will be deleted. If you want to
10688 * keep that old content object, use the elm_hover_content_unset()
10691 * All directions may have contents at the same time, except for
10692 * "smart". This is a special placement hint and its use case
10693 * independs of the calculations coming from
10694 * elm_hover_best_content_location_get(). Its use is for cases when
10695 * one desires only one hover content, but with a dinamic special
10696 * placement within the hover area. The content's geometry, whenever
10697 * it changes, will be used to decide on a best location not
10698 * extrapolating the hover's parent object view to show it in (still
10699 * being the hover's target determinant of its medium part -- move and
10700 * resize it to simulate finger sizes, for example). If one of the
10701 * directions other than "smart" are used, a previously content set
10702 * using it will be deleted, and vice-versa.
10704 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10706 * @brief Get the content of the hover object, in a given direction.
10708 * Return the content object which was set for this widget in the
10709 * @p swallow direction.
10711 * @param obj The hover object
10712 * @param swallow The direction that the object was display at.
10713 * @return The content that was being used
10715 * @see elm_hover_content_set()
10717 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10719 * @brief Unset the content of the hover object, in a given direction.
10721 * Unparent and return the content object set at @p swallow direction.
10723 * @param obj The hover object
10724 * @param swallow The direction that the object was display at.
10725 * @return The content that was being used.
10727 * @see elm_hover_content_set()
10729 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10731 * @brief Returns the best swallow location for content in the hover.
10733 * @param obj The hover object
10734 * @param pref_axis The preferred orientation axis for the hover object to use
10735 * @return The edje location to place content into the hover or @c
10738 * Best is defined here as the location at which there is the most available
10741 * @p pref_axis may be one of
10742 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10743 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10744 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10745 * - @c ELM_HOVER_AXIS_BOTH -- both
10747 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10748 * nescessarily be along the horizontal axis("left" or "right"). If
10749 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10750 * be along the vertical axis("top" or "bottom"). Chossing
10751 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10752 * returned position may be in either axis.
10754 * @see elm_hover_content_set()
10756 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10763 * @defgroup Entry Entry
10765 * @image html img/widget/entry/preview-00.png
10766 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10767 * @image html img/widget/entry/preview-01.png
10768 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10769 * @image html img/widget/entry/preview-02.png
10770 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10771 * @image html img/widget/entry/preview-03.png
10772 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10774 * An entry is a convenience widget which shows a box that the user can
10775 * enter text into. Entries by default don't scroll, so they grow to
10776 * accomodate the entire text, resizing the parent window as needed. This
10777 * can be changed with the elm_entry_scrollable_set() function.
10779 * They can also be single line or multi line (the default) and when set
10780 * to multi line mode they support text wrapping in any of the modes
10781 * indicated by #Elm_Wrap_Type.
10783 * Other features include password mode, filtering of inserted text with
10784 * elm_entry_text_filter_append() and related functions, inline "items" and
10785 * formatted markup text.
10787 * @section entry-markup Formatted text
10789 * The markup tags supported by the Entry are defined by the theme, but
10790 * even when writing new themes or extensions it's a good idea to stick to
10791 * a sane default, to maintain coherency and avoid application breakages.
10792 * Currently defined by the default theme are the following tags:
10793 * @li \<br\>: Inserts a line break.
10794 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10796 * @li \<tab\>: Inserts a tab.
10797 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10799 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10800 * @li \<link\>...\</link\>: Underlines the enclosed text.
10801 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10803 * @section entry-special Special markups
10805 * Besides those used to format text, entries support two special markup
10806 * tags used to insert clickable portions of text or items inlined within
10809 * @subsection entry-anchors Anchors
10811 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10812 * \</a\> tags and an event will be generated when this text is clicked,
10816 * This text is outside <a href=anc-01>but this one is an anchor</a>
10819 * The @c href attribute in the opening tag gives the name that will be
10820 * used to identify the anchor and it can be any valid utf8 string.
10822 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10823 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10824 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10825 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10828 * @subsection entry-items Items
10830 * Inlined in the text, any other @c Evas_Object can be inserted by using
10831 * \<item\> tags this way:
10834 * <item size=16x16 vsize=full href=emoticon/haha></item>
10837 * Just like with anchors, the @c href identifies each item, but these need,
10838 * in addition, to indicate their size, which is done using any one of
10839 * @c size, @c absize or @c relsize attributes. These attributes take their
10840 * value in the WxH format, where W is the width and H the height of the
10843 * @li absize: Absolute pixel size for the item. Whatever value is set will
10844 * be the item's size regardless of any scale value the object may have
10845 * been set to. The final line height will be adjusted to fit larger items.
10846 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10848 * @li relsize: Size is adjusted for the item to fit within the current
10851 * Besides their size, items are specificed a @c vsize value that affects
10852 * how their final size and position are calculated. The possible values
10854 * @li ascent: Item will be placed within the line's baseline and its
10855 * ascent. That is, the height between the line where all characters are
10856 * positioned and the highest point in the line. For @c size and @c absize
10857 * items, the descent value will be added to the total line height to make
10858 * them fit. @c relsize items will be adjusted to fit within this space.
10859 * @li full: Items will be placed between the descent and ascent, or the
10860 * lowest point in the line and its highest.
10862 * The next image shows different configurations of items and how they
10863 * are the previously mentioned options affect their sizes. In all cases,
10864 * the green line indicates the ascent, blue for the baseline and red for
10867 * @image html entry_item.png
10868 * @image latex entry_item.eps width=\textwidth
10870 * And another one to show how size differs from absize. In the first one,
10871 * the scale value is set to 1.0, while the second one is using one of 2.0.
10873 * @image html entry_item_scale.png
10874 * @image latex entry_item_scale.eps width=\textwidth
10876 * After the size for an item is calculated, the entry will request an
10877 * object to place in its space. For this, the functions set with
10878 * elm_entry_item_provider_append() and related functions will be called
10879 * in order until one of them returns a @c non-NULL value. If no providers
10880 * are available, or all of them return @c NULL, then the entry falls back
10881 * to one of the internal defaults, provided the name matches with one of
10884 * All of the following are currently supported:
10887 * - emoticon/angry-shout
10888 * - emoticon/crazy-laugh
10889 * - emoticon/evil-laugh
10891 * - emoticon/goggle-smile
10892 * - emoticon/grumpy
10893 * - emoticon/grumpy-smile
10894 * - emoticon/guilty
10895 * - emoticon/guilty-smile
10897 * - emoticon/half-smile
10898 * - emoticon/happy-panting
10900 * - emoticon/indifferent
10902 * - emoticon/knowing-grin
10904 * - emoticon/little-bit-sorry
10905 * - emoticon/love-lots
10907 * - emoticon/minimal-smile
10908 * - emoticon/not-happy
10909 * - emoticon/not-impressed
10911 * - emoticon/opensmile
10914 * - emoticon/squint-laugh
10915 * - emoticon/surprised
10916 * - emoticon/suspicious
10917 * - emoticon/tongue-dangling
10918 * - emoticon/tongue-poke
10920 * - emoticon/unhappy
10921 * - emoticon/very-sorry
10924 * - emoticon/worried
10927 * Alternatively, an item may reference an image by its path, using
10928 * the URI form @c file:///path/to/an/image.png and the entry will then
10929 * use that image for the item.
10931 * @section entry-files Loading and saving files
10933 * Entries have convinience functions to load text from a file and save
10934 * changes back to it after a short delay. The automatic saving is enabled
10935 * by default, but can be disabled with elm_entry_autosave_set() and files
10936 * can be loaded directly as plain text or have any markup in them
10937 * recognized. See elm_entry_file_set() for more details.
10939 * @section entry-signals Emitted signals
10941 * This widget emits the following signals:
10943 * @li "changed": The text within the entry was changed.
10944 * @li "changed,user": The text within the entry was changed because of user interaction.
10945 * @li "activated": The enter key was pressed on a single line entry.
10946 * @li "press": A mouse button has been pressed on the entry.
10947 * @li "longpressed": A mouse button has been pressed and held for a couple
10949 * @li "clicked": The entry has been clicked (mouse press and release).
10950 * @li "clicked,double": The entry has been double clicked.
10951 * @li "clicked,triple": The entry has been triple clicked.
10952 * @li "focused": The entry has received focus.
10953 * @li "unfocused": The entry has lost focus.
10954 * @li "selection,paste": A paste of the clipboard contents was requested.
10955 * @li "selection,copy": A copy of the selected text into the clipboard was
10957 * @li "selection,cut": A cut of the selected text into the clipboard was
10959 * @li "selection,start": A selection has begun and no previous selection
10961 * @li "selection,changed": The current selection has changed.
10962 * @li "selection,cleared": The current selection has been cleared.
10963 * @li "cursor,changed": The cursor has changed position.
10964 * @li "anchor,clicked": An anchor has been clicked. The event_info
10965 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10966 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10967 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10968 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10969 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10970 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10971 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10972 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10973 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10974 * @li "preedit,changed": The preedit string has changed.
10975 * @li "language,changed": Program language changed.
10977 * @section entry-examples
10979 * An overview of the Entry API can be seen in @ref entry_example_01
10984 * @typedef Elm_Entry_Anchor_Info
10986 * The info sent in the callback for the "anchor,clicked" signals emitted
10989 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10991 * @struct _Elm_Entry_Anchor_Info
10993 * The info sent in the callback for the "anchor,clicked" signals emitted
10996 struct _Elm_Entry_Anchor_Info
10998 const char *name; /**< The name of the anchor, as stated in its href */
10999 int button; /**< The mouse button used to click on it */
11000 Evas_Coord x, /**< Anchor geometry, relative to canvas */
11001 y, /**< Anchor geometry, relative to canvas */
11002 w, /**< Anchor geometry, relative to canvas */
11003 h; /**< Anchor geometry, relative to canvas */
11006 * @typedef Elm_Entry_Filter_Cb
11007 * This callback type is used by entry filters to modify text.
11008 * @param data The data specified as the last param when adding the filter
11009 * @param entry The entry object
11010 * @param text A pointer to the location of the text being filtered. This data can be modified,
11011 * but any additional allocations must be managed by the user.
11012 * @see elm_entry_text_filter_append
11013 * @see elm_entry_text_filter_prepend
11015 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11018 * This adds an entry to @p parent object.
11020 * By default, entries are:
11024 * @li autosave is enabled
11026 * @param parent The parent object
11027 * @return The new object or NULL if it cannot be created
11029 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11031 * Sets the entry to single line mode.
11033 * In single line mode, entries don't ever wrap when the text reaches the
11034 * edge, and instead they keep growing horizontally. Pressing the @c Enter
11035 * key will generate an @c "activate" event instead of adding a new line.
11037 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11038 * and pressing enter will break the text into a different line
11039 * without generating any events.
11041 * @param obj The entry object
11042 * @param single_line If true, the text in the entry
11043 * will be on a single line.
11045 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11047 * Gets whether the entry is set to be single line.
11049 * @param obj The entry object
11050 * @return single_line If true, the text in the entry is set to display
11051 * on a single line.
11053 * @see elm_entry_single_line_set()
11055 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11057 * Sets the entry to password mode.
11059 * In password mode, entries are implicitly single line and the display of
11060 * any text in them is replaced with asterisks (*).
11062 * @param obj The entry object
11063 * @param password If true, password mode is enabled.
11065 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11067 * Gets whether the entry is set to password mode.
11069 * @param obj The entry object
11070 * @return If true, the entry is set to display all characters
11071 * as asterisks (*).
11073 * @see elm_entry_password_set()
11075 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11077 * This sets the text displayed within the entry to @p entry.
11079 * @param obj The entry object
11080 * @param entry The text to be displayed
11082 * @deprecated Use elm_object_text_set() instead.
11083 * @note Using this function bypasses text filters
11085 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11087 * This returns the text currently shown in object @p entry.
11088 * See also elm_entry_entry_set().
11090 * @param obj The entry object
11091 * @return The currently displayed text or NULL on failure
11093 * @deprecated Use elm_object_text_get() instead.
11095 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11097 * Appends @p entry to the text of the entry.
11099 * Adds the text in @p entry to the end of any text already present in the
11102 * The appended text is subject to any filters set for the widget.
11104 * @param obj The entry object
11105 * @param entry The text to be displayed
11107 * @see elm_entry_text_filter_append()
11109 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11111 * Gets whether the entry is empty.
11113 * Empty means no text at all. If there are any markup tags, like an item
11114 * tag for which no provider finds anything, and no text is displayed, this
11115 * function still returns EINA_FALSE.
11117 * @param obj The entry object
11118 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11120 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11122 * Gets any selected text within the entry.
11124 * If there's any selected text in the entry, this function returns it as
11125 * a string in markup format. NULL is returned if no selection exists or
11126 * if an error occurred.
11128 * The returned value points to an internal string and should not be freed
11129 * or modified in any way. If the @p entry object is deleted or its
11130 * contents are changed, the returned pointer should be considered invalid.
11132 * @param obj The entry object
11133 * @return The selected text within the entry or NULL on failure
11135 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11137 * Inserts the given text into the entry at the current cursor position.
11139 * This inserts text at the cursor position as if it was typed
11140 * by the user (note that this also allows markup which a user
11141 * can't just "type" as it would be converted to escaped text, so this
11142 * call can be used to insert things like emoticon items or bold push/pop
11143 * tags, other font and color change tags etc.)
11145 * If any selection exists, it will be replaced by the inserted text.
11147 * The inserted text is subject to any filters set for the widget.
11149 * @param obj The entry object
11150 * @param entry The text to insert
11152 * @see elm_entry_text_filter_append()
11154 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11156 * Set the line wrap type to use on multi-line entries.
11158 * Sets the wrap type used by the entry to any of the specified in
11159 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11160 * line (without inserting a line break or paragraph separator) when it
11161 * reaches the far edge of the widget.
11163 * Note that this only makes sense for multi-line entries. A widget set
11164 * to be single line will never wrap.
11166 * @param obj The entry object
11167 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11169 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11171 * Gets the wrap mode the entry was set to use.
11173 * @param obj The entry object
11174 * @return Wrap type
11176 * @see also elm_entry_line_wrap_set()
11178 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11180 * Sets if the entry is to be editable or not.
11182 * By default, entries are editable and when focused, any text input by the
11183 * user will be inserted at the current cursor position. But calling this
11184 * function with @p editable as EINA_FALSE will prevent the user from
11185 * inputting text into the entry.
11187 * The only way to change the text of a non-editable entry is to use
11188 * elm_object_text_set(), elm_entry_entry_insert() and other related
11191 * @param obj The entry object
11192 * @param editable If EINA_TRUE, user input will be inserted in the entry,
11193 * if not, the entry is read-only and no user input is allowed.
11195 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11197 * Gets whether the entry is editable or not.
11199 * @param obj The entry object
11200 * @return If true, the entry is editable by the user.
11201 * If false, it is not editable by the user
11203 * @see elm_entry_editable_set()
11205 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11207 * This drops any existing text selection within the entry.
11209 * @param obj The entry object
11211 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11213 * This selects all text within the entry.
11215 * @param obj The entry object
11217 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11219 * This moves the cursor one place to the right within the entry.
11221 * @param obj The entry object
11222 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11224 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11226 * This moves the cursor one place to the left within the entry.
11228 * @param obj The entry object
11229 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11231 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11233 * This moves the cursor one line up within the entry.
11235 * @param obj The entry object
11236 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11238 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11240 * This moves the cursor one line down within the entry.
11242 * @param obj The entry object
11243 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11245 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11247 * This moves the cursor to the beginning of the entry.
11249 * @param obj The entry object
11251 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11253 * This moves the cursor to the end of the entry.
11255 * @param obj The entry object
11257 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11259 * This moves the cursor to the beginning of the current line.
11261 * @param obj The entry object
11263 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11265 * This moves the cursor to the end of the current line.
11267 * @param obj The entry object
11269 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11271 * This begins a selection within the entry as though
11272 * the user were holding down the mouse button to make a selection.
11274 * @param obj The entry object
11276 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11278 * This ends a selection within the entry as though
11279 * the user had just released the mouse button while making a selection.
11281 * @param obj The entry object
11283 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11285 * Gets whether a format node exists at the current cursor position.
11287 * A format node is anything that defines how the text is rendered. It can
11288 * be a visible format node, such as a line break or a paragraph separator,
11289 * or an invisible one, such as bold begin or end tag.
11290 * This function returns whether any format node exists at the current
11293 * @param obj The entry object
11294 * @return EINA_TRUE if the current cursor position contains a format node,
11295 * EINA_FALSE otherwise.
11297 * @see elm_entry_cursor_is_visible_format_get()
11299 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11301 * Gets if the current cursor position holds a visible format node.
11303 * @param obj The entry object
11304 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11305 * if it's an invisible one or no format exists.
11307 * @see elm_entry_cursor_is_format_get()
11309 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11311 * Gets the character pointed by the cursor at its current position.
11313 * This function returns a string with the utf8 character stored at the
11314 * current cursor position.
11315 * Only the text is returned, any format that may exist will not be part
11316 * of the return value.
11318 * @param obj The entry object
11319 * @return The text pointed by the cursors.
11321 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11323 * This function returns the geometry of the cursor.
11325 * It's useful if you want to draw something on the cursor (or where it is),
11326 * or for example in the case of scrolled entry where you want to show the
11329 * @param obj The entry object
11330 * @param x returned geometry
11331 * @param y returned geometry
11332 * @param w returned geometry
11333 * @param h returned geometry
11334 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11336 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);
11338 * Sets the cursor position in the entry to the given value
11340 * The value in @p pos is the index of the character position within the
11341 * contents of the string as returned by elm_entry_cursor_pos_get().
11343 * @param obj The entry object
11344 * @param pos The position of the cursor
11346 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11348 * Retrieves the current position of the cursor in the entry
11350 * @param obj The entry object
11351 * @return The cursor position
11353 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11355 * This executes a "cut" action on the selected text in the entry.
11357 * @param obj The entry object
11359 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11361 * This executes a "copy" action on the selected text in the entry.
11363 * @param obj The entry object
11365 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11367 * This executes a "paste" action in the entry.
11369 * @param obj The entry object
11371 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11373 * This clears and frees the items in a entry's contextual (longpress)
11376 * @param obj The entry object
11378 * @see elm_entry_context_menu_item_add()
11380 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11382 * This adds an item to the entry's contextual menu.
11384 * A longpress on an entry will make the contextual menu show up, if this
11385 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11386 * By default, this menu provides a few options like enabling selection mode,
11387 * which is useful on embedded devices that need to be explicit about it,
11388 * and when a selection exists it also shows the copy and cut actions.
11390 * With this function, developers can add other options to this menu to
11391 * perform any action they deem necessary.
11393 * @param obj The entry object
11394 * @param label The item's text label
11395 * @param icon_file The item's icon file
11396 * @param icon_type The item's icon type
11397 * @param func The callback to execute when the item is clicked
11398 * @param data The data to associate with the item for related functions
11400 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);
11402 * This disables the entry's contextual (longpress) menu.
11404 * @param obj The entry object
11405 * @param disabled If true, the menu is disabled
11407 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11409 * This returns whether the entry's contextual (longpress) menu is
11412 * @param obj The entry object
11413 * @return If true, the menu is disabled
11415 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11417 * This appends a custom item provider to the list for that entry
11419 * This appends the given callback. The list is walked from beginning to end
11420 * with each function called given the item href string in the text. If the
11421 * function returns an object handle other than NULL (it should create an
11422 * object to do this), then this object is used to replace that item. If
11423 * not the next provider is called until one provides an item object, or the
11424 * default provider in entry does.
11426 * @param obj The entry object
11427 * @param func The function called to provide the item object
11428 * @param data The data passed to @p func
11430 * @see @ref entry-items
11432 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);
11434 * This prepends a custom item provider to the list for that entry
11436 * This prepends the given callback. See elm_entry_item_provider_append() for
11439 * @param obj The entry object
11440 * @param func The function called to provide the item object
11441 * @param data The data passed to @p func
11443 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);
11445 * This removes a custom item provider to the list for that entry
11447 * This removes the given callback. See elm_entry_item_provider_append() for
11450 * @param obj The entry object
11451 * @param func The function called to provide the item object
11452 * @param data The data passed to @p func
11454 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);
11456 * Append a filter function for text inserted in the entry
11458 * Append the given callback to the list. This functions will be called
11459 * whenever any text is inserted into the entry, with the text to be inserted
11460 * as a parameter. The callback function is free to alter the text in any way
11461 * it wants, but it must remember to free the given pointer and update it.
11462 * If the new text is to be discarded, the function can free it and set its
11463 * text parameter to NULL. This will also prevent any following filters from
11466 * @param obj The entry object
11467 * @param func The function to use as text filter
11468 * @param data User data to pass to @p func
11470 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11472 * Prepend a filter function for text insdrted in the entry
11474 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11475 * for more information
11477 * @param obj The entry object
11478 * @param func The function to use as text filter
11479 * @param data User data to pass to @p func
11481 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11483 * Remove a filter from the list
11485 * Removes the given callback from the filter list. See
11486 * elm_entry_text_filter_append() for more information.
11488 * @param obj The entry object
11489 * @param func The filter function to remove
11490 * @param data The user data passed when adding the function
11492 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11494 * This converts a markup (HTML-like) string into UTF-8.
11496 * The returned string is a malloc'ed buffer and it should be freed when
11497 * not needed anymore.
11499 * @param s The string (in markup) to be converted
11500 * @return The converted string (in UTF-8). It should be freed.
11502 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11504 * This converts a UTF-8 string into markup (HTML-like).
11506 * The returned string is a malloc'ed buffer and it should be freed when
11507 * not needed anymore.
11509 * @param s The string (in UTF-8) to be converted
11510 * @return The converted string (in markup). It should be freed.
11512 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11514 * This sets the file (and implicitly loads it) for the text to display and
11515 * then edit. All changes are written back to the file after a short delay if
11516 * the entry object is set to autosave (which is the default).
11518 * If the entry had any other file set previously, any changes made to it
11519 * will be saved if the autosave feature is enabled, otherwise, the file
11520 * will be silently discarded and any non-saved changes will be lost.
11522 * @param obj The entry object
11523 * @param file The path to the file to load and save
11524 * @param format The file format
11526 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11528 * Gets the file being edited by the entry.
11530 * This function can be used to retrieve any file set on the entry for
11531 * edition, along with the format used to load and save it.
11533 * @param obj The entry object
11534 * @param file The path to the file to load and save
11535 * @param format The file format
11537 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11539 * This function writes any changes made to the file set with
11540 * elm_entry_file_set()
11542 * @param obj The entry object
11544 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11546 * This sets the entry object to 'autosave' the loaded text file or not.
11548 * @param obj The entry object
11549 * @param autosave Autosave the loaded file or not
11551 * @see elm_entry_file_set()
11553 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11555 * This gets the entry object's 'autosave' status.
11557 * @param obj The entry object
11558 * @return Autosave the loaded file or not
11560 * @see elm_entry_file_set()
11562 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11564 * Control pasting of text and images for the widget.
11566 * Normally the entry allows both text and images to be pasted. By setting
11567 * textonly to be true, this prevents images from being pasted.
11569 * Note this only changes the behaviour of text.
11571 * @param obj The entry object
11572 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11573 * text+image+other.
11575 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11577 * Getting elm_entry text paste/drop mode.
11579 * In textonly mode, only text may be pasted or dropped into the widget.
11581 * @param obj The entry object
11582 * @return If the widget only accepts text from pastes.
11584 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11586 * Enable or disable scrolling in entry
11588 * Normally the entry is not scrollable unless you enable it with this call.
11590 * @param obj The entry object
11591 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11593 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11595 * Get the scrollable state of the entry
11597 * Normally the entry is not scrollable. This gets the scrollable state
11598 * of the entry. See elm_entry_scrollable_set() for more information.
11600 * @param obj The entry object
11601 * @return The scrollable state
11603 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11605 * This sets a widget to be displayed to the left of a scrolled entry.
11607 * @param obj The scrolled entry object
11608 * @param icon The widget to display on the left side of the scrolled
11611 * @note A previously set widget will be destroyed.
11612 * @note If the object being set does not have minimum size hints set,
11613 * it won't get properly displayed.
11615 * @see elm_entry_end_set()
11617 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11619 * Gets the leftmost widget of the scrolled entry. This object is
11620 * owned by the scrolled entry and should not be modified.
11622 * @param obj The scrolled entry object
11623 * @return the left widget inside the scroller
11625 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11627 * Unset the leftmost widget of the scrolled entry, unparenting and
11630 * @param obj The scrolled entry object
11631 * @return the previously set icon sub-object of this entry, on
11634 * @see elm_entry_icon_set()
11636 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11638 * Sets the visibility of the left-side widget of the scrolled entry,
11639 * set by elm_entry_icon_set().
11641 * @param obj The scrolled entry object
11642 * @param setting EINA_TRUE if the object should be displayed,
11643 * EINA_FALSE if not.
11645 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11647 * This sets a widget to be displayed to the end of a scrolled entry.
11649 * @param obj The scrolled entry object
11650 * @param end The widget to display on the right side of the scrolled
11653 * @note A previously set widget will be destroyed.
11654 * @note If the object being set does not have minimum size hints set,
11655 * it won't get properly displayed.
11657 * @see elm_entry_icon_set
11659 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11661 * Gets the endmost widget of the scrolled entry. This object is owned
11662 * by the scrolled entry and should not be modified.
11664 * @param obj The scrolled entry object
11665 * @return the right widget inside the scroller
11667 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11669 * Unset the endmost widget of the scrolled entry, unparenting and
11672 * @param obj The scrolled entry object
11673 * @return the previously set icon sub-object of this entry, on
11676 * @see elm_entry_icon_set()
11678 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11680 * Sets the visibility of the end widget of the scrolled entry, set by
11681 * elm_entry_end_set().
11683 * @param obj The scrolled entry object
11684 * @param setting EINA_TRUE if the object should be displayed,
11685 * EINA_FALSE if not.
11687 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11689 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11692 * Setting an entry to single-line mode with elm_entry_single_line_set()
11693 * will automatically disable the display of scrollbars when the entry
11694 * moves inside its scroller.
11696 * @param obj The scrolled entry object
11697 * @param h The horizontal scrollbar policy to apply
11698 * @param v The vertical scrollbar policy to apply
11700 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11702 * This enables/disables bouncing within the entry.
11704 * This function sets whether the entry will bounce when scrolling reaches
11705 * the end of the contained entry.
11707 * @param obj The scrolled entry object
11708 * @param h The horizontal bounce state
11709 * @param v The vertical bounce state
11711 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11713 * Get the bounce mode
11715 * @param obj The Entry object
11716 * @param h_bounce Allow bounce horizontally
11717 * @param v_bounce Allow bounce vertically
11719 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11721 /* pre-made filters for entries */
11723 * @typedef Elm_Entry_Filter_Limit_Size
11725 * Data for the elm_entry_filter_limit_size() entry filter.
11727 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11729 * @struct _Elm_Entry_Filter_Limit_Size
11731 * Data for the elm_entry_filter_limit_size() entry filter.
11733 struct _Elm_Entry_Filter_Limit_Size
11735 int max_char_count; /**< The maximum number of characters allowed. */
11736 int max_byte_count; /**< The maximum number of bytes allowed*/
11739 * Filter inserted text based on user defined character and byte limits
11741 * Add this filter to an entry to limit the characters that it will accept
11742 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11743 * The funtion works on the UTF-8 representation of the string, converting
11744 * it from the set markup, thus not accounting for any format in it.
11746 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11747 * it as data when setting the filter. In it, it's possible to set limits
11748 * by character count or bytes (any of them is disabled if 0), and both can
11749 * be set at the same time. In that case, it first checks for characters,
11752 * The function will cut the inserted text in order to allow only the first
11753 * number of characters that are still allowed. The cut is made in
11754 * characters, even when limiting by bytes, in order to always contain
11755 * valid ones and avoid half unicode characters making it in.
11757 * This filter, like any others, does not apply when setting the entry text
11758 * directly with elm_object_text_set() (or the deprecated
11759 * elm_entry_entry_set()).
11761 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11763 * @typedef Elm_Entry_Filter_Accept_Set
11765 * Data for the elm_entry_filter_accept_set() entry filter.
11767 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11769 * @struct _Elm_Entry_Filter_Accept_Set
11771 * Data for the elm_entry_filter_accept_set() entry filter.
11773 struct _Elm_Entry_Filter_Accept_Set
11775 const char *accepted; /**< Set of characters accepted in the entry. */
11776 const char *rejected; /**< Set of characters rejected from the entry. */
11779 * Filter inserted text based on accepted or rejected sets of characters
11781 * Add this filter to an entry to restrict the set of accepted characters
11782 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11783 * This structure contains both accepted and rejected sets, but they are
11784 * mutually exclusive.
11786 * The @c accepted set takes preference, so if it is set, the filter will
11787 * only work based on the accepted characters, ignoring anything in the
11788 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11790 * In both cases, the function filters by matching utf8 characters to the
11791 * raw markup text, so it can be used to remove formatting tags.
11793 * This filter, like any others, does not apply when setting the entry text
11794 * directly with elm_object_text_set() (or the deprecated
11795 * elm_entry_entry_set()).
11797 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11799 * Set the input panel layout of the entry
11801 * @param obj The entry object
11802 * @param layout layout type
11804 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11806 * Get the input panel layout of the entry
11808 * @param obj The entry object
11809 * @return layout type
11811 * @see elm_entry_input_panel_layout_set
11813 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11815 * Set the autocapitalization type on the immodule.
11817 * @param obj The entry object
11818 * @param autocapital_type The type of autocapitalization
11820 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11822 * Retrieve the autocapitalization type on the immodule.
11824 * @param obj The entry object
11825 * @return autocapitalization type
11827 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11829 * Sets the attribute to show the input panel automatically.
11831 * @param obj The entry object
11832 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
11834 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
11836 * Retrieve the attribute to show the input panel automatically.
11838 * @param obj The entry object
11839 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
11841 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11847 /* composite widgets - these basically put together basic widgets above
11848 * in convenient packages that do more than basic stuff */
11852 * @defgroup Anchorview Anchorview
11854 * @image html img/widget/anchorview/preview-00.png
11855 * @image latex img/widget/anchorview/preview-00.eps
11857 * Anchorview is for displaying text that contains markup with anchors
11858 * like <c>\<a href=1234\>something\</\></c> in it.
11860 * Besides being styled differently, the anchorview widget provides the
11861 * necessary functionality so that clicking on these anchors brings up a
11862 * popup with user defined content such as "call", "add to contacts" or
11863 * "open web page". This popup is provided using the @ref Hover widget.
11865 * This widget is very similar to @ref Anchorblock, so refer to that
11866 * widget for an example. The only difference Anchorview has is that the
11867 * widget is already provided with scrolling functionality, so if the
11868 * text set to it is too large to fit in the given space, it will scroll,
11869 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11870 * text can be displayed.
11872 * This widget emits the following signals:
11873 * @li "anchor,clicked": will be called when an anchor is clicked. The
11874 * @p event_info parameter on the callback will be a pointer of type
11875 * ::Elm_Entry_Anchorview_Info.
11877 * See @ref Anchorblock for an example on how to use both of them.
11886 * @typedef Elm_Entry_Anchorview_Info
11888 * The info sent in the callback for "anchor,clicked" signals emitted by
11889 * the Anchorview widget.
11891 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11893 * @struct _Elm_Entry_Anchorview_Info
11895 * The info sent in the callback for "anchor,clicked" signals emitted by
11896 * the Anchorview widget.
11898 struct _Elm_Entry_Anchorview_Info
11900 const char *name; /**< Name of the anchor, as indicated in its href
11902 int button; /**< The mouse button used to click on it */
11903 Evas_Object *hover; /**< The hover object to use for the popup */
11905 Evas_Coord x, y, w, h;
11906 } anchor, /**< Geometry selection of text used as anchor */
11907 hover_parent; /**< Geometry of the object used as parent by the
11909 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11910 for content on the left side of
11911 the hover. Before calling the
11912 callback, the widget will make the
11913 necessary calculations to check
11914 which sides are fit to be set with
11915 content, based on the position the
11916 hover is activated and its distance
11917 to the edges of its parent object
11919 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11920 the right side of the hover.
11921 See @ref hover_left */
11922 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11923 of the hover. See @ref hover_left */
11924 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11925 below the hover. See @ref
11929 * Add a new Anchorview object
11931 * @param parent The parent object
11932 * @return The new object or NULL if it cannot be created
11934 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11936 * Set the text to show in the anchorview
11938 * Sets the text of the anchorview to @p text. This text can include markup
11939 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11940 * text that will be specially styled and react to click events, ended with
11941 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11942 * "anchor,clicked" signal that you can attach a callback to with
11943 * evas_object_smart_callback_add(). The name of the anchor given in the
11944 * event info struct will be the one set in the href attribute, in this
11945 * case, anchorname.
11947 * Other markup can be used to style the text in different ways, but it's
11948 * up to the style defined in the theme which tags do what.
11949 * @deprecated use elm_object_text_set() instead.
11951 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11953 * Get the markup text set for the anchorview
11955 * Retrieves the text set on the anchorview, with markup tags included.
11957 * @param obj The anchorview object
11958 * @return The markup text set or @c NULL if nothing was set or an error
11960 * @deprecated use elm_object_text_set() instead.
11962 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11964 * Set the parent of the hover popup
11966 * Sets the parent object to use by the hover created by the anchorview
11967 * when an anchor is clicked. See @ref Hover for more details on this.
11968 * If no parent is set, the same anchorview object will be used.
11970 * @param obj The anchorview object
11971 * @param parent The object to use as parent for the hover
11973 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11975 * Get the parent of the hover popup
11977 * Get the object used as parent for the hover created by the anchorview
11978 * widget. See @ref Hover for more details on this.
11980 * @param obj The anchorview object
11981 * @return The object used as parent for the hover, NULL if none is set.
11983 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11985 * Set the style that the hover should use
11987 * When creating the popup hover, anchorview will request that it's
11988 * themed according to @p style.
11990 * @param obj The anchorview object
11991 * @param style The style to use for the underlying hover
11993 * @see elm_object_style_set()
11995 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11997 * Get the style that the hover should use
11999 * Get the style the hover created by anchorview will use.
12001 * @param obj The anchorview object
12002 * @return The style to use by the hover. NULL means the default is used.
12004 * @see elm_object_style_set()
12006 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12008 * Ends the hover popup in the anchorview
12010 * When an anchor is clicked, the anchorview widget will create a hover
12011 * object to use as a popup with user provided content. This function
12012 * terminates this popup, returning the anchorview to its normal state.
12014 * @param obj The anchorview object
12016 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12018 * Set bouncing behaviour when the scrolled content reaches an edge
12020 * Tell the internal scroller object whether it should bounce or not
12021 * when it reaches the respective edges for each axis.
12023 * @param obj The anchorview object
12024 * @param h_bounce Whether to bounce or not in the horizontal axis
12025 * @param v_bounce Whether to bounce or not in the vertical axis
12027 * @see elm_scroller_bounce_set()
12029 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12031 * Get the set bouncing behaviour of the internal scroller
12033 * Get whether the internal scroller should bounce when the edge of each
12034 * axis is reached scrolling.
12036 * @param obj The anchorview object
12037 * @param h_bounce Pointer where to store the bounce state of the horizontal
12039 * @param v_bounce Pointer where to store the bounce state of the vertical
12042 * @see elm_scroller_bounce_get()
12044 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12046 * Appends a custom item provider to the given anchorview
12048 * Appends the given function to the list of items providers. This list is
12049 * called, one function at a time, with the given @p data pointer, the
12050 * anchorview object and, in the @p item parameter, the item name as
12051 * referenced in its href string. Following functions in the list will be
12052 * called in order until one of them returns something different to NULL,
12053 * which should be an Evas_Object which will be used in place of the item
12056 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12057 * href=item/name\>\</item\>
12059 * @param obj The anchorview object
12060 * @param func The function to add to the list of providers
12061 * @param data User data that will be passed to the callback function
12063 * @see elm_entry_item_provider_append()
12065 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);
12067 * Prepend a custom item provider to the given anchorview
12069 * Like elm_anchorview_item_provider_append(), but it adds the function
12070 * @p func to the beginning of the list, instead of the end.
12072 * @param obj The anchorview object
12073 * @param func The function to add to the list of providers
12074 * @param data User data that will be passed to the callback function
12076 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);
12078 * Remove a custom item provider from the list of the given anchorview
12080 * Removes the function and data pairing that matches @p func and @p data.
12081 * That is, unless the same function and same user data are given, the
12082 * function will not be removed from the list. This allows us to add the
12083 * same callback several times, with different @p data pointers and be
12084 * able to remove them later without conflicts.
12086 * @param obj The anchorview object
12087 * @param func The function to remove from the list
12088 * @param data The data matching the function to remove from the list
12090 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);
12097 * @defgroup Anchorblock Anchorblock
12099 * @image html img/widget/anchorblock/preview-00.png
12100 * @image latex img/widget/anchorblock/preview-00.eps
12102 * Anchorblock is for displaying text that contains markup with anchors
12103 * like <c>\<a href=1234\>something\</\></c> in it.
12105 * Besides being styled differently, the anchorblock widget provides the
12106 * necessary functionality so that clicking on these anchors brings up a
12107 * popup with user defined content such as "call", "add to contacts" or
12108 * "open web page". This popup is provided using the @ref Hover widget.
12110 * This widget emits the following signals:
12111 * @li "anchor,clicked": will be called when an anchor is clicked. The
12112 * @p event_info parameter on the callback will be a pointer of type
12113 * ::Elm_Entry_Anchorblock_Info.
12119 * Since examples are usually better than plain words, we might as well
12120 * try @ref tutorial_anchorblock_example "one".
12123 * @addtogroup Anchorblock
12127 * @typedef Elm_Entry_Anchorblock_Info
12129 * The info sent in the callback for "anchor,clicked" signals emitted by
12130 * the Anchorblock widget.
12132 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12134 * @struct _Elm_Entry_Anchorblock_Info
12136 * The info sent in the callback for "anchor,clicked" signals emitted by
12137 * the Anchorblock widget.
12139 struct _Elm_Entry_Anchorblock_Info
12141 const char *name; /**< Name of the anchor, as indicated in its href
12143 int button; /**< The mouse button used to click on it */
12144 Evas_Object *hover; /**< The hover object to use for the popup */
12146 Evas_Coord x, y, w, h;
12147 } anchor, /**< Geometry selection of text used as anchor */
12148 hover_parent; /**< Geometry of the object used as parent by the
12150 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12151 for content on the left side of
12152 the hover. Before calling the
12153 callback, the widget will make the
12154 necessary calculations to check
12155 which sides are fit to be set with
12156 content, based on the position the
12157 hover is activated and its distance
12158 to the edges of its parent object
12160 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12161 the right side of the hover.
12162 See @ref hover_left */
12163 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12164 of the hover. See @ref hover_left */
12165 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12166 below the hover. See @ref
12170 * Add a new Anchorblock object
12172 * @param parent The parent object
12173 * @return The new object or NULL if it cannot be created
12175 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12177 * Set the text to show in the anchorblock
12179 * Sets the text of the anchorblock to @p text. This text can include markup
12180 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12181 * of text that will be specially styled and react to click events, ended
12182 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12183 * "anchor,clicked" signal that you can attach a callback to with
12184 * evas_object_smart_callback_add(). The name of the anchor given in the
12185 * event info struct will be the one set in the href attribute, in this
12186 * case, anchorname.
12188 * Other markup can be used to style the text in different ways, but it's
12189 * up to the style defined in the theme which tags do what.
12190 * @deprecated use elm_object_text_set() instead.
12192 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12194 * Get the markup text set for the anchorblock
12196 * Retrieves the text set on the anchorblock, with markup tags included.
12198 * @param obj The anchorblock object
12199 * @return The markup text set or @c NULL if nothing was set or an error
12201 * @deprecated use elm_object_text_set() instead.
12203 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12205 * Set the parent of the hover popup
12207 * Sets the parent object to use by the hover created by the anchorblock
12208 * when an anchor is clicked. See @ref Hover for more details on this.
12210 * @param obj The anchorblock object
12211 * @param parent The object to use as parent for the hover
12213 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12215 * Get the parent of the hover popup
12217 * Get the object used as parent for the hover created by the anchorblock
12218 * widget. See @ref Hover for more details on this.
12219 * If no parent is set, the same anchorblock object will be used.
12221 * @param obj The anchorblock object
12222 * @return The object used as parent for the hover, NULL if none is set.
12224 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12226 * Set the style that the hover should use
12228 * When creating the popup hover, anchorblock will request that it's
12229 * themed according to @p style.
12231 * @param obj The anchorblock object
12232 * @param style The style to use for the underlying hover
12234 * @see elm_object_style_set()
12236 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12238 * Get the style that the hover should use
12240 * Get the style, the hover created by anchorblock will use.
12242 * @param obj The anchorblock object
12243 * @return The style to use by the hover. NULL means the default is used.
12245 * @see elm_object_style_set()
12247 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12249 * Ends the hover popup in the anchorblock
12251 * When an anchor is clicked, the anchorblock widget will create a hover
12252 * object to use as a popup with user provided content. This function
12253 * terminates this popup, returning the anchorblock to its normal state.
12255 * @param obj The anchorblock object
12257 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12259 * Appends a custom item provider to the given anchorblock
12261 * Appends the given function to the list of items providers. This list is
12262 * called, one function at a time, with the given @p data pointer, the
12263 * anchorblock object and, in the @p item parameter, the item name as
12264 * referenced in its href string. Following functions in the list will be
12265 * called in order until one of them returns something different to NULL,
12266 * which should be an Evas_Object which will be used in place of the item
12269 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12270 * href=item/name\>\</item\>
12272 * @param obj The anchorblock object
12273 * @param func The function to add to the list of providers
12274 * @param data User data that will be passed to the callback function
12276 * @see elm_entry_item_provider_append()
12278 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);
12280 * Prepend a custom item provider to the given anchorblock
12282 * Like elm_anchorblock_item_provider_append(), but it adds the function
12283 * @p func to the beginning of the list, instead of the end.
12285 * @param obj The anchorblock object
12286 * @param func The function to add to the list of providers
12287 * @param data User data that will be passed to the callback function
12289 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);
12291 * Remove a custom item provider from the list of the given anchorblock
12293 * Removes the function and data pairing that matches @p func and @p data.
12294 * That is, unless the same function and same user data are given, the
12295 * function will not be removed from the list. This allows us to add the
12296 * same callback several times, with different @p data pointers and be
12297 * able to remove them later without conflicts.
12299 * @param obj The anchorblock object
12300 * @param func The function to remove from the list
12301 * @param data The data matching the function to remove from the list
12303 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);
12309 * @defgroup Bubble Bubble
12311 * @image html img/widget/bubble/preview-00.png
12312 * @image latex img/widget/bubble/preview-00.eps
12313 * @image html img/widget/bubble/preview-01.png
12314 * @image latex img/widget/bubble/preview-01.eps
12315 * @image html img/widget/bubble/preview-02.png
12316 * @image latex img/widget/bubble/preview-02.eps
12318 * @brief The Bubble is a widget to show text similar to how speech is
12319 * represented in comics.
12321 * The bubble widget contains 5 important visual elements:
12322 * @li The frame is a rectangle with rounded edjes and an "arrow".
12323 * @li The @p icon is an image to which the frame's arrow points to.
12324 * @li The @p label is a text which appears to the right of the icon if the
12325 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12327 * @li The @p info is a text which appears to the right of the label. Info's
12328 * font is of a ligther color than label.
12329 * @li The @p content is an evas object that is shown inside the frame.
12331 * The position of the arrow, icon, label and info depends on which corner is
12332 * selected. The four available corners are:
12333 * @li "top_left" - Default
12335 * @li "bottom_left"
12336 * @li "bottom_right"
12338 * Signals that you can add callbacks for are:
12339 * @li "clicked" - This is called when a user has clicked the bubble.
12341 * For an example of using a buble see @ref bubble_01_example_page "this".
12346 * Add a new bubble to the parent
12348 * @param parent The parent object
12349 * @return The new object or NULL if it cannot be created
12351 * This function adds a text bubble to the given parent evas object.
12353 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12355 * Set the label of the bubble
12357 * @param obj The bubble object
12358 * @param label The string to set in the label
12360 * This function sets the title of the bubble. Where this appears depends on
12361 * the selected corner.
12362 * @deprecated use elm_object_text_set() instead.
12364 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12366 * Get the label of the bubble
12368 * @param obj The bubble object
12369 * @return The string of set in the label
12371 * This function gets the title of the bubble.
12372 * @deprecated use elm_object_text_get() instead.
12374 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12376 * Set the info of the bubble
12378 * @param obj The bubble object
12379 * @param info The given info about the bubble
12381 * This function sets the info of the bubble. Where this appears depends on
12382 * the selected corner.
12383 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12385 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12387 * Get the info of the bubble
12389 * @param obj The bubble object
12391 * @return The "info" string of the bubble
12393 * This function gets the info text.
12394 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12396 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12398 * Set the content to be shown in the bubble
12400 * Once the content object is set, a previously set one will be deleted.
12401 * If you want to keep the old content object, use the
12402 * elm_bubble_content_unset() function.
12404 * @param obj The bubble object
12405 * @param content The given content of the bubble
12407 * This function sets the content shown on the middle of the bubble.
12409 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12411 * Get the content shown in the bubble
12413 * Return the content object which is set for this widget.
12415 * @param obj The bubble object
12416 * @return The content that is being used
12418 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12420 * Unset the content shown in the bubble
12422 * Unparent and return the content object which was set for this widget.
12424 * @param obj The bubble object
12425 * @return The content that was being used
12427 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12429 * Set the icon of the bubble
12431 * Once the icon object is set, a previously set one will be deleted.
12432 * If you want to keep the old content object, use the
12433 * elm_icon_content_unset() function.
12435 * @param obj The bubble object
12436 * @param icon The given icon for the bubble
12438 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12440 * Get the icon of the bubble
12442 * @param obj The bubble object
12443 * @return The icon for the bubble
12445 * This function gets the icon shown on the top left of bubble.
12447 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12449 * Unset the icon of the bubble
12451 * Unparent and return the icon object which was set for this widget.
12453 * @param obj The bubble object
12454 * @return The icon that was being used
12456 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12458 * Set the corner of the bubble
12460 * @param obj The bubble object.
12461 * @param corner The given corner for the bubble.
12463 * This function sets the corner of the bubble. The corner will be used to
12464 * determine where the arrow in the frame points to and where label, icon and
12467 * Possible values for corner are:
12468 * @li "top_left" - Default
12470 * @li "bottom_left"
12471 * @li "bottom_right"
12473 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12475 * Get the corner of the bubble
12477 * @param obj The bubble object.
12478 * @return The given corner for the bubble.
12480 * This function gets the selected corner of the bubble.
12482 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12488 * @defgroup Photo Photo
12490 * For displaying the photo of a person (contact). Simple, yet
12491 * with a very specific purpose.
12493 * Signals that you can add callbacks for are:
12495 * "clicked" - This is called when a user has clicked the photo
12496 * "drag,start" - Someone started dragging the image out of the object
12497 * "drag,end" - Dragged item was dropped (somewhere)
12503 * Add a new photo to the parent
12505 * @param parent The parent object
12506 * @return The new object or NULL if it cannot be created
12510 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12513 * Set the file that will be used as photo
12515 * @param obj The photo object
12516 * @param file The path to file that will be used as photo
12518 * @return (1 = success, 0 = error)
12522 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12525 * Set the file that will be used as thumbnail in the photo.
12527 * @param obj The photo object.
12528 * @param file The path to file that will be used as thumb.
12529 * @param group The key used in case of an EET file.
12533 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12536 * Set the size that will be used on the photo
12538 * @param obj The photo object
12539 * @param size The size that the photo will be
12543 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12546 * Set if the photo should be completely visible or not.
12548 * @param obj The photo object
12549 * @param fill if true the photo will be completely visible
12553 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12556 * Set editability of the photo.
12558 * An editable photo can be dragged to or from, and can be cut or
12559 * pasted too. Note that pasting an image or dropping an item on
12560 * the image will delete the existing content.
12562 * @param obj The photo object.
12563 * @param set To set of clear editablity.
12565 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12571 /* gesture layer */
12573 * @defgroup Elm_Gesture_Layer Gesture Layer
12574 * Gesture Layer Usage:
12576 * Use Gesture Layer to detect gestures.
12577 * The advantage is that you don't have to implement
12578 * gesture detection, just set callbacks of gesture state.
12579 * By using gesture layer we make standard interface.
12581 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12582 * with a parent object parameter.
12583 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12584 * call. Usually with same object as target (2nd parameter).
12586 * Now you need to tell gesture layer what gestures you follow.
12587 * This is done with @ref elm_gesture_layer_cb_set call.
12588 * By setting the callback you actually saying to gesture layer:
12589 * I would like to know when the gesture @ref Elm_Gesture_Types
12590 * switches to state @ref Elm_Gesture_State.
12592 * Next, you need to implement the actual action that follows the input
12593 * in your callback.
12595 * Note that if you like to stop being reported about a gesture, just set
12596 * all callbacks referring this gesture to NULL.
12597 * (again with @ref elm_gesture_layer_cb_set)
12599 * The information reported by gesture layer to your callback is depending
12600 * on @ref Elm_Gesture_Types:
12601 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12602 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12603 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12605 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12606 * @ref ELM_GESTURE_MOMENTUM.
12608 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12609 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12610 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12611 * Note that we consider a flick as a line-gesture that should be completed
12612 * in flick-time-limit as defined in @ref Config.
12614 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12616 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12619 * Gesture Layer Tweaks:
12621 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12622 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12624 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12625 * so gesture starts when user touches (a *DOWN event) touch-surface
12626 * and ends when no fingers touches surface (a *UP event).
12630 * @enum _Elm_Gesture_Types
12631 * Enum of supported gesture types.
12632 * @ingroup Elm_Gesture_Layer
12634 enum _Elm_Gesture_Types
12636 ELM_GESTURE_FIRST = 0,
12638 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12639 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12640 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12641 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12643 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12645 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12646 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12648 ELM_GESTURE_ZOOM, /**< Zoom */
12649 ELM_GESTURE_ROTATE, /**< Rotate */
12655 * @typedef Elm_Gesture_Types
12656 * gesture types enum
12657 * @ingroup Elm_Gesture_Layer
12659 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12662 * @enum _Elm_Gesture_State
12663 * Enum of gesture states.
12664 * @ingroup Elm_Gesture_Layer
12666 enum _Elm_Gesture_State
12668 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12669 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12670 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12671 ELM_GESTURE_STATE_END, /**< Gesture completed */
12672 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12676 * @typedef Elm_Gesture_State
12677 * gesture states enum
12678 * @ingroup Elm_Gesture_Layer
12680 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12683 * @struct _Elm_Gesture_Taps_Info
12684 * Struct holds taps info for user
12685 * @ingroup Elm_Gesture_Layer
12687 struct _Elm_Gesture_Taps_Info
12689 Evas_Coord x, y; /**< Holds center point between fingers */
12690 unsigned int n; /**< Number of fingers tapped */
12691 unsigned int timestamp; /**< event timestamp */
12695 * @typedef Elm_Gesture_Taps_Info
12696 * holds taps info for user
12697 * @ingroup Elm_Gesture_Layer
12699 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12702 * @struct _Elm_Gesture_Momentum_Info
12703 * Struct holds momentum info for user
12704 * x1 and y1 are not necessarily in sync
12705 * x1 holds x value of x direction starting point
12706 * and same holds for y1.
12707 * This is noticeable when doing V-shape movement
12708 * @ingroup Elm_Gesture_Layer
12710 struct _Elm_Gesture_Momentum_Info
12711 { /* Report line ends, timestamps, and momentum computed */
12712 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12713 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12714 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12715 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12717 unsigned int tx; /**< Timestamp of start of final x-swipe */
12718 unsigned int ty; /**< Timestamp of start of final y-swipe */
12720 Evas_Coord mx; /**< Momentum on X */
12721 Evas_Coord my; /**< Momentum on Y */
12723 unsigned int n; /**< Number of fingers */
12727 * @typedef Elm_Gesture_Momentum_Info
12728 * holds momentum info for user
12729 * @ingroup Elm_Gesture_Layer
12731 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12734 * @struct _Elm_Gesture_Line_Info
12735 * Struct holds line info for user
12736 * @ingroup Elm_Gesture_Layer
12738 struct _Elm_Gesture_Line_Info
12739 { /* Report line ends, timestamps, and momentum computed */
12740 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12741 /* FIXME should be radians, bot degrees */
12742 double angle; /**< Angle (direction) of lines */
12746 * @typedef Elm_Gesture_Line_Info
12747 * Holds line info for user
12748 * @ingroup Elm_Gesture_Layer
12750 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12753 * @struct _Elm_Gesture_Zoom_Info
12754 * Struct holds zoom info for user
12755 * @ingroup Elm_Gesture_Layer
12757 struct _Elm_Gesture_Zoom_Info
12759 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12760 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12761 double zoom; /**< Zoom value: 1.0 means no zoom */
12762 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12766 * @typedef Elm_Gesture_Zoom_Info
12767 * Holds zoom info for user
12768 * @ingroup Elm_Gesture_Layer
12770 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12773 * @struct _Elm_Gesture_Rotate_Info
12774 * Struct holds rotation info for user
12775 * @ingroup Elm_Gesture_Layer
12777 struct _Elm_Gesture_Rotate_Info
12779 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12780 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12781 double base_angle; /**< Holds start-angle */
12782 double angle; /**< Rotation value: 0.0 means no rotation */
12783 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12787 * @typedef Elm_Gesture_Rotate_Info
12788 * Holds rotation info for user
12789 * @ingroup Elm_Gesture_Layer
12791 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12794 * @typedef Elm_Gesture_Event_Cb
12795 * User callback used to stream gesture info from gesture layer
12796 * @param data user data
12797 * @param event_info gesture report info
12798 * Returns a flag field to be applied on the causing event.
12799 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12800 * upon the event, in an irreversible way.
12802 * @ingroup Elm_Gesture_Layer
12804 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12807 * Use function to set callbacks to be notified about
12808 * change of state of gesture.
12809 * When a user registers a callback with this function
12810 * this means this gesture has to be tested.
12812 * When ALL callbacks for a gesture are set to NULL
12813 * it means user isn't interested in gesture-state
12814 * and it will not be tested.
12816 * @param obj Pointer to gesture-layer.
12817 * @param idx The gesture you would like to track its state.
12818 * @param cb callback function pointer.
12819 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12820 * @param data user info to be sent to callback (usually, Smart Data)
12822 * @ingroup Elm_Gesture_Layer
12824 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);
12827 * Call this function to get repeat-events settings.
12829 * @param obj Pointer to gesture-layer.
12831 * @return repeat events settings.
12832 * @see elm_gesture_layer_hold_events_set()
12833 * @ingroup Elm_Gesture_Layer
12835 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12838 * This function called in order to make gesture-layer repeat events.
12839 * Set this of you like to get the raw events only if gestures were not detected.
12840 * Clear this if you like gesture layer to fwd events as testing gestures.
12842 * @param obj Pointer to gesture-layer.
12843 * @param r Repeat: TRUE/FALSE
12845 * @ingroup Elm_Gesture_Layer
12847 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12850 * This function sets step-value for zoom action.
12851 * Set step to any positive value.
12852 * Cancel step setting by setting to 0.0
12854 * @param obj Pointer to gesture-layer.
12855 * @param s new zoom step value.
12857 * @ingroup Elm_Gesture_Layer
12859 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12862 * This function sets step-value for rotate action.
12863 * Set step to any positive value.
12864 * Cancel step setting by setting to 0.0
12866 * @param obj Pointer to gesture-layer.
12867 * @param s new roatate step value.
12869 * @ingroup Elm_Gesture_Layer
12871 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12874 * This function called to attach gesture-layer to an Evas_Object.
12875 * @param obj Pointer to gesture-layer.
12876 * @param t Pointer to underlying object (AKA Target)
12878 * @return TRUE, FALSE on success, failure.
12880 * @ingroup Elm_Gesture_Layer
12882 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12885 * Call this function to construct a new gesture-layer object.
12886 * This does not activate the gesture layer. You have to
12887 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12889 * @param parent the parent object.
12891 * @return Pointer to new gesture-layer object.
12893 * @ingroup Elm_Gesture_Layer
12895 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12898 * @defgroup Thumb Thumb
12900 * @image html img/widget/thumb/preview-00.png
12901 * @image latex img/widget/thumb/preview-00.eps
12903 * A thumb object is used for displaying the thumbnail of an image or video.
12904 * You must have compiled Elementary with Ethumb_Client support and the DBus
12905 * service must be present and auto-activated in order to have thumbnails to
12908 * Once the thumbnail object becomes visible, it will check if there is a
12909 * previously generated thumbnail image for the file set on it. If not, it
12910 * will start generating this thumbnail.
12912 * Different config settings will cause different thumbnails to be generated
12913 * even on the same file.
12915 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12916 * Ethumb documentation to change this path, and to see other configuration
12919 * Signals that you can add callbacks for are:
12921 * - "clicked" - This is called when a user has clicked the thumb without dragging
12923 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12924 * - "press" - This is called when a user has pressed down the thumb.
12925 * - "generate,start" - The thumbnail generation started.
12926 * - "generate,stop" - The generation process stopped.
12927 * - "generate,error" - The generation failed.
12928 * - "load,error" - The thumbnail image loading failed.
12930 * available styles:
12934 * An example of use of thumbnail:
12936 * - @ref thumb_example_01
12940 * @addtogroup Thumb
12945 * @enum _Elm_Thumb_Animation_Setting
12946 * @typedef Elm_Thumb_Animation_Setting
12948 * Used to set if a video thumbnail is animating or not.
12952 typedef enum _Elm_Thumb_Animation_Setting
12954 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12955 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
12956 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
12957 ELM_THUMB_ANIMATION_LAST
12958 } Elm_Thumb_Animation_Setting;
12961 * Add a new thumb object to the parent.
12963 * @param parent The parent object.
12964 * @return The new object or NULL if it cannot be created.
12966 * @see elm_thumb_file_set()
12967 * @see elm_thumb_ethumb_client_get()
12971 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12973 * Reload thumbnail if it was generated before.
12975 * @param obj The thumb object to reload
12977 * This is useful if the ethumb client configuration changed, like its
12978 * size, aspect or any other property one set in the handle returned
12979 * by elm_thumb_ethumb_client_get().
12981 * If the options didn't change, the thumbnail won't be generated again, but
12982 * the old one will still be used.
12984 * @see elm_thumb_file_set()
12988 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12990 * Set the file that will be used as thumbnail.
12992 * @param obj The thumb object.
12993 * @param file The path to file that will be used as thumb.
12994 * @param key The key used in case of an EET file.
12996 * The file can be an image or a video (in that case, acceptable extensions are:
12997 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12998 * function elm_thumb_animate().
13000 * @see elm_thumb_file_get()
13001 * @see elm_thumb_reload()
13002 * @see elm_thumb_animate()
13006 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13008 * Get the image or video path and key used to generate the thumbnail.
13010 * @param obj The thumb object.
13011 * @param file Pointer to filename.
13012 * @param key Pointer to key.
13014 * @see elm_thumb_file_set()
13015 * @see elm_thumb_path_get()
13019 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13021 * Get the path and key to the image or video generated by ethumb.
13023 * One just need to make sure that the thumbnail was generated before getting
13024 * its path; otherwise, the path will be NULL. One way to do that is by asking
13025 * for the path when/after the "generate,stop" smart callback is called.
13027 * @param obj The thumb object.
13028 * @param file Pointer to thumb path.
13029 * @param key Pointer to thumb key.
13031 * @see elm_thumb_file_get()
13035 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13037 * Set the animation state for the thumb object. If its content is an animated
13038 * video, you may start/stop the animation or tell it to play continuously and
13041 * @param obj The thumb object.
13042 * @param setting The animation setting.
13044 * @see elm_thumb_file_set()
13048 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13050 * Get the animation state for the thumb object.
13052 * @param obj The thumb object.
13053 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13056 * @see elm_thumb_animate_set()
13060 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13062 * Get the ethumb_client handle so custom configuration can be made.
13064 * @return Ethumb_Client instance or NULL.
13066 * This must be called before the objects are created to be sure no object is
13067 * visible and no generation started.
13069 * Example of usage:
13072 * #include <Elementary.h>
13073 * #ifndef ELM_LIB_QUICKLAUNCH
13075 * elm_main(int argc, char **argv)
13077 * Ethumb_Client *client;
13079 * elm_need_ethumb();
13083 * client = elm_thumb_ethumb_client_get();
13086 * ERR("could not get ethumb_client");
13089 * ethumb_client_size_set(client, 100, 100);
13090 * ethumb_client_crop_align_set(client, 0.5, 0.5);
13093 * // Create elm_thumb objects here
13103 * @note There's only one client handle for Ethumb, so once a configuration
13104 * change is done to it, any other request for thumbnails (for any thumbnail
13105 * object) will use that configuration. Thus, this configuration is global.
13109 EAPI void *elm_thumb_ethumb_client_get(void);
13111 * Get the ethumb_client connection state.
13113 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13116 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
13118 * Make the thumbnail 'editable'.
13120 * @param obj Thumb object.
13121 * @param set Turn on or off editability. Default is @c EINA_FALSE.
13123 * This means the thumbnail is a valid drag target for drag and drop, and can be
13124 * cut or pasted too.
13126 * @see elm_thumb_editable_get()
13130 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13132 * Make the thumbnail 'editable'.
13134 * @param obj Thumb object.
13135 * @return Editability.
13137 * This means the thumbnail is a valid drag target for drag and drop, and can be
13138 * cut or pasted too.
13140 * @see elm_thumb_editable_set()
13144 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13151 * @defgroup Web Web
13153 * @image html img/widget/web/preview-00.png
13154 * @image latex img/widget/web/preview-00.eps
13156 * A web object is used for displaying web pages (HTML/CSS/JS)
13157 * using WebKit-EFL. You must have compiled Elementary with
13160 * Signals that you can add callbacks for are:
13161 * @li "download,request": A file download has been requested. Event info is
13162 * a pointer to a Elm_Web_Download
13163 * @li "editorclient,contents,changed": Editor client's contents changed
13164 * @li "editorclient,selection,changed": Editor client's selection changed
13165 * @li "frame,created": A new frame was created. Event info is an
13166 * Evas_Object which can be handled with WebKit's ewk_frame API
13167 * @li "icon,received": An icon was received by the main frame
13168 * @li "inputmethod,changed": Input method changed. Event info is an
13169 * Eina_Bool indicating whether it's enabled or not
13170 * @li "js,windowobject,clear": JS window object has been cleared
13171 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13172 * is a char *link[2], where the first string contains the URL the link
13173 * points to, and the second one the title of the link
13174 * @li "link,hover,out": Mouse cursor left the link
13175 * @li "load,document,finished": Loading of a document finished. Event info
13176 * is the frame that finished loading
13177 * @li "load,error": Load failed. Event info is a pointer to
13178 * Elm_Web_Frame_Load_Error
13179 * @li "load,finished": Load finished. Event info is NULL on success, on
13180 * error it's a pointer to Elm_Web_Frame_Load_Error
13181 * @li "load,newwindow,show": A new window was created and is ready to be
13183 * @li "load,progress": Overall load progress. Event info is a pointer to
13184 * a double containing a value between 0.0 and 1.0
13185 * @li "load,provisional": Started provisional load
13186 * @li "load,started": Loading of a document started
13187 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13188 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13189 * the menubar is visible, or EINA_FALSE in case it's not
13190 * @li "menubar,visible,set": Informs menubar visibility. Event info is
13191 * an Eina_Bool indicating the visibility
13192 * @li "popup,created": A dropdown widget was activated, requesting its
13193 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13194 * @li "popup,willdelete": The web object is ready to destroy the popup
13195 * object created. Event info is a pointer to Elm_Web_Menu
13196 * @li "ready": Page is fully loaded
13197 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13198 * info is a pointer to Eina_Bool where the visibility state should be set
13199 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13200 * is an Eina_Bool with the visibility state set
13201 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13202 * a string with the new text
13203 * @li "statusbar,visible,get": Queries visibility of the status bar.
13204 * Event info is a pointer to Eina_Bool where the visibility state should be
13206 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13207 * an Eina_Bool with the visibility value
13208 * @li "title,changed": Title of the main frame changed. Event info is a
13209 * string with the new title
13210 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13211 * is a pointer to Eina_Bool where the visibility state should be set
13212 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13213 * info is an Eina_Bool with the visibility state
13214 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13215 * a string with the text to show
13216 * @li "uri,changed": URI of the main frame changed. Event info is a string
13218 * @li "view,resized": The web object internal's view changed sized
13219 * @li "windows,close,request": A JavaScript request to close the current
13220 * window was requested
13221 * @li "zoom,animated,end": Animated zoom finished
13223 * available styles:
13226 * An example of use of web:
13228 * - @ref web_example_01 TBD
13237 * Structure used to report load errors.
13239 * Load errors are reported as signal by elm_web. All the strings are
13240 * temporary references and should @b not be used after the signal
13241 * callback returns. If it's required, make copies with strdup() or
13242 * eina_stringshare_add() (they are not even guaranteed to be
13243 * stringshared, so must use eina_stringshare_add() and not
13244 * eina_stringshare_ref()).
13246 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13248 * Structure used to report load errors.
13250 * Load errors are reported as signal by elm_web. All the strings are
13251 * temporary references and should @b not be used after the signal
13252 * callback returns. If it's required, make copies with strdup() or
13253 * eina_stringshare_add() (they are not even guaranteed to be
13254 * stringshared, so must use eina_stringshare_add() and not
13255 * eina_stringshare_ref()).
13257 struct _Elm_Web_Frame_Load_Error
13259 int code; /**< Numeric error code */
13260 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13261 const char *domain; /**< Error domain name */
13262 const char *description; /**< Error description (already localized) */
13263 const char *failing_url; /**< The URL that failed to load */
13264 Evas_Object *frame; /**< Frame object that produced the error */
13268 * The possibles types that the items in a menu can be
13270 typedef enum _Elm_Web_Menu_Item_Type
13272 ELM_WEB_MENU_SEPARATOR,
13273 ELM_WEB_MENU_GROUP,
13274 ELM_WEB_MENU_OPTION
13275 } Elm_Web_Menu_Item_Type;
13278 * Structure describing the items in a menu
13280 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13282 * Structure describing the items in a menu
13284 struct _Elm_Web_Menu_Item
13286 const char *text; /**< The text for the item */
13287 Elm_Web_Menu_Item_Type type; /**< The type of the item */
13291 * Structure describing the menu of a popup
13293 * This structure will be passed as the @c event_info for the "popup,create"
13294 * signal, which is emitted when a dropdown menu is opened. Users wanting
13295 * to handle these popups by themselves should listen to this signal and
13296 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13297 * property as @c EINA_FALSE means that the user will not handle the popup
13298 * and the default implementation will be used.
13300 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13301 * will be emitted to notify the user that it can destroy any objects and
13302 * free all data related to it.
13304 * @see elm_web_popup_selected_set()
13305 * @see elm_web_popup_destroy()
13307 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13309 * Structure describing the menu of a popup
13311 * This structure will be passed as the @c event_info for the "popup,create"
13312 * signal, which is emitted when a dropdown menu is opened. Users wanting
13313 * to handle these popups by themselves should listen to this signal and
13314 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13315 * property as @c EINA_FALSE means that the user will not handle the popup
13316 * and the default implementation will be used.
13318 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13319 * will be emitted to notify the user that it can destroy any objects and
13320 * free all data related to it.
13322 * @see elm_web_popup_selected_set()
13323 * @see elm_web_popup_destroy()
13325 struct _Elm_Web_Menu
13327 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13328 int x; /**< The X position of the popup, relative to the elm_web object */
13329 int y; /**< The Y position of the popup, relative to the elm_web object */
13330 int width; /**< Width of the popup menu */
13331 int height; /**< Height of the popup menu */
13333 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. */
13336 typedef struct _Elm_Web_Download Elm_Web_Download;
13337 struct _Elm_Web_Download
13343 * Types of zoom available.
13345 typedef enum _Elm_Web_Zoom_Mode
13347 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13348 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13349 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13350 ELM_WEB_ZOOM_MODE_LAST
13351 } Elm_Web_Zoom_Mode;
13353 * Opaque handler containing the features (such as statusbar, menubar, etc)
13354 * that are to be set on a newly requested window.
13356 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13358 * Callback type for the create_window hook.
13360 * The function parameters are:
13361 * @li @p data User data pointer set when setting the hook function
13362 * @li @p obj The elm_web object requesting the new window
13363 * @li @p js Set to @c EINA_TRUE if the request was originated from
13364 * JavaScript. @c EINA_FALSE otherwise.
13365 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13366 * the features requested for the new window.
13368 * The returned value of the function should be the @c elm_web widget where
13369 * the request will be loaded. That is, if a new window or tab is created,
13370 * the elm_web widget in it should be returned, and @b NOT the window
13372 * Returning @c NULL should cancel the request.
13374 * @see elm_web_window_create_hook_set()
13376 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13378 * Callback type for the JS alert hook.
13380 * The function parameters are:
13381 * @li @p data User data pointer set when setting the hook function
13382 * @li @p obj The elm_web object requesting the new window
13383 * @li @p message The message to show in the alert dialog
13385 * The function should return the object representing the alert dialog.
13386 * Elm_Web will run a second main loop to handle the dialog and normal
13387 * flow of the application will be restored when the object is deleted, so
13388 * the user should handle the popup properly in order to delete the object
13389 * when the action is finished.
13390 * If the function returns @c NULL the popup will be ignored.
13392 * @see elm_web_dialog_alert_hook_set()
13394 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13396 * Callback type for the JS confirm hook.
13398 * The function parameters are:
13399 * @li @p data User data pointer set when setting the hook function
13400 * @li @p obj The elm_web object requesting the new window
13401 * @li @p message The message to show in the confirm dialog
13402 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13403 * the user selected @c Ok, @c EINA_FALSE otherwise.
13405 * The function should return the object representing the confirm dialog.
13406 * Elm_Web will run a second main loop to handle the dialog and normal
13407 * flow of the application will be restored when the object is deleted, so
13408 * the user should handle the popup properly in order to delete the object
13409 * when the action is finished.
13410 * If the function returns @c NULL the popup will be ignored.
13412 * @see elm_web_dialog_confirm_hook_set()
13414 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13416 * Callback type for the JS prompt hook.
13418 * The function parameters are:
13419 * @li @p data User data pointer set when setting the hook function
13420 * @li @p obj The elm_web object requesting the new window
13421 * @li @p message The message to show in the prompt dialog
13422 * @li @p def_value The default value to present the user in the entry
13423 * @li @p value Pointer where to store the value given by the user. Must
13424 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13425 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13426 * the user selected @c Ok, @c EINA_FALSE otherwise.
13428 * The function should return the object representing the prompt dialog.
13429 * Elm_Web will run a second main loop to handle the dialog and normal
13430 * flow of the application will be restored when the object is deleted, so
13431 * the user should handle the popup properly in order to delete the object
13432 * when the action is finished.
13433 * If the function returns @c NULL the popup will be ignored.
13435 * @see elm_web_dialog_prompt_hook_set()
13437 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13439 * Callback type for the JS file selector hook.
13441 * The function parameters are:
13442 * @li @p data User data pointer set when setting the hook function
13443 * @li @p obj The elm_web object requesting the new window
13444 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13445 * @li @p accept_types Mime types accepted
13446 * @li @p selected Pointer where to store the list of malloc'ed strings
13447 * containing the path to each file selected. Must be @c NULL if the file
13448 * dialog is cancelled
13449 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13450 * the user selected @c Ok, @c EINA_FALSE otherwise.
13452 * The function should return the object representing the file selector
13454 * Elm_Web will run a second main loop to handle the dialog and normal
13455 * flow of the application will be restored when the object is deleted, so
13456 * the user should handle the popup properly in order to delete the object
13457 * when the action is finished.
13458 * If the function returns @c NULL the popup will be ignored.
13460 * @see elm_web_dialog_file selector_hook_set()
13462 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);
13464 * Callback type for the JS console message hook.
13466 * When a console message is added from JavaScript, any set function to the
13467 * console message hook will be called for the user to handle. There is no
13468 * default implementation of this hook.
13470 * The function parameters are:
13471 * @li @p data User data pointer set when setting the hook function
13472 * @li @p obj The elm_web object that originated the message
13473 * @li @p message The message sent
13474 * @li @p line_number The line number
13475 * @li @p source_id Source id
13477 * @see elm_web_console_message_hook_set()
13479 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13481 * Add a new web object to the parent.
13483 * @param parent The parent object.
13484 * @return The new object or NULL if it cannot be created.
13486 * @see elm_web_uri_set()
13487 * @see elm_web_webkit_view_get()
13489 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13492 * Get internal ewk_view object from web object.
13494 * Elementary may not provide some low level features of EWebKit,
13495 * instead of cluttering the API with proxy methods we opted to
13496 * return the internal reference. Be careful using it as it may
13497 * interfere with elm_web behavior.
13499 * @param obj The web object.
13500 * @return The internal ewk_view object or NULL if it does not
13501 * exist. (Failure to create or Elementary compiled without
13504 * @see elm_web_add()
13506 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13509 * Sets the function to call when a new window is requested
13511 * This hook will be called when a request to create a new window is
13512 * issued from the web page loaded.
13513 * There is no default implementation for this feature, so leaving this
13514 * unset or passing @c NULL in @p func will prevent new windows from
13517 * @param obj The web object where to set the hook function
13518 * @param func The hook function to be called when a window is requested
13519 * @param data User data
13521 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13523 * Sets the function to call when an alert dialog
13525 * This hook will be called when a JavaScript alert dialog is requested.
13526 * If no function is set or @c NULL is passed in @p func, the default
13527 * implementation will take place.
13529 * @param obj The web object where to set the hook function
13530 * @param func The callback function to be used
13531 * @param data User data
13533 * @see elm_web_inwin_mode_set()
13535 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13537 * Sets the function to call when an confirm dialog
13539 * This hook will be called when a JavaScript confirm dialog is requested.
13540 * If no function is set or @c NULL is passed in @p func, the default
13541 * implementation will take place.
13543 * @param obj The web object where to set the hook function
13544 * @param func The callback function to be used
13545 * @param data User data
13547 * @see elm_web_inwin_mode_set()
13549 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13551 * Sets the function to call when an prompt dialog
13553 * This hook will be called when a JavaScript prompt dialog is requested.
13554 * If no function is set or @c NULL is passed in @p func, the default
13555 * implementation will take place.
13557 * @param obj The web object where to set the hook function
13558 * @param func The callback function to be used
13559 * @param data User data
13561 * @see elm_web_inwin_mode_set()
13563 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13565 * Sets the function to call when an file selector dialog
13567 * This hook will be called when a JavaScript file selector dialog is
13569 * If no function is set or @c NULL is passed in @p func, the default
13570 * implementation will take place.
13572 * @param obj The web object where to set the hook function
13573 * @param func The callback function to be used
13574 * @param data User data
13576 * @see elm_web_inwin_mode_set()
13578 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13580 * Sets the function to call when a console message is emitted from JS
13582 * This hook will be called when a console message is emitted from
13583 * JavaScript. There is no default implementation for this feature.
13585 * @param obj The web object where to set the hook function
13586 * @param func The callback function to be used
13587 * @param data User data
13589 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13591 * Gets the status of the tab propagation
13593 * @param obj The web object to query
13594 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13596 * @see elm_web_tab_propagate_set()
13598 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13600 * Sets whether to use tab propagation
13602 * If tab propagation is enabled, whenever the user presses the Tab key,
13603 * Elementary will handle it and switch focus to the next widget.
13604 * The default value is disabled, where WebKit will handle the Tab key to
13605 * cycle focus though its internal objects, jumping to the next widget
13606 * only when that cycle ends.
13608 * @param obj The web object
13609 * @param propagate Whether to propagate Tab keys to Elementary or not
13611 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13613 * Sets the URI for the web object
13615 * It must be a full URI, with resource included, in the form
13616 * http://www.enlightenment.org or file:///tmp/something.html
13618 * @param obj The web object
13619 * @param uri The URI to set
13620 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13622 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13624 * Gets the current URI for the object
13626 * The returned string must not be freed and is guaranteed to be
13629 * @param obj The web object
13630 * @return A stringshared internal string with the current URI, or NULL on
13633 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13635 * Gets the current title
13637 * The returned string must not be freed and is guaranteed to be
13640 * @param obj The web object
13641 * @return A stringshared internal string with the current title, or NULL on
13644 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13646 * Sets the background color to be used by the web object
13648 * This is the color that will be used by default when the loaded page
13649 * does not set it's own. Color values are pre-multiplied.
13651 * @param obj The web object
13652 * @param r Red component
13653 * @param g Green component
13654 * @param b Blue component
13655 * @param a Alpha component
13657 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13659 * Gets the background color to be used by the web object
13661 * This is the color that will be used by default when the loaded page
13662 * does not set it's own. Color values are pre-multiplied.
13664 * @param obj The web object
13665 * @param r Red component
13666 * @param g Green component
13667 * @param b Blue component
13668 * @param a Alpha component
13670 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13672 * Gets a copy of the currently selected text
13674 * The string returned must be freed by the user when it's done with it.
13676 * @param obj The web object
13677 * @return A newly allocated string, or NULL if nothing is selected or an
13680 EAPI char *elm_view_selection_get(const Evas_Object *obj);
13682 * Tells the web object which index in the currently open popup was selected
13684 * When the user handles the popup creation from the "popup,created" signal,
13685 * it needs to tell the web object which item was selected by calling this
13686 * function with the index corresponding to the item.
13688 * @param obj The web object
13689 * @param index The index selected
13691 * @see elm_web_popup_destroy()
13693 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
13695 * Dismisses an open dropdown popup
13697 * When the popup from a dropdown widget is to be dismissed, either after
13698 * selecting an option or to cancel it, this function must be called, which
13699 * will later emit an "popup,willdelete" signal to notify the user that
13700 * any memory and objects related to this popup can be freed.
13702 * @param obj The web object
13703 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13704 * if there was no menu to destroy
13706 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
13708 * Searches the given string in a document.
13710 * @param obj The web object where to search the text
13711 * @param string String to search
13712 * @param case_sensitive If search should be case sensitive or not
13713 * @param forward If search is from cursor and on or backwards
13714 * @param wrap If search should wrap at the end
13716 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13719 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13721 * Marks matches of the given string in a document.
13723 * @param obj The web object where to search text
13724 * @param string String to match
13725 * @param case_sensitive If match should be case sensitive or not
13726 * @param highlight If matches should be highlighted
13727 * @param limit Maximum amount of matches, or zero to unlimited
13729 * @return number of matched @a string
13731 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13733 * Clears all marked matches in the document
13735 * @param obj The web object
13737 * @return EINA_TRUE on success, EINA_FALSE otherwise
13739 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
13741 * Sets whether to highlight the matched marks
13743 * If enabled, marks set with elm_web_text_matches_mark() will be
13746 * @param obj The web object
13747 * @param highlight Whether to highlight the marks or not
13749 * @return EINA_TRUE on success, EINA_FALSE otherwise
13751 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13753 * Gets whether highlighting marks is enabled
13755 * @param The web object
13757 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13760 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
13762 * Gets the overall loading progress of the page
13764 * Returns the estimated loading progress of the page, with a value between
13765 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13766 * included in the page.
13768 * @param The web object
13770 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13773 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
13775 * Stops loading the current page
13777 * Cancels the loading of the current page in the web object. This will
13778 * cause a "load,error" signal to be emitted, with the is_cancellation
13779 * flag set to EINA_TRUE.
13781 * @param obj The web object
13783 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13785 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
13787 * Requests a reload of the current document in the object
13789 * @param obj The web object
13791 * @return EINA_TRUE on success, EINA_FALSE otherwise
13793 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
13795 * Requests a reload of the current document, avoiding any existing caches
13797 * @param obj The web object
13799 * @return EINA_TRUE on success, EINA_FALSE otherwise
13801 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
13803 * Goes back one step in the browsing history
13805 * This is equivalent to calling elm_web_object_navigate(obj, -1);
13807 * @param obj The web object
13809 * @return EINA_TRUE on success, EINA_FALSE otherwise
13811 * @see elm_web_history_enable_set()
13812 * @see elm_web_back_possible()
13813 * @see elm_web_forward()
13814 * @see elm_web_navigate()
13816 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
13818 * Goes forward one step in the browsing history
13820 * This is equivalent to calling elm_web_object_navigate(obj, 1);
13822 * @param obj The web object
13824 * @return EINA_TRUE on success, EINA_FALSE otherwise
13826 * @see elm_web_history_enable_set()
13827 * @see elm_web_forward_possible()
13828 * @see elm_web_back()
13829 * @see elm_web_navigate()
13831 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
13833 * Jumps the given number of steps in the browsing history
13835 * The @p steps value can be a negative integer to back in history, or a
13836 * positive to move forward.
13838 * @param obj The web object
13839 * @param steps The number of steps to jump
13841 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13842 * history exists to jump the given number of steps
13844 * @see elm_web_history_enable_set()
13845 * @see elm_web_navigate_possible()
13846 * @see elm_web_back()
13847 * @see elm_web_forward()
13849 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
13851 * Queries whether it's possible to go back in history
13853 * @param obj The web object
13855 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13858 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
13860 * Queries whether it's possible to go forward in history
13862 * @param obj The web object
13864 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13867 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
13869 * Queries whether it's possible to jump the given number of steps
13871 * The @p steps value can be a negative integer to back in history, or a
13872 * positive to move forward.
13874 * @param obj The web object
13875 * @param steps The number of steps to check for
13877 * @return EINA_TRUE if enough history exists to perform the given jump,
13878 * EINA_FALSE otherwise
13880 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
13882 * Gets whether browsing history is enabled for the given object
13884 * @param obj The web object
13886 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13888 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
13890 * Enables or disables the browsing history
13892 * @param obj The web object
13893 * @param enable Whether to enable or disable the browsing history
13895 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13897 * Sets the zoom level of the web object
13899 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
13900 * values meaning zoom in and lower meaning zoom out. This function will
13901 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
13902 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
13904 * @param obj The web object
13905 * @param zoom The zoom level to set
13907 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
13909 * Gets the current zoom level set on the web object
13911 * Note that this is the zoom level set on the web object and not that
13912 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
13913 * the two zoom levels should match, but for the other two modes the
13914 * Webkit zoom is calculated internally to match the chosen mode without
13915 * changing the zoom level set for the web object.
13917 * @param obj The web object
13919 * @return The zoom level set on the object
13921 EAPI double elm_web_zoom_get(const Evas_Object *obj);
13923 * Sets the zoom mode to use
13925 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
13926 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
13928 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
13929 * with the elm_web_zoom_set() function.
13930 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
13931 * make sure the entirety of the web object's contents are shown.
13932 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
13933 * fit the contents in the web object's size, without leaving any space
13936 * @param obj The web object
13937 * @param mode The mode to set
13939 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
13941 * Gets the currently set zoom mode
13943 * @param obj The web object
13945 * @return The current zoom mode set for the object, or
13946 * ::ELM_WEB_ZOOM_MODE_LAST on error
13948 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
13950 * Shows the given region in the web object
13952 * @param obj The web object
13953 * @param x The x coordinate of the region to show
13954 * @param y The y coordinate of the region to show
13955 * @param w The width of the region to show
13956 * @param h The height of the region to show
13958 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
13960 * Brings in the region to the visible area
13962 * Like elm_web_region_show(), but it animates the scrolling of the object
13965 * @param obj The web object
13966 * @param x The x coordinate of the region to show
13967 * @param y The y coordinate of the region to show
13968 * @param w The width of the region to show
13969 * @param h The height of the region to show
13971 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
13973 * Sets the default dialogs to use an Inwin instead of a normal window
13975 * If set, then the default implementation for the JavaScript dialogs and
13976 * file selector will be opened in an Inwin. Otherwise they will use a
13977 * normal separated window.
13979 * @param obj The web object
13980 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
13982 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
13984 * Gets whether Inwin mode is set for the current object
13986 * @param obj The web object
13988 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
13990 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
13992 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
13993 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
13994 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);
13995 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14002 * @defgroup Hoversel Hoversel
14004 * @image html img/widget/hoversel/preview-00.png
14005 * @image latex img/widget/hoversel/preview-00.eps
14007 * A hoversel is a button that pops up a list of items (automatically
14008 * choosing the direction to display) that have a label and, optionally, an
14009 * icon to select from. It is a convenience widget to avoid the need to do
14010 * all the piecing together yourself. It is intended for a small number of
14011 * items in the hoversel menu (no more than 8), though is capable of many
14014 * Signals that you can add callbacks for are:
14015 * "clicked" - the user clicked the hoversel button and popped up the sel
14016 * "selected" - an item in the hoversel list is selected. event_info is the item
14017 * "dismissed" - the hover is dismissed
14019 * See @ref tutorial_hoversel for an example.
14022 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14024 * @brief Add a new Hoversel object
14026 * @param parent The parent object
14027 * @return The new object or NULL if it cannot be created
14029 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14031 * @brief This sets the hoversel to expand horizontally.
14033 * @param obj The hoversel object
14034 * @param horizontal If true, the hover will expand horizontally to the
14037 * @note The initial button will display horizontally regardless of this
14040 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14042 * @brief This returns whether the hoversel is set to expand horizontally.
14044 * @param obj The hoversel object
14045 * @return If true, the hover will expand horizontally to the right.
14047 * @see elm_hoversel_horizontal_set()
14049 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14051 * @brief Set the Hover parent
14053 * @param obj The hoversel object
14054 * @param parent The parent to use
14056 * Sets the hover parent object, the area that will be darkened when the
14057 * hoversel is clicked. Should probably be the window that the hoversel is
14058 * in. See @ref Hover objects for more information.
14060 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14062 * @brief Get the Hover parent
14064 * @param obj The hoversel object
14065 * @return The used parent
14067 * Gets the hover parent object.
14069 * @see elm_hoversel_hover_parent_set()
14071 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14073 * @brief Set the hoversel button label
14075 * @param obj The hoversel object
14076 * @param label The label text.
14078 * This sets the label of the button that is always visible (before it is
14079 * clicked and expanded).
14081 * @deprecated elm_object_text_set()
14083 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14085 * @brief Get the hoversel button label
14087 * @param obj The hoversel object
14088 * @return The label text.
14090 * @deprecated elm_object_text_get()
14092 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14094 * @brief Set the icon of the hoversel button
14096 * @param obj The hoversel object
14097 * @param icon The icon object
14099 * Sets the icon of the button that is always visible (before it is clicked
14100 * and expanded). Once the icon object is set, a previously set one will be
14101 * deleted, if you want to keep that old content object, use the
14102 * elm_hoversel_icon_unset() function.
14104 * @see elm_object_content_set() for the button widget
14106 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14108 * @brief Get the icon of the hoversel button
14110 * @param obj The hoversel object
14111 * @return The icon object
14113 * Get the icon of the button that is always visible (before it is clicked
14114 * and expanded). Also see elm_object_content_get() for the button widget.
14116 * @see elm_hoversel_icon_set()
14118 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14120 * @brief Get and unparent the icon of the hoversel button
14122 * @param obj The hoversel object
14123 * @return The icon object that was being used
14125 * Unparent and return the icon of the button that is always visible
14126 * (before it is clicked and expanded).
14128 * @see elm_hoversel_icon_set()
14129 * @see elm_object_content_unset() for the button widget
14131 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14133 * @brief This triggers the hoversel popup from code, the same as if the user
14134 * had clicked the button.
14136 * @param obj The hoversel object
14138 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14140 * @brief This dismisses the hoversel popup as if the user had clicked
14141 * outside the hover.
14143 * @param obj The hoversel object
14145 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14147 * @brief Returns whether the hoversel is expanded.
14149 * @param obj The hoversel object
14150 * @return This will return EINA_TRUE if the hoversel is expanded or
14151 * EINA_FALSE if it is not expanded.
14153 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14155 * @brief This will remove all the children items from the hoversel.
14157 * @param obj The hoversel object
14159 * @warning Should @b not be called while the hoversel is active; use
14160 * elm_hoversel_expanded_get() to check first.
14162 * @see elm_hoversel_item_del_cb_set()
14163 * @see elm_hoversel_item_del()
14165 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14167 * @brief Get the list of items within the given hoversel.
14169 * @param obj The hoversel object
14170 * @return Returns a list of Elm_Hoversel_Item*
14172 * @see elm_hoversel_item_add()
14174 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14176 * @brief Add an item to the hoversel button
14178 * @param obj The hoversel object
14179 * @param label The text label to use for the item (NULL if not desired)
14180 * @param icon_file An image file path on disk to use for the icon or standard
14181 * icon name (NULL if not desired)
14182 * @param icon_type The icon type if relevant
14183 * @param func Convenience function to call when this item is selected
14184 * @param data Data to pass to item-related functions
14185 * @return A handle to the item added.
14187 * This adds an item to the hoversel to show when it is clicked. Note: if you
14188 * need to use an icon from an edje file then use
14189 * elm_hoversel_item_icon_set() right after the this function, and set
14190 * icon_file to NULL here.
14192 * For more information on what @p icon_file and @p icon_type are see the
14193 * @ref Icon "icon documentation".
14195 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);
14197 * @brief Delete an item from the hoversel
14199 * @param item The item to delete
14201 * This deletes the item from the hoversel (should not be called while the
14202 * hoversel is active; use elm_hoversel_expanded_get() to check first).
14204 * @see elm_hoversel_item_add()
14205 * @see elm_hoversel_item_del_cb_set()
14207 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14209 * @brief Set the function to be called when an item from the hoversel is
14212 * @param item The item to set the callback on
14213 * @param func The function called
14215 * That function will receive these parameters:
14216 * @li void *item_data
14217 * @li Evas_Object *the_item_object
14218 * @li Elm_Hoversel_Item *the_object_struct
14220 * @see elm_hoversel_item_add()
14222 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14224 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14225 * that will be passed to associated function callbacks.
14227 * @param item The item to get the data from
14228 * @return The data pointer set with elm_hoversel_item_add()
14230 * @see elm_hoversel_item_add()
14232 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14234 * @brief This returns the label text of the given hoversel item.
14236 * @param item The item to get the label
14237 * @return The label text of the hoversel item
14239 * @see elm_hoversel_item_add()
14241 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14243 * @brief This sets the icon for the given hoversel item.
14245 * @param item The item to set the icon
14246 * @param icon_file An image file path on disk to use for the icon or standard
14248 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14249 * to NULL if the icon is not an edje file
14250 * @param icon_type The icon type
14252 * The icon can be loaded from the standard set, from an image file, or from
14255 * @see elm_hoversel_item_add()
14257 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);
14259 * @brief Get the icon object of the hoversel item
14261 * @param item The item to get the icon from
14262 * @param icon_file The image file path on disk used for the icon or standard
14264 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14265 * if the icon is not an edje file
14266 * @param icon_type The icon type
14268 * @see elm_hoversel_item_icon_set()
14269 * @see elm_hoversel_item_add()
14271 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);
14277 * @defgroup Toolbar Toolbar
14278 * @ingroup Elementary
14280 * @image html img/widget/toolbar/preview-00.png
14281 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14283 * @image html img/toolbar.png
14284 * @image latex img/toolbar.eps width=\textwidth
14286 * A toolbar is a widget that displays a list of items inside
14287 * a box. It can be scrollable, show a menu with items that don't fit
14288 * to toolbar size or even crop them.
14290 * Only one item can be selected at a time.
14292 * Items can have multiple states, or show menus when selected by the user.
14294 * Smart callbacks one can listen to:
14295 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14296 * - "language,changed" - when the program language changes
14298 * Available styles for it:
14300 * - @c "transparent" - no background or shadow, just show the content
14302 * List of examples:
14303 * @li @ref toolbar_example_01
14304 * @li @ref toolbar_example_02
14305 * @li @ref toolbar_example_03
14309 * @addtogroup Toolbar
14314 * @enum _Elm_Toolbar_Shrink_Mode
14315 * @typedef Elm_Toolbar_Shrink_Mode
14317 * Set toolbar's items display behavior, it can be scrollabel,
14318 * show a menu with exceeding items, or simply hide them.
14320 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14323 * Values <b> don't </b> work as bitmask, only one can be choosen.
14325 * @see elm_toolbar_mode_shrink_set()
14326 * @see elm_toolbar_mode_shrink_get()
14330 typedef enum _Elm_Toolbar_Shrink_Mode
14332 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14333 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14334 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14335 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
14336 } Elm_Toolbar_Shrink_Mode;
14338 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(). */
14340 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(). */
14343 * Add a new toolbar widget to the given parent Elementary
14344 * (container) object.
14346 * @param parent The parent object.
14347 * @return a new toolbar widget handle or @c NULL, on errors.
14349 * This function inserts a new toolbar widget on the canvas.
14353 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14356 * Set the icon size, in pixels, to be used by toolbar items.
14358 * @param obj The toolbar object
14359 * @param icon_size The icon size in pixels
14361 * @note Default value is @c 32. It reads value from elm config.
14363 * @see elm_toolbar_icon_size_get()
14367 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14370 * Get the icon size, in pixels, to be used by toolbar items.
14372 * @param obj The toolbar object.
14373 * @return The icon size in pixels.
14375 * @see elm_toolbar_icon_size_set() for details.
14379 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14382 * Sets icon lookup order, for toolbar items' icons.
14384 * @param obj The toolbar object.
14385 * @param order The icon lookup order.
14387 * Icons added before calling this function will not be affected.
14388 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14390 * @see elm_toolbar_icon_order_lookup_get()
14394 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14397 * Gets the icon lookup order.
14399 * @param obj The toolbar object.
14400 * @return The icon lookup order.
14402 * @see elm_toolbar_icon_order_lookup_set() for details.
14406 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14409 * Set whether the toolbar should always have an item selected.
14411 * @param obj The toolbar object.
14412 * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14415 * This will cause the toolbar to always have an item selected, and clicking
14416 * the selected item will not cause a selected event to be emitted. Enabling this mode
14417 * will immediately select the first toolbar item.
14419 * Always-selected is disabled by default.
14421 * @see elm_toolbar_always_select_mode_get().
14425 EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14428 * Get whether the toolbar should always have an item selected.
14430 * @param obj The toolbar object.
14431 * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14432 * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14434 * @see elm_toolbar_always_select_mode_set() for details.
14438 EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14441 * Set whether the toolbar items' should be selected by the user or not.
14443 * @param obj The toolbar object.
14444 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14447 * This will turn off the ability to select items entirely and they will
14448 * neither appear selected nor emit selected signals. The clicked
14449 * callback function will still be called.
14451 * Selection is enabled by default.
14453 * @see elm_toolbar_no_select_mode_get().
14457 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14460 * Set whether the toolbar items' should be selected by the user or not.
14462 * @param obj The toolbar object.
14463 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14464 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14466 * @see elm_toolbar_no_select_mode_set() for details.
14470 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14473 * Append item to the toolbar.
14475 * @param obj The toolbar object.
14476 * @param icon A string with icon name or the absolute path of an image file.
14477 * @param label The label of the item.
14478 * @param func The function to call when the item is clicked.
14479 * @param data The data to associate with the item for related callbacks.
14480 * @return The created item or @c NULL upon failure.
14482 * A new item will be created and appended to the toolbar, i.e., will
14483 * be set as @b last item.
14485 * Items created with this method can be deleted with
14486 * elm_toolbar_item_del().
14488 * Associated @p data can be properly freed when item is deleted if a
14489 * callback function is set with elm_toolbar_item_del_cb_set().
14491 * If a function is passed as argument, it will be called everytime this item
14492 * is selected, i.e., the user clicks over an unselected item.
14493 * If such function isn't needed, just passing
14494 * @c NULL as @p func is enough. The same should be done for @p data.
14496 * Toolbar will load icon image from fdo or current theme.
14497 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14498 * If an absolute path is provided it will load it direct from a file.
14500 * @see elm_toolbar_item_icon_set()
14501 * @see elm_toolbar_item_del()
14502 * @see elm_toolbar_item_del_cb_set()
14506 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);
14509 * Prepend item to the toolbar.
14511 * @param obj The toolbar object.
14512 * @param icon A string with icon name or the absolute path of an image file.
14513 * @param label The label of the item.
14514 * @param func The function to call when the item is clicked.
14515 * @param data The data to associate with the item for related callbacks.
14516 * @return The created item or @c NULL upon failure.
14518 * A new item will be created and prepended to the toolbar, i.e., will
14519 * be set as @b first item.
14521 * Items created with this method can be deleted with
14522 * elm_toolbar_item_del().
14524 * Associated @p data can be properly freed when item is deleted if a
14525 * callback function is set with elm_toolbar_item_del_cb_set().
14527 * If a function is passed as argument, it will be called everytime this item
14528 * is selected, i.e., the user clicks over an unselected item.
14529 * If such function isn't needed, just passing
14530 * @c NULL as @p func is enough. The same should be done for @p data.
14532 * Toolbar will load icon image from fdo or current theme.
14533 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14534 * If an absolute path is provided it will load it direct from a file.
14536 * @see elm_toolbar_item_icon_set()
14537 * @see elm_toolbar_item_del()
14538 * @see elm_toolbar_item_del_cb_set()
14542 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);
14545 * Insert a new item into the toolbar object before item @p before.
14547 * @param obj The toolbar object.
14548 * @param before The toolbar item to insert before.
14549 * @param icon A string with icon name or the absolute path of an image file.
14550 * @param label The label of the item.
14551 * @param func The function to call when the item is clicked.
14552 * @param data The data to associate with the item for related callbacks.
14553 * @return The created item or @c NULL upon failure.
14555 * A new item will be created and added to the toolbar. Its position in
14556 * this toolbar will be just before item @p before.
14558 * Items created with this method can be deleted with
14559 * elm_toolbar_item_del().
14561 * Associated @p data can be properly freed when item is deleted if a
14562 * callback function is set with elm_toolbar_item_del_cb_set().
14564 * If a function is passed as argument, it will be called everytime this item
14565 * is selected, i.e., the user clicks over an unselected item.
14566 * If such function isn't needed, just passing
14567 * @c NULL as @p func is enough. The same should be done for @p data.
14569 * Toolbar will load icon image from fdo or current theme.
14570 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14571 * If an absolute path is provided it will load it direct from a file.
14573 * @see elm_toolbar_item_icon_set()
14574 * @see elm_toolbar_item_del()
14575 * @see elm_toolbar_item_del_cb_set()
14579 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);
14582 * Insert a new item into the toolbar object after item @p after.
14584 * @param obj The toolbar object.
14585 * @param before The toolbar item to insert before.
14586 * @param icon A string with icon name or the absolute path of an image file.
14587 * @param label The label of the item.
14588 * @param func The function to call when the item is clicked.
14589 * @param data The data to associate with the item for related callbacks.
14590 * @return The created item or @c NULL upon failure.
14592 * A new item will be created and added to the toolbar. Its position in
14593 * this toolbar will be just after item @p after.
14595 * Items created with this method can be deleted with
14596 * elm_toolbar_item_del().
14598 * Associated @p data can be properly freed when item is deleted if a
14599 * callback function is set with elm_toolbar_item_del_cb_set().
14601 * If a function is passed as argument, it will be called everytime this item
14602 * is selected, i.e., the user clicks over an unselected item.
14603 * If such function isn't needed, just passing
14604 * @c NULL as @p func is enough. The same should be done for @p data.
14606 * Toolbar will load icon image from fdo or current theme.
14607 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14608 * If an absolute path is provided it will load it direct from a file.
14610 * @see elm_toolbar_item_icon_set()
14611 * @see elm_toolbar_item_del()
14612 * @see elm_toolbar_item_del_cb_set()
14616 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);
14619 * Get the first item in the given toolbar widget's list of
14622 * @param obj The toolbar object
14623 * @return The first item or @c NULL, if it has no items (and on
14626 * @see elm_toolbar_item_append()
14627 * @see elm_toolbar_last_item_get()
14631 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14634 * Get the last item in the given toolbar widget's list of
14637 * @param obj The toolbar object
14638 * @return The last item or @c NULL, if it has no items (and on
14641 * @see elm_toolbar_item_prepend()
14642 * @see elm_toolbar_first_item_get()
14646 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14649 * Get the item after @p item in toolbar.
14651 * @param item The toolbar item.
14652 * @return The item after @p item, or @c NULL if none or on failure.
14654 * @note If it is the last item, @c NULL will be returned.
14656 * @see elm_toolbar_item_append()
14660 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14663 * Get the item before @p item in toolbar.
14665 * @param item The toolbar item.
14666 * @return The item before @p item, or @c NULL if none or on failure.
14668 * @note If it is the first item, @c NULL will be returned.
14670 * @see elm_toolbar_item_prepend()
14674 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14677 * Get the toolbar object from an item.
14679 * @param item The item.
14680 * @return The toolbar object.
14682 * This returns the toolbar object itself that an item belongs to.
14686 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14689 * Set the priority of a toolbar item.
14691 * @param item The toolbar item.
14692 * @param priority The item priority. The default is zero.
14694 * This is used only when the toolbar shrink mode is set to
14695 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14696 * When space is less than required, items with low priority
14697 * will be removed from the toolbar and added to a dynamically-created menu,
14698 * while items with higher priority will remain on the toolbar,
14699 * with the same order they were added.
14701 * @see elm_toolbar_item_priority_get()
14705 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14708 * Get the priority of a toolbar item.
14710 * @param item The toolbar item.
14711 * @return The @p item priority, or @c 0 on failure.
14713 * @see elm_toolbar_item_priority_set() for details.
14717 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14720 * Get the label of item.
14722 * @param item The item of toolbar.
14723 * @return The label of item.
14725 * The return value is a pointer to the label associated to @p item when
14726 * it was created, with function elm_toolbar_item_append() or similar,
14728 * with function elm_toolbar_item_label_set. If no label
14729 * was passed as argument, it will return @c NULL.
14731 * @see elm_toolbar_item_label_set() for more details.
14732 * @see elm_toolbar_item_append()
14736 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14739 * Set the label of item.
14741 * @param item The item of toolbar.
14742 * @param text The label of item.
14744 * The label to be displayed by the item.
14745 * Label will be placed at icons bottom (if set).
14747 * If a label was passed as argument on item creation, with function
14748 * elm_toolbar_item_append() or similar, it will be already
14749 * displayed by the item.
14751 * @see elm_toolbar_item_label_get()
14752 * @see elm_toolbar_item_append()
14756 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14759 * Return the data associated with a given toolbar widget item.
14761 * @param item The toolbar widget item handle.
14762 * @return The data associated with @p item.
14764 * @see elm_toolbar_item_data_set()
14768 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14771 * Set the data associated with a given toolbar widget item.
14773 * @param item The toolbar widget item handle.
14774 * @param data The new data pointer to set to @p item.
14776 * This sets new item data on @p item.
14778 * @warning The old data pointer won't be touched by this function, so
14779 * the user had better to free that old data himself/herself.
14783 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14786 * Returns a pointer to a toolbar item by its label.
14788 * @param obj The toolbar object.
14789 * @param label The label of the item to find.
14791 * @return The pointer to the toolbar item matching @p label or @c NULL
14796 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14799 * Get whether the @p item is selected or not.
14801 * @param item The toolbar item.
14802 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14803 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14805 * @see elm_toolbar_selected_item_set() for details.
14806 * @see elm_toolbar_item_selected_get()
14810 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14813 * Set the selected state of an item.
14815 * @param item The toolbar item
14816 * @param selected The selected state
14818 * This sets the selected state of the given item @p it.
14819 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14821 * If a new item is selected the previosly selected will be unselected.
14822 * Previoulsy selected item can be get with function
14823 * elm_toolbar_selected_item_get().
14825 * Selected items will be highlighted.
14827 * @see elm_toolbar_item_selected_get()
14828 * @see elm_toolbar_selected_item_get()
14832 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14835 * Get the selected item.
14837 * @param obj The toolbar object.
14838 * @return The selected toolbar item.
14840 * The selected item can be unselected with function
14841 * elm_toolbar_item_selected_set().
14843 * The selected item always will be highlighted on toolbar.
14845 * @see elm_toolbar_selected_items_get()
14849 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14852 * Set the icon associated with @p item.
14854 * @param obj The parent of this item.
14855 * @param item The toolbar item.
14856 * @param icon A string with icon name or the absolute path of an image file.
14858 * Toolbar will load icon image from fdo or current theme.
14859 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14860 * If an absolute path is provided it will load it direct from a file.
14862 * @see elm_toolbar_icon_order_lookup_set()
14863 * @see elm_toolbar_icon_order_lookup_get()
14867 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14870 * Get the string used to set the icon of @p item.
14872 * @param item The toolbar item.
14873 * @return The string associated with the icon object.
14875 * @see elm_toolbar_item_icon_set() for details.
14879 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14882 * Get the object of @p item.
14884 * @param item The toolbar item.
14885 * @return The object
14889 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14892 * Get the icon object of @p item.
14894 * @param item The toolbar item.
14895 * @return The icon object
14897 * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14901 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14904 * Set the icon associated with @p item to an image in a binary buffer.
14906 * @param item The toolbar item.
14907 * @param img The binary data that will be used as an image
14908 * @param size The size of binary data @p img
14909 * @param format Optional format of @p img to pass to the image loader
14910 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
14912 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
14914 * @note The icon image set by this function can be changed by
14915 * elm_toolbar_item_icon_set().
14919 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);
14922 * Delete them item from the toolbar.
14924 * @param item The item of toolbar to be deleted.
14926 * @see elm_toolbar_item_append()
14927 * @see elm_toolbar_item_del_cb_set()
14931 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14934 * Set the function called when a toolbar item is freed.
14936 * @param item The item to set the callback on.
14937 * @param func The function called.
14939 * If there is a @p func, then it will be called prior item's memory release.
14940 * That will be called with the following arguments:
14942 * @li item's Evas object;
14945 * This way, a data associated to a toolbar item could be properly freed.
14949 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14952 * Get a value whether toolbar item is disabled or not.
14954 * @param item The item.
14955 * @return The disabled state.
14957 * @see elm_toolbar_item_disabled_set() for more details.
14961 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14964 * Sets the disabled/enabled state of a toolbar item.
14966 * @param item The item.
14967 * @param disabled The disabled state.
14969 * A disabled item cannot be selected or unselected. It will also
14970 * change its appearance (generally greyed out). This sets the
14971 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
14976 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14979 * Set or unset item as a separator.
14981 * @param item The toolbar item.
14982 * @param setting @c EINA_TRUE to set item @p item as separator or
14983 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
14985 * Items aren't set as separator by default.
14987 * If set as separator it will display separator theme, so won't display
14990 * @see elm_toolbar_item_separator_get()
14994 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
14997 * Get a value whether item is a separator or not.
14999 * @param item The toolbar item.
15000 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15001 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15003 * @see elm_toolbar_item_separator_set() for details.
15007 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15010 * Set the shrink state of toolbar @p obj.
15012 * @param obj The toolbar object.
15013 * @param shrink_mode Toolbar's items display behavior.
15015 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15016 * but will enforce a minimun size so all the items will fit, won't scroll
15017 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15018 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15019 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15023 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15026 * Get the shrink mode of toolbar @p obj.
15028 * @param obj The toolbar object.
15029 * @return Toolbar's items display behavior.
15031 * @see elm_toolbar_mode_shrink_set() for details.
15035 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15038 * Enable/disable homogenous mode.
15040 * @param obj The toolbar object
15041 * @param homogeneous Assume the items within the toolbar are of the
15042 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15044 * This will enable the homogeneous mode where items are of the same size.
15045 * @see elm_toolbar_homogeneous_get()
15049 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15052 * Get whether the homogenous mode is enabled.
15054 * @param obj The toolbar object.
15055 * @return Assume the items within the toolbar are of the same height
15056 * and width (EINA_TRUE = on, EINA_FALSE = off).
15058 * @see elm_toolbar_homogeneous_set()
15062 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15065 * Enable/disable homogenous mode.
15067 * @param obj The toolbar object
15068 * @param homogeneous Assume the items within the toolbar are of the
15069 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15071 * This will enable the homogeneous mode where items are of the same size.
15072 * @see elm_toolbar_homogeneous_get()
15074 * @deprecated use elm_toolbar_homogeneous_set() instead.
15078 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
15081 * Get whether the homogenous mode is enabled.
15083 * @param obj The toolbar object.
15084 * @return Assume the items within the toolbar are of the same height
15085 * and width (EINA_TRUE = on, EINA_FALSE = off).
15087 * @see elm_toolbar_homogeneous_set()
15088 * @deprecated use elm_toolbar_homogeneous_get() instead.
15092 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15095 * Set the parent object of the toolbar items' menus.
15097 * @param obj The toolbar object.
15098 * @param parent The parent of the menu objects.
15100 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15102 * For more details about setting the parent for toolbar menus, see
15103 * elm_menu_parent_set().
15105 * @see elm_menu_parent_set() for details.
15106 * @see elm_toolbar_item_menu_set() for details.
15110 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15113 * Get the parent object of the toolbar items' menus.
15115 * @param obj The toolbar object.
15116 * @return The parent of the menu objects.
15118 * @see elm_toolbar_menu_parent_set() for details.
15122 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15125 * Set the alignment of the items.
15127 * @param obj The toolbar object.
15128 * @param align The new alignment, a float between <tt> 0.0 </tt>
15129 * and <tt> 1.0 </tt>.
15131 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15132 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15135 * Centered items by default.
15137 * @see elm_toolbar_align_get()
15141 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15144 * Get the alignment of the items.
15146 * @param obj The toolbar object.
15147 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15150 * @see elm_toolbar_align_set() for details.
15154 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15157 * Set whether the toolbar item opens a menu.
15159 * @param item The toolbar item.
15160 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15162 * A toolbar item can be set to be a menu, using this function.
15164 * Once it is set to be a menu, it can be manipulated through the
15165 * menu-like function elm_toolbar_menu_parent_set() and the other
15166 * elm_menu functions, using the Evas_Object @c menu returned by
15167 * elm_toolbar_item_menu_get().
15169 * So, items to be displayed in this item's menu should be added with
15170 * elm_menu_item_add().
15172 * The following code exemplifies the most basic usage:
15174 * tb = elm_toolbar_add(win)
15175 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15176 * elm_toolbar_item_menu_set(item, EINA_TRUE);
15177 * elm_toolbar_menu_parent_set(tb, win);
15178 * menu = elm_toolbar_item_menu_get(item);
15179 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15180 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15184 * @see elm_toolbar_item_menu_get()
15188 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15191 * Get toolbar item's menu.
15193 * @param item The toolbar item.
15194 * @return Item's menu object or @c NULL on failure.
15196 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15197 * this function will set it.
15199 * @see elm_toolbar_item_menu_set() for details.
15203 EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15206 * Add a new state to @p item.
15208 * @param item The item.
15209 * @param icon A string with icon name or the absolute path of an image file.
15210 * @param label The label of the new state.
15211 * @param func The function to call when the item is clicked when this
15212 * state is selected.
15213 * @param data The data to associate with the state.
15214 * @return The toolbar item state, or @c NULL upon failure.
15216 * Toolbar will load icon image from fdo or current theme.
15217 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15218 * If an absolute path is provided it will load it direct from a file.
15220 * States created with this function can be removed with
15221 * elm_toolbar_item_state_del().
15223 * @see elm_toolbar_item_state_del()
15224 * @see elm_toolbar_item_state_sel()
15225 * @see elm_toolbar_item_state_get()
15229 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);
15232 * Delete a previoulsy added state to @p item.
15234 * @param item The toolbar item.
15235 * @param state The state to be deleted.
15236 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15238 * @see elm_toolbar_item_state_add()
15240 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15243 * Set @p state as the current state of @p it.
15245 * @param it The item.
15246 * @param state The state to use.
15247 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15249 * If @p state is @c NULL, it won't select any state and the default item's
15250 * icon and label will be used. It's the same behaviour than
15251 * elm_toolbar_item_state_unser().
15253 * @see elm_toolbar_item_state_unset()
15257 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15260 * Unset the state of @p it.
15262 * @param it The item.
15264 * The default icon and label from this item will be displayed.
15266 * @see elm_toolbar_item_state_set() for more details.
15270 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15273 * Get the current state of @p it.
15275 * @param item The item.
15276 * @return The selected state or @c NULL if none is selected or on failure.
15278 * @see elm_toolbar_item_state_set() for details.
15279 * @see elm_toolbar_item_state_unset()
15280 * @see elm_toolbar_item_state_add()
15284 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15287 * Get the state after selected state in toolbar's @p item.
15289 * @param it The toolbar item to change state.
15290 * @return The state after current state, or @c NULL on failure.
15292 * If last state is selected, this function will return first state.
15294 * @see elm_toolbar_item_state_set()
15295 * @see elm_toolbar_item_state_add()
15299 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15302 * Get the state before selected state in toolbar's @p item.
15304 * @param it The toolbar item to change state.
15305 * @return The state before current state, or @c NULL on failure.
15307 * If first state is selected, this function will return last state.
15309 * @see elm_toolbar_item_state_set()
15310 * @see elm_toolbar_item_state_add()
15314 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15317 * Set the text to be shown in a given toolbar item's tooltips.
15319 * @param item Target item.
15320 * @param text The text to set in the content.
15322 * Setup the text as tooltip to object. The item can have only one tooltip,
15323 * so any previous tooltip data - set with this function or
15324 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15326 * @see elm_object_tooltip_text_set() for more details.
15330 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15333 * Set the content to be shown in the tooltip item.
15335 * Setup the tooltip to item. The item can have only one tooltip,
15336 * so any previous tooltip data is removed. @p func(with @p data) will
15337 * be called every time that need show the tooltip and it should
15338 * return a valid Evas_Object. This object is then managed fully by
15339 * tooltip system and is deleted when the tooltip is gone.
15341 * @param item the toolbar item being attached a tooltip.
15342 * @param func the function used to create the tooltip contents.
15343 * @param data what to provide to @a func as callback data/context.
15344 * @param del_cb called when data is not needed anymore, either when
15345 * another callback replaces @a func, the tooltip is unset with
15346 * elm_toolbar_item_tooltip_unset() or the owner @a item
15347 * dies. This callback receives as the first parameter the
15348 * given @a data, and @c event_info is the item.
15350 * @see elm_object_tooltip_content_cb_set() for more details.
15354 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);
15357 * Unset tooltip from item.
15359 * @param item toolbar item to remove previously set tooltip.
15361 * Remove tooltip from item. The callback provided as del_cb to
15362 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15363 * it is not used anymore.
15365 * @see elm_object_tooltip_unset() for more details.
15366 * @see elm_toolbar_item_tooltip_content_cb_set()
15370 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15373 * Sets a different style for this item tooltip.
15375 * @note before you set a style you should define a tooltip with
15376 * elm_toolbar_item_tooltip_content_cb_set() or
15377 * elm_toolbar_item_tooltip_text_set()
15379 * @param item toolbar item with tooltip already set.
15380 * @param style the theme style to use (default, transparent, ...)
15382 * @see elm_object_tooltip_style_set() for more details.
15386 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15389 * Get the style for this item tooltip.
15391 * @param item toolbar item with tooltip already set.
15392 * @return style the theme style in use, defaults to "default". If the
15393 * object does not have a tooltip set, then NULL is returned.
15395 * @see elm_object_tooltip_style_get() for more details.
15396 * @see elm_toolbar_item_tooltip_style_set()
15400 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15403 * Set the type of mouse pointer/cursor decoration to be shown,
15404 * when the mouse pointer is over the given toolbar widget item
15406 * @param item toolbar item to customize cursor on
15407 * @param cursor the cursor type's name
15409 * This function works analogously as elm_object_cursor_set(), but
15410 * here the cursor's changing area is restricted to the item's
15411 * area, and not the whole widget's. Note that that item cursors
15412 * have precedence over widget cursors, so that a mouse over an
15413 * item with custom cursor set will always show @b that cursor.
15415 * If this function is called twice for an object, a previously set
15416 * cursor will be unset on the second call.
15418 * @see elm_object_cursor_set()
15419 * @see elm_toolbar_item_cursor_get()
15420 * @see elm_toolbar_item_cursor_unset()
15424 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15427 * Get the type of mouse pointer/cursor decoration set to be shown,
15428 * when the mouse pointer is over the given toolbar widget item
15430 * @param item toolbar item with custom cursor set
15431 * @return the cursor type's name or @c NULL, if no custom cursors
15432 * were set to @p item (and on errors)
15434 * @see elm_object_cursor_get()
15435 * @see elm_toolbar_item_cursor_set()
15436 * @see elm_toolbar_item_cursor_unset()
15440 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15443 * Unset any custom mouse pointer/cursor decoration set to be
15444 * shown, when the mouse pointer is over the given toolbar widget
15445 * item, thus making it show the @b default cursor again.
15447 * @param item a toolbar item
15449 * Use this call to undo any custom settings on this item's cursor
15450 * decoration, bringing it back to defaults (no custom style set).
15452 * @see elm_object_cursor_unset()
15453 * @see elm_toolbar_item_cursor_set()
15457 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15460 * Set a different @b style for a given custom cursor set for a
15463 * @param item toolbar item with custom cursor set
15464 * @param style the <b>theme style</b> to use (e.g. @c "default",
15465 * @c "transparent", etc)
15467 * This function only makes sense when one is using custom mouse
15468 * cursor decorations <b>defined in a theme file</b>, which can have,
15469 * given a cursor name/type, <b>alternate styles</b> on it. It
15470 * works analogously as elm_object_cursor_style_set(), but here
15471 * applyed only to toolbar item objects.
15473 * @warning Before you set a cursor style you should have definen a
15474 * custom cursor previously on the item, with
15475 * elm_toolbar_item_cursor_set()
15477 * @see elm_toolbar_item_cursor_engine_only_set()
15478 * @see elm_toolbar_item_cursor_style_get()
15482 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15485 * Get the current @b style set for a given toolbar item's custom
15488 * @param item toolbar item with custom cursor set.
15489 * @return style the cursor style in use. If the object does not
15490 * have a cursor set, then @c NULL is returned.
15492 * @see elm_toolbar_item_cursor_style_set() for more details
15496 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15499 * Set if the (custom)cursor for a given toolbar item should be
15500 * searched in its theme, also, or should only rely on the
15501 * rendering engine.
15503 * @param item item with custom (custom) cursor already set on
15504 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15505 * only on those provided by the rendering engine, @c EINA_FALSE to
15506 * have them searched on the widget's theme, as well.
15508 * @note This call is of use only if you've set a custom cursor
15509 * for toolbar items, with elm_toolbar_item_cursor_set().
15511 * @note By default, cursors will only be looked for between those
15512 * provided by the rendering engine.
15516 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15519 * Get if the (custom) cursor for a given toolbar item is being
15520 * searched in its theme, also, or is only relying on the rendering
15523 * @param item a toolbar item
15524 * @return @c EINA_TRUE, if cursors are being looked for only on
15525 * those provided by the rendering engine, @c EINA_FALSE if they
15526 * are being searched on the widget's theme, as well.
15528 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15532 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15535 * Change a toolbar's orientation
15536 * @param obj The toolbar object
15537 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15538 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15541 EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15544 * Get a toolbar's orientation
15545 * @param obj The toolbar object
15546 * @return If @c EINA_TRUE, the toolbar is vertical
15547 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15550 EAPI Eina_Bool elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
15557 * @defgroup Tooltips Tooltips
15559 * The Tooltip is an (internal, for now) smart object used to show a
15560 * content in a frame on mouse hover of objects(or widgets), with
15561 * tips/information about them.
15566 EAPI double elm_tooltip_delay_get(void);
15567 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15568 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15569 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15570 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15571 EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15572 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15573 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);
15574 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15575 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15576 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15577 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
15578 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
15585 * @defgroup Cursors Cursors
15587 * The Elementary cursor is an internal smart object used to
15588 * customize the mouse cursor displayed over objects (or
15589 * widgets). In the most common scenario, the cursor decoration
15590 * comes from the graphical @b engine Elementary is running
15591 * on. Those engines may provide different decorations for cursors,
15592 * and Elementary provides functions to choose them (think of X11
15593 * cursors, as an example).
15595 * There's also the possibility of, besides using engine provided
15596 * cursors, also use ones coming from Edje theming files. Both
15597 * globally and per widget, Elementary makes it possible for one to
15598 * make the cursors lookup to be held on engines only or on
15599 * Elementary's theme file, too.
15605 * Set the cursor to be shown when mouse is over the object
15607 * Set the cursor that will be displayed when mouse is over the
15608 * object. The object can have only one cursor set to it, so if
15609 * this function is called twice for an object, the previous set
15611 * If using X cursors, a definition of all the valid cursor names
15612 * is listed on Elementary_Cursors.h. If an invalid name is set
15613 * the default cursor will be used.
15615 * @param obj the object being set a cursor.
15616 * @param cursor the cursor name to be used.
15620 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15623 * Get the cursor to be shown when mouse is over the object
15625 * @param obj an object with cursor already set.
15626 * @return the cursor name.
15630 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15633 * Unset cursor for object
15635 * Unset cursor for object, and set the cursor to default if the mouse
15636 * was over this object.
15638 * @param obj Target object
15639 * @see elm_object_cursor_set()
15643 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15646 * Sets a different style for this object cursor.
15648 * @note before you set a style you should define a cursor with
15649 * elm_object_cursor_set()
15651 * @param obj an object with cursor already set.
15652 * @param style the theme style to use (default, transparent, ...)
15656 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15659 * Get the style for this object cursor.
15661 * @param obj an object with cursor already set.
15662 * @return style the theme style in use, defaults to "default". If the
15663 * object does not have a cursor set, then NULL is returned.
15667 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15670 * Set if the cursor set should be searched on the theme or should use
15671 * the provided by the engine, only.
15673 * @note before you set if should look on theme you should define a cursor
15674 * with elm_object_cursor_set(). By default it will only look for cursors
15675 * provided by the engine.
15677 * @param obj an object with cursor already set.
15678 * @param engine_only boolean to define it cursors should be looked only
15679 * between the provided by the engine or searched on widget's theme as well.
15683 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15686 * Get the cursor engine only usage for this object cursor.
15688 * @param obj an object with cursor already set.
15689 * @return engine_only boolean to define it cursors should be
15690 * looked only between the provided by the engine or searched on
15691 * widget's theme as well. If the object does not have a cursor
15692 * set, then EINA_FALSE is returned.
15696 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15699 * Get the configured cursor engine only usage
15701 * This gets the globally configured exclusive usage of engine cursors.
15703 * @return 1 if only engine cursors should be used
15706 EAPI int elm_cursor_engine_only_get(void);
15709 * Set the configured cursor engine only usage
15711 * This sets the globally configured exclusive usage of engine cursors.
15712 * It won't affect cursors set before changing this value.
15714 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15715 * look for them on theme before.
15716 * @return EINA_TRUE if value is valid and setted (0 or 1)
15719 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
15726 * @defgroup Menu Menu
15728 * @image html img/widget/menu/preview-00.png
15729 * @image latex img/widget/menu/preview-00.eps
15731 * A menu is a list of items displayed above its parent. When the menu is
15732 * showing its parent is darkened. Each item can have a sub-menu. The menu
15733 * object can be used to display a menu on a right click event, in a toolbar,
15736 * Signals that you can add callbacks for are:
15737 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15738 * event_info is NULL.
15740 * @see @ref tutorial_menu
15743 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15745 * @brief Add a new menu to the parent
15747 * @param parent The parent object.
15748 * @return The new object or NULL if it cannot be created.
15750 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15752 * @brief Set the parent for the given menu widget
15754 * @param obj The menu object.
15755 * @param parent The new parent.
15757 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15759 * @brief Get the parent for the given menu widget
15761 * @param obj The menu object.
15762 * @return The parent.
15764 * @see elm_menu_parent_set()
15766 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15768 * @brief Move the menu to a new position
15770 * @param obj The menu object.
15771 * @param x The new position.
15772 * @param y The new position.
15774 * Sets the top-left position of the menu to (@p x,@p y).
15776 * @note @p x and @p y coordinates are relative to parent.
15778 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15780 * @brief Close a opened menu
15782 * @param obj the menu object
15785 * Hides the menu and all it's sub-menus.
15787 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15789 * @brief Returns a list of @p item's items.
15791 * @param obj The menu object
15792 * @return An Eina_List* of @p item's items
15794 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15796 * @brief Get the Evas_Object of an Elm_Menu_Item
15798 * @param item The menu item object.
15799 * @return The edje object containing the swallowed content
15801 * @warning Don't manipulate this object!
15803 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15805 * @brief Add an item at the end of the given menu widget
15807 * @param obj The menu object.
15808 * @param parent The parent menu item (optional)
15809 * @param icon A icon display on the item. The icon will be destryed by the menu.
15810 * @param label The label of the item.
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 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);
15817 * @brief Add an object swallowed in an item at the end of the given menu
15820 * @param obj The menu object.
15821 * @param parent The parent menu item (optional)
15822 * @param subobj The object to swallow
15823 * @param func Function called when the user select the item.
15824 * @param data Data sent by the callback.
15825 * @return Returns the new item.
15827 * Add an evas object as an item to the menu.
15829 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);
15831 * @brief Set the label of a menu item
15833 * @param item The menu item object.
15834 * @param label The label to set for @p item
15836 * @warning Don't use this funcion on items created with
15837 * elm_menu_item_add_object() or elm_menu_item_separator_add().
15839 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15841 * @brief Get the label of a menu item
15843 * @param item The menu item object.
15844 * @return The label of @p item
15846 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15848 * @brief Set the icon of a menu item to the standard icon with name @p icon
15850 * @param item The menu item object.
15851 * @param icon The icon object to set for the content of @p item
15853 * Once this icon is set, any previously set icon will be deleted.
15855 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15857 * @brief Get the string representation from the icon of a menu item
15859 * @param item The menu item object.
15860 * @return The string representation of @p item's icon or NULL
15862 * @see elm_menu_item_object_icon_name_set()
15864 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15866 * @brief Set the content object of a menu item
15868 * @param item The menu item object
15869 * @param The content object or NULL
15870 * @return EINA_TRUE on success, else EINA_FALSE
15872 * Use this function to change the object swallowed by a menu item, deleting
15873 * any previously swallowed object.
15875 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
15877 * @brief Get the content object of a menu item
15879 * @param item The menu item object
15880 * @return The content object or NULL
15881 * @note If @p item was added with elm_menu_item_add_object, this
15882 * function will return the object passed, else it will return the
15885 * @see elm_menu_item_object_content_set()
15887 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15889 * @brief Set the selected state of @p item.
15891 * @param item The menu item object.
15892 * @param selected The selected/unselected state of the item
15894 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15896 * @brief Get the selected state of @p item.
15898 * @param item The menu item object.
15899 * @return The selected/unselected state of the item
15901 * @see elm_menu_item_selected_set()
15903 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15905 * @brief Set the disabled state of @p item.
15907 * @param item The menu item object.
15908 * @param disabled The enabled/disabled state of the item
15910 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15912 * @brief Get the disabled state of @p item.
15914 * @param item The menu item object.
15915 * @return The enabled/disabled state of the item
15917 * @see elm_menu_item_disabled_set()
15919 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15921 * @brief Add a separator item to menu @p obj under @p parent.
15923 * @param obj The menu object
15924 * @param parent The item to add the separator under
15925 * @return The created item or NULL on failure
15927 * This is item is a @ref Separator.
15929 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
15931 * @brief Returns whether @p item is a separator.
15933 * @param item The item to check
15934 * @return If true, @p item is a separator
15936 * @see elm_menu_item_separator_add()
15938 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15940 * @brief Deletes an item from the menu.
15942 * @param item The item to delete.
15944 * @see elm_menu_item_add()
15946 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15948 * @brief Set the function called when a menu item is deleted.
15950 * @param item The item to set the callback on
15951 * @param func The function called
15953 * @see elm_menu_item_add()
15954 * @see elm_menu_item_del()
15956 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15958 * @brief Returns the data associated with menu item @p item.
15960 * @param item The item
15961 * @return The data associated with @p item or NULL if none was set.
15963 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
15965 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15967 * @brief Sets the data to be associated with menu item @p item.
15969 * @param item The item
15970 * @param data The data to be associated with @p item
15972 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
15974 * @brief Returns a list of @p item's subitems.
15976 * @param item The item
15977 * @return An Eina_List* of @p item's subitems
15979 * @see elm_menu_add()
15981 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15983 * @brief Get the position of a menu item
15985 * @param item The menu item
15986 * @return The item's index
15988 * This function returns the index position of a menu item in a menu.
15989 * For a sub-menu, this number is relative to the first item in the sub-menu.
15991 * @note Index values begin with 0
15993 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
15995 * @brief @brief Return a menu item's owner menu
15997 * @param item The menu item
15998 * @return The menu object owning @p item, or NULL on failure
16000 * Use this function to get the menu object owning an item.
16002 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16004 * @brief Get the selected item in the menu
16006 * @param obj The menu object
16007 * @return The selected item, or NULL if none
16009 * @see elm_menu_item_selected_get()
16010 * @see elm_menu_item_selected_set()
16012 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16014 * @brief Get the last item in the menu
16016 * @param obj The menu object
16017 * @return The last item, or NULL if none
16019 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16021 * @brief Get the first item in the menu
16023 * @param obj The menu object
16024 * @return The first item, or NULL if none
16026 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16028 * @brief Get the next item in the menu.
16030 * @param item The menu item object.
16031 * @return The item after it, or NULL if none
16033 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16035 * @brief Get the previous item in the menu.
16037 * @param item The menu item object.
16038 * @return The item before it, or NULL if none
16040 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16046 * @defgroup List List
16047 * @ingroup Elementary
16049 * @image html img/widget/list/preview-00.png
16050 * @image latex img/widget/list/preview-00.eps width=\textwidth
16052 * @image html img/list.png
16053 * @image latex img/list.eps width=\textwidth
16055 * A list widget is a container whose children are displayed vertically or
16056 * horizontally, in order, and can be selected.
16057 * The list can accept only one or multiple items selection. Also has many
16058 * modes of items displaying.
16060 * A list is a very simple type of list widget. For more robust
16061 * lists, @ref Genlist should probably be used.
16063 * Smart callbacks one can listen to:
16064 * - @c "activated" - The user has double-clicked or pressed
16065 * (enter|return|spacebar) on an item. The @c event_info parameter
16066 * is the item that was activated.
16067 * - @c "clicked,double" - The user has double-clicked an item.
16068 * The @c event_info parameter is the item that was double-clicked.
16069 * - "selected" - when the user selected an item
16070 * - "unselected" - when the user unselected an item
16071 * - "longpressed" - an item in the list is long-pressed
16072 * - "edge,top" - the list is scrolled until the top edge
16073 * - "edge,bottom" - the list is scrolled until the bottom edge
16074 * - "edge,left" - the list is scrolled until the left edge
16075 * - "edge,right" - the list is scrolled until the right edge
16076 * - "language,changed" - the program's language changed
16078 * Available styles for it:
16081 * List of examples:
16082 * @li @ref list_example_01
16083 * @li @ref list_example_02
16084 * @li @ref list_example_03
16093 * @enum _Elm_List_Mode
16094 * @typedef Elm_List_Mode
16096 * Set list's resize behavior, transverse axis scroll and
16097 * items cropping. See each mode's description for more details.
16099 * @note Default value is #ELM_LIST_SCROLL.
16101 * Values <b> don't </b> work as bitmask, only one can be choosen.
16103 * @see elm_list_mode_set()
16104 * @see elm_list_mode_get()
16108 typedef enum _Elm_List_Mode
16110 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. */
16111 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). */
16112 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. */
16113 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. */
16114 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16117 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(). */
16120 * Add a new list widget to the given parent Elementary
16121 * (container) object.
16123 * @param parent The parent object.
16124 * @return a new list widget handle or @c NULL, on errors.
16126 * This function inserts a new list widget on the canvas.
16130 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16135 * @param obj The list object
16137 * @note Call before running show() on the list object.
16138 * @warning If not called, it won't display the list properly.
16141 * li = elm_list_add(win);
16142 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16143 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16145 * evas_object_show(li);
16150 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16153 * Enable or disable multiple items selection on the list object.
16155 * @param obj The list object
16156 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16159 * Disabled by default. If disabled, the user can select a single item of
16160 * the list each time. Selected items are highlighted on list.
16161 * If enabled, many items can be selected.
16163 * If a selected item is selected again, it will be unselected.
16165 * @see elm_list_multi_select_get()
16169 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16172 * Get a value whether multiple items selection is enabled or not.
16174 * @see elm_list_multi_select_set() for details.
16176 * @param obj The list object.
16177 * @return @c EINA_TRUE means multiple items selection is enabled.
16178 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16179 * @c EINA_FALSE is returned.
16183 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16186 * Set which mode to use for the list object.
16188 * @param obj The list object
16189 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16190 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16192 * Set list's resize behavior, transverse axis scroll and
16193 * items cropping. See each mode's description for more details.
16195 * @note Default value is #ELM_LIST_SCROLL.
16197 * Only one can be set, if a previous one was set, it will be changed
16198 * by the new mode set. Bitmask won't work as well.
16200 * @see elm_list_mode_get()
16204 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16207 * Get the mode the list is at.
16209 * @param obj The list object
16210 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16211 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16213 * @note see elm_list_mode_set() for more information.
16217 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16220 * Enable or disable horizontal mode on the list object.
16222 * @param obj The list object.
16223 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16224 * disable it, i.e., to enable vertical mode.
16226 * @note Vertical mode is set by default.
16228 * On horizontal mode items are displayed on list from left to right,
16229 * instead of from top to bottom. Also, the list will scroll horizontally.
16230 * Each item will presents left icon on top and right icon, or end, at
16233 * @see elm_list_horizontal_get()
16237 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16240 * Get a value whether horizontal mode is enabled or not.
16242 * @param obj The list object.
16243 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16244 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16245 * @c EINA_FALSE is returned.
16247 * @see elm_list_horizontal_set() for details.
16251 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16254 * Enable or disable always select mode on the list object.
16256 * @param obj The list object
16257 * @param always_select @c EINA_TRUE to enable always select mode or
16258 * @c EINA_FALSE to disable it.
16260 * @note Always select mode is disabled by default.
16262 * Default behavior of list items is to only call its callback function
16263 * the first time it's pressed, i.e., when it is selected. If a selected
16264 * item is pressed again, and multi-select is disabled, it won't call
16265 * this function (if multi-select is enabled it will unselect the item).
16267 * If always select is enabled, it will call the callback function
16268 * everytime a item is pressed, so it will call when the item is selected,
16269 * and again when a selected item is pressed.
16271 * @see elm_list_always_select_mode_get()
16272 * @see elm_list_multi_select_set()
16276 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16279 * Get a value whether always select mode is enabled or not, meaning that
16280 * an item will always call its callback function, even if already selected.
16282 * @param obj The list object
16283 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16284 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16285 * @c EINA_FALSE is returned.
16287 * @see elm_list_always_select_mode_set() for details.
16291 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16294 * Set bouncing behaviour when the scrolled content reaches an edge.
16296 * Tell the internal scroller object whether it should bounce or not
16297 * when it reaches the respective edges for each axis.
16299 * @param obj The list object
16300 * @param h_bounce Whether to bounce or not in the horizontal axis.
16301 * @param v_bounce Whether to bounce or not in the vertical axis.
16303 * @see elm_scroller_bounce_set()
16307 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16310 * Get the bouncing behaviour of the internal scroller.
16312 * Get whether the internal scroller should bounce when the edge of each
16313 * axis is reached scrolling.
16315 * @param obj The list object.
16316 * @param h_bounce Pointer where to store the bounce state of the horizontal
16318 * @param v_bounce Pointer where to store the bounce state of the vertical
16321 * @see elm_scroller_bounce_get()
16322 * @see elm_list_bounce_set()
16326 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16329 * Set the scrollbar policy.
16331 * @param obj The list object
16332 * @param policy_h Horizontal scrollbar policy.
16333 * @param policy_v Vertical scrollbar policy.
16335 * This sets the scrollbar visibility policy for the given scroller.
16336 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16337 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16338 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16339 * This applies respectively for the horizontal and vertical scrollbars.
16341 * The both are disabled by default, i.e., are set to
16342 * #ELM_SCROLLER_POLICY_OFF.
16346 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16349 * Get the scrollbar policy.
16351 * @see elm_list_scroller_policy_get() for details.
16353 * @param obj The list object.
16354 * @param policy_h Pointer where to store horizontal scrollbar policy.
16355 * @param policy_v Pointer where to store vertical scrollbar policy.
16359 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);
16362 * Append a new item to the list object.
16364 * @param obj The list object.
16365 * @param label The label of the list item.
16366 * @param icon The icon object to use for the left side of the item. An
16367 * icon can be any Evas object, but usually it is an icon created
16368 * with elm_icon_add().
16369 * @param end The icon object to use for the right side of the item. An
16370 * icon can be any Evas object.
16371 * @param func The function to call when the item is clicked.
16372 * @param data The data to associate with the item for related callbacks.
16374 * @return The created item or @c NULL upon failure.
16376 * A new item will be created and appended to the list, i.e., will
16377 * be set as @b last item.
16379 * Items created with this method can be deleted with
16380 * elm_list_item_del().
16382 * Associated @p data can be properly freed when item is deleted if a
16383 * callback function is set with elm_list_item_del_cb_set().
16385 * If a function is passed as argument, it will be called everytime this item
16386 * is selected, i.e., the user clicks over an unselected item.
16387 * If always select is enabled it will call this function every time
16388 * user clicks over an item (already selected or not).
16389 * If such function isn't needed, just passing
16390 * @c NULL as @p func is enough. The same should be done for @p data.
16392 * Simple example (with no function callback or data associated):
16394 * li = elm_list_add(win);
16395 * ic = elm_icon_add(win);
16396 * elm_icon_file_set(ic, "path/to/image", NULL);
16397 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16398 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16400 * evas_object_show(li);
16403 * @see elm_list_always_select_mode_set()
16404 * @see elm_list_item_del()
16405 * @see elm_list_item_del_cb_set()
16406 * @see elm_list_clear()
16407 * @see elm_icon_add()
16411 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);
16414 * Prepend a new item to the list object.
16416 * @param obj The list object.
16417 * @param label The label of the list item.
16418 * @param icon The icon object to use for the left side of the item. An
16419 * icon can be any Evas object, but usually it is an icon created
16420 * with elm_icon_add().
16421 * @param end The icon object to use for the right side of the item. An
16422 * icon can be any Evas object.
16423 * @param func The function to call when the item is clicked.
16424 * @param data The data to associate with the item for related callbacks.
16426 * @return The created item or @c NULL upon failure.
16428 * A new item will be created and prepended to the list, i.e., will
16429 * be set as @b first item.
16431 * Items created with this method can be deleted with
16432 * elm_list_item_del().
16434 * Associated @p data can be properly freed when item is deleted if a
16435 * callback function is set with elm_list_item_del_cb_set().
16437 * If a function is passed as argument, it will be called everytime this item
16438 * is selected, i.e., the user clicks over an unselected item.
16439 * If always select is enabled it will call this function every time
16440 * user clicks over an item (already selected or not).
16441 * If such function isn't needed, just passing
16442 * @c NULL as @p func is enough. The same should be done for @p data.
16444 * @see elm_list_item_append() for a simple code example.
16445 * @see elm_list_always_select_mode_set()
16446 * @see elm_list_item_del()
16447 * @see elm_list_item_del_cb_set()
16448 * @see elm_list_clear()
16449 * @see elm_icon_add()
16453 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);
16456 * Insert a new item into the list object before item @p before.
16458 * @param obj The list object.
16459 * @param before The list item to insert before.
16460 * @param label The label of the list item.
16461 * @param icon The icon object to use for the left side of the item. An
16462 * icon can be any Evas object, but usually it is an icon created
16463 * with elm_icon_add().
16464 * @param end The icon object to use for the right side of the item. An
16465 * icon can be any Evas object.
16466 * @param func The function to call when the item is clicked.
16467 * @param data The data to associate with the item for related callbacks.
16469 * @return The created item or @c NULL upon failure.
16471 * A new item will be created and added to the list. Its position in
16472 * this list will be just before item @p before.
16474 * Items created with this method can be deleted with
16475 * elm_list_item_del().
16477 * Associated @p data can be properly freed when item is deleted if a
16478 * callback function is set with elm_list_item_del_cb_set().
16480 * If a function is passed as argument, it will be called everytime this item
16481 * is selected, i.e., the user clicks over an unselected item.
16482 * If always select is enabled it will call this function every time
16483 * user clicks over an item (already selected or not).
16484 * If such function isn't needed, just passing
16485 * @c NULL as @p func is enough. The same should be done for @p data.
16487 * @see elm_list_item_append() for a simple code example.
16488 * @see elm_list_always_select_mode_set()
16489 * @see elm_list_item_del()
16490 * @see elm_list_item_del_cb_set()
16491 * @see elm_list_clear()
16492 * @see elm_icon_add()
16496 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);
16499 * Insert a new item into the list object after item @p after.
16501 * @param obj The list object.
16502 * @param after The list item to insert after.
16503 * @param label The label of the list item.
16504 * @param icon The icon object to use for the left side of the item. An
16505 * icon can be any Evas object, but usually it is an icon created
16506 * with elm_icon_add().
16507 * @param end The icon object to use for the right side of the item. An
16508 * icon can be any Evas object.
16509 * @param func The function to call when the item is clicked.
16510 * @param data The data to associate with the item for related callbacks.
16512 * @return The created item or @c NULL upon failure.
16514 * A new item will be created and added to the list. Its position in
16515 * this list will be just after item @p after.
16517 * Items created with this method can be deleted with
16518 * elm_list_item_del().
16520 * Associated @p data can be properly freed when item is deleted if a
16521 * callback function is set with elm_list_item_del_cb_set().
16523 * If a function is passed as argument, it will be called everytime this item
16524 * is selected, i.e., the user clicks over an unselected item.
16525 * If always select is enabled it will call this function every time
16526 * user clicks over an item (already selected or not).
16527 * If such function isn't needed, just passing
16528 * @c NULL as @p func is enough. The same should be done for @p data.
16530 * @see elm_list_item_append() for a simple code example.
16531 * @see elm_list_always_select_mode_set()
16532 * @see elm_list_item_del()
16533 * @see elm_list_item_del_cb_set()
16534 * @see elm_list_clear()
16535 * @see elm_icon_add()
16539 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);
16542 * Insert a new item into the sorted list object.
16544 * @param obj The list object.
16545 * @param label The label of the list item.
16546 * @param icon The icon object to use for the left side of the item. An
16547 * icon can be any Evas object, but usually it is an icon created
16548 * with elm_icon_add().
16549 * @param end The icon object to use for the right side of the item. An
16550 * icon can be any Evas object.
16551 * @param func The function to call when the item is clicked.
16552 * @param data The data to associate with the item for related callbacks.
16553 * @param cmp_func The comparing function to be used to sort list
16554 * items <b>by #Elm_List_Item item handles</b>. This function will
16555 * receive two items and compare them, returning a non-negative integer
16556 * if the second item should be place after the first, or negative value
16557 * if should be placed before.
16559 * @return The created item or @c NULL upon failure.
16561 * @note This function inserts values into a list object assuming it was
16562 * sorted and the result will be sorted.
16564 * A new item will be created and added to the list. Its position in
16565 * this list will be found comparing the new item with previously inserted
16566 * items using function @p cmp_func.
16568 * Items created with this method can be deleted with
16569 * elm_list_item_del().
16571 * Associated @p data can be properly freed when item is deleted if a
16572 * callback function is set with elm_list_item_del_cb_set().
16574 * If a function is passed as argument, it will be called everytime this item
16575 * is selected, i.e., the user clicks over an unselected item.
16576 * If always select is enabled it will call this function every time
16577 * user clicks over an item (already selected or not).
16578 * If such function isn't needed, just passing
16579 * @c NULL as @p func is enough. The same should be done for @p data.
16581 * @see elm_list_item_append() for a simple code example.
16582 * @see elm_list_always_select_mode_set()
16583 * @see elm_list_item_del()
16584 * @see elm_list_item_del_cb_set()
16585 * @see elm_list_clear()
16586 * @see elm_icon_add()
16590 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);
16593 * Remove all list's items.
16595 * @param obj The list object
16597 * @see elm_list_item_del()
16598 * @see elm_list_item_append()
16602 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16605 * Get a list of all the list items.
16607 * @param obj The list object
16608 * @return An @c Eina_List of list items, #Elm_List_Item,
16609 * or @c NULL on failure.
16611 * @see elm_list_item_append()
16612 * @see elm_list_item_del()
16613 * @see elm_list_clear()
16617 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16620 * Get the selected item.
16622 * @param obj The list object.
16623 * @return The selected list item.
16625 * The selected item can be unselected with function
16626 * elm_list_item_selected_set().
16628 * The selected item always will be highlighted on list.
16630 * @see elm_list_selected_items_get()
16634 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16637 * Return a list of the currently selected list items.
16639 * @param obj The list object.
16640 * @return An @c Eina_List of list items, #Elm_List_Item,
16641 * or @c NULL on failure.
16643 * Multiple items can be selected if multi select is enabled. It can be
16644 * done with elm_list_multi_select_set().
16646 * @see elm_list_selected_item_get()
16647 * @see elm_list_multi_select_set()
16651 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16654 * Set the selected state of an item.
16656 * @param item The list item
16657 * @param selected The selected state
16659 * This sets the selected state of the given item @p it.
16660 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16662 * If a new item is selected the previosly selected will be unselected,
16663 * unless multiple selection is enabled with elm_list_multi_select_set().
16664 * Previoulsy selected item can be get with function
16665 * elm_list_selected_item_get().
16667 * Selected items will be highlighted.
16669 * @see elm_list_item_selected_get()
16670 * @see elm_list_selected_item_get()
16671 * @see elm_list_multi_select_set()
16675 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16678 * Get whether the @p item is selected or not.
16680 * @param item The list item.
16681 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16682 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16684 * @see elm_list_selected_item_set() for details.
16685 * @see elm_list_item_selected_get()
16689 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16692 * Set or unset item as a separator.
16694 * @param it The list item.
16695 * @param setting @c EINA_TRUE to set item @p it as separator or
16696 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16698 * Items aren't set as separator by default.
16700 * If set as separator it will display separator theme, so won't display
16703 * @see elm_list_item_separator_get()
16707 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16710 * Get a value whether item is a separator or not.
16712 * @see elm_list_item_separator_set() for details.
16714 * @param it The list item.
16715 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16716 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16720 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16723 * Show @p item in the list view.
16725 * @param item The list item to be shown.
16727 * It won't animate list until item is visible. If such behavior is wanted,
16728 * use elm_list_bring_in() intead.
16732 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16735 * Bring in the given item to list view.
16737 * @param item The item.
16739 * This causes list to jump to the given item @p item and show it
16740 * (by scrolling), if it is not fully visible.
16742 * This may use animation to do so and take a period of time.
16744 * If animation isn't wanted, elm_list_item_show() can be used.
16748 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16751 * Delete them item from the list.
16753 * @param item The item of list to be deleted.
16755 * If deleting all list items is required, elm_list_clear()
16756 * should be used instead of getting items list and deleting each one.
16758 * @see elm_list_clear()
16759 * @see elm_list_item_append()
16760 * @see elm_list_item_del_cb_set()
16764 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16767 * Set the function called when a list item is freed.
16769 * @param item The item to set the callback on
16770 * @param func The function called
16772 * If there is a @p func, then it will be called prior item's memory release.
16773 * That will be called with the following arguments:
16775 * @li item's Evas object;
16778 * This way, a data associated to a list item could be properly freed.
16782 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16785 * Get the data associated to the item.
16787 * @param item The list item
16788 * @return The data associated to @p item
16790 * The return value is a pointer to data associated to @p item when it was
16791 * created, with function elm_list_item_append() or similar. If no data
16792 * was passed as argument, it will return @c NULL.
16794 * @see elm_list_item_append()
16798 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16801 * Get the left side icon associated to the item.
16803 * @param item The list item
16804 * @return The left side icon associated to @p item
16806 * The return value is a pointer to the icon associated to @p item when
16808 * created, with function elm_list_item_append() or similar, or later
16809 * with function elm_list_item_icon_set(). If no icon
16810 * was passed as argument, it will return @c NULL.
16812 * @see elm_list_item_append()
16813 * @see elm_list_item_icon_set()
16817 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16820 * Set the left side icon associated to the item.
16822 * @param item The list item
16823 * @param icon The left side icon object to associate with @p item
16825 * The icon object to use at left side of the item. An
16826 * icon can be any Evas object, but usually it is an icon created
16827 * with elm_icon_add().
16829 * Once the icon object is set, a previously set one will be deleted.
16830 * @warning Setting the same icon for two items will cause the icon to
16831 * dissapear from the first item.
16833 * If an icon was passed as argument on item creation, with function
16834 * elm_list_item_append() or similar, it will be already
16835 * associated to the item.
16837 * @see elm_list_item_append()
16838 * @see elm_list_item_icon_get()
16842 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16845 * Get the right side icon associated to the item.
16847 * @param item The list item
16848 * @return The right side icon associated to @p item
16850 * The return value is a pointer to the icon associated to @p item when
16852 * created, with function elm_list_item_append() or similar, or later
16853 * with function elm_list_item_icon_set(). If no icon
16854 * was passed as argument, it will return @c NULL.
16856 * @see elm_list_item_append()
16857 * @see elm_list_item_icon_set()
16861 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16864 * Set the right side icon associated to the item.
16866 * @param item The list item
16867 * @param end The right side icon object to associate with @p item
16869 * The icon object to use at right side of the item. An
16870 * icon can be any Evas object, but usually it is an icon created
16871 * with elm_icon_add().
16873 * Once the icon object is set, a previously set one will be deleted.
16874 * @warning Setting the same icon for two items will cause the icon to
16875 * dissapear from the first item.
16877 * If an icon was passed as argument on item creation, with function
16878 * elm_list_item_append() or similar, it will be already
16879 * associated to the item.
16881 * @see elm_list_item_append()
16882 * @see elm_list_item_end_get()
16886 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
16889 * Gets the base object of the item.
16891 * @param item The list item
16892 * @return The base object associated with @p item
16894 * Base object is the @c Evas_Object that represents that item.
16898 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16899 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16902 * Get the label of item.
16904 * @param item The item of list.
16905 * @return The label of item.
16907 * The return value is a pointer to the label associated to @p item when
16908 * it was created, with function elm_list_item_append(), or later
16909 * with function elm_list_item_label_set. If no label
16910 * was passed as argument, it will return @c NULL.
16912 * @see elm_list_item_label_set() for more details.
16913 * @see elm_list_item_append()
16917 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16920 * Set the label of item.
16922 * @param item The item of list.
16923 * @param text The label of item.
16925 * The label to be displayed by the item.
16926 * Label will be placed between left and right side icons (if set).
16928 * If a label was passed as argument on item creation, with function
16929 * elm_list_item_append() or similar, it will be already
16930 * displayed by the item.
16932 * @see elm_list_item_label_get()
16933 * @see elm_list_item_append()
16937 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16941 * Get the item before @p it in list.
16943 * @param it The list item.
16944 * @return The item before @p it, or @c NULL if none or on failure.
16946 * @note If it is the first item, @c NULL will be returned.
16948 * @see elm_list_item_append()
16949 * @see elm_list_items_get()
16953 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16956 * Get the item after @p it in list.
16958 * @param it The list item.
16959 * @return The item after @p it, or @c NULL if none or on failure.
16961 * @note If it is the last item, @c NULL will be returned.
16963 * @see elm_list_item_append()
16964 * @see elm_list_items_get()
16968 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16971 * Sets the disabled/enabled state of a list item.
16973 * @param it The item.
16974 * @param disabled The disabled state.
16976 * A disabled item cannot be selected or unselected. It will also
16977 * change its appearance (generally greyed out). This sets the
16978 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
16983 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16986 * Get a value whether list item is disabled or not.
16988 * @param it The item.
16989 * @return The disabled state.
16991 * @see elm_list_item_disabled_set() for more details.
16995 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16998 * Set the text to be shown in a given list item's tooltips.
17000 * @param item Target item.
17001 * @param text The text to set in the content.
17003 * Setup the text as tooltip to object. The item can have only one tooltip,
17004 * so any previous tooltip data - set with this function or
17005 * elm_list_item_tooltip_content_cb_set() - is removed.
17007 * @see elm_object_tooltip_text_set() for more details.
17011 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17015 * @brief Disable size restrictions on an object's tooltip
17016 * @param item The tooltip's anchor object
17017 * @param disable If EINA_TRUE, size restrictions are disabled
17018 * @return EINA_FALSE on failure, EINA_TRUE on success
17020 * This function allows a tooltip to expand beyond its parant window's canvas.
17021 * It will instead be limited only by the size of the display.
17023 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17025 * @brief Retrieve size restriction state of an object's tooltip
17026 * @param obj The tooltip's anchor object
17027 * @return If EINA_TRUE, size restrictions are disabled
17029 * This function returns whether a tooltip is allowed to expand beyond
17030 * its parant window's canvas.
17031 * It will instead be limited only by the size of the display.
17033 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17036 * Set the content to be shown in the tooltip item.
17038 * Setup the tooltip to item. The item can have only one tooltip,
17039 * so any previous tooltip data is removed. @p func(with @p data) will
17040 * be called every time that need show the tooltip and it should
17041 * return a valid Evas_Object. This object is then managed fully by
17042 * tooltip system and is deleted when the tooltip is gone.
17044 * @param item the list item being attached a tooltip.
17045 * @param func the function used to create the tooltip contents.
17046 * @param data what to provide to @a func as callback data/context.
17047 * @param del_cb called when data is not needed anymore, either when
17048 * another callback replaces @a func, the tooltip is unset with
17049 * elm_list_item_tooltip_unset() or the owner @a item
17050 * dies. This callback receives as the first parameter the
17051 * given @a data, and @c event_info is the item.
17053 * @see elm_object_tooltip_content_cb_set() for more details.
17057 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);
17060 * Unset tooltip from item.
17062 * @param item list item to remove previously set tooltip.
17064 * Remove tooltip from item. The callback provided as del_cb to
17065 * elm_list_item_tooltip_content_cb_set() will be called to notify
17066 * it is not used anymore.
17068 * @see elm_object_tooltip_unset() for more details.
17069 * @see elm_list_item_tooltip_content_cb_set()
17073 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17076 * Sets a different style for this item tooltip.
17078 * @note before you set a style you should define a tooltip with
17079 * elm_list_item_tooltip_content_cb_set() or
17080 * elm_list_item_tooltip_text_set()
17082 * @param item list item with tooltip already set.
17083 * @param style the theme style to use (default, transparent, ...)
17085 * @see elm_object_tooltip_style_set() for more details.
17089 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17092 * Get the style for this item tooltip.
17094 * @param item list item with tooltip already set.
17095 * @return style the theme style in use, defaults to "default". If the
17096 * object does not have a tooltip set, then NULL is returned.
17098 * @see elm_object_tooltip_style_get() for more details.
17099 * @see elm_list_item_tooltip_style_set()
17103 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17106 * Set the type of mouse pointer/cursor decoration to be shown,
17107 * when the mouse pointer is over the given list widget item
17109 * @param item list item to customize cursor on
17110 * @param cursor the cursor type's name
17112 * This function works analogously as elm_object_cursor_set(), but
17113 * here the cursor's changing area is restricted to the item's
17114 * area, and not the whole widget's. Note that that item cursors
17115 * have precedence over widget cursors, so that a mouse over an
17116 * item with custom cursor set will always show @b that cursor.
17118 * If this function is called twice for an object, a previously set
17119 * cursor will be unset on the second call.
17121 * @see elm_object_cursor_set()
17122 * @see elm_list_item_cursor_get()
17123 * @see elm_list_item_cursor_unset()
17127 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17130 * Get the type of mouse pointer/cursor decoration set to be shown,
17131 * when the mouse pointer is over the given list widget item
17133 * @param item list item with custom cursor set
17134 * @return the cursor type's name or @c NULL, if no custom cursors
17135 * were set to @p item (and on errors)
17137 * @see elm_object_cursor_get()
17138 * @see elm_list_item_cursor_set()
17139 * @see elm_list_item_cursor_unset()
17143 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17146 * Unset any custom mouse pointer/cursor decoration set to be
17147 * shown, when the mouse pointer is over the given list widget
17148 * item, thus making it show the @b default cursor again.
17150 * @param item a list item
17152 * Use this call to undo any custom settings on this item's cursor
17153 * decoration, bringing it back to defaults (no custom style set).
17155 * @see elm_object_cursor_unset()
17156 * @see elm_list_item_cursor_set()
17160 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17163 * Set a different @b style for a given custom cursor set for a
17166 * @param item list item with custom cursor set
17167 * @param style the <b>theme style</b> to use (e.g. @c "default",
17168 * @c "transparent", etc)
17170 * This function only makes sense when one is using custom mouse
17171 * cursor decorations <b>defined in a theme file</b>, which can have,
17172 * given a cursor name/type, <b>alternate styles</b> on it. It
17173 * works analogously as elm_object_cursor_style_set(), but here
17174 * applyed only to list item objects.
17176 * @warning Before you set a cursor style you should have definen a
17177 * custom cursor previously on the item, with
17178 * elm_list_item_cursor_set()
17180 * @see elm_list_item_cursor_engine_only_set()
17181 * @see elm_list_item_cursor_style_get()
17185 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17188 * Get the current @b style set for a given list item's custom
17191 * @param item list item with custom cursor set.
17192 * @return style the cursor style in use. If the object does not
17193 * have a cursor set, then @c NULL is returned.
17195 * @see elm_list_item_cursor_style_set() for more details
17199 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17202 * Set if the (custom)cursor for a given list item should be
17203 * searched in its theme, also, or should only rely on the
17204 * rendering engine.
17206 * @param item item with custom (custom) cursor already set on
17207 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17208 * only on those provided by the rendering engine, @c EINA_FALSE to
17209 * have them searched on the widget's theme, as well.
17211 * @note This call is of use only if you've set a custom cursor
17212 * for list items, with elm_list_item_cursor_set().
17214 * @note By default, cursors will only be looked for between those
17215 * provided by the rendering engine.
17219 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17222 * Get if the (custom) cursor for a given list item is being
17223 * searched in its theme, also, or is only relying on the rendering
17226 * @param item a list item
17227 * @return @c EINA_TRUE, if cursors are being looked for only on
17228 * those provided by the rendering engine, @c EINA_FALSE if they
17229 * are being searched on the widget's theme, as well.
17231 * @see elm_list_item_cursor_engine_only_set(), for more details
17235 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17242 * @defgroup Slider Slider
17243 * @ingroup Elementary
17245 * @image html img/widget/slider/preview-00.png
17246 * @image latex img/widget/slider/preview-00.eps width=\textwidth
17248 * The slider adds a dragable āsliderā widget for selecting the value of
17249 * something within a range.
17251 * A slider can be horizontal or vertical. It can contain an Icon and has a
17252 * primary label as well as a units label (that is formatted with floating
17253 * point values and thus accepts a printf-style format string, like
17254 * ā%1.2f unitsā. There is also an indicator string that may be somewhere
17255 * else (like on the slider itself) that also accepts a format string like
17256 * units. Label, Icon Unit and Indicator strings/objects are optional.
17258 * A slider may be inverted which means values invert, with high vales being
17259 * on the left or top and low values on the right or bottom (as opposed to
17260 * normally being low on the left or top and high on the bottom and right).
17262 * The slider should have its minimum and maximum values set by the
17263 * application with elm_slider_min_max_set() and value should also be set by
17264 * the application before use with elm_slider_value_set(). The span of the
17265 * slider is its length (horizontally or vertically). This will be scaled by
17266 * the object or applications scaling factor. At any point code can query the
17267 * slider for its value with elm_slider_value_get().
17269 * Smart callbacks one can listen to:
17270 * - "changed" - Whenever the slider value is changed by the user.
17271 * - "slider,drag,start" - dragging the slider indicator around has started.
17272 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17273 * - "delay,changed" - A short time after the value is changed by the user.
17274 * This will be called only when the user stops dragging for
17275 * a very short period or when they release their
17276 * finger/mouse, so it avoids possibly expensive reactions to
17277 * the value change.
17279 * Available styles for it:
17282 * Here is an example on its usage:
17283 * @li @ref slider_example
17287 * @addtogroup Slider
17292 * Add a new slider widget to the given parent Elementary
17293 * (container) object.
17295 * @param parent The parent object.
17296 * @return a new slider widget handle or @c NULL, on errors.
17298 * This function inserts a new slider widget on the canvas.
17302 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17305 * Set the label of a given slider widget
17307 * @param obj The progress bar object
17308 * @param label The text label string, in UTF-8
17311 * @deprecated use elm_object_text_set() instead.
17313 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17316 * Get the label of a given slider widget
17318 * @param obj The progressbar object
17319 * @return The text label string, in UTF-8
17322 * @deprecated use elm_object_text_get() instead.
17324 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17327 * Set the icon object of the slider object.
17329 * @param obj The slider object.
17330 * @param icon The icon object.
17332 * On horizontal mode, icon is placed at left, and on vertical mode,
17335 * @note Once the icon object is set, a previously set one will be deleted.
17336 * If you want to keep that old content object, use the
17337 * elm_slider_icon_unset() function.
17339 * @warning If the object being set does not have minimum size hints set,
17340 * it won't get properly displayed.
17344 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17347 * Unset an icon set on a given slider widget.
17349 * @param obj The slider object.
17350 * @return The icon object that was being used, if any was set, or
17351 * @c NULL, otherwise (and on errors).
17353 * On horizontal mode, icon is placed at left, and on vertical mode,
17356 * This call will unparent and return the icon object which was set
17357 * for this widget, previously, on success.
17359 * @see elm_slider_icon_set() for more details
17360 * @see elm_slider_icon_get()
17364 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17367 * Retrieve the icon object set for a given slider widget.
17369 * @param obj The slider object.
17370 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17371 * otherwise (and on errors).
17373 * On horizontal mode, icon is placed at left, and on vertical mode,
17376 * @see elm_slider_icon_set() for more details
17377 * @see elm_slider_icon_unset()
17381 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17384 * Set the end object of the slider object.
17386 * @param obj The slider object.
17387 * @param end The end object.
17389 * On horizontal mode, end is placed at left, and on vertical mode,
17390 * placed at bottom.
17392 * @note Once the icon object is set, a previously set one will be deleted.
17393 * If you want to keep that old content object, use the
17394 * elm_slider_end_unset() function.
17396 * @warning If the object being set does not have minimum size hints set,
17397 * it won't get properly displayed.
17401 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17404 * Unset an end object set on a given slider widget.
17406 * @param obj The slider object.
17407 * @return The end object that was being used, if any was set, or
17408 * @c NULL, otherwise (and on errors).
17410 * On horizontal mode, end is placed at left, and on vertical mode,
17411 * placed at bottom.
17413 * This call will unparent and return the icon object which was set
17414 * for this widget, previously, on success.
17416 * @see elm_slider_end_set() for more details.
17417 * @see elm_slider_end_get()
17421 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17424 * Retrieve the end object set for a given slider widget.
17426 * @param obj The slider object.
17427 * @return The end object's handle, if @p obj had one set, or @c NULL,
17428 * otherwise (and on errors).
17430 * On horizontal mode, icon is placed at right, and on vertical mode,
17431 * placed at bottom.
17433 * @see elm_slider_end_set() for more details.
17434 * @see elm_slider_end_unset()
17438 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17441 * Set the (exact) length of the bar region of a given slider widget.
17443 * @param obj The slider object.
17444 * @param size The length of the slider's bar region.
17446 * This sets the minimum width (when in horizontal mode) or height
17447 * (when in vertical mode) of the actual bar area of the slider
17448 * @p obj. This in turn affects the object's minimum size. Use
17449 * this when you're not setting other size hints expanding on the
17450 * given direction (like weight and alignment hints) and you would
17451 * like it to have a specific size.
17453 * @note Icon, end, label, indicator and unit text around @p obj
17454 * will require their
17455 * own space, which will make @p obj to require more the @p size,
17458 * @see elm_slider_span_size_get()
17462 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17465 * Get the length set for the bar region of a given slider widget
17467 * @param obj The slider object.
17468 * @return The length of the slider's bar region.
17470 * If that size was not set previously, with
17471 * elm_slider_span_size_set(), this call will return @c 0.
17475 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17478 * Set the format string for the unit label.
17480 * @param obj The slider object.
17481 * @param format The format string for the unit display.
17483 * Unit label is displayed all the time, if set, after slider's bar.
17484 * In horizontal mode, at right and in vertical mode, at bottom.
17486 * If @c NULL, unit label won't be visible. If not it sets the format
17487 * string for the label text. To the label text is provided a floating point
17488 * value, so the label text can display up to 1 floating point value.
17489 * Note that this is optional.
17491 * Use a format string such as "%1.2f meters" for example, and it will
17492 * display values like: "3.14 meters" for a value equal to 3.14159.
17494 * Default is unit label disabled.
17496 * @see elm_slider_indicator_format_get()
17500 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17503 * Get the unit label format of the slider.
17505 * @param obj The slider object.
17506 * @return The unit label format string in UTF-8.
17508 * Unit label is displayed all the time, if set, after slider's bar.
17509 * In horizontal mode, at right and in vertical mode, at bottom.
17511 * @see elm_slider_unit_format_set() for more
17512 * information on how this works.
17516 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17519 * Set the format string for the indicator label.
17521 * @param obj The slider object.
17522 * @param indicator The format string for the indicator display.
17524 * The slider may display its value somewhere else then unit label,
17525 * for example, above the slider knob that is dragged around. This function
17526 * sets the format string used for this.
17528 * If @c NULL, indicator label won't be visible. If not it sets the format
17529 * string for the label text. To the label text is provided a floating point
17530 * value, so the label text can display up to 1 floating point value.
17531 * Note that this is optional.
17533 * Use a format string such as "%1.2f meters" for example, and it will
17534 * display values like: "3.14 meters" for a value equal to 3.14159.
17536 * Default is indicator label disabled.
17538 * @see elm_slider_indicator_format_get()
17542 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17545 * Get the indicator label format of the slider.
17547 * @param obj The slider object.
17548 * @return The indicator label format string in UTF-8.
17550 * The slider may display its value somewhere else then unit label,
17551 * for example, above the slider knob that is dragged around. This function
17552 * gets the format string used for this.
17554 * @see elm_slider_indicator_format_set() for more
17555 * information on how this works.
17559 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17562 * Set the format function pointer for the indicator label
17564 * @param obj The slider object.
17565 * @param func The indicator format function.
17566 * @param free_func The freeing function for the format string.
17568 * Set the callback function to format the indicator string.
17570 * @see elm_slider_indicator_format_set() for more info on how this works.
17574 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);
17577 * Set the format function pointer for the units label
17579 * @param obj The slider object.
17580 * @param func The units format function.
17581 * @param free_func The freeing function for the format string.
17583 * Set the callback function to format the indicator string.
17585 * @see elm_slider_units_format_set() for more info on how this works.
17589 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);
17592 * Set the orientation of a given slider widget.
17594 * @param obj The slider object.
17595 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17596 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17598 * Use this function to change how your slider is to be
17599 * disposed: vertically or horizontally.
17601 * By default it's displayed horizontally.
17603 * @see elm_slider_horizontal_get()
17607 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17610 * Retrieve the orientation of a given slider widget
17612 * @param obj The slider object.
17613 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17614 * @c EINA_FALSE if it's @b vertical (and on errors).
17616 * @see elm_slider_horizontal_set() for more details.
17620 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17623 * Set the minimum and maximum values for the slider.
17625 * @param obj The slider object.
17626 * @param min The minimum value.
17627 * @param max The maximum value.
17629 * Define the allowed range of values to be selected by the user.
17631 * If actual value is less than @p min, it will be updated to @p min. If it
17632 * is bigger then @p max, will be updated to @p max. Actual value can be
17633 * get with elm_slider_value_get().
17635 * By default, min is equal to 0.0, and max is equal to 1.0.
17637 * @warning Maximum must be greater than minimum, otherwise behavior
17640 * @see elm_slider_min_max_get()
17644 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17647 * Get the minimum and maximum values of the slider.
17649 * @param obj The slider object.
17650 * @param min Pointer where to store the minimum value.
17651 * @param max Pointer where to store the maximum value.
17653 * @note If only one value is needed, the other pointer can be passed
17656 * @see elm_slider_min_max_set() for details.
17660 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17663 * Set the value the slider displays.
17665 * @param obj The slider object.
17666 * @param val The value to be displayed.
17668 * Value will be presented on the unit label following format specified with
17669 * elm_slider_unit_format_set() and on indicator with
17670 * elm_slider_indicator_format_set().
17672 * @warning The value must to be between min and max values. This values
17673 * are set by elm_slider_min_max_set().
17675 * @see elm_slider_value_get()
17676 * @see elm_slider_unit_format_set()
17677 * @see elm_slider_indicator_format_set()
17678 * @see elm_slider_min_max_set()
17682 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17685 * Get the value displayed by the spinner.
17687 * @param obj The spinner object.
17688 * @return The value displayed.
17690 * @see elm_spinner_value_set() for details.
17694 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17697 * Invert a given slider widget's displaying values order
17699 * @param obj The slider object.
17700 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17701 * @c EINA_FALSE to bring it back to default, non-inverted values.
17703 * A slider may be @b inverted, in which state it gets its
17704 * values inverted, with high vales being on the left or top and
17705 * low values on the right or bottom, as opposed to normally have
17706 * the low values on the former and high values on the latter,
17707 * respectively, for horizontal and vertical modes.
17709 * @see elm_slider_inverted_get()
17713 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17716 * Get whether a given slider widget's displaying values are
17719 * @param obj The slider object.
17720 * @return @c EINA_TRUE, if @p obj has inverted values,
17721 * @c EINA_FALSE otherwise (and on errors).
17723 * @see elm_slider_inverted_set() for more details.
17727 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17730 * Set whether to enlarge slider indicator (augmented knob) or not.
17732 * @param obj The slider object.
17733 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17734 * let the knob always at default size.
17736 * By default, indicator will be bigger while dragged by the user.
17738 * @warning It won't display values set with
17739 * elm_slider_indicator_format_set() if you disable indicator.
17743 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17746 * Get whether a given slider widget's enlarging indicator or not.
17748 * @param obj The slider object.
17749 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17750 * @c EINA_FALSE otherwise (and on errors).
17752 * @see elm_slider_indicator_show_set() for details.
17756 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17763 * @addtogroup Actionslider Actionslider
17765 * @image html img/widget/actionslider/preview-00.png
17766 * @image latex img/widget/actionslider/preview-00.eps
17768 * An actionslider is a switcher for 2 or 3 labels with customizable magnet
17769 * properties. The user drags and releases the indicator, to choose a label.
17771 * Labels occupy the following positions.
17776 * Positions can be enabled or disabled.
17778 * Magnets can be set on the above positions.
17780 * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
17782 * @note By default all positions are set as enabled.
17784 * Signals that you can add callbacks for are:
17786 * "selected" - when user selects an enabled position (the label is passed
17789 * "pos_changed" - when the indicator reaches any of the positions("left",
17790 * "right" or "center").
17792 * See an example of actionslider usage @ref actionslider_example_page "here"
17795 typedef enum _Elm_Actionslider_Pos
17797 ELM_ACTIONSLIDER_NONE = 0,
17798 ELM_ACTIONSLIDER_LEFT = 1 << 0,
17799 ELM_ACTIONSLIDER_CENTER = 1 << 1,
17800 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
17801 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
17802 } Elm_Actionslider_Pos;
17805 * Add a new actionslider to the parent.
17807 * @param parent The parent object
17808 * @return The new actionslider object or NULL if it cannot be created
17810 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17812 * Set actionslider labels.
17814 * @param obj The actionslider object
17815 * @param left_label The label to be set on the left.
17816 * @param center_label The label to be set on the center.
17817 * @param right_label The label to be set on the right.
17818 * @deprecated use elm_object_text_set() instead.
17820 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);
17822 * Get actionslider labels.
17824 * @param obj The actionslider object
17825 * @param left_label A char** to place the left_label of @p obj into.
17826 * @param center_label A char** to place the center_label of @p obj into.
17827 * @param right_label A char** to place the right_label of @p obj into.
17828 * @deprecated use elm_object_text_set() instead.
17830 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);
17832 * Get actionslider selected label.
17834 * @param obj The actionslider object
17835 * @return The selected label
17837 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17839 * Set actionslider indicator position.
17841 * @param obj The actionslider object.
17842 * @param pos The position of the indicator.
17844 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17846 * Get actionslider indicator position.
17848 * @param obj The actionslider object.
17849 * @return The position of the indicator.
17851 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17853 * Set actionslider magnet position. To make multiple positions magnets @c or
17854 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
17856 * @param obj The actionslider object.
17857 * @param pos Bit mask indicating the magnet positions.
17859 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17861 * Get actionslider magnet position.
17863 * @param obj The actionslider object.
17864 * @return The positions with magnet property.
17866 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17868 * Set actionslider enabled position. To set multiple positions as enabled @c or
17869 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
17871 * @note All the positions are enabled by default.
17873 * @param obj The actionslider object.
17874 * @param pos Bit mask indicating the enabled positions.
17876 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17878 * Get actionslider enabled position.
17880 * @param obj The actionslider object.
17881 * @return The enabled positions.
17883 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17885 * Set the label used on the indicator.
17887 * @param obj The actionslider object
17888 * @param label The label to be set on the indicator.
17889 * @deprecated use elm_object_text_set() instead.
17891 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17893 * Get the label used on the indicator object.
17895 * @param obj The actionslider object
17896 * @return The indicator label
17897 * @deprecated use elm_object_text_get() instead.
17899 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
17905 * @defgroup Genlist Genlist
17907 * @image html img/widget/genlist/preview-00.png
17908 * @image latex img/widget/genlist/preview-00.eps
17909 * @image html img/genlist.png
17910 * @image latex img/genlist.eps
17912 * This widget aims to have more expansive list than the simple list in
17913 * Elementary that could have more flexible items and allow many more entries
17914 * while still being fast and low on memory usage. At the same time it was
17915 * also made to be able to do tree structures. But the price to pay is more
17916 * complexity when it comes to usage. If all you want is a simple list with
17917 * icons and a single label, use the normal @ref List object.
17919 * Genlist has a fairly large API, mostly because it's relatively complex,
17920 * trying to be both expansive, powerful and efficient. First we will begin
17921 * an overview on the theory behind genlist.
17923 * @section Genlist_Item_Class Genlist item classes - creating items
17925 * In order to have the ability to add and delete items on the fly, genlist
17926 * implements a class (callback) system where the application provides a
17927 * structure with information about that type of item (genlist may contain
17928 * multiple different items with different classes, states and styles).
17929 * Genlist will call the functions in this struct (methods) when an item is
17930 * "realized" (i.e., created dynamically, while the user is scrolling the
17931 * grid). All objects will simply be deleted when no longer needed with
17932 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
17933 * following members:
17934 * - @c item_style - This is a constant string and simply defines the name
17935 * of the item style. It @b must be specified and the default should be @c
17938 * - @c func - A struct with pointers to functions that will be called when
17939 * an item is going to be actually created. All of them receive a @c data
17940 * parameter that will point to the same data passed to
17941 * elm_genlist_item_append() and related item creation functions, and a @c
17942 * obj parameter that points to the genlist object itself.
17944 * The function pointers inside @c func are @c label_get, @c icon_get, @c
17945 * state_get and @c del. The 3 first functions also receive a @c part
17946 * parameter described below. A brief description of these functions follows:
17948 * - @c label_get - The @c part parameter is the name string of one of the
17949 * existing text parts in the Edje group implementing the item's theme.
17950 * This function @b must return a strdup'()ed string, as the caller will
17951 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
17952 * - @c content_get - The @c part parameter is the name string of one of the
17953 * existing (content) swallow parts in the Edje group implementing the item's
17954 * theme. It must return @c NULL, when no content is desired, or a valid
17955 * object handle, otherwise. The object will be deleted by the genlist on
17956 * its deletion or when the item is "unrealized". See
17957 * #Elm_Genlist_Item_Icon_Get_Cb.
17958 * - @c func.state_get - The @c part parameter is the name string of one of
17959 * the state parts in the Edje group implementing the item's theme. Return
17960 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
17961 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
17962 * and @c "elm" as "emission" and "source" arguments, respectively, when
17963 * the state is true (the default is false), where @c XXX is the name of
17964 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
17965 * - @c func.del - This is intended for use when genlist items are deleted,
17966 * so any data attached to the item (e.g. its data parameter on creation)
17967 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
17969 * available item styles:
17971 * - default_style - The text part is a textblock
17973 * @image html img/widget/genlist/preview-04.png
17974 * @image latex img/widget/genlist/preview-04.eps
17978 * @image html img/widget/genlist/preview-01.png
17979 * @image latex img/widget/genlist/preview-01.eps
17981 * - icon_top_text_bottom
17983 * @image html img/widget/genlist/preview-02.png
17984 * @image latex img/widget/genlist/preview-02.eps
17988 * @image html img/widget/genlist/preview-03.png
17989 * @image latex img/widget/genlist/preview-03.eps
17991 * @section Genlist_Items Structure of items
17993 * An item in a genlist can have 0 or more text labels (they can be regular
17994 * text or textblock Evas objects - that's up to the style to determine), 0
17995 * or more contents (which are simply objects swallowed into the genlist item's
17996 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
17997 * behavior left to the user to define. The Edje part names for each of
17998 * these properties will be looked up, in the theme file for the genlist,
17999 * under the Edje (string) data items named @c "labels", @c "contents" and @c
18000 * "states", respectively. For each of those properties, if more than one
18001 * part is provided, they must have names listed separated by spaces in the
18002 * data fields. For the default genlist item theme, we have @b one label
18003 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18004 * "elm.swallow.end") and @b no state parts.
18006 * A genlist item may be at one of several styles. Elementary provides one
18007 * by default - "default", but this can be extended by system or application
18008 * custom themes/overlays/extensions (see @ref Theme "themes" for more
18011 * @section Genlist_Manipulation Editing and Navigating
18013 * Items can be added by several calls. All of them return a @ref
18014 * Elm_Genlist_Item handle that is an internal member inside the genlist.
18015 * They all take a data parameter that is meant to be used for a handle to
18016 * the applications internal data (eg the struct with the original item
18017 * data). The parent parameter is the parent genlist item this belongs to if
18018 * it is a tree or an indexed group, and NULL if there is no parent. The
18019 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18020 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18021 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18022 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
18023 * is set then this item is group index item that is displayed at the top
18024 * until the next group comes. The func parameter is a convenience callback
18025 * that is called when the item is selected and the data parameter will be
18026 * the func_data parameter, obj be the genlist object and event_info will be
18027 * the genlist item.
18029 * elm_genlist_item_append() adds an item to the end of the list, or if
18030 * there is a parent, to the end of all the child items of the parent.
18031 * elm_genlist_item_prepend() is the same but adds to the beginning of
18032 * the list or children list. elm_genlist_item_insert_before() inserts at
18033 * item before another item and elm_genlist_item_insert_after() inserts after
18034 * the indicated item.
18036 * The application can clear the list with elm_genlist_clear() which deletes
18037 * all the items in the list and elm_genlist_item_del() will delete a specific
18038 * item. elm_genlist_item_subitems_clear() will clear all items that are
18039 * children of the indicated parent item.
18041 * To help inspect list items you can jump to the item at the top of the list
18042 * with elm_genlist_first_item_get() which will return the item pointer, and
18043 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18044 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18045 * and previous items respectively relative to the indicated item. Using
18046 * these calls you can walk the entire item list/tree. Note that as a tree
18047 * the items are flattened in the list, so elm_genlist_item_parent_get() will
18048 * let you know which item is the parent (and thus know how to skip them if
18051 * @section Genlist_Muti_Selection Multi-selection
18053 * If the application wants multiple items to be able to be selected,
18054 * elm_genlist_multi_select_set() can enable this. If the list is
18055 * single-selection only (the default), then elm_genlist_selected_item_get()
18056 * will return the selected item, if any, or NULL I none is selected. If the
18057 * list is multi-select then elm_genlist_selected_items_get() will return a
18058 * list (that is only valid as long as no items are modified (added, deleted,
18059 * selected or unselected)).
18061 * @section Genlist_Usage_Hints Usage hints
18063 * There are also convenience functions. elm_genlist_item_genlist_get() will
18064 * return the genlist object the item belongs to. elm_genlist_item_show()
18065 * will make the scroller scroll to show that specific item so its visible.
18066 * elm_genlist_item_data_get() returns the data pointer set by the item
18067 * creation functions.
18069 * If an item changes (state of boolean changes, label or contents change),
18070 * then use elm_genlist_item_update() to have genlist update the item with
18071 * the new state. Genlist will re-realize the item thus call the functions
18072 * in the _Elm_Genlist_Item_Class for that item.
18074 * To programmatically (un)select an item use elm_genlist_item_selected_set().
18075 * To get its selected state use elm_genlist_item_selected_get(). Similarly
18076 * to expand/contract an item and get its expanded state, use
18077 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18078 * again to make an item disabled (unable to be selected and appear
18079 * differently) use elm_genlist_item_disabled_set() to set this and
18080 * elm_genlist_item_disabled_get() to get the disabled state.
18082 * In general to indicate how the genlist should expand items horizontally to
18083 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18084 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18085 * mode means that if items are too wide to fit, the scroller will scroll
18086 * horizontally. Otherwise items are expanded to fill the width of the
18087 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18088 * to the viewport width and limited to that size. This can be combined with
18089 * a different style that uses edjes' ellipsis feature (cutting text off like
18092 * Items will only call their selection func and callback when first becoming
18093 * selected. Any further clicks will do nothing, unless you enable always
18094 * select with elm_genlist_always_select_mode_set(). This means even if
18095 * selected, every click will make the selected callbacks be called.
18096 * elm_genlist_no_select_mode_set() will turn off the ability to select
18097 * items entirely and they will neither appear selected nor call selected
18098 * callback functions.
18100 * Remember that you can create new styles and add your own theme augmentation
18101 * per application with elm_theme_extension_add(). If you absolutely must
18102 * have a specific style that overrides any theme the user or system sets up
18103 * you can use elm_theme_overlay_add() to add such a file.
18105 * @section Genlist_Implementation Implementation
18107 * Evas tracks every object you create. Every time it processes an event
18108 * (mouse move, down, up etc.) it needs to walk through objects and find out
18109 * what event that affects. Even worse every time it renders display updates,
18110 * in order to just calculate what to re-draw, it needs to walk through many
18111 * many many objects. Thus, the more objects you keep active, the more
18112 * overhead Evas has in just doing its work. It is advisable to keep your
18113 * active objects to the minimum working set you need. Also remember that
18114 * object creation and deletion carries an overhead, so there is a
18115 * middle-ground, which is not easily determined. But don't keep massive lists
18116 * of objects you can't see or use. Genlist does this with list objects. It
18117 * creates and destroys them dynamically as you scroll around. It groups them
18118 * into blocks so it can determine the visibility etc. of a whole block at
18119 * once as opposed to having to walk the whole list. This 2-level list allows
18120 * for very large numbers of items to be in the list (tests have used up to
18121 * 2,000,000 items). Also genlist employs a queue for adding items. As items
18122 * may be different sizes, every item added needs to be calculated as to its
18123 * size and thus this presents a lot of overhead on populating the list, this
18124 * genlist employs a queue. Any item added is queued and spooled off over
18125 * time, actually appearing some time later, so if your list has many members
18126 * you may find it takes a while for them to all appear, with your process
18127 * consuming a lot of CPU while it is busy spooling.
18129 * Genlist also implements a tree structure, but it does so with callbacks to
18130 * the application, with the application filling in tree structures when
18131 * requested (allowing for efficient building of a very deep tree that could
18132 * even be used for file-management). See the above smart signal callbacks for
18135 * @section Genlist_Smart_Events Genlist smart events
18137 * Signals that you can add callbacks for are:
18138 * - @c "activated" - The user has double-clicked or pressed
18139 * (enter|return|spacebar) on an item. The @c event_info parameter is the
18140 * item that was activated.
18141 * - @c "clicked,double" - The user has double-clicked an item. The @c
18142 * event_info parameter is the item that was double-clicked.
18143 * - @c "selected" - This is called when a user has made an item selected.
18144 * The event_info parameter is the genlist item that was selected.
18145 * - @c "unselected" - This is called when a user has made an item
18146 * unselected. The event_info parameter is the genlist item that was
18148 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18149 * called and the item is now meant to be expanded. The event_info
18150 * parameter is the genlist item that was indicated to expand. It is the
18151 * job of this callback to then fill in the child items.
18152 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18153 * called and the item is now meant to be contracted. The event_info
18154 * parameter is the genlist item that was indicated to contract. It is the
18155 * job of this callback to then delete the child items.
18156 * - @c "expand,request" - This is called when a user has indicated they want
18157 * to expand a tree branch item. The callback should decide if the item can
18158 * expand (has any children) and then call elm_genlist_item_expanded_set()
18159 * appropriately to set the state. The event_info parameter is the genlist
18160 * item that was indicated to expand.
18161 * - @c "contract,request" - This is called when a user has indicated they
18162 * want to contract a tree branch item. The callback should decide if the
18163 * item can contract (has any children) and then call
18164 * elm_genlist_item_expanded_set() appropriately to set the state. The
18165 * event_info parameter is the genlist item that was indicated to contract.
18166 * - @c "realized" - This is called when the item in the list is created as a
18167 * real evas object. event_info parameter is the genlist item that was
18168 * created. The object may be deleted at any time, so it is up to the
18169 * caller to not use the object pointer from elm_genlist_item_object_get()
18170 * in a way where it may point to freed objects.
18171 * - @c "unrealized" - This is called just before an item is unrealized.
18172 * After this call content objects provided will be deleted and the item
18173 * object itself delete or be put into a floating cache.
18174 * - @c "drag,start,up" - This is called when the item in the list has been
18175 * dragged (not scrolled) up.
18176 * - @c "drag,start,down" - This is called when the item in the list has been
18177 * dragged (not scrolled) down.
18178 * - @c "drag,start,left" - This is called when the item in the list has been
18179 * dragged (not scrolled) left.
18180 * - @c "drag,start,right" - This is called when the item in the list has
18181 * been dragged (not scrolled) right.
18182 * - @c "drag,stop" - This is called when the item in the list has stopped
18184 * - @c "drag" - This is called when the item in the list is being dragged.
18185 * - @c "longpressed" - This is called when the item is pressed for a certain
18186 * amount of time. By default it's 1 second.
18187 * - @c "scroll,anim,start" - This is called when scrolling animation has
18189 * - @c "scroll,anim,stop" - This is called when scrolling animation has
18191 * - @c "scroll,drag,start" - This is called when dragging the content has
18193 * - @c "scroll,drag,stop" - This is called when dragging the content has
18195 * - @c "edge,top" - This is called when the genlist is scrolled until
18197 * - @c "edge,bottom" - This is called when the genlist is scrolled
18198 * until the bottom edge.
18199 * - @c "edge,left" - This is called when the genlist is scrolled
18200 * until the left edge.
18201 * - @c "edge,right" - This is called when the genlist is scrolled
18202 * until the right edge.
18203 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18205 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18207 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18209 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18211 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18212 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
18213 * multi-touch pinched in.
18214 * - @c "swipe" - This is called when the genlist is swiped.
18215 * - @c "moved" - This is called when a genlist item is moved.
18216 * - @c "language,changed" - This is called when the program's language is
18219 * @section Genlist_Examples Examples
18221 * Here is a list of examples that use the genlist, trying to show some of
18222 * its capabilities:
18223 * - @ref genlist_example_01
18224 * - @ref genlist_example_02
18225 * - @ref genlist_example_03
18226 * - @ref genlist_example_04
18227 * - @ref genlist_example_05
18231 * @addtogroup Genlist
18236 * @enum _Elm_Genlist_Item_Flags
18237 * @typedef Elm_Genlist_Item_Flags
18239 * Defines if the item is of any special type (has subitems or it's the
18240 * index of a group), or is just a simple item.
18244 typedef enum _Elm_Genlist_Item_Flags
18246 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18247 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18248 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18249 } Elm_Genlist_Item_Flags;
18250 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
18251 #define Elm_Genlist_Item_Class Elm_Gen_Item_Class
18252 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18253 #define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18254 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
18255 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
18256 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. */
18257 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. */
18258 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
18261 * @struct _Elm_Genlist_Item_Class
18263 * Genlist item class definition structs.
18265 * This struct contains the style and fetching functions that will define the
18266 * contents of each item.
18268 * @see @ref Genlist_Item_Class
18270 struct _Elm_Genlist_Item_Class
18272 const char *item_style; /**< style of this class. */
18273 struct Elm_Genlist_Item_Class_Func
18275 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
18276 Elm_Genlist_Item_Content_Get_Cb content_get; /**< Content fetching class function for genlist item classes. */
18277 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
18278 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
18281 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18283 * Add a new genlist widget to the given parent Elementary
18284 * (container) object
18286 * @param parent The parent object
18287 * @return a new genlist widget handle or @c NULL, on errors
18289 * This function inserts a new genlist widget on the canvas.
18291 * @see elm_genlist_item_append()
18292 * @see elm_genlist_item_del()
18293 * @see elm_genlist_clear()
18297 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18299 * Remove all items from a given genlist widget.
18301 * @param obj The genlist object
18303 * This removes (and deletes) all items in @p obj, leaving it empty.
18305 * @see elm_genlist_item_del(), to remove just one item.
18309 EINA_DEPRECATED EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18311 * Enable or disable multi-selection in the genlist
18313 * @param obj The genlist object
18314 * @param multi Multi-select enable/disable. Default is disabled.
18316 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18317 * the list. This allows more than 1 item to be selected. To retrieve the list
18318 * of selected items, use elm_genlist_selected_items_get().
18320 * @see elm_genlist_selected_items_get()
18321 * @see elm_genlist_multi_select_get()
18325 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18327 * Gets if multi-selection in genlist is enabled or disabled.
18329 * @param obj The genlist object
18330 * @return Multi-select enabled/disabled
18331 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18333 * @see elm_genlist_multi_select_set()
18337 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18339 * This sets the horizontal stretching mode.
18341 * @param obj The genlist object
18342 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18344 * This sets the mode used for sizing items horizontally. Valid modes
18345 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18346 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18347 * the scroller will scroll horizontally. Otherwise items are expanded
18348 * to fill the width of the viewport of the scroller. If it is
18349 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18350 * limited to that size.
18352 * @see elm_genlist_horizontal_get()
18356 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18357 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18359 * Gets the horizontal stretching mode.
18361 * @param obj The genlist object
18362 * @return The mode to use
18363 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18365 * @see elm_genlist_horizontal_set()
18369 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18370 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18372 * Set the always select mode.
18374 * @param obj The genlist object
18375 * @param always_select The always select mode (@c EINA_TRUE = on, @c
18376 * EINA_FALSE = off). Default is @c EINA_FALSE.
18378 * Items will only call their selection func and callback when first
18379 * becoming selected. Any further clicks will do nothing, unless you
18380 * enable always select with elm_genlist_always_select_mode_set().
18381 * This means that, even if selected, every click will make the selected
18382 * callbacks be called.
18384 * @see elm_genlist_always_select_mode_get()
18388 EINA_DEPRECATED EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18390 * Get the always select mode.
18392 * @param obj The genlist object
18393 * @return The always select mode
18394 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18396 * @see elm_genlist_always_select_mode_set()
18400 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18402 * Enable/disable the no select mode.
18404 * @param obj The genlist object
18405 * @param no_select The no select mode
18406 * (EINA_TRUE = on, EINA_FALSE = off)
18408 * This will turn off the ability to select items entirely and they
18409 * will neither appear selected nor call selected callback functions.
18411 * @see elm_genlist_no_select_mode_get()
18415 EINA_DEPRECATED EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18417 * Gets whether the no select mode is enabled.
18419 * @param obj The genlist object
18420 * @return The no select mode
18421 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18423 * @see elm_genlist_no_select_mode_set()
18427 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18429 * Enable/disable compress mode.
18431 * @param obj The genlist object
18432 * @param compress The compress mode
18433 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18435 * This will enable the compress mode where items are "compressed"
18436 * horizontally to fit the genlist scrollable viewport width. This is
18437 * special for genlist. Do not rely on
18438 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18439 * work as genlist needs to handle it specially.
18441 * @see elm_genlist_compress_mode_get()
18445 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18447 * Get whether the compress mode is enabled.
18449 * @param obj The genlist object
18450 * @return The compress mode
18451 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18453 * @see elm_genlist_compress_mode_set()
18457 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18459 * Enable/disable height-for-width mode.
18461 * @param obj The genlist object
18462 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18463 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18465 * With height-for-width mode the item width will be fixed (restricted
18466 * to a minimum of) to the list width when calculating its size in
18467 * order to allow the height to be calculated based on it. This allows,
18468 * for instance, text block to wrap lines if the Edje part is
18469 * configured with "text.min: 0 1".
18471 * @note This mode will make list resize slower as it will have to
18472 * recalculate every item height again whenever the list width
18475 * @note When height-for-width mode is enabled, it also enables
18476 * compress mode (see elm_genlist_compress_mode_set()) and
18477 * disables homogeneous (see elm_genlist_homogeneous_set()).
18481 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18483 * Get whether the height-for-width mode is enabled.
18485 * @param obj The genlist object
18486 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18491 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18493 * Enable/disable horizontal and vertical bouncing effect.
18495 * @param obj The genlist object
18496 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18497 * EINA_FALSE = off). Default is @c EINA_FALSE.
18498 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18499 * EINA_FALSE = off). Default is @c EINA_TRUE.
18501 * This will enable or disable the scroller bouncing effect for the
18502 * genlist. See elm_scroller_bounce_set() for details.
18504 * @see elm_scroller_bounce_set()
18505 * @see elm_genlist_bounce_get()
18509 EINA_DEPRECATED EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18511 * Get whether the horizontal and vertical bouncing effect is enabled.
18513 * @param obj The genlist object
18514 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18516 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18519 * @see elm_genlist_bounce_set()
18523 EINA_DEPRECATED EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18525 * Enable/disable homogenous mode.
18527 * @param obj The genlist object
18528 * @param homogeneous Assume the items within the genlist are of the
18529 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18532 * This will enable the homogeneous mode where items are of the same
18533 * height and width so that genlist may do the lazy-loading at its
18534 * maximum (which increases the performance for scrolling the list). This
18535 * implies 'compressed' mode.
18537 * @see elm_genlist_compress_mode_set()
18538 * @see elm_genlist_homogeneous_get()
18542 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18544 * Get whether the homogenous mode is enabled.
18546 * @param obj The genlist object
18547 * @return Assume the items within the genlist are of the same height
18548 * and width (EINA_TRUE = on, EINA_FALSE = off)
18550 * @see elm_genlist_homogeneous_set()
18554 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18556 * Set the maximum number of items within an item block
18558 * @param obj The genlist object
18559 * @param n Maximum number of items within an item block. Default is 32.
18561 * This will configure the block count to tune to the target with
18562 * particular performance matrix.
18564 * A block of objects will be used to reduce the number of operations due to
18565 * many objects in the screen. It can determine the visibility, or if the
18566 * object has changed, it theme needs to be updated, etc. doing this kind of
18567 * calculation to the entire block, instead of per object.
18569 * The default value for the block count is enough for most lists, so unless
18570 * you know you will have a lot of objects visible in the screen at the same
18571 * time, don't try to change this.
18573 * @see elm_genlist_block_count_get()
18574 * @see @ref Genlist_Implementation
18578 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18580 * Get the maximum number of items within an item block
18582 * @param obj The genlist object
18583 * @return Maximum number of items within an item block
18585 * @see elm_genlist_block_count_set()
18589 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18591 * Set the timeout in seconds for the longpress event.
18593 * @param obj The genlist object
18594 * @param timeout timeout in seconds. Default is 1.
18596 * This option will change how long it takes to send an event "longpressed"
18597 * after the mouse down signal is sent to the list. If this event occurs, no
18598 * "clicked" event will be sent.
18600 * @see elm_genlist_longpress_timeout_set()
18604 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18606 * Get the timeout in seconds for the longpress event.
18608 * @param obj The genlist object
18609 * @return timeout in seconds
18611 * @see elm_genlist_longpress_timeout_get()
18615 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18617 * Append a new item in a given genlist widget.
18619 * @param obj The genlist object
18620 * @param itc The item class for the item
18621 * @param data The item data
18622 * @param parent The parent item, or NULL if none
18623 * @param flags Item flags
18624 * @param func Convenience function called when the item is selected
18625 * @param func_data Data passed to @p func above.
18626 * @return A handle to the item added or @c NULL if not possible
18628 * This adds the given item to the end of the list or the end of
18629 * the children list if the @p parent is given.
18631 * @see elm_genlist_item_prepend()
18632 * @see elm_genlist_item_insert_before()
18633 * @see elm_genlist_item_insert_after()
18634 * @see elm_genlist_item_del()
18638 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);
18640 * Prepend a new item in a given genlist widget.
18642 * @param obj The genlist object
18643 * @param itc The item class for the item
18644 * @param data The item data
18645 * @param parent The parent item, or NULL if none
18646 * @param flags Item flags
18647 * @param func Convenience function called when the item is selected
18648 * @param func_data Data passed to @p func above.
18649 * @return A handle to the item added or NULL if not possible
18651 * This adds an item to the beginning of the list or beginning of the
18652 * children of the parent if given.
18654 * @see elm_genlist_item_append()
18655 * @see elm_genlist_item_insert_before()
18656 * @see elm_genlist_item_insert_after()
18657 * @see elm_genlist_item_del()
18661 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);
18663 * Insert an item before another in a genlist widget
18665 * @param obj The genlist object
18666 * @param itc The item class for the item
18667 * @param data The item data
18668 * @param before The item to place this new one before.
18669 * @param flags Item flags
18670 * @param func Convenience function called when the item is selected
18671 * @param func_data Data passed to @p func above.
18672 * @return A handle to the item added or @c NULL if not possible
18674 * This inserts an item before another in the list. It will be in the
18675 * same tree level or group as the item it is inserted before.
18677 * @see elm_genlist_item_append()
18678 * @see elm_genlist_item_prepend()
18679 * @see elm_genlist_item_insert_after()
18680 * @see elm_genlist_item_del()
18684 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);
18686 * Insert an item after another in a genlist widget
18688 * @param obj The genlist object
18689 * @param itc The item class for the item
18690 * @param data The item data
18691 * @param after The item to place this new one after.
18692 * @param flags Item flags
18693 * @param func Convenience function called when the item is selected
18694 * @param func_data Data passed to @p func above.
18695 * @return A handle to the item added or @c NULL if not possible
18697 * This inserts an item after another in the list. It will be in the
18698 * same tree level or group as the item it is inserted after.
18700 * @see elm_genlist_item_append()
18701 * @see elm_genlist_item_prepend()
18702 * @see elm_genlist_item_insert_before()
18703 * @see elm_genlist_item_del()
18707 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);
18709 * Insert a new item into the sorted genlist object
18711 * @param obj The genlist object
18712 * @param itc The item class for the item
18713 * @param data The item data
18714 * @param parent The parent item, or NULL if none
18715 * @param flags Item flags
18716 * @param comp The function called for the sort
18717 * @param func Convenience function called when item selected
18718 * @param func_data Data passed to @p func above.
18719 * @return A handle to the item added or NULL if not possible
18723 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);
18724 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);
18725 /* operations to retrieve existing items */
18727 * Get the selectd item in the genlist.
18729 * @param obj The genlist object
18730 * @return The selected item, or NULL if none is selected.
18732 * This gets the selected item in the list (if multi-selection is enabled, only
18733 * the item that was first selected in the list is returned - which is not very
18734 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18737 * If no item is selected, NULL is returned.
18739 * @see elm_genlist_selected_items_get()
18743 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18745 * Get a list of selected items in the genlist.
18747 * @param obj The genlist object
18748 * @return The list of selected items, or NULL if none are selected.
18750 * It returns a list of the selected items. This list pointer is only valid so
18751 * long as the selection doesn't change (no items are selected or unselected, or
18752 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18753 * pointers. The order of the items in this list is the order which they were
18754 * selected, i.e. the first item in this list is the first item that was
18755 * selected, and so on.
18757 * @note If not in multi-select mode, consider using function
18758 * elm_genlist_selected_item_get() instead.
18760 * @see elm_genlist_multi_select_set()
18761 * @see elm_genlist_selected_item_get()
18765 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18767 * Get the mode item style of items in the genlist
18768 * @param obj The genlist object
18769 * @return The mode item style string, or NULL if none is specified
18771 * This is a constant string and simply defines the name of the
18772 * style that will be used for mode animations. It can be
18773 * @c NULL if you don't plan to use Genlist mode. See
18774 * elm_genlist_item_mode_set() for more info.
18778 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18780 * Set the mode item style of items in the genlist
18781 * @param obj The genlist object
18782 * @param style The mode item style string, or NULL if none is desired
18784 * This is a constant string and simply defines the name of the
18785 * style that will be used for mode animations. It can be
18786 * @c NULL if you don't plan to use Genlist mode. See
18787 * elm_genlist_item_mode_set() for more info.
18791 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
18793 * Get a list of realized items in genlist
18795 * @param obj The genlist object
18796 * @return The list of realized items, nor NULL if none are realized.
18798 * This returns a list of the realized items in the genlist. The list
18799 * contains Elm_Genlist_Item pointers. The list must be freed by the
18800 * caller when done with eina_list_free(). The item pointers in the
18801 * list are only valid so long as those items are not deleted or the
18802 * genlist is not deleted.
18804 * @see elm_genlist_realized_items_update()
18808 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18810 * Get the item that is at the x, y canvas coords.
18812 * @param obj The gelinst object.
18813 * @param x The input x coordinate
18814 * @param y The input y coordinate
18815 * @param posret The position relative to the item returned here
18816 * @return The item at the coordinates or NULL if none
18818 * This returns the item at the given coordinates (which are canvas
18819 * relative, not object-relative). If an item is at that coordinate,
18820 * that item handle is returned, and if @p posret is not NULL, the
18821 * integer pointed to is set to a value of -1, 0 or 1, depending if
18822 * the coordinate is on the upper portion of that item (-1), on the
18823 * middle section (0) or on the lower part (1). If NULL is returned as
18824 * an item (no item found there), then posret may indicate -1 or 1
18825 * based if the coordinate is above or below all items respectively in
18830 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);
18832 * Get the first item in the genlist
18834 * This returns the first item in the list.
18836 * @param obj The genlist object
18837 * @return The first item, or NULL if none
18841 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18843 * Get the last item in the genlist
18845 * This returns the last item in the list.
18847 * @return The last item, or NULL if none
18851 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18853 * Set the scrollbar policy
18855 * @param obj The genlist object
18856 * @param policy_h Horizontal scrollbar policy.
18857 * @param policy_v Vertical scrollbar policy.
18859 * This sets the scrollbar visibility policy for the given genlist
18860 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
18861 * made visible if it is needed, and otherwise kept hidden.
18862 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
18863 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
18864 * respectively for the horizontal and vertical scrollbars. Default is
18865 * #ELM_SMART_SCROLLER_POLICY_AUTO
18867 * @see elm_genlist_scroller_policy_get()
18871 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
18873 * Get the scrollbar policy
18875 * @param obj The genlist object
18876 * @param policy_h Pointer to store the horizontal scrollbar policy.
18877 * @param policy_v Pointer to store the vertical scrollbar policy.
18879 * @see elm_genlist_scroller_policy_set()
18883 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);
18885 * Get the @b next item in a genlist widget's internal list of items,
18886 * given a handle to one of those items.
18888 * @param item The genlist item to fetch next from
18889 * @return The item after @p item, or @c NULL if there's none (and
18892 * This returns the item placed after the @p item, on the container
18895 * @see elm_genlist_item_prev_get()
18899 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18901 * Get the @b previous item in a genlist widget's internal list of items,
18902 * given a handle to one of those items.
18904 * @param item The genlist item to fetch previous from
18905 * @return The item before @p item, or @c NULL if there's none (and
18908 * This returns the item placed before the @p item, on the container
18911 * @see elm_genlist_item_next_get()
18915 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18917 * Get the genlist object's handle which contains a given genlist
18920 * @param item The item to fetch the container from
18921 * @return The genlist (parent) object
18923 * This returns the genlist object itself that an item belongs to.
18927 EINA_DEPRECATED EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18929 * Get the parent item of the given item
18931 * @param it The item
18932 * @return The parent of the item or @c NULL if it has no parent.
18934 * This returns the item that was specified as parent of the item @p it on
18935 * elm_genlist_item_append() and insertion related functions.
18939 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18941 * Remove all sub-items (children) of the given item
18943 * @param it The item
18945 * This removes all items that are children (and their descendants) of the
18946 * given item @p it.
18948 * @see elm_genlist_clear()
18949 * @see elm_genlist_item_del()
18953 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18955 * Set whether a given genlist item is selected or not
18957 * @param it The item
18958 * @param selected Use @c EINA_TRUE, to make it selected, @c
18959 * EINA_FALSE to make it unselected
18961 * This sets the selected state of an item. If multi selection is
18962 * not enabled on the containing genlist and @p selected is @c
18963 * EINA_TRUE, any other previously selected items will get
18964 * unselected in favor of this new one.
18966 * @see elm_genlist_item_selected_get()
18970 EINA_DEPRECATED EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
18972 * Get whether a given genlist item is selected or not
18974 * @param it The item
18975 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
18977 * @see elm_genlist_item_selected_set() for more details
18981 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18983 * Sets the expanded state of an item.
18985 * @param it The item
18986 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
18988 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
18991 * The theme will respond to this change visually, and a signal "expanded" or
18992 * "contracted" will be sent from the genlist with a pointer to the item that
18993 * has been expanded/contracted.
18995 * Calling this function won't show or hide any child of this item (if it is
18996 * a parent). You must manually delete and create them on the callbacks fo
18997 * the "expanded" or "contracted" signals.
18999 * @see elm_genlist_item_expanded_get()
19003 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19005 * Get the expanded state of an item
19007 * @param it The item
19008 * @return The expanded state
19010 * This gets the expanded state of an item.
19012 * @see elm_genlist_item_expanded_set()
19016 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19018 * Get the depth of expanded item
19020 * @param it The genlist item object
19021 * @return The depth of expanded item
19025 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19027 * Set whether a given genlist item is disabled or not.
19029 * @param it The item
19030 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19031 * to enable it back.
19033 * A disabled item cannot be selected or unselected. It will also
19034 * change its appearance, to signal the user it's disabled.
19036 * @see elm_genlist_item_disabled_get()
19040 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19042 * Get whether a given genlist item is disabled or not.
19044 * @param it The item
19045 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19048 * @see elm_genlist_item_disabled_set() for more details
19052 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19054 * Sets the display only state of an item.
19056 * @param it The item
19057 * @param display_only @c EINA_TRUE if the item is display only, @c
19058 * EINA_FALSE otherwise.
19060 * A display only item cannot be selected or unselected. It is for
19061 * display only and not selecting or otherwise clicking, dragging
19062 * etc. by the user, thus finger size rules will not be applied to
19065 * It's good to set group index items to display only state.
19067 * @see elm_genlist_item_display_only_get()
19071 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19073 * Get the display only state of an item
19075 * @param it The item
19076 * @return @c EINA_TRUE if the item is display only, @c
19077 * EINA_FALSE otherwise.
19079 * @see elm_genlist_item_display_only_set()
19083 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19085 * Show the portion of a genlist's internal list containing a given
19086 * item, immediately.
19088 * @param it The item to display
19090 * This causes genlist to jump to the given item @p it and show it (by
19091 * immediately scrolling to that position), if it is not fully visible.
19093 * @see elm_genlist_item_bring_in()
19094 * @see elm_genlist_item_top_show()
19095 * @see elm_genlist_item_middle_show()
19099 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19101 * Animatedly bring in, to the visible are of a genlist, a given
19104 * @param it The item to display
19106 * This causes genlist to jump to the given item @p it and show it (by
19107 * animatedly scrolling), if it is not fully visible. This may use animation
19108 * to do so and take a period of time
19110 * @see elm_genlist_item_show()
19111 * @see elm_genlist_item_top_bring_in()
19112 * @see elm_genlist_item_middle_bring_in()
19116 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19118 * Show the portion of a genlist's internal list containing a given
19119 * item, immediately.
19121 * @param it The item to display
19123 * This causes genlist to jump to the given item @p it and show it (by
19124 * immediately scrolling to that position), if it is not fully visible.
19126 * The item will be positioned at the top of the genlist viewport.
19128 * @see elm_genlist_item_show()
19129 * @see elm_genlist_item_top_bring_in()
19133 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19135 * Animatedly bring in, to the visible are of a genlist, a given
19138 * @param it The item
19140 * This causes genlist to jump to the given item @p it and show it (by
19141 * animatedly scrolling), if it is not fully visible. This may use animation
19142 * to do so and take a period of time
19144 * The item will be positioned at the top of the genlist viewport.
19146 * @see elm_genlist_item_bring_in()
19147 * @see elm_genlist_item_top_show()
19151 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19153 * Show the portion of a genlist's internal list containing a given
19154 * item, immediately.
19156 * @param it The item to display
19158 * This causes genlist to jump to the given item @p it and show it (by
19159 * immediately scrolling to that position), if it is not fully visible.
19161 * The item will be positioned at the middle of the genlist viewport.
19163 * @see elm_genlist_item_show()
19164 * @see elm_genlist_item_middle_bring_in()
19168 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19170 * Animatedly bring in, to the visible are of a genlist, a given
19173 * @param it The item
19175 * This causes genlist to jump to the given item @p it and show it (by
19176 * animatedly scrolling), if it is not fully visible. This may use animation
19177 * to do so and take a period of time
19179 * The item will be positioned at the middle of the genlist viewport.
19181 * @see elm_genlist_item_bring_in()
19182 * @see elm_genlist_item_middle_show()
19186 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19188 * Remove a genlist item from the its parent, deleting it.
19190 * @param item The item to be removed.
19191 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19193 * @see elm_genlist_clear(), to remove all items in a genlist at
19198 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19200 * Return the data associated to a given genlist item
19202 * @param item The genlist item.
19203 * @return the data associated to this item.
19205 * This returns the @c data value passed on the
19206 * elm_genlist_item_append() and related item addition calls.
19208 * @see elm_genlist_item_append()
19209 * @see elm_genlist_item_data_set()
19213 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19215 * Set the data associated to a given genlist item
19217 * @param item The genlist item
19218 * @param data The new data pointer to set on it
19220 * This @b overrides the @c data value passed on the
19221 * elm_genlist_item_append() and related item addition calls. This
19222 * function @b won't call elm_genlist_item_update() automatically,
19223 * so you'd issue it afterwards if you want to hove the item
19224 * updated to reflect the that new data.
19226 * @see elm_genlist_item_data_get()
19230 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19232 * Tells genlist to "orphan" icons fetchs by the item class
19234 * @param it The item
19236 * This instructs genlist to release references to icons in the item,
19237 * meaning that they will no longer be managed by genlist and are
19238 * floating "orphans" that can be re-used elsewhere if the user wants
19243 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19244 EINA_DEPRECATED EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19246 * Get the real Evas object created to implement the view of a
19247 * given genlist item
19249 * @param item The genlist item.
19250 * @return the Evas object implementing this item's view.
19252 * This returns the actual Evas object used to implement the
19253 * specified genlist item's view. This may be @c NULL, as it may
19254 * not have been created or may have been deleted, at any time, by
19255 * the genlist. <b>Do not modify this object</b> (move, resize,
19256 * show, hide, etc.), as the genlist is controlling it. This
19257 * function is for querying, emitting custom signals or hooking
19258 * lower level callbacks for events on that object. Do not delete
19259 * this object under any circumstances.
19261 * @see elm_genlist_item_data_get()
19265 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19267 * Update the contents of an item
19269 * @param it The item
19271 * This updates an item by calling all the item class functions again
19272 * to get the icons, labels and states. Use this when the original
19273 * item data has changed and the changes are desired to be reflected.
19275 * Use elm_genlist_realized_items_update() to update all already realized
19278 * @see elm_genlist_realized_items_update()
19282 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19284 * Update the item class of an item
19286 * @param it The item
19287 * @param itc The item class for the item
19289 * This sets another class fo the item, changing the way that it is
19290 * displayed. After changing the item class, elm_genlist_item_update() is
19291 * called on the item @p it.
19295 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19296 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19298 * Set the text to be shown in a given genlist item's tooltips.
19300 * @param item The genlist item
19301 * @param text The text to set in the content
19303 * This call will setup the text to be used as tooltip to that item
19304 * (analogous to elm_object_tooltip_text_set(), but being item
19305 * tooltips with higher precedence than object tooltips). It can
19306 * have only one tooltip at a time, so any previous tooltip data
19307 * will get removed.
19309 * In order to set an icon or something else as a tooltip, look at
19310 * elm_genlist_item_tooltip_content_cb_set().
19314 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19316 * Set the content to be shown in a given genlist item's tooltips
19318 * @param item The genlist item.
19319 * @param func The function returning the tooltip contents.
19320 * @param data What to provide to @a func as callback data/context.
19321 * @param del_cb Called when data is not needed anymore, either when
19322 * another callback replaces @p func, the tooltip is unset with
19323 * elm_genlist_item_tooltip_unset() or the owner @p item
19324 * dies. This callback receives as its first parameter the
19325 * given @p data, being @c event_info the item handle.
19327 * This call will setup the tooltip's contents to @p item
19328 * (analogous to elm_object_tooltip_content_cb_set(), but being
19329 * item tooltips with higher precedence than object tooltips). It
19330 * can have only one tooltip at a time, so any previous tooltip
19331 * content will get removed. @p func (with @p data) will be called
19332 * every time Elementary needs to show the tooltip and it should
19333 * return a valid Evas object, which will be fully managed by the
19334 * tooltip system, getting deleted when the tooltip is gone.
19336 * In order to set just a text as a tooltip, look at
19337 * elm_genlist_item_tooltip_text_set().
19341 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);
19343 * Unset a tooltip from a given genlist item
19345 * @param item genlist item to remove a previously set tooltip from.
19347 * This call removes any tooltip set on @p item. The callback
19348 * provided as @c del_cb to
19349 * elm_genlist_item_tooltip_content_cb_set() will be called to
19350 * notify it is not used anymore (and have resources cleaned, if
19353 * @see elm_genlist_item_tooltip_content_cb_set()
19357 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19359 * Set a different @b style for a given genlist item's tooltip.
19361 * @param item genlist item with tooltip set
19362 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19363 * "default", @c "transparent", etc)
19365 * Tooltips can have <b>alternate styles</b> to be displayed on,
19366 * which are defined by the theme set on Elementary. This function
19367 * works analogously as elm_object_tooltip_style_set(), but here
19368 * applied only to genlist item objects. The default style for
19369 * tooltips is @c "default".
19371 * @note before you set a style you should define a tooltip with
19372 * elm_genlist_item_tooltip_content_cb_set() or
19373 * elm_genlist_item_tooltip_text_set()
19375 * @see elm_genlist_item_tooltip_style_get()
19379 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19381 * Get the style set a given genlist item's tooltip.
19383 * @param item genlist item with tooltip already set on.
19384 * @return style the theme style in use, which defaults to
19385 * "default". If the object does not have a tooltip set,
19386 * then @c NULL is returned.
19388 * @see elm_genlist_item_tooltip_style_set() for more details
19392 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19394 * @brief Disable size restrictions on an object's tooltip
19395 * @param item The tooltip's anchor object
19396 * @param disable If EINA_TRUE, size restrictions are disabled
19397 * @return EINA_FALSE on failure, EINA_TRUE on success
19399 * This function allows a tooltip to expand beyond its parant window's canvas.
19400 * It will instead be limited only by the size of the display.
19402 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19404 * @brief Retrieve size restriction state of an object's tooltip
19405 * @param item The tooltip's anchor object
19406 * @return If EINA_TRUE, size restrictions are disabled
19408 * This function returns whether a tooltip is allowed to expand beyond
19409 * its parant window's canvas.
19410 * It will instead be limited only by the size of the display.
19412 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19414 * Set the type of mouse pointer/cursor decoration to be shown,
19415 * when the mouse pointer is over the given genlist widget item
19417 * @param item genlist item to customize cursor on
19418 * @param cursor the cursor type's name
19420 * This function works analogously as elm_object_cursor_set(), but
19421 * here the cursor's changing area is restricted to the item's
19422 * area, and not the whole widget's. Note that that item cursors
19423 * have precedence over widget cursors, so that a mouse over @p
19424 * item will always show cursor @p type.
19426 * If this function is called twice for an object, a previously set
19427 * cursor will be unset on the second call.
19429 * @see elm_object_cursor_set()
19430 * @see elm_genlist_item_cursor_get()
19431 * @see elm_genlist_item_cursor_unset()
19435 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19437 * Get the type of mouse pointer/cursor decoration set to be shown,
19438 * when the mouse pointer is over the given genlist widget item
19440 * @param item genlist item with custom cursor set
19441 * @return the cursor type's name or @c NULL, if no custom cursors
19442 * were set to @p item (and on errors)
19444 * @see elm_object_cursor_get()
19445 * @see elm_genlist_item_cursor_set() for more details
19446 * @see elm_genlist_item_cursor_unset()
19450 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19452 * Unset any custom mouse pointer/cursor decoration set to be
19453 * shown, when the mouse pointer is over the given genlist widget
19454 * item, thus making it show the @b default cursor again.
19456 * @param item a genlist item
19458 * Use this call to undo any custom settings on this item's cursor
19459 * decoration, bringing it back to defaults (no custom style set).
19461 * @see elm_object_cursor_unset()
19462 * @see elm_genlist_item_cursor_set() for more details
19466 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19468 * Set a different @b style for a given custom cursor set for a
19471 * @param item genlist item with custom cursor set
19472 * @param style the <b>theme style</b> to use (e.g. @c "default",
19473 * @c "transparent", etc)
19475 * This function only makes sense when one is using custom mouse
19476 * cursor decorations <b>defined in a theme file</b> , which can
19477 * have, given a cursor name/type, <b>alternate styles</b> on
19478 * it. It works analogously as elm_object_cursor_style_set(), but
19479 * here applied only to genlist item objects.
19481 * @warning Before you set a cursor style you should have defined a
19482 * custom cursor previously on the item, with
19483 * elm_genlist_item_cursor_set()
19485 * @see elm_genlist_item_cursor_engine_only_set()
19486 * @see elm_genlist_item_cursor_style_get()
19490 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19492 * Get the current @b style set for a given genlist item's custom
19495 * @param item genlist item with custom cursor set.
19496 * @return style the cursor style in use. If the object does not
19497 * have a cursor set, then @c NULL is returned.
19499 * @see elm_genlist_item_cursor_style_set() for more details
19503 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19505 * Set if the (custom) cursor for a given genlist item should be
19506 * searched in its theme, also, or should only rely on the
19507 * rendering engine.
19509 * @param item item with custom (custom) cursor already set on
19510 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19511 * only on those provided by the rendering engine, @c EINA_FALSE to
19512 * have them searched on the widget's theme, as well.
19514 * @note This call is of use only if you've set a custom cursor
19515 * for genlist items, with elm_genlist_item_cursor_set().
19517 * @note By default, cursors will only be looked for between those
19518 * provided by the rendering engine.
19522 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19524 * Get if the (custom) cursor for a given genlist item is being
19525 * searched in its theme, also, or is only relying on the rendering
19528 * @param item a genlist item
19529 * @return @c EINA_TRUE, if cursors are being looked for only on
19530 * those provided by the rendering engine, @c EINA_FALSE if they
19531 * are being searched on the widget's theme, as well.
19533 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19537 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19539 * Update the contents of all realized items.
19541 * @param obj The genlist object.
19543 * This updates all realized items by calling all the item class functions again
19544 * to get the icons, labels and states. Use this when the original
19545 * item data has changed and the changes are desired to be reflected.
19547 * To update just one item, use elm_genlist_item_update().
19549 * @see elm_genlist_realized_items_get()
19550 * @see elm_genlist_item_update()
19554 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19556 * Activate a genlist mode on an item
19558 * @param item The genlist item
19559 * @param mode Mode name
19560 * @param mode_set Boolean to define set or unset mode.
19562 * A genlist mode is a different way of selecting an item. Once a mode is
19563 * activated on an item, any other selected item is immediately unselected.
19564 * This feature provides an easy way of implementing a new kind of animation
19565 * for selecting an item, without having to entirely rewrite the item style
19566 * theme. However, the elm_genlist_selected_* API can't be used to get what
19567 * item is activate for a mode.
19569 * The current item style will still be used, but applying a genlist mode to
19570 * an item will select it using a different kind of animation.
19572 * The current active item for a mode can be found by
19573 * elm_genlist_mode_item_get().
19575 * The characteristics of genlist mode are:
19576 * - Only one mode can be active at any time, and for only one item.
19577 * - Genlist handles deactivating other items when one item is activated.
19578 * - A mode is defined in the genlist theme (edc), and more modes can easily
19580 * - A mode style and the genlist item style are different things. They
19581 * can be combined to provide a default style to the item, with some kind
19582 * of animation for that item when the mode is activated.
19584 * When a mode is activated on an item, a new view for that item is created.
19585 * The theme of this mode defines the animation that will be used to transit
19586 * the item from the old view to the new view. This second (new) view will be
19587 * active for that item while the mode is active on the item, and will be
19588 * destroyed after the mode is totally deactivated from that item.
19590 * @see elm_genlist_mode_get()
19591 * @see elm_genlist_mode_item_get()
19595 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19597 * Get the last (or current) genlist mode used.
19599 * @param obj The genlist object
19601 * This function just returns the name of the last used genlist mode. It will
19602 * be the current mode if it's still active.
19604 * @see elm_genlist_item_mode_set()
19605 * @see elm_genlist_mode_item_get()
19609 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19611 * Get active genlist mode item
19613 * @param obj The genlist object
19614 * @return The active item for that current mode. Or @c NULL if no item is
19615 * activated with any mode.
19617 * This function returns the item that was activated with a mode, by the
19618 * function elm_genlist_item_mode_set().
19620 * @see elm_genlist_item_mode_set()
19621 * @see elm_genlist_mode_get()
19625 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19630 * @param obj The genlist object
19631 * @param reorder_mode The reorder mode
19632 * (EINA_TRUE = on, EINA_FALSE = off)
19636 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19639 * Get the reorder mode
19641 * @param obj The genlist object
19642 * @return The reorder mode
19643 * (EINA_TRUE = on, EINA_FALSE = off)
19647 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19654 * @defgroup Check Check
19656 * @image html img/widget/check/preview-00.png
19657 * @image latex img/widget/check/preview-00.eps
19658 * @image html img/widget/check/preview-01.png
19659 * @image latex img/widget/check/preview-01.eps
19660 * @image html img/widget/check/preview-02.png
19661 * @image latex img/widget/check/preview-02.eps
19663 * @brief The check widget allows for toggling a value between true and
19666 * Check objects are a lot like radio objects in layout and functionality
19667 * except they do not work as a group, but independently and only toggle the
19668 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19669 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19670 * returns the current state. For convenience, like the radio objects, you
19671 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19672 * for it to modify.
19674 * Signals that you can add callbacks for are:
19675 * "changed" - This is called whenever the user changes the state of one of
19676 * the check object(event_info is NULL).
19678 * Default contents parts of the check widget that you can use for are:
19679 * @li "elm.swallow.content" - A icon of the check
19681 * Default text parts of the check widget that you can use for are:
19682 * @li "elm.text" - Label of the check
19684 * @ref tutorial_check should give you a firm grasp of how to use this widget
19689 * @brief Add a new Check object
19691 * @param parent The parent object
19692 * @return The new object or NULL if it cannot be created
19694 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19696 * @brief Set the text label of the check object
19698 * @param obj The check object
19699 * @param label The text label string in UTF-8
19701 * @deprecated use elm_object_text_set() instead.
19703 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19705 * @brief Get the text label of the check object
19707 * @param obj The check object
19708 * @return The text label string in UTF-8
19710 * @deprecated use elm_object_text_get() instead.
19712 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19714 * @brief Set the icon object of the check object
19716 * @param obj The check object
19717 * @param icon The icon object
19719 * Once the icon object is set, a previously set one will be deleted.
19720 * If you want to keep that old content object, use the
19721 * elm_object_content_unset() function.
19723 EINA_DEPRECATED EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19725 * @brief Get the icon object of the check object
19727 * @param obj The check object
19728 * @return The icon object
19730 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19732 * @brief Unset the icon used for the check object
19734 * @param obj The check object
19735 * @return The icon object that was being used
19737 * Unparent and return the icon object which was set for this widget.
19739 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19741 * @brief Set the on/off state of the check object
19743 * @param obj The check object
19744 * @param state The state to use (1 == on, 0 == off)
19746 * This sets the state of the check. If set
19747 * with elm_check_state_pointer_set() the state of that variable is also
19748 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19750 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19752 * @brief Get the state of the check object
19754 * @param obj The check object
19755 * @return The boolean state
19757 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19759 * @brief Set a convenience pointer to a boolean to change
19761 * @param obj The check object
19762 * @param statep Pointer to the boolean to modify
19764 * This sets a pointer to a boolean, that, in addition to the check objects
19765 * state will also be modified directly. To stop setting the object pointed
19766 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19767 * then when this is called, the check objects state will also be modified to
19768 * reflect the value of the boolean @p statep points to, just like calling
19769 * elm_check_state_set().
19771 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19772 EINA_DEPRECATED EAPI void elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
19773 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);
19780 * @defgroup Radio Radio
19782 * @image html img/widget/radio/preview-00.png
19783 * @image latex img/widget/radio/preview-00.eps
19785 * @brief Radio is a widget that allows for 1 or more options to be displayed
19786 * and have the user choose only 1 of them.
19788 * A radio object contains an indicator, an optional Label and an optional
19789 * icon object. While it's possible to have a group of only one radio they,
19790 * are normally used in groups of 2 or more. To add a radio to a group use
19791 * elm_radio_group_add(). The radio object(s) will select from one of a set
19792 * of integer values, so any value they are configuring needs to be mapped to
19793 * a set of integers. To configure what value that radio object represents,
19794 * use elm_radio_state_value_set() to set the integer it represents. To set
19795 * the value the whole group(which one is currently selected) is to indicate
19796 * use elm_radio_value_set() on any group member, and to get the groups value
19797 * use elm_radio_value_get(). For convenience the radio objects are also able
19798 * to directly set an integer(int) to the value that is selected. To specify
19799 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19800 * The radio objects will modify this directly. That implies the pointer must
19801 * point to valid memory for as long as the radio objects exist.
19803 * Signals that you can add callbacks for are:
19804 * @li changed - This is called whenever the user changes the state of one of
19805 * the radio objects within the group of radio objects that work together.
19807 * @ref tutorial_radio show most of this API in action.
19811 * @brief Add a new radio to the parent
19813 * @param parent The parent object
19814 * @return The new object or NULL if it cannot be created
19816 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19818 * @brief Set the text label of the radio object
19820 * @param obj The radio object
19821 * @param label The text label string in UTF-8
19823 * @deprecated use elm_object_text_set() instead.
19825 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19827 * @brief Get the text label of the radio object
19829 * @param obj The radio object
19830 * @return The text label string in UTF-8
19832 * @deprecated use elm_object_text_set() instead.
19834 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19836 * @brief Set the icon object of the radio object
19838 * @param obj The radio object
19839 * @param icon The icon object
19841 * Once the icon object is set, a previously set one will be deleted. If you
19842 * want to keep that old content object, use the elm_radio_icon_unset()
19845 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19847 * @brief Get the icon object of the radio object
19849 * @param obj The radio object
19850 * @return The icon object
19852 * @see elm_radio_icon_set()
19854 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19856 * @brief Unset the icon used for the radio object
19858 * @param obj The radio object
19859 * @return The icon object that was being used
19861 * Unparent and return the icon object which was set for this widget.
19863 * @see elm_radio_icon_set()
19865 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19867 * @brief Add this radio to a group of other radio objects
19869 * @param obj The radio object
19870 * @param group Any object whose group the @p obj is to join.
19872 * Radio objects work in groups. Each member should have a different integer
19873 * value assigned. In order to have them work as a group, they need to know
19874 * about each other. This adds the given radio object to the group of which
19875 * the group object indicated is a member.
19877 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
19879 * @brief Set the integer value that this radio object represents
19881 * @param obj The radio object
19882 * @param value The value to use if this radio object is selected
19884 * This sets the value of the radio.
19886 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19888 * @brief Get the integer value that this radio object represents
19890 * @param obj The radio object
19891 * @return The value used if this radio object is selected
19893 * This gets the value of the radio.
19895 * @see elm_radio_value_set()
19897 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19899 * @brief Set the value of the radio.
19901 * @param obj The radio object
19902 * @param value The value to use for the group
19904 * This sets the value of the radio group and will also set the value if
19905 * pointed to, to the value supplied, but will not call any callbacks.
19907 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19909 * @brief Get the state of the radio object
19911 * @param obj The radio object
19912 * @return The integer state
19914 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19916 * @brief Set a convenience pointer to a integer to change
19918 * @param obj The radio object
19919 * @param valuep Pointer to the integer to modify
19921 * This sets a pointer to a integer, that, in addition to the radio objects
19922 * state will also be modified directly. To stop setting the object pointed
19923 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
19924 * when this is called, the radio objects state will also be modified to
19925 * reflect the value of the integer valuep points to, just like calling
19926 * elm_radio_value_set().
19928 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
19934 * @defgroup Pager Pager
19936 * @image html img/widget/pager/preview-00.png
19937 * @image latex img/widget/pager/preview-00.eps
19939 * @brief Widget that allows flipping between 1 or more āpagesā of objects.
19941 * The flipping between āpagesā of objects is animated. All content in pager
19942 * is kept in a stack, the last content to be added will be on the top of the
19943 * stack(be visible).
19945 * Objects can be pushed or popped from the stack or deleted as normal.
19946 * Pushes and pops will animate (and a pop will delete the object once the
19947 * animation is finished). Any object already in the pager can be promoted to
19948 * the top(from its current stacking position) through the use of
19949 * elm_pager_content_promote(). Objects are pushed to the top with
19950 * elm_pager_content_push() and when the top item is no longer wanted, simply
19951 * pop it with elm_pager_content_pop() and it will also be deleted. If an
19952 * object is no longer needed and is not the top item, just delete it as
19953 * normal. You can query which objects are the top and bottom with
19954 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
19956 * Signals that you can add callbacks for are:
19957 * "hide,finished" - when the previous page is hided
19959 * This widget has the following styles available:
19962 * @li fade_translucide
19963 * @li fade_invisible
19964 * @note This styles affect only the flipping animations, the appearance when
19965 * not animating is unaffected by styles.
19967 * @ref tutorial_pager gives a good overview of the usage of the API.
19971 * Add a new pager to the parent
19973 * @param parent The parent object
19974 * @return The new object or NULL if it cannot be created
19978 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19980 * @brief Push an object to the top of the pager stack (and show it).
19982 * @param obj The pager object
19983 * @param content The object to push
19985 * The object pushed becomes a child of the pager, it will be controlled and
19986 * deleted when the pager is deleted.
19988 * @note If the content is already in the stack use
19989 * elm_pager_content_promote().
19990 * @warning Using this function on @p content already in the stack results in
19991 * undefined behavior.
19993 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19995 * @brief Pop the object that is on top of the stack
19997 * @param obj The pager object
19999 * This pops the object that is on the top(visible) of the pager, makes it
20000 * disappear, then deletes the object. The object that was underneath it on
20001 * the stack will become visible.
20003 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20005 * @brief Moves an object already in the pager stack to the top of the stack.
20007 * @param obj The pager object
20008 * @param content The object to promote
20010 * This will take the @p content and move it to the top of the stack as
20011 * if it had been pushed there.
20013 * @note If the content isn't already in the stack use
20014 * elm_pager_content_push().
20015 * @warning Using this function on @p content not already in the stack
20016 * results in undefined behavior.
20018 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20020 * @brief Return the object at the bottom of the pager stack
20022 * @param obj The pager object
20023 * @return The bottom object or NULL if none
20025 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20027 * @brief Return the object at the top of the pager stack
20029 * @param obj The pager object
20030 * @return The top object or NULL if none
20032 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20039 * @defgroup Slideshow Slideshow
20041 * @image html img/widget/slideshow/preview-00.png
20042 * @image latex img/widget/slideshow/preview-00.eps
20044 * This widget, as the name indicates, is a pre-made image
20045 * slideshow panel, with API functions acting on (child) image
20046 * items presentation. Between those actions, are:
20047 * - advance to next/previous image
20048 * - select the style of image transition animation
20049 * - set the exhibition time for each image
20050 * - start/stop the slideshow
20052 * The transition animations are defined in the widget's theme,
20053 * consequently new animations can be added without having to
20054 * update the widget's code.
20056 * @section Slideshow_Items Slideshow items
20058 * For slideshow items, just like for @ref Genlist "genlist" ones,
20059 * the user defines a @b classes, specifying functions that will be
20060 * called on the item's creation and deletion times.
20062 * The #Elm_Slideshow_Item_Class structure contains the following
20065 * - @c func.get - When an item is displayed, this function is
20066 * called, and it's where one should create the item object, de
20067 * facto. For example, the object can be a pure Evas image object
20068 * or an Elementary @ref Photocam "photocam" widget. See
20069 * #SlideshowItemGetFunc.
20070 * - @c func.del - When an item is no more displayed, this function
20071 * is called, where the user must delete any data associated to
20072 * the item. See #SlideshowItemDelFunc.
20074 * @section Slideshow_Caching Slideshow caching
20076 * The slideshow provides facilities to have items adjacent to the
20077 * one being displayed <b>already "realized"</b> (i.e. loaded) for
20078 * you, so that the system does not have to decode image data
20079 * anymore at the time it has to actually switch images on its
20080 * viewport. The user is able to set the numbers of items to be
20081 * cached @b before and @b after the current item, in the widget's
20084 * Smart events one can add callbacks for are:
20086 * - @c "changed" - when the slideshow switches its view to a new
20089 * List of examples for the slideshow widget:
20090 * @li @ref slideshow_example
20094 * @addtogroup Slideshow
20098 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20099 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20100 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
20101 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20102 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20105 * @struct _Elm_Slideshow_Item_Class
20107 * Slideshow item class definition. See @ref Slideshow_Items for
20110 struct _Elm_Slideshow_Item_Class
20112 struct _Elm_Slideshow_Item_Class_Func
20114 SlideshowItemGetFunc get;
20115 SlideshowItemDelFunc del;
20117 }; /**< #Elm_Slideshow_Item_Class member definitions */
20120 * Add a new slideshow widget to the given parent Elementary
20121 * (container) object
20123 * @param parent The parent object
20124 * @return A new slideshow widget handle or @c NULL, on errors
20126 * This function inserts a new slideshow widget on the canvas.
20128 * @ingroup Slideshow
20130 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20133 * Add (append) a new item in a given slideshow widget.
20135 * @param obj The slideshow object
20136 * @param itc The item class for the item
20137 * @param data The item's data
20138 * @return A handle to the item added or @c NULL, on errors
20140 * Add a new item to @p obj's internal list of items, appending it.
20141 * The item's class must contain the function really fetching the
20142 * image object to show for this item, which could be an Evas image
20143 * object or an Elementary photo, for example. The @p data
20144 * parameter is going to be passed to both class functions of the
20147 * @see #Elm_Slideshow_Item_Class
20148 * @see elm_slideshow_item_sorted_insert()
20150 * @ingroup Slideshow
20152 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20155 * Insert a new item into the given slideshow widget, using the @p func
20156 * function to sort items (by item handles).
20158 * @param obj The slideshow object
20159 * @param itc The item class for the item
20160 * @param data The item's data
20161 * @param func The comparing function to be used to sort slideshow
20162 * items <b>by #Elm_Slideshow_Item item handles</b>
20163 * @return Returns The slideshow item handle, on success, or
20164 * @c NULL, on errors
20166 * Add a new item to @p obj's internal list of items, in a position
20167 * determined by the @p func comparing function. The item's class
20168 * must contain the function really fetching the image object to
20169 * show for this item, which could be an Evas image object or an
20170 * Elementary photo, for example. The @p data parameter is going to
20171 * be passed to both class functions of the item.
20173 * @see #Elm_Slideshow_Item_Class
20174 * @see elm_slideshow_item_add()
20176 * @ingroup Slideshow
20178 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);
20181 * Display a given slideshow widget's item, programmatically.
20183 * @param obj The slideshow object
20184 * @param item The item to display on @p obj's viewport
20186 * The change between the current item and @p item will use the
20187 * transition @p obj is set to use (@see
20188 * elm_slideshow_transition_set()).
20190 * @ingroup Slideshow
20192 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20195 * Slide to the @b next item, in a given slideshow widget
20197 * @param obj The slideshow object
20199 * The sliding animation @p obj is set to use will be the
20200 * transition effect used, after this call is issued.
20202 * @note If the end of the slideshow's internal list of items is
20203 * reached, it'll wrap around to the list's beginning, again.
20205 * @ingroup Slideshow
20207 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20210 * Slide to the @b previous item, in a given slideshow widget
20212 * @param obj The slideshow object
20214 * The sliding animation @p obj is set to use will be the
20215 * transition effect used, after this call is issued.
20217 * @note If the beginning of the slideshow's internal list of items
20218 * is reached, it'll wrap around to the list's end, again.
20220 * @ingroup Slideshow
20222 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20225 * Returns the list of sliding transition/effect names available, for a
20226 * given slideshow widget.
20228 * @param obj The slideshow object
20229 * @return The list of transitions (list of @b stringshared strings
20232 * The transitions, which come from @p obj's theme, must be an EDC
20233 * data item named @c "transitions" on the theme file, with (prefix)
20234 * names of EDC programs actually implementing them.
20236 * The available transitions for slideshows on the default theme are:
20237 * - @c "fade" - the current item fades out, while the new one
20238 * fades in to the slideshow's viewport.
20239 * - @c "black_fade" - the current item fades to black, and just
20240 * then, the new item will fade in.
20241 * - @c "horizontal" - the current item slides horizontally, until
20242 * it gets out of the slideshow's viewport, while the new item
20243 * comes from the left to take its place.
20244 * - @c "vertical" - the current item slides vertically, until it
20245 * gets out of the slideshow's viewport, while the new item comes
20246 * from the bottom to take its place.
20247 * - @c "square" - the new item starts to appear from the middle of
20248 * the current one, but with a tiny size, growing until its
20249 * target (full) size and covering the old one.
20251 * @warning The stringshared strings get no new references
20252 * exclusive to the user grabbing the list, here, so if you'd like
20253 * to use them out of this call's context, you'd better @c
20254 * eina_stringshare_ref() them.
20256 * @see elm_slideshow_transition_set()
20258 * @ingroup Slideshow
20260 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20263 * Set the current slide transition/effect in use for a given
20266 * @param obj The slideshow object
20267 * @param transition The new transition's name string
20269 * If @p transition is implemented in @p obj's theme (i.e., is
20270 * contained in the list returned by
20271 * elm_slideshow_transitions_get()), this new sliding effect will
20272 * be used on the widget.
20274 * @see elm_slideshow_transitions_get() for more details
20276 * @ingroup Slideshow
20278 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20281 * Get the current slide transition/effect in use for a given
20284 * @param obj The slideshow object
20285 * @return The current transition's name
20287 * @see elm_slideshow_transition_set() for more details
20289 * @ingroup Slideshow
20291 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20294 * Set the interval between each image transition on a given
20295 * slideshow widget, <b>and start the slideshow, itself</b>
20297 * @param obj The slideshow object
20298 * @param timeout The new displaying timeout for images
20300 * After this call, the slideshow widget will start cycling its
20301 * view, sequentially and automatically, with the images of the
20302 * items it has. The time between each new image displayed is going
20303 * to be @p timeout, in @b seconds. If a different timeout was set
20304 * previously and an slideshow was in progress, it will continue
20305 * with the new time between transitions, after this call.
20307 * @note A value less than or equal to 0 on @p timeout will disable
20308 * the widget's internal timer, thus halting any slideshow which
20309 * could be happening on @p obj.
20311 * @see elm_slideshow_timeout_get()
20313 * @ingroup Slideshow
20315 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20318 * Get the interval set for image transitions on a given slideshow
20321 * @param obj The slideshow object
20322 * @return Returns the timeout set on it
20324 * @see elm_slideshow_timeout_set() for more details
20326 * @ingroup Slideshow
20328 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20331 * Set if, after a slideshow is started, for a given slideshow
20332 * widget, its items should be displayed cyclically or not.
20334 * @param obj The slideshow object
20335 * @param loop Use @c EINA_TRUE to make it cycle through items or
20336 * @c EINA_FALSE for it to stop at the end of @p obj's internal
20339 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20340 * ignore what is set by this functions, i.e., they'll @b always
20341 * cycle through items. This affects only the "automatic"
20342 * slideshow, as set by elm_slideshow_timeout_set().
20344 * @see elm_slideshow_loop_get()
20346 * @ingroup Slideshow
20348 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20351 * Get if, after a slideshow is started, for a given slideshow
20352 * widget, its items are to be displayed cyclically or not.
20354 * @param obj The slideshow object
20355 * @return @c EINA_TRUE, if the items in @p obj will be cycled
20356 * through or @c EINA_FALSE, otherwise
20358 * @see elm_slideshow_loop_set() for more details
20360 * @ingroup Slideshow
20362 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20365 * Remove all items from a given slideshow widget
20367 * @param obj The slideshow object
20369 * This removes (and deletes) all items in @p obj, leaving it
20372 * @see elm_slideshow_item_del(), to remove just one item.
20374 * @ingroup Slideshow
20376 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20379 * Get the internal list of items in a given slideshow widget.
20381 * @param obj The slideshow object
20382 * @return The list of items (#Elm_Slideshow_Item as data) or
20383 * @c NULL on errors.
20385 * This list is @b not to be modified in any way and must not be
20386 * freed. Use the list members with functions like
20387 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20389 * @warning This list is only valid until @p obj object's internal
20390 * items list is changed. It should be fetched again with another
20391 * call to this function when changes happen.
20393 * @ingroup Slideshow
20395 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20398 * Delete a given item from a slideshow widget.
20400 * @param item The slideshow item
20402 * @ingroup Slideshow
20404 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20407 * Return the data associated with a given slideshow item
20409 * @param item The slideshow item
20410 * @return Returns the data associated to this item
20412 * @ingroup Slideshow
20414 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20417 * Returns the currently displayed item, in a given slideshow widget
20419 * @param obj The slideshow object
20420 * @return A handle to the item being displayed in @p obj or
20421 * @c NULL, if none is (and on errors)
20423 * @ingroup Slideshow
20425 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20428 * Get the real Evas object created to implement the view of a
20429 * given slideshow item
20431 * @param item The slideshow item.
20432 * @return the Evas object implementing this item's view.
20434 * This returns the actual Evas object used to implement the
20435 * specified slideshow item's view. This may be @c NULL, as it may
20436 * not have been created or may have been deleted, at any time, by
20437 * the slideshow. <b>Do not modify this object</b> (move, resize,
20438 * show, hide, etc.), as the slideshow is controlling it. This
20439 * function is for querying, emitting custom signals or hooking
20440 * lower level callbacks for events on that object. Do not delete
20441 * this object under any circumstances.
20443 * @see elm_slideshow_item_data_get()
20445 * @ingroup Slideshow
20447 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20450 * Get the the item, in a given slideshow widget, placed at
20451 * position @p nth, in its internal items list
20453 * @param obj The slideshow object
20454 * @param nth The number of the item to grab a handle to (0 being
20456 * @return The item stored in @p obj at position @p nth or @c NULL,
20457 * if there's no item with that index (and on errors)
20459 * @ingroup Slideshow
20461 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20464 * Set the current slide layout in use for a given slideshow widget
20466 * @param obj The slideshow object
20467 * @param layout The new layout's name string
20469 * If @p layout is implemented in @p obj's theme (i.e., is contained
20470 * in the list returned by elm_slideshow_layouts_get()), this new
20471 * images layout will be used on the widget.
20473 * @see elm_slideshow_layouts_get() for more details
20475 * @ingroup Slideshow
20477 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20480 * Get the current slide layout in use for a given slideshow widget
20482 * @param obj The slideshow object
20483 * @return The current layout's name
20485 * @see elm_slideshow_layout_set() for more details
20487 * @ingroup Slideshow
20489 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20492 * Returns the list of @b layout names available, for a given
20493 * slideshow widget.
20495 * @param obj The slideshow object
20496 * @return The list of layouts (list of @b stringshared strings
20499 * Slideshow layouts will change how the widget is to dispose each
20500 * image item in its viewport, with regard to cropping, scaling,
20503 * The layouts, which come from @p obj's theme, must be an EDC
20504 * data item name @c "layouts" on the theme file, with (prefix)
20505 * names of EDC programs actually implementing them.
20507 * The available layouts for slideshows on the default theme are:
20508 * - @c "fullscreen" - item images with original aspect, scaled to
20509 * touch top and down slideshow borders or, if the image's heigh
20510 * is not enough, left and right slideshow borders.
20511 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20512 * one, but always leaving 10% of the slideshow's dimensions of
20513 * distance between the item image's borders and the slideshow
20514 * borders, for each axis.
20516 * @warning The stringshared strings get no new references
20517 * exclusive to the user grabbing the list, here, so if you'd like
20518 * to use them out of this call's context, you'd better @c
20519 * eina_stringshare_ref() them.
20521 * @see elm_slideshow_layout_set()
20523 * @ingroup Slideshow
20525 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20528 * Set the number of items to cache, on a given slideshow widget,
20529 * <b>before the current item</b>
20531 * @param obj The slideshow object
20532 * @param count Number of items to cache before the current one
20534 * The default value for this property is @c 2. See
20535 * @ref Slideshow_Caching "slideshow caching" for more details.
20537 * @see elm_slideshow_cache_before_get()
20539 * @ingroup Slideshow
20541 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20544 * Retrieve the number of items to cache, on a given slideshow widget,
20545 * <b>before the current item</b>
20547 * @param obj The slideshow object
20548 * @return The number of items set to be cached before the current one
20550 * @see elm_slideshow_cache_before_set() for more details
20552 * @ingroup Slideshow
20554 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20557 * Set the number of items to cache, on a given slideshow widget,
20558 * <b>after the current item</b>
20560 * @param obj The slideshow object
20561 * @param count Number of items to cache after the current one
20563 * The default value for this property is @c 2. See
20564 * @ref Slideshow_Caching "slideshow caching" for more details.
20566 * @see elm_slideshow_cache_after_get()
20568 * @ingroup Slideshow
20570 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20573 * Retrieve the number of items to cache, on a given slideshow widget,
20574 * <b>after the current item</b>
20576 * @param obj The slideshow object
20577 * @return The number of items set to be cached after the current one
20579 * @see elm_slideshow_cache_after_set() for more details
20581 * @ingroup Slideshow
20583 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20586 * Get the number of items stored in a given slideshow widget
20588 * @param obj The slideshow object
20589 * @return The number of items on @p obj, at the moment of this call
20591 * @ingroup Slideshow
20593 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20600 * @defgroup Fileselector File Selector
20602 * @image html img/widget/fileselector/preview-00.png
20603 * @image latex img/widget/fileselector/preview-00.eps
20605 * A file selector is a widget that allows a user to navigate
20606 * through a file system, reporting file selections back via its
20609 * It contains shortcut buttons for home directory (@c ~) and to
20610 * jump one directory upwards (..), as well as cancel/ok buttons to
20611 * confirm/cancel a given selection. After either one of those two
20612 * former actions, the file selector will issue its @c "done" smart
20615 * There's a text entry on it, too, showing the name of the current
20616 * selection. There's the possibility of making it editable, so it
20617 * is useful on file saving dialogs on applications, where one
20618 * gives a file name to save contents to, in a given directory in
20619 * the system. This custom file name will be reported on the @c
20620 * "done" smart callback (explained in sequence).
20622 * Finally, it has a view to display file system items into in two
20627 * If Elementary is built with support of the Ethumb thumbnailing
20628 * library, the second form of view will display preview thumbnails
20629 * of files which it supports.
20631 * Smart callbacks one can register to:
20633 * - @c "selected" - the user has clicked on a file (when not in
20634 * folders-only mode) or directory (when in folders-only mode)
20635 * - @c "directory,open" - the list has been populated with new
20636 * content (@c event_info is a pointer to the directory's
20637 * path, a @b stringshared string)
20638 * - @c "done" - the user has clicked on the "ok" or "cancel"
20639 * buttons (@c event_info is a pointer to the selection's
20640 * path, a @b stringshared string)
20642 * Here is an example on its usage:
20643 * @li @ref fileselector_example
20647 * @addtogroup Fileselector
20652 * Defines how a file selector widget is to layout its contents
20653 * (file system entries).
20655 typedef enum _Elm_Fileselector_Mode
20657 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20658 ELM_FILESELECTOR_GRID, /**< layout as a grid */
20659 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20660 } Elm_Fileselector_Mode;
20663 * Add a new file selector widget to the given parent Elementary
20664 * (container) object
20666 * @param parent The parent object
20667 * @return a new file selector widget handle or @c NULL, on errors
20669 * This function inserts a new file selector widget on the canvas.
20671 * @ingroup Fileselector
20673 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20676 * Enable/disable the file name entry box where the user can type
20677 * in a name for a file, in a given file selector widget
20679 * @param obj The file selector object
20680 * @param is_save @c EINA_TRUE to make the file selector a "saving
20681 * dialog", @c EINA_FALSE otherwise
20683 * Having the entry editable is useful on file saving dialogs on
20684 * applications, where one gives a file name to save contents to,
20685 * in a given directory in the system. This custom file name will
20686 * be reported on the @c "done" smart callback.
20688 * @see elm_fileselector_is_save_get()
20690 * @ingroup Fileselector
20692 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20695 * Get whether the given file selector is in "saving dialog" mode
20697 * @param obj The file selector object
20698 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20699 * mode, @c EINA_FALSE otherwise (and on errors)
20701 * @see elm_fileselector_is_save_set() for more details
20703 * @ingroup Fileselector
20705 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20708 * Enable/disable folder-only view for a given file selector widget
20710 * @param obj The file selector object
20711 * @param only @c EINA_TRUE to make @p obj only display
20712 * directories, @c EINA_FALSE to make files to be displayed in it
20715 * If enabled, the widget's view will only display folder items,
20718 * @see elm_fileselector_folder_only_get()
20720 * @ingroup Fileselector
20722 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20725 * Get whether folder-only view is set for a given file selector
20728 * @param obj The file selector object
20729 * @return only @c EINA_TRUE if @p obj is only displaying
20730 * directories, @c EINA_FALSE if files are being displayed in it
20731 * too (and on errors)
20733 * @see elm_fileselector_folder_only_get()
20735 * @ingroup Fileselector
20737 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20740 * Enable/disable the "ok" and "cancel" buttons on a given file
20743 * @param obj The file selector object
20744 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20746 * @note A file selector without those buttons will never emit the
20747 * @c "done" smart event, and is only usable if one is just hooking
20748 * to the other two events.
20750 * @see elm_fileselector_buttons_ok_cancel_get()
20752 * @ingroup Fileselector
20754 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20757 * Get whether the "ok" and "cancel" buttons on a given file
20758 * selector widget are being shown.
20760 * @param obj The file selector object
20761 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20762 * otherwise (and on errors)
20764 * @see elm_fileselector_buttons_ok_cancel_set() for more details
20766 * @ingroup Fileselector
20768 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20771 * Enable/disable a tree view in the given file selector widget,
20772 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20774 * @param obj The file selector object
20775 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20778 * In a tree view, arrows are created on the sides of directories,
20779 * allowing them to expand in place.
20781 * @note If it's in other mode, the changes made by this function
20782 * will only be visible when one switches back to "list" mode.
20784 * @see elm_fileselector_expandable_get()
20786 * @ingroup Fileselector
20788 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20791 * Get whether tree view is enabled for the given file selector
20794 * @param obj The file selector object
20795 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20796 * otherwise (and or errors)
20798 * @see elm_fileselector_expandable_set() for more details
20800 * @ingroup Fileselector
20802 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20805 * Set, programmatically, the @b directory that a given file
20806 * selector widget will display contents from
20808 * @param obj The file selector object
20809 * @param path The path to display in @p obj
20811 * This will change the @b directory that @p obj is displaying. It
20812 * will also clear the text entry area on the @p obj object, which
20813 * displays select files' names.
20815 * @see elm_fileselector_path_get()
20817 * @ingroup Fileselector
20819 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20822 * Get the parent directory's path that a given file selector
20823 * widget is displaying
20825 * @param obj The file selector object
20826 * @return The (full) path of the directory the file selector is
20827 * displaying, a @b stringshared string
20829 * @see elm_fileselector_path_set()
20831 * @ingroup Fileselector
20833 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20836 * Set, programmatically, the currently selected file/directory in
20837 * the given file selector widget
20839 * @param obj The file selector object
20840 * @param path The (full) path to a file or directory
20841 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
20842 * latter case occurs if the directory or file pointed to do not
20845 * @see elm_fileselector_selected_get()
20847 * @ingroup Fileselector
20849 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20852 * Get the currently selected item's (full) path, in the given file
20855 * @param obj The file selector object
20856 * @return The absolute path of the selected item, a @b
20857 * stringshared string
20859 * @note Custom editions on @p obj object's text entry, if made,
20860 * will appear on the return string of this function, naturally.
20862 * @see elm_fileselector_selected_set() for more details
20864 * @ingroup Fileselector
20866 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20869 * Set the mode in which a given file selector widget will display
20870 * (layout) file system entries in its view
20872 * @param obj The file selector object
20873 * @param mode The mode of the fileselector, being it one of
20874 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
20875 * first one, naturally, will display the files in a list. The
20876 * latter will make the widget to display its entries in a grid
20879 * @note By using elm_fileselector_expandable_set(), the user may
20880 * trigger a tree view for that list.
20882 * @note If Elementary is built with support of the Ethumb
20883 * thumbnailing library, the second form of view will display
20884 * preview thumbnails of files which it supports. You must have
20885 * elm_need_ethumb() called in your Elementary for thumbnailing to
20888 * @see elm_fileselector_expandable_set().
20889 * @see elm_fileselector_mode_get().
20891 * @ingroup Fileselector
20893 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
20896 * Get the mode in which a given file selector widget is displaying
20897 * (layouting) file system entries in its view
20899 * @param obj The fileselector object
20900 * @return The mode in which the fileselector is at
20902 * @see elm_fileselector_mode_set() for more details
20904 * @ingroup Fileselector
20906 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20913 * @defgroup Progressbar Progress bar
20915 * The progress bar is a widget for visually representing the
20916 * progress status of a given job/task.
20918 * A progress bar may be horizontal or vertical. It may display an
20919 * icon besides it, as well as primary and @b units labels. The
20920 * former is meant to label the widget as a whole, while the
20921 * latter, which is formatted with floating point values (and thus
20922 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
20923 * units"</c>), is meant to label the widget's <b>progress
20924 * value</b>. Label, icon and unit strings/objects are @b optional
20925 * for progress bars.
20927 * A progress bar may be @b inverted, in which state it gets its
20928 * values inverted, with high values being on the left or top and
20929 * low values on the right or bottom, as opposed to normally have
20930 * the low values on the former and high values on the latter,
20931 * respectively, for horizontal and vertical modes.
20933 * The @b span of the progress, as set by
20934 * elm_progressbar_span_size_set(), is its length (horizontally or
20935 * vertically), unless one puts size hints on the widget to expand
20936 * on desired directions, by any container. That length will be
20937 * scaled by the object or applications scaling factor. At any
20938 * point code can query the progress bar for its value with
20939 * elm_progressbar_value_get().
20941 * Available widget styles for progress bars:
20943 * - @c "wheel" (simple style, no text, no progression, only
20944 * "pulse" effect is available)
20946 * Here is an example on its usage:
20947 * @li @ref progressbar_example
20951 * Add a new progress bar widget to the given parent Elementary
20952 * (container) object
20954 * @param parent The parent object
20955 * @return a new progress bar widget handle or @c NULL, on errors
20957 * This function inserts a new progress bar widget on the canvas.
20959 * @ingroup Progressbar
20961 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20964 * Set whether a given progress bar widget is at "pulsing mode" or
20967 * @param obj The progress bar object
20968 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
20969 * @c EINA_FALSE to put it back to its default one
20971 * By default, progress bars will display values from the low to
20972 * high value boundaries. There are, though, contexts in which the
20973 * state of progression of a given task is @b unknown. For those,
20974 * one can set a progress bar widget to a "pulsing state", to give
20975 * the user an idea that some computation is being held, but
20976 * without exact progress values. In the default theme it will
20977 * animate its bar with the contents filling in constantly and back
20978 * to non-filled, in a loop. To start and stop this pulsing
20979 * animation, one has to explicitly call elm_progressbar_pulse().
20981 * @see elm_progressbar_pulse_get()
20982 * @see elm_progressbar_pulse()
20984 * @ingroup Progressbar
20986 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
20989 * Get whether a given progress bar widget is at "pulsing mode" or
20992 * @param obj The progress bar object
20993 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
20994 * if it's in the default one (and on errors)
20996 * @ingroup Progressbar
20998 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21001 * Start/stop a given progress bar "pulsing" animation, if its
21004 * @param obj The progress bar object
21005 * @param state @c EINA_TRUE, to @b start the pulsing animation,
21006 * @c EINA_FALSE to @b stop it
21008 * @note This call won't do anything if @p obj is not under "pulsing mode".
21010 * @see elm_progressbar_pulse_set() for more details.
21012 * @ingroup Progressbar
21014 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21017 * Set the progress value (in percentage) on a given progress bar
21020 * @param obj The progress bar object
21021 * @param val The progress value (@b must be between @c 0.0 and @c
21024 * Use this call to set progress bar levels.
21026 * @note If you passes a value out of the specified range for @p
21027 * val, it will be interpreted as the @b closest of the @b boundary
21028 * values in the range.
21030 * @ingroup Progressbar
21032 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21035 * Get the progress value (in percentage) on a given progress bar
21038 * @param obj The progress bar object
21039 * @return The value of the progressbar
21041 * @see elm_progressbar_value_set() for more details
21043 * @ingroup Progressbar
21045 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21048 * Set the label of a given progress bar widget
21050 * @param obj The progress bar object
21051 * @param label The text label string, in UTF-8
21053 * @ingroup Progressbar
21054 * @deprecated use elm_object_text_set() instead.
21056 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21059 * Get the label of a given progress bar widget
21061 * @param obj The progressbar object
21062 * @return The text label string, in UTF-8
21064 * @ingroup Progressbar
21065 * @deprecated use elm_object_text_set() instead.
21067 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21070 * Set the icon object of a given progress bar widget
21072 * @param obj The progress bar object
21073 * @param icon The icon object
21075 * Use this call to decorate @p obj with an icon next to it.
21077 * @note Once the icon object is set, a previously set one will be
21078 * deleted. If you want to keep that old content object, use the
21079 * elm_progressbar_icon_unset() function.
21081 * @see elm_progressbar_icon_get()
21083 * @ingroup Progressbar
21085 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21088 * Retrieve the icon object set for a given progress bar widget
21090 * @param obj The progress bar object
21091 * @return The icon object's handle, if @p obj had one set, or @c NULL,
21092 * otherwise (and on errors)
21094 * @see elm_progressbar_icon_set() for more details
21096 * @ingroup Progressbar
21098 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21101 * Unset an icon set on a given progress bar widget
21103 * @param obj The progress bar object
21104 * @return The icon object that was being used, if any was set, or
21105 * @c NULL, otherwise (and on errors)
21107 * This call will unparent and return the icon object which was set
21108 * for this widget, previously, on success.
21110 * @see elm_progressbar_icon_set() for more details
21112 * @ingroup Progressbar
21114 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21117 * Set the (exact) length of the bar region of a given progress bar
21120 * @param obj The progress bar object
21121 * @param size The length of the progress bar's bar region
21123 * This sets the minimum width (when in horizontal mode) or height
21124 * (when in vertical mode) of the actual bar area of the progress
21125 * bar @p obj. This in turn affects the object's minimum size. Use
21126 * this when you're not setting other size hints expanding on the
21127 * given direction (like weight and alignment hints) and you would
21128 * like it to have a specific size.
21130 * @note Icon, label and unit text around @p obj will require their
21131 * own space, which will make @p obj to require more the @p size,
21134 * @see elm_progressbar_span_size_get()
21136 * @ingroup Progressbar
21138 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21141 * Get the length set for the bar region of a given progress bar
21144 * @param obj The progress bar object
21145 * @return The length of the progress bar's bar region
21147 * If that size was not set previously, with
21148 * elm_progressbar_span_size_set(), this call will return @c 0.
21150 * @ingroup Progressbar
21152 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21155 * Set the format string for a given progress bar widget's units
21158 * @param obj The progress bar object
21159 * @param format The format string for @p obj's units label
21161 * If @c NULL is passed on @p format, it will make @p obj's units
21162 * area to be hidden completely. If not, it'll set the <b>format
21163 * string</b> for the units label's @b text. The units label is
21164 * provided a floating point value, so the units text is up display
21165 * at most one floating point falue. Note that the units label is
21166 * optional. Use a format string such as "%1.2f meters" for
21169 * @note The default format string for a progress bar is an integer
21170 * percentage, as in @c "%.0f %%".
21172 * @see elm_progressbar_unit_format_get()
21174 * @ingroup Progressbar
21176 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21179 * Retrieve the format string set for a given progress bar widget's
21182 * @param obj The progress bar object
21183 * @return The format set string for @p obj's units label or
21184 * @c NULL, if none was set (and on errors)
21186 * @see elm_progressbar_unit_format_set() for more details
21188 * @ingroup Progressbar
21190 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21193 * Set the orientation of a given progress bar widget
21195 * @param obj The progress bar object
21196 * @param horizontal Use @c EINA_TRUE to make @p obj to be
21197 * @b horizontal, @c EINA_FALSE to make it @b vertical
21199 * Use this function to change how your progress bar is to be
21200 * disposed: vertically or horizontally.
21202 * @see elm_progressbar_horizontal_get()
21204 * @ingroup Progressbar
21206 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21209 * Retrieve the orientation of a given progress bar widget
21211 * @param obj The progress bar object
21212 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21213 * @c EINA_FALSE if it's @b vertical (and on errors)
21215 * @see elm_progressbar_horizontal_set() for more details
21217 * @ingroup Progressbar
21219 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21222 * Invert a given progress bar widget's displaying values order
21224 * @param obj The progress bar object
21225 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21226 * @c EINA_FALSE to bring it back to default, non-inverted values.
21228 * A progress bar may be @b inverted, in which state it gets its
21229 * values inverted, with high values being on the left or top and
21230 * low values on the right or bottom, as opposed to normally have
21231 * the low values on the former and high values on the latter,
21232 * respectively, for horizontal and vertical modes.
21234 * @see elm_progressbar_inverted_get()
21236 * @ingroup Progressbar
21238 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21241 * Get whether a given progress bar widget's displaying values are
21244 * @param obj The progress bar object
21245 * @return @c EINA_TRUE, if @p obj has inverted values,
21246 * @c EINA_FALSE otherwise (and on errors)
21248 * @see elm_progressbar_inverted_set() for more details
21250 * @ingroup Progressbar
21252 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21255 * @defgroup Separator Separator
21257 * @brief Separator is a very thin object used to separate other objects.
21259 * A separator can be vertical or horizontal.
21261 * @ref tutorial_separator is a good example of how to use a separator.
21265 * @brief Add a separator object to @p parent
21267 * @param parent The parent object
21269 * @return The separator object, or NULL upon failure
21271 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21273 * @brief Set the horizontal mode of a separator object
21275 * @param obj The separator object
21276 * @param horizontal If true, the separator is horizontal
21278 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21280 * @brief Get the horizontal mode of a separator object
21282 * @param obj The separator object
21283 * @return If true, the separator is horizontal
21285 * @see elm_separator_horizontal_set()
21287 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21293 * @defgroup Spinner Spinner
21294 * @ingroup Elementary
21296 * @image html img/widget/spinner/preview-00.png
21297 * @image latex img/widget/spinner/preview-00.eps
21299 * A spinner is a widget which allows the user to increase or decrease
21300 * numeric values using arrow buttons, or edit values directly, clicking
21301 * over it and typing the new value.
21303 * By default the spinner will not wrap and has a label
21304 * of "%.0f" (just showing the integer value of the double).
21306 * A spinner has a label that is formatted with floating
21307 * point values and thus accepts a printf-style format string, like
21308 * ā%1.2f unitsā.
21310 * It also allows specific values to be replaced by pre-defined labels.
21312 * Smart callbacks one can register to:
21314 * - "changed" - Whenever the spinner value is changed.
21315 * - "delay,changed" - A short time after the value is changed by the user.
21316 * This will be called only when the user stops dragging for a very short
21317 * period or when they release their finger/mouse, so it avoids possibly
21318 * expensive reactions to the value change.
21320 * Available styles for it:
21322 * - @c "vertical": up/down buttons at the right side and text left aligned.
21324 * Here is an example on its usage:
21325 * @ref spinner_example
21329 * @addtogroup Spinner
21334 * Add a new spinner widget to the given parent Elementary
21335 * (container) object.
21337 * @param parent The parent object.
21338 * @return a new spinner widget handle or @c NULL, on errors.
21340 * This function inserts a new spinner widget on the canvas.
21345 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21348 * Set the format string of the displayed label.
21350 * @param obj The spinner object.
21351 * @param fmt The format string for the label display.
21353 * If @c NULL, this sets the format to "%.0f". If not it sets the format
21354 * string for the label text. The label text is provided a floating point
21355 * value, so the label text can display up to 1 floating point value.
21356 * Note that this is optional.
21358 * Use a format string such as "%1.2f meters" for example, and it will
21359 * display values like: "3.14 meters" for a value equal to 3.14159.
21361 * Default is "%0.f".
21363 * @see elm_spinner_label_format_get()
21367 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21370 * Get the label format of the spinner.
21372 * @param obj The spinner object.
21373 * @return The text label format string in UTF-8.
21375 * @see elm_spinner_label_format_set() for details.
21379 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21382 * Set the minimum and maximum values for the spinner.
21384 * @param obj The spinner object.
21385 * @param min The minimum value.
21386 * @param max The maximum value.
21388 * Define the allowed range of values to be selected by the user.
21390 * If actual value is less than @p min, it will be updated to @p min. If it
21391 * is bigger then @p max, will be updated to @p max. Actual value can be
21392 * get with elm_spinner_value_get().
21394 * By default, min is equal to 0, and max is equal to 100.
21396 * @warning Maximum must be greater than minimum.
21398 * @see elm_spinner_min_max_get()
21402 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21405 * Get the minimum and maximum values of the spinner.
21407 * @param obj The spinner object.
21408 * @param min Pointer where to store the minimum value.
21409 * @param max Pointer where to store the maximum value.
21411 * @note If only one value is needed, the other pointer can be passed
21414 * @see elm_spinner_min_max_set() for details.
21418 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21421 * Set the step used to increment or decrement the spinner value.
21423 * @param obj The spinner object.
21424 * @param step The step value.
21426 * This value will be incremented or decremented to the displayed value.
21427 * It will be incremented while the user keep right or top arrow pressed,
21428 * and will be decremented while the user keep left or bottom arrow pressed.
21430 * The interval to increment / decrement can be set with
21431 * elm_spinner_interval_set().
21433 * By default step value is equal to 1.
21435 * @see elm_spinner_step_get()
21439 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21442 * Get the step used to increment or decrement the spinner value.
21444 * @param obj The spinner object.
21445 * @return The step value.
21447 * @see elm_spinner_step_get() for more details.
21451 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21454 * Set the value the spinner displays.
21456 * @param obj The spinner object.
21457 * @param val The value to be displayed.
21459 * Value will be presented on the label following format specified with
21460 * elm_spinner_format_set().
21462 * @warning The value must to be between min and max values. This values
21463 * are set by elm_spinner_min_max_set().
21465 * @see elm_spinner_value_get().
21466 * @see elm_spinner_format_set().
21467 * @see elm_spinner_min_max_set().
21471 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21474 * Get the value displayed by the spinner.
21476 * @param obj The spinner object.
21477 * @return The value displayed.
21479 * @see elm_spinner_value_set() for details.
21483 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21486 * Set whether the spinner should wrap when it reaches its
21487 * minimum or maximum value.
21489 * @param obj The spinner object.
21490 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21493 * Disabled by default. If disabled, when the user tries to increment the
21495 * but displayed value plus step value is bigger than maximum value,
21497 * won't allow it. The same happens when the user tries to decrement it,
21498 * but the value less step is less than minimum value.
21500 * When wrap is enabled, in such situations it will allow these changes,
21501 * but will get the value that would be less than minimum and subtracts
21502 * from maximum. Or add the value that would be more than maximum to
21506 * @li min value = 10
21507 * @li max value = 50
21508 * @li step value = 20
21509 * @li displayed value = 20
21511 * When the user decrement value (using left or bottom arrow), it will
21512 * displays @c 40, because max - (min - (displayed - step)) is
21513 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21515 * @see elm_spinner_wrap_get().
21519 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21522 * Get whether the spinner should wrap when it reaches its
21523 * minimum or maximum value.
21525 * @param obj The spinner object
21526 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21527 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21529 * @see elm_spinner_wrap_set() for details.
21533 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21536 * Set whether the spinner can be directly edited by the user or not.
21538 * @param obj The spinner object.
21539 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21540 * don't allow users to edit it directly.
21542 * Spinner objects can have edition @b disabled, in which state they will
21543 * be changed only by arrows.
21544 * Useful for contexts
21545 * where you don't want your users to interact with it writting the value.
21547 * when using special values, the user can see real value instead
21548 * of special label on edition.
21550 * It's enabled by default.
21552 * @see elm_spinner_editable_get()
21556 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21559 * Get whether the spinner can be directly edited by the user or not.
21561 * @param obj The spinner object.
21562 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21563 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21565 * @see elm_spinner_editable_set() for details.
21569 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21572 * Set a special string to display in the place of the numerical value.
21574 * @param obj The spinner object.
21575 * @param value The value to be replaced.
21576 * @param label The label to be used.
21578 * It's useful for cases when a user should select an item that is
21579 * better indicated by a label than a value. For example, weekdays or months.
21583 * sp = elm_spinner_add(win);
21584 * elm_spinner_min_max_set(sp, 1, 3);
21585 * elm_spinner_special_value_add(sp, 1, "January");
21586 * elm_spinner_special_value_add(sp, 2, "February");
21587 * elm_spinner_special_value_add(sp, 3, "March");
21588 * evas_object_show(sp);
21593 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21596 * Set the interval on time updates for an user mouse button hold
21597 * on spinner widgets' arrows.
21599 * @param obj The spinner object.
21600 * @param interval The (first) interval value in seconds.
21602 * This interval value is @b decreased while the user holds the
21603 * mouse pointer either incrementing or decrementing spinner's value.
21605 * This helps the user to get to a given value distant from the
21606 * current one easier/faster, as it will start to change quicker and
21607 * quicker on mouse button holds.
21609 * The calculation for the next change interval value, starting from
21610 * the one set with this call, is the previous interval divided by
21611 * @c 1.05, so it decreases a little bit.
21613 * The default starting interval value for automatic changes is
21616 * @see elm_spinner_interval_get()
21620 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21623 * Get the interval on time updates for an user mouse button hold
21624 * on spinner widgets' arrows.
21626 * @param obj The spinner object.
21627 * @return The (first) interval value, in seconds, set on it.
21629 * @see elm_spinner_interval_set() for more details.
21633 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21640 * @defgroup Index Index
21642 * @image html img/widget/index/preview-00.png
21643 * @image latex img/widget/index/preview-00.eps
21645 * An index widget gives you an index for fast access to whichever
21646 * group of other UI items one might have. It's a list of text
21647 * items (usually letters, for alphabetically ordered access).
21649 * Index widgets are by default hidden and just appear when the
21650 * user clicks over it's reserved area in the canvas. In its
21651 * default theme, it's an area one @ref Fingers "finger" wide on
21652 * the right side of the index widget's container.
21654 * When items on the index are selected, smart callbacks get
21655 * called, so that its user can make other container objects to
21656 * show a given area or child object depending on the index item
21657 * selected. You'd probably be using an index together with @ref
21658 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21661 * Smart events one can add callbacks for are:
21662 * - @c "changed" - When the selected index item changes. @c
21663 * event_info is the selected item's data pointer.
21664 * - @c "delay,changed" - When the selected index item changes, but
21665 * after a small idling period. @c event_info is the selected
21666 * item's data pointer.
21667 * - @c "selected" - When the user releases a mouse button and
21668 * selects an item. @c event_info is the selected item's data
21670 * - @c "level,up" - when the user moves a finger from the first
21671 * level to the second level
21672 * - @c "level,down" - when the user moves a finger from the second
21673 * level to the first level
21675 * The @c "delay,changed" event is so that it'll wait a small time
21676 * before actually reporting those events and, moreover, just the
21677 * last event happening on those time frames will actually be
21680 * Here are some examples on its usage:
21681 * @li @ref index_example_01
21682 * @li @ref index_example_02
21686 * @addtogroup Index
21690 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21693 * Add a new index widget to the given parent Elementary
21694 * (container) object
21696 * @param parent The parent object
21697 * @return a new index widget handle or @c NULL, on errors
21699 * This function inserts a new index widget on the canvas.
21703 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21706 * Set whether a given index widget is or not visible,
21709 * @param obj The index object
21710 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21712 * Not to be confused with visible as in @c evas_object_show() --
21713 * visible with regard to the widget's auto hiding feature.
21715 * @see elm_index_active_get()
21719 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21722 * Get whether a given index widget is currently visible or not.
21724 * @param obj The index object
21725 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21727 * @see elm_index_active_set() for more details
21731 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21734 * Set the items level for a given index widget.
21736 * @param obj The index object.
21737 * @param level @c 0 or @c 1, the currently implemented levels.
21739 * @see elm_index_item_level_get()
21743 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21746 * Get the items level set for a given index widget.
21748 * @param obj The index object.
21749 * @return @c 0 or @c 1, which are the levels @p obj might be at.
21751 * @see elm_index_item_level_set() for more information
21755 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21758 * Returns the last selected item's data, for a given index widget.
21760 * @param obj The index object.
21761 * @return The item @b data associated to the last selected item on
21762 * @p obj (or @c NULL, on errors).
21764 * @warning The returned value is @b not an #Elm_Index_Item item
21765 * handle, but the data associated to it (see the @c item parameter
21766 * in elm_index_item_append(), as an example).
21770 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21773 * Append a new item on a given index widget.
21775 * @param obj The index object.
21776 * @param letter Letter under which the item should be indexed
21777 * @param item The item data to set for the index's item
21779 * Despite the most common usage of the @p letter argument is for
21780 * single char strings, one could use arbitrary strings as index
21783 * @c item will be the pointer returned back on @c "changed", @c
21784 * "delay,changed" and @c "selected" smart events.
21788 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21791 * Prepend a new item on a given index widget.
21793 * @param obj The index object.
21794 * @param letter Letter under which the item should be indexed
21795 * @param item The item data to set for the index's item
21797 * Despite the most common usage of the @p letter argument is for
21798 * single char strings, one could use arbitrary strings as index
21801 * @c item will be the pointer returned back on @c "changed", @c
21802 * "delay,changed" and @c "selected" smart events.
21806 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21809 * Append a new item, on a given index widget, <b>after the item
21810 * having @p relative as data</b>.
21812 * @param obj The index object.
21813 * @param letter Letter under which the item should be indexed
21814 * @param item The item data to set for the index's item
21815 * @param relative The item data of the index item to be the
21816 * predecessor of this new one
21818 * Despite the most common usage of the @p letter argument is for
21819 * single char strings, one could use arbitrary strings as index
21822 * @c item will be the pointer returned back on @c "changed", @c
21823 * "delay,changed" and @c "selected" smart events.
21825 * @note If @p relative is @c NULL or if it's not found to be data
21826 * set on any previous item on @p obj, this function will behave as
21827 * elm_index_item_append().
21831 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21834 * Prepend a new item, on a given index widget, <b>after the item
21835 * having @p relative as data</b>.
21837 * @param obj The index object.
21838 * @param letter Letter under which the item should be indexed
21839 * @param item The item data to set for the index's item
21840 * @param relative The item data of the index item to be the
21841 * successor of this new one
21843 * Despite the most common usage of the @p letter argument is for
21844 * single char strings, one could use arbitrary strings as index
21847 * @c item will be the pointer returned back on @c "changed", @c
21848 * "delay,changed" and @c "selected" smart events.
21850 * @note If @p relative is @c NULL or if it's not found to be data
21851 * set on any previous item on @p obj, this function will behave as
21852 * elm_index_item_prepend().
21856 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21859 * Insert a new item into the given index widget, using @p cmp_func
21860 * function to sort items (by item handles).
21862 * @param obj The index object.
21863 * @param letter Letter under which the item should be indexed
21864 * @param item The item data to set for the index's item
21865 * @param cmp_func The comparing function to be used to sort index
21866 * items <b>by #Elm_Index_Item item handles</b>
21867 * @param cmp_data_func A @b fallback function to be called for the
21868 * sorting of index items <b>by item data</b>). It will be used
21869 * when @p cmp_func returns @c 0 (equality), which means an index
21870 * item with provided item data already exists. To decide which
21871 * data item should be pointed to by the index item in question, @p
21872 * cmp_data_func will be used. If @p cmp_data_func returns a
21873 * non-negative value, the previous index item data will be
21874 * replaced by the given @p item pointer. If the previous data need
21875 * to be freed, it should be done by the @p cmp_data_func function,
21876 * because all references to it will be lost. If this function is
21877 * not provided (@c NULL is given), index items will be @b
21878 * duplicated, if @p cmp_func returns @c 0.
21880 * Despite the most common usage of the @p letter argument is for
21881 * single char strings, one could use arbitrary strings as index
21884 * @c item will be the pointer returned back on @c "changed", @c
21885 * "delay,changed" and @c "selected" smart events.
21889 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);
21892 * Remove an item from a given index widget, <b>to be referenced by
21893 * it's data value</b>.
21895 * @param obj The index object
21896 * @param item The item's data pointer for the item to be removed
21899 * If a deletion callback is set, via elm_index_item_del_cb_set(),
21900 * that callback function will be called by this one.
21902 * @warning The item to be removed from @p obj will be found via
21903 * its item data pointer, and not by an #Elm_Index_Item handle.
21907 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21910 * Find a given index widget's item, <b>using item data</b>.
21912 * @param obj The index object
21913 * @param item The item data pointed to by the desired index item
21914 * @return The index item handle, if found, or @c NULL otherwise
21918 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21921 * Removes @b all items from a given index widget.
21923 * @param obj The index object.
21925 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
21926 * that callback function will be called for each item in @p obj.
21930 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21933 * Go to a given items level on a index widget
21935 * @param obj The index object
21936 * @param level The index level (one of @c 0 or @c 1)
21940 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21943 * Return the data associated with a given index widget item
21945 * @param it The index widget item handle
21946 * @return The data associated with @p it
21948 * @see elm_index_item_data_set()
21952 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21955 * Set the data associated with a given index widget item
21957 * @param it The index widget item handle
21958 * @param data The new data pointer to set to @p it
21960 * This sets new item data on @p it.
21962 * @warning The old data pointer won't be touched by this function, so
21963 * the user had better to free that old data himself/herself.
21967 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
21970 * Set the function to be called when a given index widget item is freed.
21972 * @param it The item to set the callback on
21973 * @param func The function to call on the item's deletion
21975 * When called, @p func will have both @c data and @c event_info
21976 * arguments with the @p it item's data value and, naturally, the
21977 * @c obj argument with a handle to the parent index widget.
21981 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
21984 * Get the letter (string) set on a given index widget item.
21986 * @param it The index item handle
21987 * @return The letter string set on @p it
21991 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21998 * @defgroup Photocam Photocam
22000 * @image html img/widget/photocam/preview-00.png
22001 * @image latex img/widget/photocam/preview-00.eps
22003 * This is a widget specifically for displaying high-resolution digital
22004 * camera photos giving speedy feedback (fast load), low memory footprint
22005 * and zooming and panning as well as fitting logic. It is entirely focused
22006 * on jpeg images, and takes advantage of properties of the jpeg format (via
22007 * evas loader features in the jpeg loader).
22009 * Signals that you can add callbacks for are:
22010 * @li "clicked" - This is called when a user has clicked the photo without
22012 * @li "press" - This is called when a user has pressed down on the photo.
22013 * @li "longpressed" - This is called when a user has pressed down on the
22014 * photo for a long time without dragging around.
22015 * @li "clicked,double" - This is called when a user has double-clicked the
22017 * @li "load" - Photo load begins.
22018 * @li "loaded" - This is called when the image file load is complete for the
22019 * first view (low resolution blurry version).
22020 * @li "load,detail" - Photo detailed data load begins.
22021 * @li "loaded,detail" - This is called when the image file load is complete
22022 * for the detailed image data (full resolution needed).
22023 * @li "zoom,start" - Zoom animation started.
22024 * @li "zoom,stop" - Zoom animation stopped.
22025 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22026 * @li "scroll" - the content has been scrolled (moved)
22027 * @li "scroll,anim,start" - scrolling animation has started
22028 * @li "scroll,anim,stop" - scrolling animation has stopped
22029 * @li "scroll,drag,start" - dragging the contents around has started
22030 * @li "scroll,drag,stop" - dragging the contents around has stopped
22032 * @ref tutorial_photocam shows the API in action.
22036 * @brief Types of zoom available.
22038 typedef enum _Elm_Photocam_Zoom_Mode
22040 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
22041 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22042 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22043 ELM_PHOTOCAM_ZOOM_MODE_LAST
22044 } Elm_Photocam_Zoom_Mode;
22046 * @brief Add a new Photocam object
22048 * @param parent The parent object
22049 * @return The new object or NULL if it cannot be created
22051 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22053 * @brief Set the photo file to be shown
22055 * @param obj The photocam object
22056 * @param file The photo file
22057 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22059 * This sets (and shows) the specified file (with a relative or absolute
22060 * path) and will return a load error (same error that
22061 * evas_object_image_load_error_get() will return). The image will change and
22062 * adjust its size at this point and begin a background load process for this
22063 * photo that at some time in the future will be displayed at the full
22066 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22068 * @brief Returns the path of the current image file
22070 * @param obj The photocam object
22071 * @return Returns the path
22073 * @see elm_photocam_file_set()
22075 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22077 * @brief Set the zoom level of the photo
22079 * @param obj The photocam object
22080 * @param zoom The zoom level to set
22082 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22083 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22084 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22085 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22088 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22090 * @brief Get the zoom level of the photo
22092 * @param obj The photocam object
22093 * @return The current zoom level
22095 * This returns the current zoom level of the photocam object. Note that if
22096 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22097 * (which is the default), the zoom level may be changed at any time by the
22098 * photocam object itself to account for photo size and photocam viewpoer
22101 * @see elm_photocam_zoom_set()
22102 * @see elm_photocam_zoom_mode_set()
22104 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22106 * @brief Set the zoom mode
22108 * @param obj The photocam object
22109 * @param mode The desired mode
22111 * This sets the zoom mode to manual or one of several automatic levels.
22112 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22113 * elm_photocam_zoom_set() and will stay at that level until changed by code
22114 * or until zoom mode is changed. This is the default mode. The Automatic
22115 * modes will allow the photocam object to automatically adjust zoom mode
22116 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22117 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22118 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22119 * pixels within the frame are left unfilled.
22121 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22123 * @brief Get the zoom mode
22125 * @param obj The photocam object
22126 * @return The current zoom mode
22128 * This gets the current zoom mode of the photocam object.
22130 * @see elm_photocam_zoom_mode_set()
22132 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22134 * @brief Get the current image pixel width and height
22136 * @param obj The photocam object
22137 * @param w A pointer to the width return
22138 * @param h A pointer to the height return
22140 * This gets the current photo pixel width and height (for the original).
22141 * The size will be returned in the integers @p w and @p h that are pointed
22144 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22146 * @brief Get the area of the image that is currently shown
22149 * @param x A pointer to the X-coordinate of region
22150 * @param y A pointer to the Y-coordinate of region
22151 * @param w A pointer to the width
22152 * @param h A pointer to the height
22154 * @see elm_photocam_image_region_show()
22155 * @see elm_photocam_image_region_bring_in()
22157 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22159 * @brief Set the viewed portion of the image
22161 * @param obj The photocam object
22162 * @param x X-coordinate of region in image original pixels
22163 * @param y Y-coordinate of region in image original pixels
22164 * @param w Width of region in image original pixels
22165 * @param h Height of region in image original pixels
22167 * This shows the region of the image without using animation.
22169 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22171 * @brief Bring in the viewed portion of the image
22173 * @param obj The photocam object
22174 * @param x X-coordinate of region in image original pixels
22175 * @param y Y-coordinate of region in image original pixels
22176 * @param w Width of region in image original pixels
22177 * @param h Height of region in image original pixels
22179 * This shows the region of the image using animation.
22181 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22183 * @brief Set the paused state for photocam
22185 * @param obj The photocam object
22186 * @param paused The pause state to set
22188 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22189 * photocam. The default is off. This will stop zooming using animation on
22190 * zoom levels changes and change instantly. This will stop any existing
22191 * animations that are running.
22193 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22195 * @brief Get the paused state for photocam
22197 * @param obj The photocam object
22198 * @return The current paused state
22200 * This gets the current paused state for the photocam object.
22202 * @see elm_photocam_paused_set()
22204 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22206 * @brief Get the internal low-res image used for photocam
22208 * @param obj The photocam object
22209 * @return The internal image object handle, or NULL if none exists
22211 * This gets the internal image object inside photocam. Do not modify it. It
22212 * is for inspection only, and hooking callbacks to. Nothing else. It may be
22213 * deleted at any time as well.
22215 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22217 * @brief Set the photocam scrolling bouncing.
22219 * @param obj The photocam object
22220 * @param h_bounce bouncing for horizontal
22221 * @param v_bounce bouncing for vertical
22223 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22225 * @brief Get the photocam scrolling bouncing.
22227 * @param obj The photocam object
22228 * @param h_bounce bouncing for horizontal
22229 * @param v_bounce bouncing for vertical
22231 * @see elm_photocam_bounce_set()
22233 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22239 * @defgroup Map Map
22240 * @ingroup Elementary
22242 * @image html img/widget/map/preview-00.png
22243 * @image latex img/widget/map/preview-00.eps
22245 * This is a widget specifically for displaying a map. It uses basically
22246 * OpenStreetMap provider http://www.openstreetmap.org/,
22247 * but custom providers can be added.
22249 * It supports some basic but yet nice features:
22250 * @li zoom and scroll
22251 * @li markers with content to be displayed when user clicks over it
22252 * @li group of markers
22255 * Smart callbacks one can listen to:
22257 * - "clicked" - This is called when a user has clicked the map without
22259 * - "press" - This is called when a user has pressed down on the map.
22260 * - "longpressed" - This is called when a user has pressed down on the map
22261 * for a long time without dragging around.
22262 * - "clicked,double" - This is called when a user has double-clicked
22264 * - "load,detail" - Map detailed data load begins.
22265 * - "loaded,detail" - This is called when all currently visible parts of
22266 * the map are loaded.
22267 * - "zoom,start" - Zoom animation started.
22268 * - "zoom,stop" - Zoom animation stopped.
22269 * - "zoom,change" - Zoom changed when using an auto zoom mode.
22270 * - "scroll" - the content has been scrolled (moved).
22271 * - "scroll,anim,start" - scrolling animation has started.
22272 * - "scroll,anim,stop" - scrolling animation has stopped.
22273 * - "scroll,drag,start" - dragging the contents around has started.
22274 * - "scroll,drag,stop" - dragging the contents around has stopped.
22275 * - "downloaded" - This is called when all currently required map images
22277 * - "route,load" - This is called when route request begins.
22278 * - "route,loaded" - This is called when route request ends.
22279 * - "name,load" - This is called when name request begins.
22280 * - "name,loaded- This is called when name request ends.
22282 * Available style for map widget:
22285 * Available style for markers:
22290 * Available style for marker bubble:
22293 * List of examples:
22294 * @li @ref map_example_01
22295 * @li @ref map_example_02
22296 * @li @ref map_example_03
22305 * @enum _Elm_Map_Zoom_Mode
22306 * @typedef Elm_Map_Zoom_Mode
22308 * Set map's zoom behavior. It can be set to manual or automatic.
22310 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22312 * Values <b> don't </b> work as bitmask, only one can be choosen.
22314 * @note Valid sizes are 2^zoom, consequently the map may be smaller
22315 * than the scroller view.
22317 * @see elm_map_zoom_mode_set()
22318 * @see elm_map_zoom_mode_get()
22322 typedef enum _Elm_Map_Zoom_Mode
22324 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22325 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22326 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22327 ELM_MAP_ZOOM_MODE_LAST
22328 } Elm_Map_Zoom_Mode;
22331 * @enum _Elm_Map_Route_Sources
22332 * @typedef Elm_Map_Route_Sources
22334 * Set route service to be used. By default used source is
22335 * #ELM_MAP_ROUTE_SOURCE_YOURS.
22337 * @see elm_map_route_source_set()
22338 * @see elm_map_route_source_get()
22342 typedef enum _Elm_Map_Route_Sources
22344 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22345 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. */
22346 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22347 ELM_MAP_ROUTE_SOURCE_LAST
22348 } Elm_Map_Route_Sources;
22350 typedef enum _Elm_Map_Name_Sources
22352 ELM_MAP_NAME_SOURCE_NOMINATIM,
22353 ELM_MAP_NAME_SOURCE_LAST
22354 } Elm_Map_Name_Sources;
22357 * @enum _Elm_Map_Route_Type
22358 * @typedef Elm_Map_Route_Type
22360 * Set type of transport used on route.
22362 * @see elm_map_route_add()
22366 typedef enum _Elm_Map_Route_Type
22368 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22369 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22370 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22371 ELM_MAP_ROUTE_TYPE_LAST
22372 } Elm_Map_Route_Type;
22375 * @enum _Elm_Map_Route_Method
22376 * @typedef Elm_Map_Route_Method
22378 * Set the routing method, what should be priorized, time or distance.
22380 * @see elm_map_route_add()
22384 typedef enum _Elm_Map_Route_Method
22386 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22387 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22388 ELM_MAP_ROUTE_METHOD_LAST
22389 } Elm_Map_Route_Method;
22391 typedef enum _Elm_Map_Name_Method
22393 ELM_MAP_NAME_METHOD_SEARCH,
22394 ELM_MAP_NAME_METHOD_REVERSE,
22395 ELM_MAP_NAME_METHOD_LAST
22396 } Elm_Map_Name_Method;
22398 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(). */
22399 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(). */
22400 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(). */
22401 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(). */
22402 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
22403 typedef struct _Elm_Map_Track Elm_Map_Track;
22405 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. */
22406 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22407 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22408 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22410 typedef char *(*ElmMapModuleSourceFunc) (void);
22411 typedef int (*ElmMapModuleZoomMinFunc) (void);
22412 typedef int (*ElmMapModuleZoomMaxFunc) (void);
22413 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22414 typedef int (*ElmMapModuleRouteSourceFunc) (void);
22415 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22416 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22417 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22418 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22421 * Add a new map widget to the given parent Elementary (container) object.
22423 * @param parent The parent object.
22424 * @return a new map widget handle or @c NULL, on errors.
22426 * This function inserts a new map widget on the canvas.
22430 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22433 * Set the zoom level of the map.
22435 * @param obj The map object.
22436 * @param zoom The zoom level to set.
22438 * This sets the zoom level.
22440 * It will respect limits defined by elm_map_source_zoom_min_set() and
22441 * elm_map_source_zoom_max_set().
22443 * By default these values are 0 (world map) and 18 (maximum zoom).
22445 * This function should be used when zoom mode is set to
22446 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22447 * with elm_map_zoom_mode_set().
22449 * @see elm_map_zoom_mode_set().
22450 * @see elm_map_zoom_get().
22454 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22457 * Get the zoom level of the map.
22459 * @param obj The map object.
22460 * @return The current zoom level.
22462 * This returns the current zoom level of the map object.
22464 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22465 * (which is the default), the zoom level may be changed at any time by the
22466 * map object itself to account for map size and map viewport size.
22468 * @see elm_map_zoom_set() for details.
22472 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22475 * Set the zoom mode used by the map object.
22477 * @param obj The map object.
22478 * @param mode The zoom mode of the map, being it one of
22479 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22480 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22482 * This sets the zoom mode to manual or one of the automatic levels.
22483 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22484 * elm_map_zoom_set() and will stay at that level until changed by code
22485 * or until zoom mode is changed. This is the default mode.
22487 * The Automatic modes will allow the map object to automatically
22488 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22489 * adjust zoom so the map fits inside the scroll frame with no pixels
22490 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22491 * ensure no pixels within the frame are left unfilled. Do not forget that
22492 * the valid sizes are 2^zoom, consequently the map may be smaller than
22493 * the scroller view.
22495 * @see elm_map_zoom_set()
22499 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22502 * Get the zoom mode used by the map object.
22504 * @param obj The map object.
22505 * @return The zoom mode of the map, being it one of
22506 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22507 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22509 * This function returns the current zoom mode used by the map object.
22511 * @see elm_map_zoom_mode_set() for more details.
22515 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22518 * Get the current coordinates of the map.
22520 * @param obj The map object.
22521 * @param lon Pointer where to store longitude.
22522 * @param lat Pointer where to store latitude.
22524 * This gets the current center coordinates of the map object. It can be
22525 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22527 * @see elm_map_geo_region_bring_in()
22528 * @see elm_map_geo_region_show()
22532 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22535 * Animatedly bring in given coordinates to the center of the map.
22537 * @param obj The map object.
22538 * @param lon Longitude to center at.
22539 * @param lat Latitude to center at.
22541 * This causes map to jump to the given @p lat and @p lon coordinates
22542 * and show it (by scrolling) in the center of the viewport, if it is not
22543 * already centered. This will use animation to do so and take a period
22544 * of time to complete.
22546 * @see elm_map_geo_region_show() for a function to avoid animation.
22547 * @see elm_map_geo_region_get()
22551 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22554 * Show the given coordinates at the center of the map, @b immediately.
22556 * @param obj The map object.
22557 * @param lon Longitude to center at.
22558 * @param lat Latitude to center at.
22560 * This causes map to @b redraw its viewport's contents to the
22561 * region contining the given @p lat and @p lon, that will be moved to the
22562 * center of the map.
22564 * @see elm_map_geo_region_bring_in() for a function to move with animation.
22565 * @see elm_map_geo_region_get()
22569 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22572 * Pause or unpause the map.
22574 * @param obj The map object.
22575 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22578 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22581 * The default is off.
22583 * This will stop zooming using animation, changing zoom levels will
22584 * change instantly. This will stop any existing animations that are running.
22586 * @see elm_map_paused_get()
22590 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22593 * Get a value whether map is paused or not.
22595 * @param obj The map object.
22596 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22597 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22599 * This gets the current paused state for the map object.
22601 * @see elm_map_paused_set() for details.
22605 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22608 * Set to show markers during zoom level changes or not.
22610 * @param obj The map object.
22611 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22614 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22617 * The default is off.
22619 * This will stop zooming using animation, changing zoom levels will
22620 * change instantly. This will stop any existing animations that are running.
22622 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22625 * The default is off.
22627 * Enabling it will force the map to stop displaying the markers during
22628 * zoom level changes. Set to on if you have a large number of markers.
22630 * @see elm_map_paused_markers_get()
22634 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22637 * Get a value whether markers will be displayed on zoom level changes or not
22639 * @param obj The map object.
22640 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22641 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22643 * This gets the current markers paused state for the map object.
22645 * @see elm_map_paused_markers_set() for details.
22649 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22652 * Get the information of downloading status.
22654 * @param obj The map object.
22655 * @param try_num Pointer where to store number of tiles being downloaded.
22656 * @param finish_num Pointer where to store number of tiles successfully
22659 * This gets the current downloading status for the map object, the number
22660 * of tiles being downloaded and the number of tiles already downloaded.
22664 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22667 * Convert a pixel coordinate (x,y) into a geographic coordinate
22668 * (longitude, latitude).
22670 * @param obj The map object.
22671 * @param x the coordinate.
22672 * @param y the coordinate.
22673 * @param size the size in pixels of the map.
22674 * The map is a square and generally his size is : pow(2.0, zoom)*256.
22675 * @param lon Pointer where to store the longitude that correspond to x.
22676 * @param lat Pointer where to store the latitude that correspond to y.
22678 * @note Origin pixel point is the top left corner of the viewport.
22679 * Map zoom and size are taken on account.
22681 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22685 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);
22688 * Convert a geographic coordinate (longitude, latitude) into a pixel
22689 * coordinate (x, y).
22691 * @param obj The map object.
22692 * @param lon the longitude.
22693 * @param lat the latitude.
22694 * @param size the size in pixels of the map. The map is a square
22695 * and generally his size is : pow(2.0, zoom)*256.
22696 * @param x Pointer where to store the horizontal pixel coordinate that
22697 * correspond to the longitude.
22698 * @param y Pointer where to store the vertical pixel coordinate that
22699 * correspond to the latitude.
22701 * @note Origin pixel point is the top left corner of the viewport.
22702 * Map zoom and size are taken on account.
22704 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22708 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);
22711 * Convert a geographic coordinate (longitude, latitude) into a name
22714 * @param obj The map object.
22715 * @param lon the longitude.
22716 * @param lat the latitude.
22717 * @return name A #Elm_Map_Name handle for this coordinate.
22719 * To get the string for this address, elm_map_name_address_get()
22722 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22726 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22729 * Convert a name (address) into a geographic coordinate
22730 * (longitude, latitude).
22732 * @param obj The map object.
22733 * @param name The address.
22734 * @return name A #Elm_Map_Name handle for this address.
22736 * To get the longitude and latitude, elm_map_name_region_get()
22739 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22743 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22746 * Convert a pixel coordinate into a rotated pixel coordinate.
22748 * @param obj The map object.
22749 * @param x horizontal coordinate of the point to rotate.
22750 * @param y vertical coordinate of the point to rotate.
22751 * @param cx rotation's center horizontal position.
22752 * @param cy rotation's center vertical position.
22753 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22754 * @param xx Pointer where to store rotated x.
22755 * @param yy Pointer where to store rotated y.
22759 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);
22762 * Add a new marker to the map object.
22764 * @param obj The map object.
22765 * @param lon The longitude of the marker.
22766 * @param lat The latitude of the marker.
22767 * @param clas The class, to use when marker @b isn't grouped to others.
22768 * @param clas_group The class group, to use when marker is grouped to others
22769 * @param data The data passed to the callbacks.
22771 * @return The created marker or @c NULL upon failure.
22773 * A marker will be created and shown in a specific point of the map, defined
22774 * by @p lon and @p lat.
22776 * It will be displayed using style defined by @p class when this marker
22777 * is displayed alone (not grouped). A new class can be created with
22778 * elm_map_marker_class_new().
22780 * If the marker is grouped to other markers, it will be displayed with
22781 * style defined by @p class_group. Markers with the same group are grouped
22782 * if they are close. A new group class can be created with
22783 * elm_map_marker_group_class_new().
22785 * Markers created with this method can be deleted with
22786 * elm_map_marker_remove().
22788 * A marker can have associated content to be displayed by a bubble,
22789 * when a user click over it, as well as an icon. These objects will
22790 * be fetch using class' callback functions.
22792 * @see elm_map_marker_class_new()
22793 * @see elm_map_marker_group_class_new()
22794 * @see elm_map_marker_remove()
22798 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);
22801 * Set the maximum numbers of markers' content to be displayed in a group.
22803 * @param obj The map object.
22804 * @param max The maximum numbers of items displayed in a bubble.
22806 * A bubble will be displayed when the user clicks over the group,
22807 * and will place the content of markers that belong to this group
22810 * A group can have a long list of markers, consequently the creation
22811 * of the content of the bubble can be very slow.
22813 * In order to avoid this, a maximum number of items is displayed
22816 * By default this number is 30.
22818 * Marker with the same group class are grouped if they are close.
22820 * @see elm_map_marker_add()
22824 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
22827 * Remove a marker from the map.
22829 * @param marker The marker to remove.
22831 * @see elm_map_marker_add()
22835 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22838 * Get the current coordinates of the marker.
22840 * @param marker marker.
22841 * @param lat Pointer where to store the marker's latitude.
22842 * @param lon Pointer where to store the marker's longitude.
22844 * These values are set when adding markers, with function
22845 * elm_map_marker_add().
22847 * @see elm_map_marker_add()
22851 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
22854 * Animatedly bring in given marker to the center of the map.
22856 * @param marker The marker to center at.
22858 * This causes map to jump to the given @p marker's coordinates
22859 * and show it (by scrolling) in the center of the viewport, if it is not
22860 * already centered. This will use animation to do so and take a period
22861 * of time to complete.
22863 * @see elm_map_marker_show() for a function to avoid animation.
22864 * @see elm_map_marker_region_get()
22868 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22871 * Show the given marker at the center of the map, @b immediately.
22873 * @param marker The marker to center at.
22875 * This causes map to @b redraw its viewport's contents to the
22876 * region contining the given @p marker's coordinates, that will be
22877 * moved to the center of the map.
22879 * @see elm_map_marker_bring_in() for a function to move with animation.
22880 * @see elm_map_markers_list_show() if more than one marker need to be
22882 * @see elm_map_marker_region_get()
22886 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22889 * Move and zoom the map to display a list of markers.
22891 * @param markers A list of #Elm_Map_Marker handles.
22893 * The map will be centered on the center point of the markers in the list.
22894 * Then the map will be zoomed in order to fit the markers using the maximum
22895 * zoom which allows display of all the markers.
22897 * @warning All the markers should belong to the same map object.
22899 * @see elm_map_marker_show() to show a single marker.
22900 * @see elm_map_marker_bring_in()
22904 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
22907 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
22909 * @param marker The marker wich content should be returned.
22910 * @return Return the evas object if it exists, else @c NULL.
22912 * To set callback function #ElmMapMarkerGetFunc for the marker class,
22913 * elm_map_marker_class_get_cb_set() should be used.
22915 * This content is what will be inside the bubble that will be displayed
22916 * when an user clicks over the marker.
22918 * This returns the actual Evas object used to be placed inside
22919 * the bubble. This may be @c NULL, as it may
22920 * not have been created or may have been deleted, at any time, by
22921 * the map. <b>Do not modify this object</b> (move, resize,
22922 * show, hide, etc.), as the map is controlling it. This
22923 * function is for querying, emitting custom signals or hooking
22924 * lower level callbacks for events on that object. Do not delete
22925 * this object under any circumstances.
22929 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22932 * Update the marker
22934 * @param marker The marker to be updated.
22936 * If a content is set to this marker, it will call function to delete it,
22937 * #ElmMapMarkerDelFunc, and then will fetch the content again with
22938 * #ElmMapMarkerGetFunc.
22940 * These functions are set for the marker class with
22941 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
22945 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22948 * Close all the bubbles opened by the user.
22950 * @param obj The map object.
22952 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
22953 * when the user clicks on a marker.
22955 * This functions is set for the marker class with
22956 * elm_map_marker_class_get_cb_set().
22960 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
22963 * Create a new group class.
22965 * @param obj The map object.
22966 * @return Returns the new group class.
22968 * Each marker must be associated to a group class. Markers in the same
22969 * group are grouped if they are close.
22971 * The group class defines the style of the marker when a marker is grouped
22972 * to others markers. When it is alone, another class will be used.
22974 * A group class will need to be provided when creating a marker with
22975 * elm_map_marker_add().
22977 * Some properties and functions can be set by class, as:
22978 * - style, with elm_map_group_class_style_set()
22979 * - data - to be associated to the group class. It can be set using
22980 * elm_map_group_class_data_set().
22981 * - min zoom to display markers, set with
22982 * elm_map_group_class_zoom_displayed_set().
22983 * - max zoom to group markers, set using
22984 * elm_map_group_class_zoom_grouped_set().
22985 * - visibility - set if markers will be visible or not, set with
22986 * elm_map_group_class_hide_set().
22987 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
22988 * It can be set using elm_map_group_class_icon_cb_set().
22990 * @see elm_map_marker_add()
22991 * @see elm_map_group_class_style_set()
22992 * @see elm_map_group_class_data_set()
22993 * @see elm_map_group_class_zoom_displayed_set()
22994 * @see elm_map_group_class_zoom_grouped_set()
22995 * @see elm_map_group_class_hide_set()
22996 * @see elm_map_group_class_icon_cb_set()
23000 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23003 * Set the marker's style of a group class.
23005 * @param clas The group class.
23006 * @param style The style to be used by markers.
23008 * Each marker must be associated to a group class, and will use the style
23009 * defined by such class when grouped to other markers.
23011 * The following styles are provided by default theme:
23012 * @li @c radio - blue circle
23013 * @li @c radio2 - green circle
23016 * @see elm_map_group_class_new() for more details.
23017 * @see elm_map_marker_add()
23021 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23024 * Set the icon callback function of a group class.
23026 * @param clas The group class.
23027 * @param icon_get The callback function that will return the icon.
23029 * Each marker must be associated to a group class, and it can display a
23030 * custom icon. The function @p icon_get must return this icon.
23032 * @see elm_map_group_class_new() for more details.
23033 * @see elm_map_marker_add()
23037 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23040 * Set the data associated to the group class.
23042 * @param clas The group class.
23043 * @param data The new user data.
23045 * This data will be passed for callback functions, like icon get callback,
23046 * that can be set with elm_map_group_class_icon_cb_set().
23048 * If a data was previously set, the object will lose the pointer for it,
23049 * so if needs to be freed, you must do it yourself.
23051 * @see elm_map_group_class_new() for more details.
23052 * @see elm_map_group_class_icon_cb_set()
23053 * @see elm_map_marker_add()
23057 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23060 * Set the minimum zoom from where the markers are displayed.
23062 * @param clas The group class.
23063 * @param zoom The minimum zoom.
23065 * Markers only will be displayed when the map is displayed at @p zoom
23068 * @see elm_map_group_class_new() for more details.
23069 * @see elm_map_marker_add()
23073 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23076 * Set the zoom from where the markers are no more grouped.
23078 * @param clas The group class.
23079 * @param zoom The maximum zoom.
23081 * Markers only will be grouped when the map is displayed at
23082 * less than @p zoom.
23084 * @see elm_map_group_class_new() for more details.
23085 * @see elm_map_marker_add()
23089 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23092 * Set if the markers associated to the group class @clas are hidden or not.
23094 * @param clas The group class.
23095 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23098 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23103 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23106 * Create a new marker class.
23108 * @param obj The map object.
23109 * @return Returns the new group class.
23111 * Each marker must be associated to a class.
23113 * The marker class defines the style of the marker when a marker is
23114 * displayed alone, i.e., not grouped to to others markers. When grouped
23115 * it will use group class style.
23117 * A marker class will need to be provided when creating a marker with
23118 * elm_map_marker_add().
23120 * Some properties and functions can be set by class, as:
23121 * - style, with elm_map_marker_class_style_set()
23122 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23123 * It can be set using elm_map_marker_class_icon_cb_set().
23124 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23125 * Set using elm_map_marker_class_get_cb_set().
23126 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23127 * Set using elm_map_marker_class_del_cb_set().
23129 * @see elm_map_marker_add()
23130 * @see elm_map_marker_class_style_set()
23131 * @see elm_map_marker_class_icon_cb_set()
23132 * @see elm_map_marker_class_get_cb_set()
23133 * @see elm_map_marker_class_del_cb_set()
23137 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23140 * Set the marker's style of a marker class.
23142 * @param clas The marker class.
23143 * @param style The style to be used by markers.
23145 * Each marker must be associated to a marker class, and will use the style
23146 * defined by such class when alone, i.e., @b not grouped to other markers.
23148 * The following styles are provided by default theme:
23153 * @see elm_map_marker_class_new() for more details.
23154 * @see elm_map_marker_add()
23158 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23161 * Set the icon callback function of a marker class.
23163 * @param clas The marker class.
23164 * @param icon_get The callback function that will return the icon.
23166 * Each marker must be associated to a marker class, and it can display a
23167 * custom icon. The function @p icon_get must return this icon.
23169 * @see elm_map_marker_class_new() for more details.
23170 * @see elm_map_marker_add()
23174 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23177 * Set the bubble content callback function of a marker class.
23179 * @param clas The marker class.
23180 * @param get The callback function that will return the content.
23182 * Each marker must be associated to a marker class, and it can display a
23183 * a content on a bubble that opens when the user click over the marker.
23184 * The function @p get must return this content object.
23186 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23189 * @see elm_map_marker_class_new() for more details.
23190 * @see elm_map_marker_class_del_cb_set()
23191 * @see elm_map_marker_add()
23195 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23198 * Set the callback function used to delete bubble content of a marker class.
23200 * @param clas The marker class.
23201 * @param del The callback function that will delete the content.
23203 * Each marker must be associated to a marker class, and it can display a
23204 * a content on a bubble that opens when the user click over the marker.
23205 * The function to return such content can be set with
23206 * elm_map_marker_class_get_cb_set().
23208 * If this content must be freed, a callback function need to be
23209 * set for that task with this function.
23211 * If this callback is defined it will have to delete (or not) the
23212 * object inside, but if the callback is not defined the object will be
23213 * destroyed with evas_object_del().
23215 * @see elm_map_marker_class_new() for more details.
23216 * @see elm_map_marker_class_get_cb_set()
23217 * @see elm_map_marker_add()
23221 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23224 * Get the list of available sources.
23226 * @param obj The map object.
23227 * @return The source names list.
23229 * It will provide a list with all available sources, that can be set as
23230 * current source with elm_map_source_name_set(), or get with
23231 * elm_map_source_name_get().
23233 * Available sources:
23239 * @see elm_map_source_name_set() for more details.
23240 * @see elm_map_source_name_get()
23244 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23247 * Set the source of the map.
23249 * @param obj The map object.
23250 * @param source The source to be used.
23252 * Map widget retrieves images that composes the map from a web service.
23253 * This web service can be set with this method.
23255 * A different service can return a different maps with different
23256 * information and it can use different zoom values.
23258 * The @p source_name need to match one of the names provided by
23259 * elm_map_source_names_get().
23261 * The current source can be get using elm_map_source_name_get().
23263 * @see elm_map_source_names_get()
23264 * @see elm_map_source_name_get()
23269 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23272 * Get the name of currently used source.
23274 * @param obj The map object.
23275 * @return Returns the name of the source in use.
23277 * @see elm_map_source_name_set() for more details.
23281 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23284 * Set the source of the route service to be used by the map.
23286 * @param obj The map object.
23287 * @param source The route service to be used, being it one of
23288 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23289 * and #ELM_MAP_ROUTE_SOURCE_ORS.
23291 * Each one has its own algorithm, so the route retrieved may
23292 * differ depending on the source route. Now, only the default is working.
23294 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23295 * http://www.yournavigation.org/.
23297 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23298 * assumptions. Its routing core is based on Contraction Hierarchies.
23300 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23302 * @see elm_map_route_source_get().
23306 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23309 * Get the current route source.
23311 * @param obj The map object.
23312 * @return The source of the route service used by the map.
23314 * @see elm_map_route_source_set() for details.
23318 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23321 * Set the minimum zoom of the source.
23323 * @param obj The map object.
23324 * @param zoom New minimum zoom value to be used.
23326 * By default, it's 0.
23330 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23333 * Get the minimum zoom of the source.
23335 * @param obj The map object.
23336 * @return Returns the minimum zoom of the source.
23338 * @see elm_map_source_zoom_min_set() for details.
23342 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23345 * Set the maximum zoom of the source.
23347 * @param obj The map object.
23348 * @param zoom New maximum zoom value to be used.
23350 * By default, it's 18.
23354 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23357 * Get the maximum zoom of the source.
23359 * @param obj The map object.
23360 * @return Returns the maximum zoom of the source.
23362 * @see elm_map_source_zoom_min_set() for details.
23366 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23369 * Set the user agent used by the map object to access routing services.
23371 * @param obj The map object.
23372 * @param user_agent The user agent to be used by the map.
23374 * User agent is a client application implementing a network protocol used
23375 * in communications within a clientāserver distributed computing system
23377 * The @p user_agent identification string will transmitted in a header
23378 * field @c User-Agent.
23380 * @see elm_map_user_agent_get()
23384 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23387 * Get the user agent used by the map object.
23389 * @param obj The map object.
23390 * @return The user agent identification string used by the map.
23392 * @see elm_map_user_agent_set() for details.
23396 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23399 * Add a new route to the map object.
23401 * @param obj The map object.
23402 * @param type The type of transport to be considered when tracing a route.
23403 * @param method The routing method, what should be priorized.
23404 * @param flon The start longitude.
23405 * @param flat The start latitude.
23406 * @param tlon The destination longitude.
23407 * @param tlat The destination latitude.
23409 * @return The created route or @c NULL upon failure.
23411 * A route will be traced by point on coordinates (@p flat, @p flon)
23412 * to point on coordinates (@p tlat, @p tlon), using the route service
23413 * set with elm_map_route_source_set().
23415 * It will take @p type on consideration to define the route,
23416 * depending if the user will be walking or driving, the route may vary.
23417 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23418 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23420 * Another parameter is what the route should priorize, the minor distance
23421 * or the less time to be spend on the route. So @p method should be one
23422 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23424 * Routes created with this method can be deleted with
23425 * elm_map_route_remove(), colored with elm_map_route_color_set(),
23426 * and distance can be get with elm_map_route_distance_get().
23428 * @see elm_map_route_remove()
23429 * @see elm_map_route_color_set()
23430 * @see elm_map_route_distance_get()
23431 * @see elm_map_route_source_set()
23435 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);
23438 * Remove a route from the map.
23440 * @param route The route to remove.
23442 * @see elm_map_route_add()
23446 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23449 * Set the route color.
23451 * @param route The route object.
23452 * @param r Red channel value, from 0 to 255.
23453 * @param g Green channel value, from 0 to 255.
23454 * @param b Blue channel value, from 0 to 255.
23455 * @param a Alpha channel value, from 0 to 255.
23457 * It uses an additive color model, so each color channel represents
23458 * how much of each primary colors must to be used. 0 represents
23459 * ausence of this color, so if all of the three are set to 0,
23460 * the color will be black.
23462 * These component values should be integers in the range 0 to 255,
23463 * (single 8-bit byte).
23465 * This sets the color used for the route. By default, it is set to
23466 * solid red (r = 255, g = 0, b = 0, a = 255).
23468 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23470 * @see elm_map_route_color_get()
23474 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23477 * Get the route color.
23479 * @param route The route object.
23480 * @param r Pointer where to store the red channel value.
23481 * @param g Pointer where to store the green channel value.
23482 * @param b Pointer where to store the blue channel value.
23483 * @param a Pointer where to store the alpha channel value.
23485 * @see elm_map_route_color_set() for details.
23489 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23492 * Get the route distance in kilometers.
23494 * @param route The route object.
23495 * @return The distance of route (unit : km).
23499 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23502 * Get the information of route nodes.
23504 * @param route The route object.
23505 * @return Returns a string with the nodes of route.
23509 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23512 * Get the information of route waypoint.
23514 * @param route the route object.
23515 * @return Returns a string with information about waypoint of route.
23519 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23522 * Get the address of the name.
23524 * @param name The name handle.
23525 * @return Returns the address string of @p name.
23527 * This gets the coordinates of the @p name, created with one of the
23528 * conversion functions.
23530 * @see elm_map_utils_convert_name_into_coord()
23531 * @see elm_map_utils_convert_coord_into_name()
23535 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23538 * Get the current coordinates of the name.
23540 * @param name The name handle.
23541 * @param lat Pointer where to store the latitude.
23542 * @param lon Pointer where to store The longitude.
23544 * This gets the coordinates of the @p name, created with one of the
23545 * conversion functions.
23547 * @see elm_map_utils_convert_name_into_coord()
23548 * @see elm_map_utils_convert_coord_into_name()
23552 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23555 * Remove a name from the map.
23557 * @param name The name to remove.
23559 * Basically the struct handled by @p name will be freed, so convertions
23560 * between address and coordinates will be lost.
23562 * @see elm_map_utils_convert_name_into_coord()
23563 * @see elm_map_utils_convert_coord_into_name()
23567 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23572 * @param obj The map object.
23573 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23574 * @param cx Rotation's center horizontal position.
23575 * @param cy Rotation's center vertical position.
23577 * @see elm_map_rotate_get()
23581 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23584 * Get the rotate degree of the map
23586 * @param obj The map object
23587 * @param degree Pointer where to store degrees from 0.0 to 360.0
23588 * to rotate arount Z axis.
23589 * @param cx Pointer where to store rotation's center horizontal position.
23590 * @param cy Pointer where to store rotation's center vertical position.
23592 * @see elm_map_rotate_set() to set map rotation.
23596 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);
23599 * Enable or disable mouse wheel to be used to zoom in / out the map.
23601 * @param obj The map object.
23602 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23605 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23607 * It's disabled by default.
23609 * @see elm_map_wheel_disabled_get()
23613 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23616 * Get a value whether mouse wheel is enabled or not.
23618 * @param obj The map object.
23619 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23620 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23622 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23624 * @see elm_map_wheel_disabled_set() for details.
23628 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23632 * Add a track on the map
23634 * @param obj The map object.
23635 * @param emap The emap route object.
23636 * @return The route object. This is an elm object of type Route.
23638 * @see elm_route_add() for details.
23642 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23646 * Remove a track from the map
23648 * @param obj The map object.
23649 * @param route The track to remove.
23653 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23660 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23662 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23664 EAPI double elm_route_lon_min_get(Evas_Object *obj);
23665 EAPI double elm_route_lat_min_get(Evas_Object *obj);
23666 EAPI double elm_route_lon_max_get(Evas_Object *obj);
23667 EAPI double elm_route_lat_max_get(Evas_Object *obj);
23671 * @defgroup Panel Panel
23673 * @image html img/widget/panel/preview-00.png
23674 * @image latex img/widget/panel/preview-00.eps
23676 * @brief A panel is a type of animated container that contains subobjects.
23677 * It can be expanded or contracted by clicking the button on it's edge.
23679 * Orientations are as follows:
23680 * @li ELM_PANEL_ORIENT_TOP
23681 * @li ELM_PANEL_ORIENT_LEFT
23682 * @li ELM_PANEL_ORIENT_RIGHT
23684 * To set/get/unset the content of the panel, you can use
23685 * elm_object_content_set/get/unset APIs.
23686 * Once the content object is set, a previously set one will be deleted.
23687 * If you want to keep that old content object, use the
23688 * elm_object_content_unset() function
23690 * @ref tutorial_panel shows one way to use this widget.
23693 typedef enum _Elm_Panel_Orient
23695 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23696 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23697 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23698 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23699 } Elm_Panel_Orient;
23701 * @brief Adds a panel object
23703 * @param parent The parent object
23705 * @return The panel object, or NULL on failure
23707 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23709 * @brief Sets the orientation of the panel
23711 * @param parent The parent object
23712 * @param orient The panel orientation. Can be one of the following:
23713 * @li ELM_PANEL_ORIENT_TOP
23714 * @li ELM_PANEL_ORIENT_LEFT
23715 * @li ELM_PANEL_ORIENT_RIGHT
23717 * Sets from where the panel will (dis)appear.
23719 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23721 * @brief Get the orientation of the panel.
23723 * @param obj The panel object
23724 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23726 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23728 * @brief Set the content of the panel.
23730 * @param obj The panel object
23731 * @param content The panel content
23733 * Once the content object is set, a previously set one will be deleted.
23734 * If you want to keep that old content object, use the
23735 * elm_panel_content_unset() function.
23737 EINA_DEPRECATED EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23739 * @brief Get the content of the panel.
23741 * @param obj The panel object
23742 * @return The content that is being used
23744 * Return the content object which is set for this widget.
23746 * @see elm_panel_content_set()
23748 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23750 * @brief Unset the content of the panel.
23752 * @param obj The panel object
23753 * @return The content that was being used
23755 * Unparent and return the content object which was set for this widget.
23757 * @see elm_panel_content_set()
23759 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23761 * @brief Set the state of the panel.
23763 * @param obj The panel object
23764 * @param hidden If true, the panel will run the animation to contract
23766 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23768 * @brief Get the state of the panel.
23770 * @param obj The panel object
23771 * @param hidden If true, the panel is in the "hide" state
23773 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23775 * @brief Toggle the hidden state of the panel from code
23777 * @param obj The panel object
23779 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23785 * @defgroup Panes Panes
23786 * @ingroup Elementary
23788 * @image html img/widget/panes/preview-00.png
23789 * @image latex img/widget/panes/preview-00.eps width=\textwidth
23791 * @image html img/panes.png
23792 * @image latex img/panes.eps width=\textwidth
23794 * The panes adds a dragable bar between two contents. When dragged
23795 * this bar will resize contents size.
23797 * Panes can be displayed vertically or horizontally, and contents
23798 * size proportion can be customized (homogeneous by default).
23800 * Smart callbacks one can listen to:
23801 * - "press" - The panes has been pressed (button wasn't released yet).
23802 * - "unpressed" - The panes was released after being pressed.
23803 * - "clicked" - The panes has been clicked>
23804 * - "clicked,double" - The panes has been double clicked
23806 * Available styles for it:
23809 * Default contents parts of the panes widget that you can use for are:
23810 * @li "elm.swallow.left" - A leftside content of the panes
23811 * @li "elm.swallow.right" - A rightside content of the panes
23813 * If panes is displayed vertically, left content will be displayed at
23816 * Here is an example on its usage:
23817 * @li @ref panes_example
23820 #define ELM_PANES_CONTENT_LEFT "elm.swallow.left"
23821 #define ELM_PANES_CONTENT_RIGHT "elm.swallow.right"
23824 * @addtogroup Panes
23829 * Add a new panes widget to the given parent Elementary
23830 * (container) object.
23832 * @param parent The parent object.
23833 * @return a new panes widget handle or @c NULL, on errors.
23835 * This function inserts a new panes widget on the canvas.
23839 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23842 * Set the left content of the panes widget.
23844 * @param obj The panes object.
23845 * @param content The new left content object.
23847 * Once the content object is set, a previously set one will be deleted.
23848 * If you want to keep that old content object, use the
23849 * elm_panes_content_left_unset() function.
23851 * If panes is displayed vertically, left content will be displayed at
23854 * @see elm_panes_content_left_get()
23855 * @see elm_panes_content_right_set() to set content on the other side.
23859 EINA_DEPRECATED EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23862 * Set the right content of the panes widget.
23864 * @param obj The panes object.
23865 * @param content The new right content object.
23867 * Once the content object is set, a previously set one will be deleted.
23868 * If you want to keep that old content object, use the
23869 * elm_panes_content_right_unset() function.
23871 * If panes is displayed vertically, left content will be displayed at
23874 * @see elm_panes_content_right_get()
23875 * @see elm_panes_content_left_set() to set content on the other side.
23879 EINA_DEPRECATED EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23882 * Get the left content of the panes.
23884 * @param obj The panes object.
23885 * @return The left content object that is being used.
23887 * Return the left content object which is set for this widget.
23889 * @see elm_panes_content_left_set() for details.
23893 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23896 * Get the right content of the panes.
23898 * @param obj The panes object
23899 * @return The right content object that is being used
23901 * Return the right content object which is set for this widget.
23903 * @see elm_panes_content_right_set() for details.
23907 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23910 * Unset the left content used for the panes.
23912 * @param obj The panes object.
23913 * @return The left content object that was being used.
23915 * Unparent and return the left content object which was set for this widget.
23917 * @see elm_panes_content_left_set() for details.
23918 * @see elm_panes_content_left_get().
23922 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23925 * Unset the right content used for the panes.
23927 * @param obj The panes object.
23928 * @return The right content object that was being used.
23930 * Unparent and return the right content object which was set for this
23933 * @see elm_panes_content_right_set() for details.
23934 * @see elm_panes_content_right_get().
23938 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23941 * Get the size proportion of panes widget's left side.
23943 * @param obj The panes object.
23944 * @return float value between 0.0 and 1.0 representing size proportion
23947 * @see elm_panes_content_left_size_set() for more details.
23951 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23954 * Set the size proportion of panes widget's left side.
23956 * @param obj The panes object.
23957 * @param size Value between 0.0 and 1.0 representing size proportion
23960 * By default it's homogeneous, i.e., both sides have the same size.
23962 * If something different is required, it can be set with this function.
23963 * For example, if the left content should be displayed over
23964 * 75% of the panes size, @p size should be passed as @c 0.75.
23965 * This way, right content will be resized to 25% of panes size.
23967 * If displayed vertically, left content is displayed at top, and
23968 * right content at bottom.
23970 * @note This proportion will change when user drags the panes bar.
23972 * @see elm_panes_content_left_size_get()
23976 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
23979 * Set the orientation of a given panes widget.
23981 * @param obj The panes object.
23982 * @param horizontal Use @c EINA_TRUE to make @p obj to be
23983 * @b horizontal, @c EINA_FALSE to make it @b vertical.
23985 * Use this function to change how your panes is to be
23986 * disposed: vertically or horizontally.
23988 * By default it's displayed horizontally.
23990 * @see elm_panes_horizontal_get()
23994 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
23997 * Retrieve the orientation of a given panes widget.
23999 * @param obj The panes object.
24000 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24001 * @c EINA_FALSE if it's @b vertical (and on errors).
24003 * @see elm_panes_horizontal_set() for more details.
24007 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24008 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24009 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24016 * @defgroup Flip Flip
24018 * @image html img/widget/flip/preview-00.png
24019 * @image latex img/widget/flip/preview-00.eps
24021 * This widget holds 2 content objects(Evas_Object): one on the front and one
24022 * on the back. It allows you to flip from front to back and vice-versa using
24023 * various animations.
24025 * If either the front or back contents are not set the flip will treat that
24026 * as transparent. So if you wore to set the front content but not the back,
24027 * and then call elm_flip_go() you would see whatever is below the flip.
24029 * For a list of supported animations see elm_flip_go().
24031 * Signals that you can add callbacks for are:
24032 * "animate,begin" - when a flip animation was started
24033 * "animate,done" - when a flip animation is finished
24035 * @ref tutorial_flip show how to use most of the API.
24039 typedef enum _Elm_Flip_Mode
24041 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24042 ELM_FLIP_ROTATE_X_CENTER_AXIS,
24043 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24044 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24045 ELM_FLIP_CUBE_LEFT,
24046 ELM_FLIP_CUBE_RIGHT,
24048 ELM_FLIP_CUBE_DOWN,
24049 ELM_FLIP_PAGE_LEFT,
24050 ELM_FLIP_PAGE_RIGHT,
24054 typedef enum _Elm_Flip_Interaction
24056 ELM_FLIP_INTERACTION_NONE,
24057 ELM_FLIP_INTERACTION_ROTATE,
24058 ELM_FLIP_INTERACTION_CUBE,
24059 ELM_FLIP_INTERACTION_PAGE
24060 } Elm_Flip_Interaction;
24061 typedef enum _Elm_Flip_Direction
24063 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24064 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24065 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24066 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24067 } Elm_Flip_Direction;
24069 * @brief Add a new flip to the parent
24071 * @param parent The parent object
24072 * @return The new object or NULL if it cannot be created
24074 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24076 * @brief Set the front content of the flip widget.
24078 * @param obj The flip object
24079 * @param content The new front content object
24081 * Once the content object is set, a previously set one will be deleted.
24082 * If you want to keep that old content object, use the
24083 * elm_flip_content_front_unset() function.
24085 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24087 * @brief Set the back content of the flip widget.
24089 * @param obj The flip object
24090 * @param content The new back content object
24092 * Once the content object is set, a previously set one will be deleted.
24093 * If you want to keep that old content object, use the
24094 * elm_flip_content_back_unset() function.
24096 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24098 * @brief Get the front content used for the flip
24100 * @param obj The flip object
24101 * @return The front content object that is being used
24103 * Return the front content object which is set for this widget.
24105 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24107 * @brief Get the back content used for the flip
24109 * @param obj The flip object
24110 * @return The back content object that is being used
24112 * Return the back content object which is set for this widget.
24114 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24116 * @brief Unset the front content used for the flip
24118 * @param obj The flip object
24119 * @return The front content object that was being used
24121 * Unparent and return the front content object which was set for this widget.
24123 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24125 * @brief Unset the back content used for the flip
24127 * @param obj The flip object
24128 * @return The back content object that was being used
24130 * Unparent and return the back content object which was set for this widget.
24132 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24134 * @brief Get flip front visibility state
24136 * @param obj The flip objct
24137 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24140 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24142 * @brief Set flip perspective
24144 * @param obj The flip object
24145 * @param foc The coordinate to set the focus on
24146 * @param x The X coordinate
24147 * @param y The Y coordinate
24149 * @warning This function currently does nothing.
24151 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24153 * @brief Runs the flip animation
24155 * @param obj The flip object
24156 * @param mode The mode type
24158 * Flips the front and back contents using the @p mode animation. This
24159 * efectively hides the currently visible content and shows the hidden one.
24161 * There a number of possible animations to use for the flipping:
24162 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24163 * around a horizontal axis in the middle of its height, the other content
24164 * is shown as the other side of the flip.
24165 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24166 * around a vertical axis in the middle of its width, the other content is
24167 * shown as the other side of the flip.
24168 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24169 * around a diagonal axis in the middle of its width, the other content is
24170 * shown as the other side of the flip.
24171 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24172 * around a diagonal axis in the middle of its height, the other content is
24173 * shown as the other side of the flip.
24174 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24175 * as if the flip was a cube, the other content is show as the right face of
24177 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24178 * right as if the flip was a cube, the other content is show as the left
24179 * face of the cube.
24180 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24181 * flip was a cube, the other content is show as the bottom face of the cube.
24182 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24183 * the flip was a cube, the other content is show as the upper face of the
24185 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24186 * if the flip was a book, the other content is shown as the page below that.
24187 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24188 * as if the flip was a book, the other content is shown as the page below
24190 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24191 * flip was a book, the other content is shown as the page below that.
24192 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24193 * flip was a book, the other content is shown as the page below that.
24195 * @image html elm_flip.png
24196 * @image latex elm_flip.eps width=\textwidth
24198 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24200 * @brief Set the interactive flip mode
24202 * @param obj The flip object
24203 * @param mode The interactive flip mode to use
24205 * This sets if the flip should be interactive (allow user to click and
24206 * drag a side of the flip to reveal the back page and cause it to flip).
24207 * By default a flip is not interactive. You may also need to set which
24208 * sides of the flip are "active" for flipping and how much space they use
24209 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24210 * and elm_flip_interacton_direction_hitsize_set()
24212 * The four avilable mode of interaction are:
24213 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24214 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24215 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24216 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24218 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24219 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24220 * happen, those can only be acheived with elm_flip_go();
24222 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24224 * @brief Get the interactive flip mode
24226 * @param obj The flip object
24227 * @return The interactive flip mode
24229 * Returns the interactive flip mode set by elm_flip_interaction_set()
24231 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24233 * @brief Set which directions of the flip respond to interactive flip
24235 * @param obj The flip object
24236 * @param dir The direction to change
24237 * @param enabled If that direction is enabled or not
24239 * By default all directions are disabled, so you may want to enable the
24240 * desired directions for flipping if you need interactive flipping. You must
24241 * call this function once for each direction that should be enabled.
24243 * @see elm_flip_interaction_set()
24245 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24247 * @brief Get the enabled state of that flip direction
24249 * @param obj The flip object
24250 * @param dir The direction to check
24251 * @return If that direction is enabled or not
24253 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24255 * @see elm_flip_interaction_set()
24257 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24259 * @brief Set the amount of the flip that is sensitive to interactive flip
24261 * @param obj The flip object
24262 * @param dir The direction to modify
24263 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24265 * Set the amount of the flip that is sensitive to interactive flip, with 0
24266 * representing no area in the flip and 1 representing the entire flip. There
24267 * is however a consideration to be made in that the area will never be
24268 * smaller than the finger size set(as set in your Elementary configuration).
24270 * @see elm_flip_interaction_set()
24272 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24274 * @brief Get the amount of the flip that is sensitive to interactive flip
24276 * @param obj The flip object
24277 * @param dir The direction to check
24278 * @return The size set for that direction
24280 * Returns the amount os sensitive area set by
24281 * elm_flip_interacton_direction_hitsize_set().
24283 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24288 /* scrolledentry */
24289 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24290 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24291 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24292 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24293 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24294 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24295 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24296 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24297 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24298 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24299 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24300 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24301 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24302 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24303 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24304 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24305 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24306 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24307 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24308 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24309 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24310 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24311 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24312 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24313 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24314 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24315 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24316 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24317 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24318 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24319 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24320 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24321 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24322 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24323 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24324 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);
24325 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24326 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24327 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);
24328 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24329 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);
24330 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24331 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24332 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24333 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24334 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24335 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24336 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24337 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24338 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);
24339 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);
24340 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);
24341 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);
24342 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);
24343 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);
24344 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24345 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24346 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24347 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24348 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24349 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24350 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24353 * @defgroup Conformant Conformant
24354 * @ingroup Elementary
24356 * @image html img/widget/conformant/preview-00.png
24357 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24359 * @image html img/conformant.png
24360 * @image latex img/conformant.eps width=\textwidth
24362 * The aim is to provide a widget that can be used in elementary apps to
24363 * account for space taken up by the indicator, virtual keypad & softkey
24364 * windows when running the illume2 module of E17.
24366 * So conformant content will be sized and positioned considering the
24367 * space required for such stuff, and when they popup, as a keyboard
24368 * shows when an entry is selected, conformant content won't change.
24370 * Available styles for it:
24373 * Default contents parts of the conformant widget that you can use for are:
24374 * @li "elm.swallow.content" - A content of the conformant
24376 * See how to use this widget in this example:
24377 * @ref conformant_example
24381 * @addtogroup Conformant
24386 * Add a new conformant widget to the given parent Elementary
24387 * (container) object.
24389 * @param parent The parent object.
24390 * @return A new conformant widget handle or @c NULL, on errors.
24392 * This function inserts a new conformant widget on the canvas.
24394 * @ingroup Conformant
24396 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24399 * Set the content of the conformant widget.
24401 * @param obj The conformant object.
24402 * @param content The content to be displayed by the conformant.
24404 * Content will be sized and positioned considering the space required
24405 * to display a virtual keyboard. So it won't fill all the conformant
24406 * size. This way is possible to be sure that content won't resize
24407 * or be re-positioned after the keyboard is displayed.
24409 * Once the content object is set, a previously set one will be deleted.
24410 * If you want to keep that old content object, use the
24411 * elm_object_content_unset() function.
24413 * @see elm_object_content_unset()
24414 * @see elm_object_content_get()
24416 * @ingroup Conformant
24418 EINA_DEPRECATED EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24421 * Get the content of the conformant widget.
24423 * @param obj The conformant object.
24424 * @return The content that is being used.
24426 * Return the content object which is set for this widget.
24427 * It won't be unparent from conformant. For that, use
24428 * elm_object_content_unset().
24430 * @see elm_object_content_set().
24431 * @see elm_object_content_unset()
24433 * @ingroup Conformant
24435 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24438 * Unset the content of the conformant widget.
24440 * @param obj The conformant object.
24441 * @return The content that was being used.
24443 * Unparent and return the content object which was set for this widget.
24445 * @see elm_object_content_set().
24447 * @ingroup Conformant
24449 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24452 * Returns the Evas_Object that represents the content area.
24454 * @param obj The conformant object.
24455 * @return The content area of the widget.
24457 * @ingroup Conformant
24459 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24466 * @defgroup Mapbuf Mapbuf
24467 * @ingroup Elementary
24469 * @image html img/widget/mapbuf/preview-00.png
24470 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24472 * This holds one content object and uses an Evas Map of transformation
24473 * points to be later used with this content. So the content will be
24474 * moved, resized, etc as a single image. So it will improve performance
24475 * when you have a complex interafce, with a lot of elements, and will
24476 * need to resize or move it frequently (the content object and its
24479 * To set/get/unset the content of the mapbuf, you can use
24480 * elm_object_content_set/get/unset APIs.
24481 * Once the content object is set, a previously set one will be deleted.
24482 * If you want to keep that old content object, use the
24483 * elm_object_content_unset() function.
24485 * To enable map, elm_mapbuf_enabled_set() should be used.
24487 * See how to use this widget in this example:
24488 * @ref mapbuf_example
24492 * @addtogroup Mapbuf
24497 * Add a new mapbuf widget to the given parent Elementary
24498 * (container) object.
24500 * @param parent The parent object.
24501 * @return A new mapbuf widget handle or @c NULL, on errors.
24503 * This function inserts a new mapbuf widget on the canvas.
24507 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24510 * Set the content of the mapbuf.
24512 * @param obj The mapbuf object.
24513 * @param content The content that will be filled in this mapbuf object.
24515 * Once the content object is set, a previously set one will be deleted.
24516 * If you want to keep that old content object, use the
24517 * elm_mapbuf_content_unset() function.
24519 * To enable map, elm_mapbuf_enabled_set() should be used.
24523 EINA_DEPRECATED EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24526 * Get the content of the mapbuf.
24528 * @param obj The mapbuf object.
24529 * @return The content that is being used.
24531 * Return the content object which is set for this widget.
24533 * @see elm_mapbuf_content_set() for details.
24537 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24540 * Unset the content of the mapbuf.
24542 * @param obj The mapbuf object.
24543 * @return The content that was being used.
24545 * Unparent and return the content object which was set for this widget.
24547 * @see elm_mapbuf_content_set() for details.
24551 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24554 * Enable or disable the map.
24556 * @param obj The mapbuf object.
24557 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24559 * This enables the map that is set or disables it. On enable, the object
24560 * geometry will be saved, and the new geometry will change (position and
24561 * size) to reflect the map geometry set.
24563 * Also, when enabled, alpha and smooth states will be used, so if the
24564 * content isn't solid, alpha should be enabled, for example, otherwise
24565 * a black retangle will fill the content.
24567 * When disabled, the stored map will be freed and geometry prior to
24568 * enabling the map will be restored.
24570 * It's disabled by default.
24572 * @see elm_mapbuf_alpha_set()
24573 * @see elm_mapbuf_smooth_set()
24577 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24580 * Get a value whether map is enabled or not.
24582 * @param obj The mapbuf object.
24583 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24584 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24586 * @see elm_mapbuf_enabled_set() for details.
24590 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24593 * Enable or disable smooth map rendering.
24595 * @param obj The mapbuf object.
24596 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24599 * This sets smoothing for map rendering. If the object is a type that has
24600 * its own smoothing settings, then both the smooth settings for this object
24601 * and the map must be turned off.
24603 * By default smooth maps are enabled.
24607 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24610 * Get a value whether smooth map rendering is enabled or not.
24612 * @param obj The mapbuf object.
24613 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24614 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24616 * @see elm_mapbuf_smooth_set() for details.
24620 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24623 * Set or unset alpha flag for map rendering.
24625 * @param obj The mapbuf object.
24626 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24629 * This sets alpha flag for map rendering. If the object is a type that has
24630 * its own alpha settings, then this will take precedence. Only image objects
24631 * have this currently. It stops alpha blending of the map area, and is
24632 * useful if you know the object and/or all sub-objects is 100% solid.
24634 * Alpha is enabled by default.
24638 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24641 * Get a value whether alpha blending is enabled or not.
24643 * @param obj The mapbuf object.
24644 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24645 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24647 * @see elm_mapbuf_alpha_set() for details.
24651 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24658 * @defgroup Flipselector Flip Selector
24660 * @image html img/widget/flipselector/preview-00.png
24661 * @image latex img/widget/flipselector/preview-00.eps
24663 * A flip selector is a widget to show a set of @b text items, one
24664 * at a time, with the same sheet switching style as the @ref Clock
24665 * "clock" widget, when one changes the current displaying sheet
24666 * (thus, the "flip" in the name).
24668 * User clicks to flip sheets which are @b held for some time will
24669 * make the flip selector to flip continuosly and automatically for
24670 * the user. The interval between flips will keep growing in time,
24671 * so that it helps the user to reach an item which is distant from
24672 * the current selection.
24674 * Smart callbacks one can register to:
24675 * - @c "selected" - when the widget's selected text item is changed
24676 * - @c "overflowed" - when the widget's current selection is changed
24677 * from the first item in its list to the last
24678 * - @c "underflowed" - when the widget's current selection is changed
24679 * from the last item in its list to the first
24681 * Available styles for it:
24684 * Here is an example on its usage:
24685 * @li @ref flipselector_example
24689 * @addtogroup Flipselector
24693 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24696 * Add a new flip selector widget to the given parent Elementary
24697 * (container) widget
24699 * @param parent The parent object
24700 * @return a new flip selector widget handle or @c NULL, on errors
24702 * This function inserts a new flip selector widget on the canvas.
24704 * @ingroup Flipselector
24706 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24709 * Programmatically select the next item of a flip selector widget
24711 * @param obj The flipselector object
24713 * @note The selection will be animated. Also, if it reaches the
24714 * end of its list of member items, it will continue with the first
24717 * @ingroup Flipselector
24719 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24722 * Programmatically select the previous item of a flip selector
24725 * @param obj The flipselector object
24727 * @note The selection will be animated. Also, if it reaches the
24728 * beginning of its list of member items, it will continue with the
24729 * last one backwards.
24731 * @ingroup Flipselector
24733 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24736 * Append a (text) item to a flip selector widget
24738 * @param obj The flipselector object
24739 * @param label The (text) label of the new item
24740 * @param func Convenience callback function to take place when
24742 * @param data Data passed to @p func, above
24743 * @return A handle to the item added or @c NULL, on errors
24745 * The widget's list of labels to show will be appended with the
24746 * given value. If the user wishes so, a callback function pointer
24747 * can be passed, which will get called when this same item is
24750 * @note The current selection @b won't be modified by appending an
24751 * element to the list.
24753 * @note The maximum length of the text label is going to be
24754 * determined <b>by the widget's theme</b>. Strings larger than
24755 * that value are going to be @b truncated.
24757 * @ingroup Flipselector
24759 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24762 * Prepend a (text) item to a flip selector widget
24764 * @param obj The flipselector object
24765 * @param label The (text) label of the new item
24766 * @param func Convenience callback function to take place when
24768 * @param data Data passed to @p func, above
24769 * @return A handle to the item added or @c NULL, on errors
24771 * The widget's list of labels to show will be prepended with the
24772 * given value. If the user wishes so, a callback function pointer
24773 * can be passed, which will get called when this same item is
24776 * @note The current selection @b won't be modified by prepending
24777 * an element to the list.
24779 * @note The maximum length of the text label is going to be
24780 * determined <b>by the widget's theme</b>. Strings larger than
24781 * that value are going to be @b truncated.
24783 * @ingroup Flipselector
24785 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24788 * Get the internal list of items in a given flip selector widget.
24790 * @param obj The flipselector object
24791 * @return The list of items (#Elm_Flipselector_Item as data) or
24792 * @c NULL on errors.
24794 * This list is @b not to be modified in any way and must not be
24795 * freed. Use the list members with functions like
24796 * elm_flipselector_item_label_set(),
24797 * elm_flipselector_item_label_get(),
24798 * elm_flipselector_item_del(),
24799 * elm_flipselector_item_selected_get(),
24800 * elm_flipselector_item_selected_set().
24802 * @warning This list is only valid until @p obj object's internal
24803 * items list is changed. It should be fetched again with another
24804 * call to this function when changes happen.
24806 * @ingroup Flipselector
24808 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24811 * Get the first item in the given flip selector widget's list of
24814 * @param obj The flipselector object
24815 * @return The first item or @c NULL, if it has no items (and on
24818 * @see elm_flipselector_item_append()
24819 * @see elm_flipselector_last_item_get()
24821 * @ingroup Flipselector
24823 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24826 * Get the last item in the given flip selector widget's list of
24829 * @param obj The flipselector object
24830 * @return The last item or @c NULL, if it has no items (and on
24833 * @see elm_flipselector_item_prepend()
24834 * @see elm_flipselector_first_item_get()
24836 * @ingroup Flipselector
24838 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24841 * Get the currently selected item in a flip selector widget.
24843 * @param obj The flipselector object
24844 * @return The selected item or @c NULL, if the widget has no items
24847 * @ingroup Flipselector
24849 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24852 * Set whether a given flip selector widget's item should be the
24853 * currently selected one.
24855 * @param item The flip selector item
24856 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
24858 * This sets whether @p item is or not the selected (thus, under
24859 * display) one. If @p item is different than one under display,
24860 * the latter will be unselected. If the @p item is set to be
24861 * unselected, on the other hand, the @b first item in the widget's
24862 * internal members list will be the new selected one.
24864 * @see elm_flipselector_item_selected_get()
24866 * @ingroup Flipselector
24868 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24871 * Get whether a given flip selector widget's item is the currently
24874 * @param item The flip selector item
24875 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
24878 * @see elm_flipselector_item_selected_set()
24880 * @ingroup Flipselector
24882 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24885 * Delete a given item from a flip selector widget.
24887 * @param item The item to delete
24889 * @ingroup Flipselector
24891 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24894 * Get the label of a given flip selector widget's item.
24896 * @param item The item to get label from
24897 * @return The text label of @p item or @c NULL, on errors
24899 * @see elm_flipselector_item_label_set()
24901 * @ingroup Flipselector
24903 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24906 * Set the label of a given flip selector widget's item.
24908 * @param item The item to set label on
24909 * @param label The text label string, in UTF-8 encoding
24911 * @see elm_flipselector_item_label_get()
24913 * @ingroup Flipselector
24915 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24918 * Gets the item before @p item in a flip selector widget's
24919 * internal list of items.
24921 * @param item The item to fetch previous from
24922 * @return The item before the @p item, in its parent's list. If
24923 * there is no previous item for @p item or there's an
24924 * error, @c NULL is returned.
24926 * @see elm_flipselector_item_next_get()
24928 * @ingroup Flipselector
24930 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24933 * Gets the item after @p item in a flip selector widget's
24934 * internal list of items.
24936 * @param item The item to fetch next from
24937 * @return The item after the @p item, in its parent's list. If
24938 * there is no next item for @p item or there's an
24939 * error, @c NULL is returned.
24941 * @see elm_flipselector_item_next_get()
24943 * @ingroup Flipselector
24945 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24948 * Set the interval on time updates for an user mouse button hold
24949 * on a flip selector widget.
24951 * @param obj The flip selector object
24952 * @param interval The (first) interval value in seconds
24954 * This interval value is @b decreased while the user holds the
24955 * mouse pointer either flipping up or flipping doww a given flip
24958 * This helps the user to get to a given item distant from the
24959 * current one easier/faster, as it will start to flip quicker and
24960 * quicker on mouse button holds.
24962 * The calculation for the next flip interval value, starting from
24963 * the one set with this call, is the previous interval divided by
24964 * 1.05, so it decreases a little bit.
24966 * The default starting interval value for automatic flips is
24969 * @see elm_flipselector_interval_get()
24971 * @ingroup Flipselector
24973 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
24976 * Get the interval on time updates for an user mouse button hold
24977 * on a flip selector widget.
24979 * @param obj The flip selector object
24980 * @return The (first) interval value, in seconds, set on it
24982 * @see elm_flipselector_interval_set() for more details
24984 * @ingroup Flipselector
24986 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24992 * @addtogroup Calendar
24997 * @enum _Elm_Calendar_Mark_Repeat
24998 * @typedef Elm_Calendar_Mark_Repeat
25000 * Event periodicity, used to define if a mark should be repeated
25001 * @b beyond event's day. It's set when a mark is added.
25003 * So, for a mark added to 13th May with periodicity set to WEEKLY,
25004 * there will be marks every week after this date. Marks will be displayed
25005 * at 13th, 20th, 27th, 3rd June ...
25007 * Values don't work as bitmask, only one can be choosen.
25009 * @see elm_calendar_mark_add()
25011 * @ingroup Calendar
25013 typedef enum _Elm_Calendar_Mark_Repeat
25015 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25016 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25017 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25018 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*/
25019 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. */
25020 } Elm_Calendar_Mark_Repeat;
25022 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(). */
25025 * Add a new calendar widget to the given parent Elementary
25026 * (container) object.
25028 * @param parent The parent object.
25029 * @return a new calendar widget handle or @c NULL, on errors.
25031 * This function inserts a new calendar widget on the canvas.
25033 * @ref calendar_example_01
25035 * @ingroup Calendar
25037 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25040 * Get weekdays names displayed by the calendar.
25042 * @param obj The calendar object.
25043 * @return Array of seven strings to be used as weekday names.
25045 * By default, weekdays abbreviations get from system are displayed:
25046 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25047 * The first string is related to Sunday, the second to Monday...
25049 * @see elm_calendar_weekdays_name_set()
25051 * @ref calendar_example_05
25053 * @ingroup Calendar
25055 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25058 * Set weekdays names to be displayed by the calendar.
25060 * @param obj The calendar object.
25061 * @param weekdays Array of seven strings to be used as weekday names.
25062 * @warning It must have 7 elements, or it will access invalid memory.
25063 * @warning The strings must be NULL terminated ('@\0').
25065 * By default, weekdays abbreviations get from system are displayed:
25066 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25068 * The first string should be related to Sunday, the second to Monday...
25070 * The usage should be like this:
25072 * const char *weekdays[] =
25074 * "Sunday", "Monday", "Tuesday", "Wednesday",
25075 * "Thursday", "Friday", "Saturday"
25077 * elm_calendar_weekdays_names_set(calendar, weekdays);
25080 * @see elm_calendar_weekdays_name_get()
25082 * @ref calendar_example_02
25084 * @ingroup Calendar
25086 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25089 * Set the minimum and maximum values for the year
25091 * @param obj The calendar object
25092 * @param min The minimum year, greater than 1901;
25093 * @param max The maximum year;
25095 * Maximum must be greater than minimum, except if you don't wan't to set
25097 * Default values are 1902 and -1.
25099 * If the maximum year is a negative value, it will be limited depending
25100 * on the platform architecture (year 2037 for 32 bits);
25102 * @see elm_calendar_min_max_year_get()
25104 * @ref calendar_example_03
25106 * @ingroup Calendar
25108 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25111 * Get the minimum and maximum values for the year
25113 * @param obj The calendar object.
25114 * @param min The minimum year.
25115 * @param max The maximum year.
25117 * Default values are 1902 and -1.
25119 * @see elm_calendar_min_max_year_get() for more details.
25121 * @ref calendar_example_05
25123 * @ingroup Calendar
25125 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25128 * Enable or disable day selection
25130 * @param obj The calendar object.
25131 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25134 * Enabled by default. If disabled, the user still can select months,
25135 * but not days. Selected days are highlighted on calendar.
25136 * It should be used if you won't need such selection for the widget usage.
25138 * When a day is selected, or month is changed, smart callbacks for
25139 * signal "changed" will be called.
25141 * @see elm_calendar_day_selection_enable_get()
25143 * @ref calendar_example_04
25145 * @ingroup Calendar
25147 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25150 * Get a value whether day selection is enabled or not.
25152 * @see elm_calendar_day_selection_enable_set() for details.
25154 * @param obj The calendar object.
25155 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25156 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25158 * @ref calendar_example_05
25160 * @ingroup Calendar
25162 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25166 * Set selected date to be highlighted on calendar.
25168 * @param obj The calendar object.
25169 * @param selected_time A @b tm struct to represent the selected date.
25171 * Set the selected date, changing the displayed month if needed.
25172 * Selected date changes when the user goes to next/previous month or
25173 * select a day pressing over it on calendar.
25175 * @see elm_calendar_selected_time_get()
25177 * @ref calendar_example_04
25179 * @ingroup Calendar
25181 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25184 * Get selected date.
25186 * @param obj The calendar object
25187 * @param selected_time A @b tm struct to point to selected date
25188 * @return EINA_FALSE means an error ocurred and returned time shouldn't
25191 * Get date selected by the user or set by function
25192 * elm_calendar_selected_time_set().
25193 * Selected date changes when the user goes to next/previous month or
25194 * select a day pressing over it on calendar.
25196 * @see elm_calendar_selected_time_get()
25198 * @ref calendar_example_05
25200 * @ingroup Calendar
25202 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25205 * Set a function to format the string that will be used to display
25208 * @param obj The calendar object
25209 * @param format_function Function to set the month-year string given
25210 * the selected date
25212 * By default it uses strftime with "%B %Y" format string.
25213 * It should allocate the memory that will be used by the string,
25214 * that will be freed by the widget after usage.
25215 * A pointer to the string and a pointer to the time struct will be provided.
25220 * _format_month_year(struct tm *selected_time)
25223 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25224 * return strdup(buf);
25227 * elm_calendar_format_function_set(calendar, _format_month_year);
25230 * @ref calendar_example_02
25232 * @ingroup Calendar
25234 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25237 * Add a new mark to the calendar
25239 * @param obj The calendar object
25240 * @param mark_type A string used to define the type of mark. It will be
25241 * emitted to the theme, that should display a related modification on these
25242 * days representation.
25243 * @param mark_time A time struct to represent the date of inclusion of the
25244 * mark. For marks that repeats it will just be displayed after the inclusion
25245 * date in the calendar.
25246 * @param repeat Repeat the event following this periodicity. Can be a unique
25247 * mark (that don't repeat), daily, weekly, monthly or annually.
25248 * @return The created mark or @p NULL upon failure.
25250 * Add a mark that will be drawn in the calendar respecting the insertion
25251 * time and periodicity. It will emit the type as signal to the widget theme.
25252 * Default theme supports "holiday" and "checked", but it can be extended.
25254 * It won't immediately update the calendar, drawing the marks.
25255 * For this, call elm_calendar_marks_draw(). However, when user selects
25256 * next or previous month calendar forces marks drawn.
25258 * Marks created with this method can be deleted with
25259 * elm_calendar_mark_del().
25263 * struct tm selected_time;
25264 * time_t current_time;
25266 * current_time = time(NULL) + 5 * 84600;
25267 * localtime_r(¤t_time, &selected_time);
25268 * elm_calendar_mark_add(cal, "holiday", selected_time,
25269 * ELM_CALENDAR_ANNUALLY);
25271 * current_time = time(NULL) + 1 * 84600;
25272 * localtime_r(¤t_time, &selected_time);
25273 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25275 * elm_calendar_marks_draw(cal);
25278 * @see elm_calendar_marks_draw()
25279 * @see elm_calendar_mark_del()
25281 * @ref calendar_example_06
25283 * @ingroup Calendar
25285 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);
25288 * Delete mark from the calendar.
25290 * @param mark The mark to be deleted.
25292 * If deleting all calendar marks is required, elm_calendar_marks_clear()
25293 * should be used instead of getting marks list and deleting each one.
25295 * @see elm_calendar_mark_add()
25297 * @ref calendar_example_06
25299 * @ingroup Calendar
25301 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25304 * Remove all calendar's marks
25306 * @param obj The calendar object.
25308 * @see elm_calendar_mark_add()
25309 * @see elm_calendar_mark_del()
25311 * @ingroup Calendar
25313 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25317 * Get a list of all the calendar marks.
25319 * @param obj The calendar object.
25320 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25322 * @see elm_calendar_mark_add()
25323 * @see elm_calendar_mark_del()
25324 * @see elm_calendar_marks_clear()
25326 * @ingroup Calendar
25328 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25331 * Draw calendar marks.
25333 * @param obj The calendar object.
25335 * Should be used after adding, removing or clearing marks.
25336 * It will go through the entire marks list updating the calendar.
25337 * If lots of marks will be added, add all the marks and then call
25340 * When the month is changed, i.e. user selects next or previous month,
25341 * marks will be drawed.
25343 * @see elm_calendar_mark_add()
25344 * @see elm_calendar_mark_del()
25345 * @see elm_calendar_marks_clear()
25347 * @ref calendar_example_06
25349 * @ingroup Calendar
25351 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25354 * Set a day text color to the same that represents Saturdays.
25356 * @param obj The calendar object.
25357 * @param pos The text position. Position is the cell counter, from left
25358 * to right, up to down. It starts on 0 and ends on 41.
25360 * @deprecated use elm_calendar_mark_add() instead like:
25363 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25364 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25367 * @see elm_calendar_mark_add()
25369 * @ingroup Calendar
25371 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25374 * Set a day text color to the same that represents Sundays.
25376 * @param obj The calendar object.
25377 * @param pos The text position. Position is the cell counter, from left
25378 * to right, up to down. It starts on 0 and ends on 41.
25380 * @deprecated use elm_calendar_mark_add() instead like:
25383 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25384 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25387 * @see elm_calendar_mark_add()
25389 * @ingroup Calendar
25391 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25394 * Set a day text color to the same that represents Weekdays.
25396 * @param obj The calendar object
25397 * @param pos The text position. Position is the cell counter, from left
25398 * to right, up to down. It starts on 0 and ends on 41.
25400 * @deprecated use elm_calendar_mark_add() instead like:
25403 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25405 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25406 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25407 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25408 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25409 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25410 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25411 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25412 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25413 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25416 * @see elm_calendar_mark_add()
25418 * @ingroup Calendar
25420 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25423 * Set the interval on time updates for an user mouse button hold
25424 * on calendar widgets' month selection.
25426 * @param obj The calendar object
25427 * @param interval The (first) interval value in seconds
25429 * This interval value is @b decreased while the user holds the
25430 * mouse pointer either selecting next or previous month.
25432 * This helps the user to get to a given month distant from the
25433 * current one easier/faster, as it will start to change quicker and
25434 * quicker on mouse button holds.
25436 * The calculation for the next change interval value, starting from
25437 * the one set with this call, is the previous interval divided by
25438 * 1.05, so it decreases a little bit.
25440 * The default starting interval value for automatic changes is
25443 * @see elm_calendar_interval_get()
25445 * @ingroup Calendar
25447 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25450 * Get the interval on time updates for an user mouse button hold
25451 * on calendar widgets' month selection.
25453 * @param obj The calendar object
25454 * @return The (first) interval value, in seconds, set on it
25456 * @see elm_calendar_interval_set() for more details
25458 * @ingroup Calendar
25460 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25467 * @defgroup Diskselector Diskselector
25468 * @ingroup Elementary
25470 * @image html img/widget/diskselector/preview-00.png
25471 * @image latex img/widget/diskselector/preview-00.eps
25473 * A diskselector is a kind of list widget. It scrolls horizontally,
25474 * and can contain label and icon objects. Three items are displayed
25475 * with the selected one in the middle.
25477 * It can act like a circular list with round mode and labels can be
25478 * reduced for a defined length for side items.
25480 * Smart callbacks one can listen to:
25481 * - "selected" - when item is selected, i.e. scroller stops.
25483 * Available styles for it:
25486 * List of examples:
25487 * @li @ref diskselector_example_01
25488 * @li @ref diskselector_example_02
25492 * @addtogroup Diskselector
25496 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(). */
25499 * Add a new diskselector widget to the given parent Elementary
25500 * (container) object.
25502 * @param parent The parent object.
25503 * @return a new diskselector widget handle or @c NULL, on errors.
25505 * This function inserts a new diskselector widget on the canvas.
25507 * @ingroup Diskselector
25509 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25512 * Enable or disable round mode.
25514 * @param obj The diskselector object.
25515 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25518 * Disabled by default. If round mode is enabled the items list will
25519 * work like a circle list, so when the user reaches the last item,
25520 * the first one will popup.
25522 * @see elm_diskselector_round_get()
25524 * @ingroup Diskselector
25526 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25529 * Get a value whether round mode is enabled or not.
25531 * @see elm_diskselector_round_set() for details.
25533 * @param obj The diskselector object.
25534 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25535 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25537 * @ingroup Diskselector
25539 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25542 * Get the side labels max length.
25544 * @deprecated use elm_diskselector_side_label_length_get() instead:
25546 * @param obj The diskselector object.
25547 * @return The max length defined for side labels, or 0 if not a valid
25550 * @ingroup Diskselector
25552 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25555 * Set the side labels max length.
25557 * @deprecated use elm_diskselector_side_label_length_set() instead:
25559 * @param obj The diskselector object.
25560 * @param len The max length defined for side labels.
25562 * @ingroup Diskselector
25564 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25567 * Get the side labels max length.
25569 * @see elm_diskselector_side_label_length_set() for details.
25571 * @param obj The diskselector object.
25572 * @return The max length defined for side labels, or 0 if not a valid
25575 * @ingroup Diskselector
25577 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25580 * Set the side labels max length.
25582 * @param obj The diskselector object.
25583 * @param len The max length defined for side labels.
25585 * Length is the number of characters of items' label that will be
25586 * visible when it's set on side positions. It will just crop
25587 * the string after defined size. E.g.:
25589 * An item with label "January" would be displayed on side position as
25590 * "Jan" if max length is set to 3, or "Janu", if this property
25593 * When it's selected, the entire label will be displayed, except for
25594 * width restrictions. In this case label will be cropped and "..."
25595 * will be concatenated.
25597 * Default side label max length is 3.
25599 * This property will be applyed over all items, included before or
25600 * later this function call.
25602 * @ingroup Diskselector
25604 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25607 * Set the number of items to be displayed.
25609 * @param obj The diskselector object.
25610 * @param num The number of items the diskselector will display.
25612 * Default value is 3, and also it's the minimun. If @p num is less
25613 * than 3, it will be set to 3.
25615 * Also, it can be set on theme, using data item @c display_item_num
25616 * on group "elm/diskselector/item/X", where X is style set.
25619 * group { name: "elm/diskselector/item/X";
25621 * item: "display_item_num" "5";
25624 * @ingroup Diskselector
25626 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25629 * Get the number of items in the diskselector object.
25631 * @param obj The diskselector object.
25633 * @ingroup Diskselector
25635 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25638 * Set bouncing behaviour when the scrolled content reaches an edge.
25640 * Tell the internal scroller object whether it should bounce or not
25641 * when it reaches the respective edges for each axis.
25643 * @param obj The diskselector object.
25644 * @param h_bounce Whether to bounce or not in the horizontal axis.
25645 * @param v_bounce Whether to bounce or not in the vertical axis.
25647 * @see elm_scroller_bounce_set()
25649 * @ingroup Diskselector
25651 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25654 * Get the bouncing behaviour of the internal scroller.
25656 * Get whether the internal scroller should bounce when the edge of each
25657 * axis is reached scrolling.
25659 * @param obj The diskselector object.
25660 * @param h_bounce Pointer where to store the bounce state of the horizontal
25662 * @param v_bounce Pointer where to store the bounce state of the vertical
25665 * @see elm_scroller_bounce_get()
25666 * @see elm_diskselector_bounce_set()
25668 * @ingroup Diskselector
25670 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25673 * Get the scrollbar policy.
25675 * @see elm_diskselector_scroller_policy_get() for details.
25677 * @param obj The diskselector object.
25678 * @param policy_h Pointer where to store horizontal scrollbar policy.
25679 * @param policy_v Pointer where to store vertical scrollbar policy.
25681 * @ingroup Diskselector
25683 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);
25686 * Set the scrollbar policy.
25688 * @param obj The diskselector object.
25689 * @param policy_h Horizontal scrollbar policy.
25690 * @param policy_v Vertical scrollbar policy.
25692 * This sets the scrollbar visibility policy for the given scroller.
25693 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25694 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25695 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25696 * This applies respectively for the horizontal and vertical scrollbars.
25698 * The both are disabled by default, i.e., are set to
25699 * #ELM_SCROLLER_POLICY_OFF.
25701 * @ingroup Diskselector
25703 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
25706 * Remove all diskselector's items.
25708 * @param obj The diskselector object.
25710 * @see elm_diskselector_item_del()
25711 * @see elm_diskselector_item_append()
25713 * @ingroup Diskselector
25715 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25718 * Get a list of all the diskselector items.
25720 * @param obj The diskselector object.
25721 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
25722 * or @c NULL on failure.
25724 * @see elm_diskselector_item_append()
25725 * @see elm_diskselector_item_del()
25726 * @see elm_diskselector_clear()
25728 * @ingroup Diskselector
25730 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25733 * Appends a new item to the diskselector object.
25735 * @param obj The diskselector object.
25736 * @param label The label of the diskselector item.
25737 * @param icon The icon object to use at left side of the item. An
25738 * icon can be any Evas object, but usually it is an icon created
25739 * with elm_icon_add().
25740 * @param func The function to call when the item is selected.
25741 * @param data The data to associate with the item for related callbacks.
25743 * @return The created item or @c NULL upon failure.
25745 * A new item will be created and appended to the diskselector, i.e., will
25746 * be set as last item. Also, if there is no selected item, it will
25747 * be selected. This will always happens for the first appended item.
25749 * If no icon is set, label will be centered on item position, otherwise
25750 * the icon will be placed at left of the label, that will be shifted
25753 * Items created with this method can be deleted with
25754 * elm_diskselector_item_del().
25756 * Associated @p data can be properly freed when item is deleted if a
25757 * callback function is set with elm_diskselector_item_del_cb_set().
25759 * If a function is passed as argument, it will be called everytime this item
25760 * is selected, i.e., the user stops the diskselector with this
25761 * item on center position. If such function isn't needed, just passing
25762 * @c NULL as @p func is enough. The same should be done for @p data.
25764 * Simple example (with no function callback or data associated):
25766 * disk = elm_diskselector_add(win);
25767 * ic = elm_icon_add(win);
25768 * elm_icon_file_set(ic, "path/to/image", NULL);
25769 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25770 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
25773 * @see elm_diskselector_item_del()
25774 * @see elm_diskselector_item_del_cb_set()
25775 * @see elm_diskselector_clear()
25776 * @see elm_icon_add()
25778 * @ingroup Diskselector
25780 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);
25784 * Delete them item from the diskselector.
25786 * @param it The item of diskselector to be deleted.
25788 * If deleting all diskselector items is required, elm_diskselector_clear()
25789 * should be used instead of getting items list and deleting each one.
25791 * @see elm_diskselector_clear()
25792 * @see elm_diskselector_item_append()
25793 * @see elm_diskselector_item_del_cb_set()
25795 * @ingroup Diskselector
25797 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25800 * Set the function called when a diskselector item is freed.
25802 * @param it The item to set the callback on
25803 * @param func The function called
25805 * If there is a @p func, then it will be called prior item's memory release.
25806 * That will be called with the following arguments:
25808 * @li item's Evas object;
25811 * This way, a data associated to a diskselector item could be properly
25814 * @ingroup Diskselector
25816 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
25819 * Get the data associated to the item.
25821 * @param it The diskselector item
25822 * @return The data associated to @p it
25824 * The return value is a pointer to data associated to @p item when it was
25825 * created, with function elm_diskselector_item_append(). If no data
25826 * was passed as argument, it will return @c NULL.
25828 * @see elm_diskselector_item_append()
25830 * @ingroup Diskselector
25832 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25835 * Set the icon associated to the item.
25837 * @param it The diskselector item
25838 * @param icon The icon object to associate with @p it
25840 * The icon object to use at left side of the item. An
25841 * icon can be any Evas object, but usually it is an icon created
25842 * with elm_icon_add().
25844 * Once the icon object is set, a previously set one will be deleted.
25845 * @warning Setting the same icon for two items will cause the icon to
25846 * dissapear from the first item.
25848 * If an icon was passed as argument on item creation, with function
25849 * elm_diskselector_item_append(), it will be already
25850 * associated to the item.
25852 * @see elm_diskselector_item_append()
25853 * @see elm_diskselector_item_icon_get()
25855 * @ingroup Diskselector
25857 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
25860 * Get the icon associated to the item.
25862 * @param it The diskselector item
25863 * @return The icon associated to @p it
25865 * The return value is a pointer to the icon associated to @p item when it was
25866 * created, with function elm_diskselector_item_append(), or later
25867 * with function elm_diskselector_item_icon_set. If no icon
25868 * was passed as argument, it will return @c NULL.
25870 * @see elm_diskselector_item_append()
25871 * @see elm_diskselector_item_icon_set()
25873 * @ingroup Diskselector
25875 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25878 * Set the label of item.
25880 * @param it The item of diskselector.
25881 * @param label The label of item.
25883 * The label to be displayed by the item.
25885 * If no icon is set, label will be centered on item position, otherwise
25886 * the icon will be placed at left of the label, that will be shifted
25889 * An item with label "January" would be displayed on side position as
25890 * "Jan" if max length is set to 3 with function
25891 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
25894 * When this @p item is selected, the entire label will be displayed,
25895 * except for width restrictions.
25896 * In this case label will be cropped and "..." will be concatenated,
25897 * but only for display purposes. It will keep the entire string, so
25898 * if diskselector is resized the remaining characters will be displayed.
25900 * If a label was passed as argument on item creation, with function
25901 * elm_diskselector_item_append(), it will be already
25902 * displayed by the item.
25904 * @see elm_diskselector_side_label_lenght_set()
25905 * @see elm_diskselector_item_label_get()
25906 * @see elm_diskselector_item_append()
25908 * @ingroup Diskselector
25910 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
25913 * Get the label of item.
25915 * @param it The item of diskselector.
25916 * @return The label of item.
25918 * The return value is a pointer to the label associated to @p item when it was
25919 * created, with function elm_diskselector_item_append(), or later
25920 * with function elm_diskselector_item_label_set. If no label
25921 * was passed as argument, it will return @c NULL.
25923 * @see elm_diskselector_item_label_set() for more details.
25924 * @see elm_diskselector_item_append()
25926 * @ingroup Diskselector
25928 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25931 * Get the selected item.
25933 * @param obj The diskselector object.
25934 * @return The selected diskselector item.
25936 * The selected item can be unselected with function
25937 * elm_diskselector_item_selected_set(), and the first item of
25938 * diskselector will be selected.
25940 * The selected item always will be centered on diskselector, with
25941 * full label displayed, i.e., max lenght set to side labels won't
25942 * apply on the selected item. More details on
25943 * elm_diskselector_side_label_length_set().
25945 * @ingroup Diskselector
25947 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25950 * Set the selected state of an item.
25952 * @param it The diskselector item
25953 * @param selected The selected state
25955 * This sets the selected state of the given item @p it.
25956 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
25958 * If a new item is selected the previosly selected will be unselected.
25959 * Previoulsy selected item can be get with function
25960 * elm_diskselector_selected_item_get().
25962 * If the item @p it is unselected, the first item of diskselector will
25965 * Selected items will be visible on center position of diskselector.
25966 * So if it was on another position before selected, or was invisible,
25967 * diskselector will animate items until the selected item reaches center
25970 * @see elm_diskselector_item_selected_get()
25971 * @see elm_diskselector_selected_item_get()
25973 * @ingroup Diskselector
25975 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
25978 * Get whether the @p item is selected or not.
25980 * @param it The diskselector item.
25981 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
25982 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
25984 * @see elm_diskselector_selected_item_set() for details.
25985 * @see elm_diskselector_item_selected_get()
25987 * @ingroup Diskselector
25989 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25992 * Get the first item of the diskselector.
25994 * @param obj The diskselector object.
25995 * @return The first item, or @c NULL if none.
25997 * The list of items follows append order. So it will return the first
25998 * item appended to the widget that wasn't deleted.
26000 * @see elm_diskselector_item_append()
26001 * @see elm_diskselector_items_get()
26003 * @ingroup Diskselector
26005 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26008 * Get the last item of the diskselector.
26010 * @param obj The diskselector object.
26011 * @return The last item, or @c NULL if none.
26013 * The list of items follows append order. So it will return last first
26014 * item appended to the widget that wasn't deleted.
26016 * @see elm_diskselector_item_append()
26017 * @see elm_diskselector_items_get()
26019 * @ingroup Diskselector
26021 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26024 * Get the item before @p item in diskselector.
26026 * @param it The diskselector item.
26027 * @return The item before @p item, or @c NULL if none or on failure.
26029 * The list of items follows append order. So it will return item appended
26030 * just before @p item and that wasn't deleted.
26032 * If it is the first item, @c NULL will be returned.
26033 * First item can be get by elm_diskselector_first_item_get().
26035 * @see elm_diskselector_item_append()
26036 * @see elm_diskselector_items_get()
26038 * @ingroup Diskselector
26040 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26043 * Get the item after @p item in diskselector.
26045 * @param it The diskselector item.
26046 * @return The item after @p item, or @c NULL if none or on failure.
26048 * The list of items follows append order. So it will return item appended
26049 * just after @p item and that wasn't deleted.
26051 * If it is the last item, @c NULL will be returned.
26052 * Last item can be get by elm_diskselector_last_item_get().
26054 * @see elm_diskselector_item_append()
26055 * @see elm_diskselector_items_get()
26057 * @ingroup Diskselector
26059 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26062 * Set the text to be shown in the diskselector item.
26064 * @param item Target item
26065 * @param text The text to set in the content
26067 * Setup the text as tooltip to object. The item can have only one tooltip,
26068 * so any previous tooltip data is removed.
26070 * @see elm_object_tooltip_text_set() for more details.
26072 * @ingroup Diskselector
26074 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26077 * Set the content to be shown in the tooltip item.
26079 * Setup the tooltip to item. The item can have only one tooltip,
26080 * so any previous tooltip data is removed. @p func(with @p data) will
26081 * be called every time that need show the tooltip and it should
26082 * return a valid Evas_Object. This object is then managed fully by
26083 * tooltip system and is deleted when the tooltip is gone.
26085 * @param item the diskselector item being attached a tooltip.
26086 * @param func the function used to create the tooltip contents.
26087 * @param data what to provide to @a func as callback data/context.
26088 * @param del_cb called when data is not needed anymore, either when
26089 * another callback replaces @p func, the tooltip is unset with
26090 * elm_diskselector_item_tooltip_unset() or the owner @a item
26091 * dies. This callback receives as the first parameter the
26092 * given @a data, and @c event_info is the item.
26094 * @see elm_object_tooltip_content_cb_set() for more details.
26096 * @ingroup Diskselector
26098 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);
26101 * Unset tooltip from item.
26103 * @param item diskselector item to remove previously set tooltip.
26105 * Remove tooltip from item. The callback provided as del_cb to
26106 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26107 * it is not used anymore.
26109 * @see elm_object_tooltip_unset() for more details.
26110 * @see elm_diskselector_item_tooltip_content_cb_set()
26112 * @ingroup Diskselector
26114 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26118 * Sets a different style for this item tooltip.
26120 * @note before you set a style you should define a tooltip with
26121 * elm_diskselector_item_tooltip_content_cb_set() or
26122 * elm_diskselector_item_tooltip_text_set()
26124 * @param item diskselector item with tooltip already set.
26125 * @param style the theme style to use (default, transparent, ...)
26127 * @see elm_object_tooltip_style_set() for more details.
26129 * @ingroup Diskselector
26131 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26134 * Get the style for this item tooltip.
26136 * @param item diskselector item with tooltip already set.
26137 * @return style the theme style in use, defaults to "default". If the
26138 * object does not have a tooltip set, then NULL is returned.
26140 * @see elm_object_tooltip_style_get() for more details.
26141 * @see elm_diskselector_item_tooltip_style_set()
26143 * @ingroup Diskselector
26145 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26148 * Set the cursor to be shown when mouse is over the diskselector item
26150 * @param item Target item
26151 * @param cursor the cursor name to be used.
26153 * @see elm_object_cursor_set() for more details.
26155 * @ingroup Diskselector
26157 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26160 * Get the cursor to be shown when mouse is over the diskselector item
26162 * @param item diskselector item with cursor already set.
26163 * @return the cursor name.
26165 * @see elm_object_cursor_get() for more details.
26166 * @see elm_diskselector_cursor_set()
26168 * @ingroup Diskselector
26170 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26174 * Unset the cursor to be shown when mouse is over the diskselector item
26176 * @param item Target item
26178 * @see elm_object_cursor_unset() for more details.
26179 * @see elm_diskselector_cursor_set()
26181 * @ingroup Diskselector
26183 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26186 * Sets a different style for this item cursor.
26188 * @note before you set a style you should define a cursor with
26189 * elm_diskselector_item_cursor_set()
26191 * @param item diskselector item with cursor already set.
26192 * @param style the theme style to use (default, transparent, ...)
26194 * @see elm_object_cursor_style_set() for more details.
26196 * @ingroup Diskselector
26198 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26202 * Get the style for this item cursor.
26204 * @param item diskselector item with cursor already set.
26205 * @return style the theme style in use, defaults to "default". If the
26206 * object does not have a cursor set, then @c NULL is returned.
26208 * @see elm_object_cursor_style_get() for more details.
26209 * @see elm_diskselector_item_cursor_style_set()
26211 * @ingroup Diskselector
26213 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26217 * Set if the cursor set should be searched on the theme or should use
26218 * the provided by the engine, only.
26220 * @note before you set if should look on theme you should define a cursor
26221 * with elm_diskselector_item_cursor_set().
26222 * By default it will only look for cursors provided by the engine.
26224 * @param item widget item with cursor already set.
26225 * @param engine_only boolean to define if cursors set with
26226 * elm_diskselector_item_cursor_set() should be searched only
26227 * between cursors provided by the engine or searched on widget's
26230 * @see elm_object_cursor_engine_only_set() for more details.
26232 * @ingroup Diskselector
26234 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26237 * Get the cursor engine only usage for this item cursor.
26239 * @param item widget item with cursor already set.
26240 * @return engine_only boolean to define it cursors should be looked only
26241 * between the provided by the engine or searched on widget's theme as well.
26242 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26244 * @see elm_object_cursor_engine_only_get() for more details.
26245 * @see elm_diskselector_item_cursor_engine_only_set()
26247 * @ingroup Diskselector
26249 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26256 * @defgroup Colorselector Colorselector
26260 * @image html img/widget/colorselector/preview-00.png
26261 * @image latex img/widget/colorselector/preview-00.eps
26263 * @brief Widget for user to select a color.
26265 * Signals that you can add callbacks for are:
26266 * "changed" - When the color value changes(event_info is NULL).
26268 * See @ref tutorial_colorselector.
26271 * @brief Add a new colorselector to the parent
26273 * @param parent The parent object
26274 * @return The new object or NULL if it cannot be created
26276 * @ingroup Colorselector
26278 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26280 * Set a color for the colorselector
26282 * @param obj Colorselector object
26283 * @param r r-value of color
26284 * @param g g-value of color
26285 * @param b b-value of color
26286 * @param a a-value of color
26288 * @ingroup Colorselector
26290 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26292 * Get a color from the colorselector
26294 * @param obj Colorselector object
26295 * @param r integer pointer for r-value of color
26296 * @param g integer pointer for g-value of color
26297 * @param b integer pointer for b-value of color
26298 * @param a integer pointer for a-value of color
26300 * @ingroup Colorselector
26302 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26308 * @defgroup Ctxpopup Ctxpopup
26310 * @image html img/widget/ctxpopup/preview-00.png
26311 * @image latex img/widget/ctxpopup/preview-00.eps
26313 * @brief Context popup widet.
26315 * A ctxpopup is a widget that, when shown, pops up a list of items.
26316 * It automatically chooses an area inside its parent object's view
26317 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26318 * optimally fit into it. In the default theme, it will also point an
26319 * arrow to it's top left position at the time one shows it. Ctxpopup
26320 * items have a label and/or an icon. It is intended for a small
26321 * number of items (hence the use of list, not genlist).
26323 * @note Ctxpopup is a especialization of @ref Hover.
26325 * Signals that you can add callbacks for are:
26326 * "dismissed" - the ctxpopup was dismissed
26328 * Default contents parts of the ctxpopup widget that you can use for are:
26329 * @li "elm.swallow.content" - A content of the ctxpopup
26331 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26334 typedef enum _Elm_Ctxpopup_Direction
26336 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26338 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26339 the clicked area */
26340 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26341 the clicked area */
26342 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26344 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26345 } Elm_Ctxpopup_Direction;
26348 * @brief Add a new Ctxpopup object to the parent.
26350 * @param parent Parent object
26351 * @return New object or @c NULL, if it cannot be created
26353 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26355 * @brief Set the Ctxpopup's parent
26357 * @param obj The ctxpopup object
26358 * @param area The parent to use
26360 * Set the parent object.
26362 * @note elm_ctxpopup_add() will automatically call this function
26363 * with its @c parent argument.
26365 * @see elm_ctxpopup_add()
26366 * @see elm_hover_parent_set()
26368 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26370 * @brief Get the Ctxpopup's parent
26372 * @param obj The ctxpopup object
26374 * @see elm_ctxpopup_hover_parent_set() for more information
26376 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26378 * @brief Clear all items in the given ctxpopup object.
26380 * @param obj Ctxpopup object
26382 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26384 * @brief Change the ctxpopup's orientation to horizontal or vertical.
26386 * @param obj Ctxpopup object
26387 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26389 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26391 * @brief Get the value of current ctxpopup object's orientation.
26393 * @param obj Ctxpopup object
26394 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26396 * @see elm_ctxpopup_horizontal_set()
26398 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26400 * @brief Add a new item to a ctxpopup object.
26402 * @param obj Ctxpopup object
26403 * @param icon Icon to be set on new item
26404 * @param label The Label of the new item
26405 * @param func Convenience function called when item selected
26406 * @param data Data passed to @p func
26407 * @return A handle to the item added or @c NULL, on errors
26409 * @warning Ctxpopup can't hold both an item list and a content at the same
26410 * time. When an item is added, any previous content will be removed.
26412 * @see elm_ctxpopup_content_set()
26414 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);
26416 * @brief Delete the given item in a ctxpopup object.
26418 * @param it Ctxpopup item to be deleted
26420 * @see elm_ctxpopup_item_append()
26422 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26424 * @brief Set the ctxpopup item's state as disabled or enabled.
26426 * @param it Ctxpopup item to be enabled/disabled
26427 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26429 * When disabled the item is greyed out to indicate it's state.
26431 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26433 * @brief Get the ctxpopup item's disabled/enabled state.
26435 * @param it Ctxpopup item to be enabled/disabled
26436 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26438 * @see elm_ctxpopup_item_disabled_set()
26440 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26442 * @brief Get the icon object for the given ctxpopup item.
26444 * @param it Ctxpopup item
26445 * @return icon object or @c NULL, if the item does not have icon or an error
26448 * @see elm_ctxpopup_item_append()
26449 * @see elm_ctxpopup_item_icon_set()
26451 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26453 * @brief Sets the side icon associated with the ctxpopup item
26455 * @param it Ctxpopup item
26456 * @param icon Icon object to be set
26458 * Once the icon object is set, a previously set one will be deleted.
26459 * @warning Setting the same icon for two items will cause the icon to
26460 * dissapear from the first item.
26462 * @see elm_ctxpopup_item_append()
26464 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26466 * @brief Get the label for the given ctxpopup item.
26468 * @param it Ctxpopup item
26469 * @return label string or @c NULL, if the item does not have label or an
26472 * @see elm_ctxpopup_item_append()
26473 * @see elm_ctxpopup_item_label_set()
26475 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26477 * @brief (Re)set the label on the given ctxpopup item.
26479 * @param it Ctxpopup item
26480 * @param label String to set as label
26482 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26484 * @brief Set an elm widget as the content of the ctxpopup.
26486 * @param obj Ctxpopup object
26487 * @param content Content to be swallowed
26489 * If the content object is already set, a previous one will bedeleted. If
26490 * you want to keep that old content object, use the
26491 * elm_ctxpopup_content_unset() function.
26493 * @deprecated use elm_object_content_set()
26495 * @warning Ctxpopup can't hold both a item list and a content at the same
26496 * time. When a content is set, any previous items will be removed.
26498 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26500 * @brief Unset the ctxpopup content
26502 * @param obj Ctxpopup object
26503 * @return The content that was being used
26505 * Unparent and return the content object which was set for this widget.
26507 * @deprecated use elm_object_content_unset()
26509 * @see elm_ctxpopup_content_set()
26511 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26513 * @brief Set the direction priority of a ctxpopup.
26515 * @param obj Ctxpopup object
26516 * @param first 1st priority of direction
26517 * @param second 2nd priority of direction
26518 * @param third 3th priority of direction
26519 * @param fourth 4th priority of direction
26521 * This functions gives a chance to user to set the priority of ctxpopup
26522 * showing direction. This doesn't guarantee the ctxpopup will appear in the
26523 * requested direction.
26525 * @see Elm_Ctxpopup_Direction
26527 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);
26529 * @brief Get the direction priority of a ctxpopup.
26531 * @param obj Ctxpopup object
26532 * @param first 1st priority of direction to be returned
26533 * @param second 2nd priority of direction to be returned
26534 * @param third 3th priority of direction to be returned
26535 * @param fourth 4th priority of direction to be returned
26537 * @see elm_ctxpopup_direction_priority_set() for more information.
26539 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);
26542 * @brief Get the current direction of a ctxpopup.
26544 * @param obj Ctxpopup object
26545 * @return current direction of a ctxpopup
26547 * @warning Once the ctxpopup showed up, the direction would be determined
26549 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26558 * @defgroup Transit Transit
26559 * @ingroup Elementary
26561 * Transit is designed to apply various animated transition effects to @c
26562 * Evas_Object, such like translation, rotation, etc. For using these
26563 * effects, create an @ref Elm_Transit and add the desired transition effects.
26565 * Once the effects are added into transit, they will be automatically
26566 * managed (their callback will be called until the duration is ended, and
26567 * they will be deleted on completion).
26571 * Elm_Transit *trans = elm_transit_add();
26572 * elm_transit_object_add(trans, obj);
26573 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26574 * elm_transit_duration_set(transit, 1);
26575 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26576 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26577 * elm_transit_repeat_times_set(transit, 3);
26580 * Some transition effects are used to change the properties of objects. They
26582 * @li @ref elm_transit_effect_translation_add
26583 * @li @ref elm_transit_effect_color_add
26584 * @li @ref elm_transit_effect_rotation_add
26585 * @li @ref elm_transit_effect_wipe_add
26586 * @li @ref elm_transit_effect_zoom_add
26587 * @li @ref elm_transit_effect_resizing_add
26589 * Other transition effects are used to make one object disappear and another
26590 * object appear on its old place. These effects are:
26592 * @li @ref elm_transit_effect_flip_add
26593 * @li @ref elm_transit_effect_resizable_flip_add
26594 * @li @ref elm_transit_effect_fade_add
26595 * @li @ref elm_transit_effect_blend_add
26597 * It's also possible to make a transition chain with @ref
26598 * elm_transit_chain_transit_add.
26600 * @warning We strongly recommend to use elm_transit just when edje can not do
26601 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26602 * animations can be manipulated inside the theme.
26604 * List of examples:
26605 * @li @ref transit_example_01_explained
26606 * @li @ref transit_example_02_explained
26607 * @li @ref transit_example_03_c
26608 * @li @ref transit_example_04_c
26614 * @enum Elm_Transit_Tween_Mode
26616 * The type of acceleration used in the transition.
26620 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26621 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26622 over time, then decrease again
26624 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26626 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26628 } Elm_Transit_Tween_Mode;
26631 * @enum Elm_Transit_Effect_Flip_Axis
26633 * The axis where flip effect should be applied.
26637 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26638 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26639 } Elm_Transit_Effect_Flip_Axis;
26641 * @enum Elm_Transit_Effect_Wipe_Dir
26643 * The direction where the wipe effect should occur.
26647 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26648 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26649 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26650 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26651 } Elm_Transit_Effect_Wipe_Dir;
26652 /** @enum Elm_Transit_Effect_Wipe_Type
26654 * Whether the wipe effect should show or hide the object.
26658 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26660 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26662 } Elm_Transit_Effect_Wipe_Type;
26665 * @typedef Elm_Transit
26667 * The Transit created with elm_transit_add(). This type has the information
26668 * about the objects which the transition will be applied, and the
26669 * transition effects that will be used. It also contains info about
26670 * duration, number of repetitions, auto-reverse, etc.
26672 typedef struct _Elm_Transit Elm_Transit;
26673 typedef void Elm_Transit_Effect;
26675 * @typedef Elm_Transit_Effect_Transition_Cb
26677 * Transition callback called for this effect on each transition iteration.
26679 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26681 * Elm_Transit_Effect_End_Cb
26683 * Transition callback called for this effect when the transition is over.
26685 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26688 * Elm_Transit_Del_Cb
26690 * A callback called when the transit is deleted.
26692 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26697 * @note Is not necessary to delete the transit object, it will be deleted at
26698 * the end of its operation.
26699 * @note The transit will start playing when the program enter in the main loop, is not
26700 * necessary to give a start to the transit.
26702 * @return The transit object.
26706 EAPI Elm_Transit *elm_transit_add(void);
26709 * Stops the animation and delete the @p transit object.
26711 * Call this function if you wants to stop the animation before the duration
26712 * time. Make sure the @p transit object is still alive with
26713 * elm_transit_del_cb_set() function.
26714 * All added effects will be deleted, calling its repective data_free_cb
26715 * functions. The function setted by elm_transit_del_cb_set() will be called.
26717 * @see elm_transit_del_cb_set()
26719 * @param transit The transit object to be deleted.
26722 * @warning Just call this function if you are sure the transit is alive.
26724 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26727 * Add a new effect to the transit.
26729 * @note The cb function and the data are the key to the effect. If you try to
26730 * add an already added effect, nothing is done.
26731 * @note After the first addition of an effect in @p transit, if its
26732 * effect list become empty again, the @p transit will be killed by
26733 * elm_transit_del(transit) function.
26737 * Elm_Transit *transit = elm_transit_add();
26738 * elm_transit_effect_add(transit,
26739 * elm_transit_effect_blend_op,
26740 * elm_transit_effect_blend_context_new(),
26741 * elm_transit_effect_blend_context_free);
26744 * @param transit The transit object.
26745 * @param transition_cb The operation function. It is called when the
26746 * animation begins, it is the function that actually performs the animation.
26747 * It is called with the @p data, @p transit and the time progression of the
26748 * animation (a double value between 0.0 and 1.0).
26749 * @param effect The context data of the effect.
26750 * @param end_cb The function to free the context data, it will be called
26751 * at the end of the effect, it must finalize the animation and free the
26755 * @warning The transit free the context data at the and of the transition with
26756 * the data_free_cb function, do not use the context data in another transit.
26758 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);
26761 * Delete an added effect.
26763 * This function will remove the effect from the @p transit, calling the
26764 * data_free_cb to free the @p data.
26766 * @see elm_transit_effect_add()
26768 * @note If the effect is not found, nothing is done.
26769 * @note If the effect list become empty, this function will call
26770 * elm_transit_del(transit), that is, it will kill the @p transit.
26772 * @param transit The transit object.
26773 * @param transition_cb The operation function.
26774 * @param effect The context data of the effect.
26778 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);
26781 * Add new object to apply the effects.
26783 * @note After the first addition of an object in @p transit, if its
26784 * object list become empty again, the @p transit will be killed by
26785 * elm_transit_del(transit) function.
26786 * @note If the @p obj belongs to another transit, the @p obj will be
26787 * removed from it and it will only belong to the @p transit. If the old
26788 * transit stays without objects, it will die.
26789 * @note When you add an object into the @p transit, its state from
26790 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26791 * transit ends, if you change this state whith evas_object_pass_events_set()
26792 * after add the object, this state will change again when @p transit stops to
26795 * @param transit The transit object.
26796 * @param obj Object to be animated.
26799 * @warning It is not allowed to add a new object after transit begins to go.
26801 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26804 * Removes an added object from the transit.
26806 * @note If the @p obj is not in the @p transit, nothing is done.
26807 * @note If the list become empty, this function will call
26808 * elm_transit_del(transit), that is, it will kill the @p transit.
26810 * @param transit The transit object.
26811 * @param obj Object to be removed from @p transit.
26814 * @warning It is not allowed to remove objects after transit begins to go.
26816 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26819 * Get the objects of the transit.
26821 * @param transit The transit object.
26822 * @return a Eina_List with the objects from the transit.
26826 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26829 * Enable/disable keeping up the objects states.
26830 * If it is not kept, the objects states will be reset when transition ends.
26832 * @note @p transit can not be NULL.
26833 * @note One state includes geometry, color, map data.
26835 * @param transit The transit object.
26836 * @param state_keep Keeping or Non Keeping.
26840 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
26843 * Get a value whether the objects states will be reset or not.
26845 * @note @p transit can not be NULL
26847 * @see elm_transit_objects_final_state_keep_set()
26849 * @param transit The transit object.
26850 * @return EINA_TRUE means the states of the objects will be reset.
26851 * If @p transit is NULL, EINA_FALSE is returned
26855 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26858 * Set the event enabled when transit is operating.
26860 * If @p enabled is EINA_TRUE, the objects of the transit will receives
26861 * events from mouse and keyboard during the animation.
26862 * @note When you add an object with elm_transit_object_add(), its state from
26863 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26864 * transit ends, if you change this state with evas_object_pass_events_set()
26865 * after adding the object, this state will change again when @p transit stops
26868 * @param transit The transit object.
26869 * @param enabled Events are received when enabled is @c EINA_TRUE, and
26870 * ignored otherwise.
26874 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26877 * Get the value of event enabled status.
26879 * @see elm_transit_event_enabled_set()
26881 * @param transit The Transit object
26882 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
26883 * EINA_FALSE is returned
26887 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26890 * Set the user-callback function when the transit is deleted.
26892 * @note Using this function twice will overwrite the first function setted.
26893 * @note the @p transit object will be deleted after call @p cb function.
26895 * @param transit The transit object.
26896 * @param cb Callback function pointer. This function will be called before
26897 * the deletion of the transit.
26898 * @param data Callback funtion user data. It is the @p op parameter.
26902 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
26905 * Set reverse effect automatically.
26907 * If auto reverse is setted, after running the effects with the progress
26908 * parameter from 0 to 1, it will call the effecs again with the progress
26909 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
26910 * where the duration was setted with the function elm_transit_add and
26911 * the repeat with the function elm_transit_repeat_times_set().
26913 * @param transit The transit object.
26914 * @param reverse EINA_TRUE means the auto_reverse is on.
26918 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
26921 * Get if the auto reverse is on.
26923 * @see elm_transit_auto_reverse_set()
26925 * @param transit The transit object.
26926 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
26927 * EINA_FALSE is returned
26931 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26934 * Set the transit repeat count. Effect will be repeated by repeat count.
26936 * This function sets the number of repetition the transit will run after
26937 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
26938 * If the @p repeat is a negative number, it will repeat infinite times.
26940 * @note If this function is called during the transit execution, the transit
26941 * will run @p repeat times, ignoring the times it already performed.
26943 * @param transit The transit object
26944 * @param repeat Repeat count
26948 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
26951 * Get the transit repeat count.
26953 * @see elm_transit_repeat_times_set()
26955 * @param transit The Transit object.
26956 * @return The repeat count. If @p transit is NULL
26961 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26964 * Set the transit animation acceleration type.
26966 * This function sets the tween mode of the transit that can be:
26967 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
26968 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
26969 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
26970 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
26972 * @param transit The transit object.
26973 * @param tween_mode The tween type.
26977 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
26980 * Get the transit animation acceleration type.
26982 * @note @p transit can not be NULL
26984 * @param transit The transit object.
26985 * @return The tween type. If @p transit is NULL
26986 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
26990 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26993 * Set the transit animation time
26995 * @note @p transit can not be NULL
26997 * @param transit The transit object.
26998 * @param duration The animation time.
27002 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27005 * Get the transit animation time
27007 * @note @p transit can not be NULL
27009 * @param transit The transit object.
27011 * @return The transit animation time.
27015 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27018 * Starts the transition.
27019 * Once this API is called, the transit begins to measure the time.
27021 * @note @p transit can not be NULL
27023 * @param transit The transit object.
27027 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27030 * Pause/Resume the transition.
27032 * If you call elm_transit_go again, the transit will be started from the
27033 * beginning, and will be unpaused.
27035 * @note @p transit can not be NULL
27037 * @param transit The transit object.
27038 * @param paused Whether the transition should be paused or not.
27042 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27045 * Get the value of paused status.
27047 * @see elm_transit_paused_set()
27049 * @note @p transit can not be NULL
27051 * @param transit The transit object.
27052 * @return EINA_TRUE means transition is paused. If @p transit is NULL
27053 * EINA_FALSE is returned
27057 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27060 * Get the time progression of the animation (a double value between 0.0 and 1.0).
27062 * The value returned is a fraction (current time / total time). It
27063 * represents the progression position relative to the total.
27065 * @note @p transit can not be NULL
27067 * @param transit The transit object.
27069 * @return The time progression value. If @p transit is NULL
27074 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27077 * Makes the chain relationship between two transits.
27079 * @note @p transit can not be NULL. Transit would have multiple chain transits.
27080 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27082 * @param transit The transit object.
27083 * @param chain_transit The chain transit object. This transit will be operated
27084 * after transit is done.
27086 * This function adds @p chain_transit transition to a chain after the @p
27087 * transit, and will be started as soon as @p transit ends. See @ref
27088 * transit_example_02_explained for a full example.
27092 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27095 * Cut off the chain relationship between two transits.
27097 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27098 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27100 * @param transit The transit object.
27101 * @param chain_transit The chain transit object.
27103 * This function remove the @p chain_transit transition from the @p transit.
27107 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27110 * Get the current chain transit list.
27112 * @note @p transit can not be NULL.
27114 * @param transit The transit object.
27115 * @return chain transit list.
27119 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
27122 * Add the Resizing Effect to Elm_Transit.
27124 * @note This API is one of the facades. It creates resizing effect context
27125 * and add it's required APIs to elm_transit_effect_add.
27127 * @see elm_transit_effect_add()
27129 * @param transit Transit object.
27130 * @param from_w Object width size when effect begins.
27131 * @param from_h Object height size when effect begins.
27132 * @param to_w Object width size when effect ends.
27133 * @param to_h Object height size when effect ends.
27134 * @return Resizing effect context data.
27138 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);
27141 * Add the Translation Effect to Elm_Transit.
27143 * @note This API is one of the facades. It creates translation effect context
27144 * and add it's required APIs to elm_transit_effect_add.
27146 * @see elm_transit_effect_add()
27148 * @param transit Transit object.
27149 * @param from_dx X Position variation when effect begins.
27150 * @param from_dy Y Position variation when effect begins.
27151 * @param to_dx X Position variation when effect ends.
27152 * @param to_dy Y Position variation when effect ends.
27153 * @return Translation effect context data.
27156 * @warning It is highly recommended just create a transit with this effect when
27157 * the window that the objects of the transit belongs has already been created.
27158 * This is because this effect needs the geometry information about the objects,
27159 * and if the window was not created yet, it can get a wrong information.
27161 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);
27164 * Add the Zoom Effect to Elm_Transit.
27166 * @note This API is one of the facades. It creates zoom effect context
27167 * and add it's required APIs to elm_transit_effect_add.
27169 * @see elm_transit_effect_add()
27171 * @param transit Transit object.
27172 * @param from_rate Scale rate when effect begins (1 is current rate).
27173 * @param to_rate Scale rate when effect ends.
27174 * @return Zoom effect context data.
27177 * @warning It is highly recommended just create a transit with this effect when
27178 * the window that the objects of the transit belongs has already been created.
27179 * This is because this effect needs the geometry information about the objects,
27180 * and if the window was not created yet, it can get a wrong information.
27182 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27185 * Add the Flip Effect to Elm_Transit.
27187 * @note This API is one of the facades. It creates flip effect context
27188 * and add it's required APIs to elm_transit_effect_add.
27189 * @note This effect is applied to each pair of objects in the order they are listed
27190 * in the transit list of objects. The first object in the pair will be the
27191 * "front" object and the second will be the "back" object.
27193 * @see elm_transit_effect_add()
27195 * @param transit Transit object.
27196 * @param axis Flipping Axis(X or Y).
27197 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27198 * @return Flip effect context data.
27201 * @warning It is highly recommended just create a transit with this effect when
27202 * the window that the objects of the transit belongs has already been created.
27203 * This is because this effect needs the geometry information about the objects,
27204 * and if the window was not created yet, it can get a wrong information.
27206 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27209 * Add the Resizable Flip Effect to Elm_Transit.
27211 * @note This API is one of the facades. It creates resizable flip effect context
27212 * and add it's required APIs to elm_transit_effect_add.
27213 * @note This effect is applied to each pair of objects in the order they are listed
27214 * in the transit list of objects. The first object in the pair will be the
27215 * "front" object and the second will be the "back" object.
27217 * @see elm_transit_effect_add()
27219 * @param transit Transit object.
27220 * @param axis Flipping Axis(X or Y).
27221 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27222 * @return Resizable flip effect context data.
27225 * @warning It is highly recommended just create a transit with this effect when
27226 * the window that the objects of the transit belongs has already been created.
27227 * This is because this effect needs the geometry information about the objects,
27228 * and if the window was not created yet, it can get a wrong information.
27230 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27233 * Add the Wipe Effect to Elm_Transit.
27235 * @note This API is one of the facades. It creates wipe effect context
27236 * and add it's required APIs to elm_transit_effect_add.
27238 * @see elm_transit_effect_add()
27240 * @param transit Transit object.
27241 * @param type Wipe type. Hide or show.
27242 * @param dir Wipe Direction.
27243 * @return Wipe effect context data.
27246 * @warning It is highly recommended just create a transit with this effect when
27247 * the window that the objects of the transit belongs has already been created.
27248 * This is because this effect needs the geometry information about the objects,
27249 * and if the window was not created yet, it can get a wrong information.
27251 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27254 * Add the Color Effect to Elm_Transit.
27256 * @note This API is one of the facades. It creates color effect context
27257 * and add it's required APIs to elm_transit_effect_add.
27259 * @see elm_transit_effect_add()
27261 * @param transit Transit object.
27262 * @param from_r RGB R when effect begins.
27263 * @param from_g RGB G when effect begins.
27264 * @param from_b RGB B when effect begins.
27265 * @param from_a RGB A when effect begins.
27266 * @param to_r RGB R when effect ends.
27267 * @param to_g RGB G when effect ends.
27268 * @param to_b RGB B when effect ends.
27269 * @param to_a RGB A when effect ends.
27270 * @return Color effect context data.
27274 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);
27277 * Add the Fade Effect to Elm_Transit.
27279 * @note This API is one of the facades. It creates fade effect context
27280 * and add it's required APIs to elm_transit_effect_add.
27281 * @note This effect is applied to each pair of objects in the order they are listed
27282 * in the transit list of objects. The first object in the pair will be the
27283 * "before" object and the second will be the "after" object.
27285 * @see elm_transit_effect_add()
27287 * @param transit Transit object.
27288 * @return Fade effect context data.
27291 * @warning It is highly recommended just create a transit with this effect when
27292 * the window that the objects of the transit belongs has already been created.
27293 * This is because this effect needs the color information about the objects,
27294 * and if the window was not created yet, it can get a wrong information.
27296 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27299 * Add the Blend Effect to Elm_Transit.
27301 * @note This API is one of the facades. It creates blend effect context
27302 * and add it's required APIs to elm_transit_effect_add.
27303 * @note This effect is applied to each pair of objects in the order they are listed
27304 * in the transit list of objects. The first object in the pair will be the
27305 * "before" object and the second will be the "after" object.
27307 * @see elm_transit_effect_add()
27309 * @param transit Transit object.
27310 * @return Blend effect context data.
27313 * @warning It is highly recommended just create a transit with this effect when
27314 * the window that the objects of the transit belongs has already been created.
27315 * This is because this effect needs the color information about the objects,
27316 * and if the window was not created yet, it can get a wrong information.
27318 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27321 * Add the Rotation Effect to Elm_Transit.
27323 * @note This API is one of the facades. It creates rotation effect context
27324 * and add it's required APIs to elm_transit_effect_add.
27326 * @see elm_transit_effect_add()
27328 * @param transit Transit object.
27329 * @param from_degree Degree when effect begins.
27330 * @param to_degree Degree when effect is ends.
27331 * @return Rotation effect context data.
27334 * @warning It is highly recommended just create a transit with this effect when
27335 * the window that the objects of the transit belongs has already been created.
27336 * This is because this effect needs the geometry information about the objects,
27337 * and if the window was not created yet, it can get a wrong information.
27339 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27342 * Add the ImageAnimation Effect to Elm_Transit.
27344 * @note This API is one of the facades. It creates image animation effect context
27345 * and add it's required APIs to elm_transit_effect_add.
27346 * The @p images parameter is a list images paths. This list and
27347 * its contents will be deleted at the end of the effect by
27348 * elm_transit_effect_image_animation_context_free() function.
27352 * char buf[PATH_MAX];
27353 * Eina_List *images = NULL;
27354 * Elm_Transit *transi = elm_transit_add();
27356 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27357 * images = eina_list_append(images, eina_stringshare_add(buf));
27359 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27360 * images = eina_list_append(images, eina_stringshare_add(buf));
27361 * elm_transit_effect_image_animation_add(transi, images);
27365 * @see elm_transit_effect_add()
27367 * @param transit Transit object.
27368 * @param images Eina_List of images file paths. This list and
27369 * its contents will be deleted at the end of the effect by
27370 * elm_transit_effect_image_animation_context_free() function.
27371 * @return Image Animation effect context data.
27375 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27380 typedef struct _Elm_Store Elm_Store;
27381 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
27382 typedef struct _Elm_Store_Item Elm_Store_Item;
27383 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
27384 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
27385 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27386 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
27387 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
27388 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
27389 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
27390 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
27392 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27393 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
27394 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
27395 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27399 ELM_STORE_ITEM_MAPPING_NONE = 0,
27400 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27401 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27402 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27403 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27404 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27405 // can add more here as needed by common apps
27406 ELM_STORE_ITEM_MAPPING_LAST
27407 } Elm_Store_Item_Mapping_Type;
27409 struct _Elm_Store_Item_Mapping_Icon
27411 // FIXME: allow edje file icons
27413 Elm_Icon_Lookup_Order lookup_order;
27414 Eina_Bool standard_name : 1;
27415 Eina_Bool no_scale : 1;
27416 Eina_Bool smooth : 1;
27417 Eina_Bool scale_up : 1;
27418 Eina_Bool scale_down : 1;
27421 struct _Elm_Store_Item_Mapping_Empty
27426 struct _Elm_Store_Item_Mapping_Photo
27431 struct _Elm_Store_Item_Mapping_Custom
27433 Elm_Store_Item_Mapping_Cb func;
27436 struct _Elm_Store_Item_Mapping
27438 Elm_Store_Item_Mapping_Type type;
27443 Elm_Store_Item_Mapping_Empty empty;
27444 Elm_Store_Item_Mapping_Icon icon;
27445 Elm_Store_Item_Mapping_Photo photo;
27446 Elm_Store_Item_Mapping_Custom custom;
27447 // add more types here
27451 struct _Elm_Store_Item_Info
27453 Elm_Genlist_Item_Class *item_class;
27454 const Elm_Store_Item_Mapping *mapping;
27459 struct _Elm_Store_Item_Info_Filesystem
27461 Elm_Store_Item_Info base;
27465 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27466 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27468 EAPI void elm_store_free(Elm_Store *st);
27470 EAPI Elm_Store *elm_store_filesystem_new(void);
27471 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27472 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27473 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27475 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27477 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27478 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27479 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27480 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27481 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27482 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27484 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27485 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27486 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27487 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27488 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27489 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27490 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27493 * @defgroup SegmentControl SegmentControl
27494 * @ingroup Elementary
27496 * @image html img/widget/segment_control/preview-00.png
27497 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27499 * @image html img/segment_control.png
27500 * @image latex img/segment_control.eps width=\textwidth
27502 * Segment control widget is a horizontal control made of multiple segment
27503 * items, each segment item functioning similar to discrete two state button.
27504 * A segment control groups the items together and provides compact
27505 * single button with multiple equal size segments.
27507 * Segment item size is determined by base widget
27508 * size and the number of items added.
27509 * Only one segment item can be at selected state. A segment item can display
27510 * combination of Text and any Evas_Object like Images or other widget.
27512 * Smart callbacks one can listen to:
27513 * - "changed" - When the user clicks on a segment item which is not
27514 * previously selected and get selected. The event_info parameter is the
27515 * segment item index.
27517 * Available styles for it:
27520 * Here is an example on its usage:
27521 * @li @ref segment_control_example
27525 * @addtogroup SegmentControl
27529 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27532 * Add a new segment control widget to the given parent Elementary
27533 * (container) object.
27535 * @param parent The parent object.
27536 * @return a new segment control widget handle or @c NULL, on errors.
27538 * This function inserts a new segment control widget on the canvas.
27540 * @ingroup SegmentControl
27542 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27545 * Append a new item to the segment control object.
27547 * @param obj The segment control object.
27548 * @param icon The icon object to use for the left side of the item. An
27549 * icon can be any Evas object, but usually it is an icon created
27550 * with elm_icon_add().
27551 * @param label The label of the item.
27552 * Note that, NULL is different from empty string "".
27553 * @return The created item or @c NULL upon failure.
27555 * A new item will be created and appended to the segment control, i.e., will
27556 * be set as @b last item.
27558 * If it should be inserted at another position,
27559 * elm_segment_control_item_insert_at() should be used instead.
27561 * Items created with this function can be deleted with function
27562 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27564 * @note @p label set to @c NULL is different from empty string "".
27566 * only has icon, it will be displayed bigger and centered. If it has
27567 * icon and label, even that an empty string, icon will be smaller and
27568 * positioned at left.
27572 * sc = elm_segment_control_add(win);
27573 * ic = elm_icon_add(win);
27574 * elm_icon_file_set(ic, "path/to/image", NULL);
27575 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27576 * elm_segment_control_item_add(sc, ic, "label");
27577 * evas_object_show(sc);
27580 * @see elm_segment_control_item_insert_at()
27581 * @see elm_segment_control_item_del()
27583 * @ingroup SegmentControl
27585 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27588 * Insert a new item to the segment control object at specified position.
27590 * @param obj The segment control object.
27591 * @param icon The icon object to use for the left side of the item. An
27592 * icon can be any Evas object, but usually it is an icon created
27593 * with elm_icon_add().
27594 * @param label The label of the item.
27595 * @param index Item position. Value should be between 0 and items count.
27596 * @return The created item or @c NULL upon failure.
27598 * Index values must be between @c 0, when item will be prepended to
27599 * segment control, and items count, that can be get with
27600 * elm_segment_control_item_count_get(), case when item will be appended
27601 * to segment control, just like elm_segment_control_item_add().
27603 * Items created with this function can be deleted with function
27604 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27606 * @note @p label set to @c NULL is different from empty string "".
27608 * only has icon, it will be displayed bigger and centered. If it has
27609 * icon and label, even that an empty string, icon will be smaller and
27610 * positioned at left.
27612 * @see elm_segment_control_item_add()
27613 * @see elm_segment_control_item_count_get()
27614 * @see elm_segment_control_item_del()
27616 * @ingroup SegmentControl
27618 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);
27621 * Remove a segment control item from its parent, deleting it.
27623 * @param it The item to be removed.
27625 * Items can be added with elm_segment_control_item_add() or
27626 * elm_segment_control_item_insert_at().
27628 * @ingroup SegmentControl
27630 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27633 * Remove a segment control item at given index from its parent,
27636 * @param obj The segment control object.
27637 * @param index The position of the segment control item to be deleted.
27639 * Items can be added with elm_segment_control_item_add() or
27640 * elm_segment_control_item_insert_at().
27642 * @ingroup SegmentControl
27644 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27647 * Get the Segment items count from segment control.
27649 * @param obj The segment control object.
27650 * @return Segment items count.
27652 * It will just return the number of items added to segment control @p obj.
27654 * @ingroup SegmentControl
27656 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27659 * Get the item placed at specified index.
27661 * @param obj The segment control object.
27662 * @param index The index of the segment item.
27663 * @return The segment control item or @c NULL on failure.
27665 * Index is the position of an item in segment control widget. Its
27666 * range is from @c 0 to <tt> count - 1 </tt>.
27667 * Count is the number of items, that can be get with
27668 * elm_segment_control_item_count_get().
27670 * @ingroup SegmentControl
27672 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27675 * Get the label of item.
27677 * @param obj The segment control object.
27678 * @param index The index of the segment item.
27679 * @return The label of the item at @p index.
27681 * The return value is a pointer to the label associated to the item when
27682 * it was created, with function elm_segment_control_item_add(), or later
27683 * with function elm_segment_control_item_label_set. If no label
27684 * was passed as argument, it will return @c NULL.
27686 * @see elm_segment_control_item_label_set() for more details.
27687 * @see elm_segment_control_item_add()
27689 * @ingroup SegmentControl
27691 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27694 * Set the label of item.
27696 * @param it The item of segment control.
27697 * @param text The label of item.
27699 * The label to be displayed by the item.
27700 * Label will be at right of the icon (if set).
27702 * If a label was passed as argument on item creation, with function
27703 * elm_control_segment_item_add(), it will be already
27704 * displayed by the item.
27706 * @see elm_segment_control_item_label_get()
27707 * @see elm_segment_control_item_add()
27709 * @ingroup SegmentControl
27711 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
27714 * Get the icon associated to the item.
27716 * @param obj The segment control object.
27717 * @param index The index of the segment item.
27718 * @return The left side icon associated to the item at @p index.
27720 * The return value is a pointer to the icon associated to the item when
27721 * it was created, with function elm_segment_control_item_add(), or later
27722 * with function elm_segment_control_item_icon_set(). If no icon
27723 * was passed as argument, it will return @c NULL.
27725 * @see elm_segment_control_item_add()
27726 * @see elm_segment_control_item_icon_set()
27728 * @ingroup SegmentControl
27730 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27733 * Set the icon associated to the item.
27735 * @param it The segment control item.
27736 * @param icon The icon object to associate with @p it.
27738 * The icon object to use at left side of the item. An
27739 * icon can be any Evas object, but usually it is an icon created
27740 * with elm_icon_add().
27742 * Once the icon object is set, a previously set one will be deleted.
27743 * @warning Setting the same icon for two items will cause the icon to
27744 * dissapear from the first item.
27746 * If an icon was passed as argument on item creation, with function
27747 * elm_segment_control_item_add(), it will be already
27748 * associated to the item.
27750 * @see elm_segment_control_item_add()
27751 * @see elm_segment_control_item_icon_get()
27753 * @ingroup SegmentControl
27755 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27758 * Get the index of an item.
27760 * @param it The segment control item.
27761 * @return The position of item in segment control widget.
27763 * Index is the position of an item in segment control widget. Its
27764 * range is from @c 0 to <tt> count - 1 </tt>.
27765 * Count is the number of items, that can be get with
27766 * elm_segment_control_item_count_get().
27768 * @ingroup SegmentControl
27770 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27773 * Get the base object of the item.
27775 * @param it The segment control item.
27776 * @return The base object associated with @p it.
27778 * Base object is the @c Evas_Object that represents that item.
27780 * @ingroup SegmentControl
27782 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27785 * Get the selected item.
27787 * @param obj The segment control object.
27788 * @return The selected item or @c NULL if none of segment items is
27791 * The selected item can be unselected with function
27792 * elm_segment_control_item_selected_set().
27794 * The selected item always will be highlighted on segment control.
27796 * @ingroup SegmentControl
27798 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27801 * Set the selected state of an item.
27803 * @param it The segment control item
27804 * @param select The selected state
27806 * This sets the selected state of the given item @p it.
27807 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27809 * If a new item is selected the previosly selected will be unselected.
27810 * Previoulsy selected item can be get with function
27811 * elm_segment_control_item_selected_get().
27813 * The selected item always will be highlighted on segment control.
27815 * @see elm_segment_control_item_selected_get()
27817 * @ingroup SegmentControl
27819 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
27826 * @defgroup Grid Grid
27828 * The grid is a grid layout widget that lays out a series of children as a
27829 * fixed "grid" of widgets using a given percentage of the grid width and
27830 * height each using the child object.
27832 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
27833 * widgets size itself. The default is 100 x 100, so that means the
27834 * position and sizes of children will effectively be percentages (0 to 100)
27835 * of the width or height of the grid widget
27841 * Add a new grid to the parent
27843 * @param parent The parent object
27844 * @return The new object or NULL if it cannot be created
27848 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
27851 * Set the virtual size of the grid
27853 * @param obj The grid object
27854 * @param w The virtual width of the grid
27855 * @param h The virtual height of the grid
27859 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
27862 * Get the virtual size of the grid
27864 * @param obj The grid object
27865 * @param w Pointer to integer to store the virtual width of the grid
27866 * @param h Pointer to integer to store the virtual height of the grid
27870 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
27873 * Pack child at given position and size
27875 * @param obj The grid object
27876 * @param subobj The child to pack
27877 * @param x The virtual x coord at which to pack it
27878 * @param y The virtual y coord at which to pack it
27879 * @param w The virtual width at which to pack it
27880 * @param h The virtual height at which to pack it
27884 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
27887 * Unpack a child from a grid object
27889 * @param obj The grid object
27890 * @param subobj The child to unpack
27894 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
27897 * Faster way to remove all child objects from a grid object.
27899 * @param obj The grid object
27900 * @param clear If true, it will delete just removed children
27904 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
27907 * Set packing of an existing child at to position and size
27909 * @param subobj The child to set packing of
27910 * @param x The virtual x coord at which to pack it
27911 * @param y The virtual y coord at which to pack it
27912 * @param w The virtual width at which to pack it
27913 * @param h The virtual height at which to pack it
27917 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
27920 * get packing of a child
27922 * @param subobj The child to query
27923 * @param x Pointer to integer to store the virtual x coord
27924 * @param y Pointer to integer to store the virtual y coord
27925 * @param w Pointer to integer to store the virtual width
27926 * @param h Pointer to integer to store the virtual height
27930 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
27936 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
27937 EINA_DEPRECATED EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
27938 EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
27939 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
27940 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
27941 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
27944 * @defgroup Video Video
27946 * @addtogroup Video
27949 * Elementary comes with two object that help design application that need
27950 * to display video. The main one, Elm_Video, display a video by using Emotion.
27951 * It does embedded the video inside an Edje object, so you can do some
27952 * animation depending on the video state change. It does also implement a
27953 * ressource management policy to remove this burden from the application writer.
27955 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
27956 * It take care of updating its content according to Emotion event and provide a
27957 * way to theme itself. It also does automatically raise the priority of the
27958 * linked Elm_Video so it will use the video decoder if available. It also does
27959 * activate the remember function on the linked Elm_Video object.
27961 * Signals that you can add callback for are :
27963 * "forward,clicked" - the user clicked the forward button.
27964 * "info,clicked" - the user clicked the info button.
27965 * "next,clicked" - the user clicked the next button.
27966 * "pause,clicked" - the user clicked the pause button.
27967 * "play,clicked" - the user clicked the play button.
27968 * "prev,clicked" - the user clicked the prev button.
27969 * "rewind,clicked" - the user clicked the rewind button.
27970 * "stop,clicked" - the user clicked the stop button.
27974 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
27976 * @param parent The parent object
27977 * @return a new player widget handle or @c NULL, on errors.
27979 * This function inserts a new player widget on the canvas.
27981 * @see elm_player_video_set()
27985 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
27988 * @brief Link a Elm_Payer with an Elm_Video object.
27990 * @param player the Elm_Player object.
27991 * @param video The Elm_Video object.
27993 * This mean that action on the player widget will affect the
27994 * video object and the state of the video will be reflected in
27995 * the player itself.
27997 * @see elm_player_add()
27998 * @see elm_video_add()
28002 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28005 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28007 * @param parent The parent object
28008 * @return a new video widget handle or @c NULL, on errors.
28010 * This function inserts a new video widget on the canvas.
28012 * @seeelm_video_file_set()
28013 * @see elm_video_uri_set()
28017 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28020 * @brief Define the file that will be the video source.
28022 * @param video The video object to define the file for.
28023 * @param filename The file to target.
28025 * This function will explicitly define a filename as a source
28026 * for the video of the Elm_Video object.
28028 * @see elm_video_uri_set()
28029 * @see elm_video_add()
28030 * @see elm_player_add()
28034 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28037 * @brief Define the uri that will be the video source.
28039 * @param video The video object to define the file for.
28040 * @param uri The uri to target.
28042 * This function will define an uri as a source for the video of the
28043 * Elm_Video object. URI could be remote source of video, like http:// or local source
28044 * like for example WebCam who are most of the time v4l2:// (but that depend and
28045 * you should use Emotion API to request and list the available Webcam on your system).
28047 * @see elm_video_file_set()
28048 * @see elm_video_add()
28049 * @see elm_player_add()
28053 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28056 * @brief Get the underlying Emotion object.
28058 * @param video The video object to proceed the request on.
28059 * @return the underlying Emotion object.
28063 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
28066 * @brief Start to play the video
28068 * @param video The video object to proceed the request on.
28070 * Start to play the video and cancel all suspend state.
28074 EAPI void elm_video_play(Evas_Object *video);
28077 * @brief Pause the video
28079 * @param video The video object to proceed the request on.
28081 * Pause the video and start a timer to trigger suspend mode.
28085 EAPI void elm_video_pause(Evas_Object *video);
28088 * @brief Stop the video
28090 * @param video The video object to proceed the request on.
28092 * Stop the video and put the emotion in deep sleep mode.
28096 EAPI void elm_video_stop(Evas_Object *video);
28099 * @brief Is the video actually playing.
28101 * @param video The video object to proceed the request on.
28102 * @return EINA_TRUE if the video is actually playing.
28104 * You should consider watching event on the object instead of polling
28105 * the object state.
28109 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
28112 * @brief Is it possible to seek inside the video.
28114 * @param video The video object to proceed the request on.
28115 * @return EINA_TRUE if is possible to seek inside the video.
28119 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
28122 * @brief Is the audio muted.
28124 * @param video The video object to proceed the request on.
28125 * @return EINA_TRUE if the audio is muted.
28129 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
28132 * @brief Change the mute state of the Elm_Video object.
28134 * @param video The video object to proceed the request on.
28135 * @param mute The new mute state.
28139 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28142 * @brief Get the audio level of the current video.
28144 * @param video The video object to proceed the request on.
28145 * @return the current audio level.
28149 EAPI double elm_video_audio_level_get(Evas_Object *video);
28152 * @brief Set the audio level of anElm_Video object.
28154 * @param video The video object to proceed the request on.
28155 * @param volume The new audio volume.
28159 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28161 EAPI double elm_video_play_position_get(Evas_Object *video);
28162 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28163 EAPI double elm_video_play_length_get(Evas_Object *video);
28164 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28165 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
28166 EAPI const char *elm_video_title_get(Evas_Object *video);
28172 * @defgroup Naviframe Naviframe
28173 * @ingroup Elementary
28175 * @brief Naviframe is a kind of view manager for the applications.
28177 * Naviframe provides functions to switch different pages with stack
28178 * mechanism. It means if one page(item) needs to be changed to the new one,
28179 * then naviframe would push the new page to it's internal stack. Of course,
28180 * it can be back to the previous page by popping the top page. Naviframe
28181 * provides some transition effect while the pages are switching (same as
28184 * Since each item could keep the different styles, users could keep the
28185 * same look & feel for the pages or different styles for the items in it's
28188 * Signals that you can add callback for are:
28189 * @li "transition,finished" - When the transition is finished in changing
28191 * @li "title,clicked" - User clicked title area
28193 * Default contents parts of the naviframe items that you can use for are:
28194 * @li "elm.swallow.content" - A main content of the page
28195 * @li "elm.swallow.icon" - A icon in the title area
28196 * @li "elm.swallow.prev_btn" - A button to go to the previous page
28197 * @li "elm.swallow.next_btn" - A button to go to the next page
28199 * Default text parts of the naviframe items that you can use for are:
28200 * @li "elm.text.title" - Title label in the title area
28201 * @li "elm.text.subtitle" - Sub-title label in the title area
28203 * @ref tutorial_naviframe gives a good overview of the usage of the API.
28206 #define ELM_NAVIFRAME_ITEM_CONTENT_ICON "elm.swallow.icon"
28207 #define ELM_NAVIFRAME_ITEM_CONTENT_PREV_BTN "elm.swallow.prev_btn"
28208 #define ELM_NAVIFRAME_ITEM_CONTNET_NEXT_BTN "elm.swallow.next_btn"
28209 #define ELM_NAVIFRAME_ITEM_TEXT_SUBTITLE "elm.text.subtitle"
28212 * @addtogroup Naviframe
28217 * @brief Add a new Naviframe object to the parent.
28219 * @param parent Parent object
28220 * @return New object or @c NULL, if it cannot be created
28222 * @ingroup Naviframe
28224 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28226 * @brief Push a new item to the top of the naviframe stack (and show it).
28228 * @param obj The naviframe object
28229 * @param title_label The label in the title area. The name of the title
28230 * label part is "elm.text.title"
28231 * @param prev_btn The button to go to the previous item. If it is NULL,
28232 * then naviframe will create a back button automatically. The name of
28233 * the prev_btn part is "elm.swallow.prev_btn"
28234 * @param next_btn The button to go to the next item. Or It could be just an
28235 * extra function button. The name of the next_btn part is
28236 * "elm.swallow.next_btn"
28237 * @param content The main content object. The name of content part is
28238 * "elm.swallow.content"
28239 * @param item_style The current item style name. @c NULL would be default.
28240 * @return The created item or @c NULL upon failure.
28242 * The item pushed becomes one page of the naviframe, this item will be
28243 * deleted when it is popped.
28245 * @see also elm_naviframe_item_style_set()
28247 * The following styles are available for this item:
28250 * @ingroup Naviframe
28252 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);
28254 * @brief Pop an item that is on top of the stack
28256 * @param obj The naviframe object
28257 * @return @c NULL or the content object(if the
28258 * elm_naviframe_content_preserve_on_pop_get is true).
28260 * This pops an item that is on the top(visible) of the naviframe, makes it
28261 * disappear, then deletes the item. The item that was underneath it on the
28262 * stack will become visible.
28264 * @see also elm_naviframe_content_preserve_on_pop_get()
28266 * @ingroup Naviframe
28268 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28270 * @brief Pop the items between the top and the above one on the given item.
28272 * @param it The naviframe item
28274 * @ingroup Naviframe
28276 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28278 * Promote an item already in the naviframe stack to the top of the stack
28280 * @param it The naviframe item
28282 * This will take the indicated item and promote it to the top of the stack
28283 * as if it had been pushed there. The item must already be inside the
28284 * naviframe stack to work.
28287 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28289 * @brief Delete the given item instantly.
28291 * @param it The naviframe item
28293 * This just deletes the given item from the naviframe item list instantly.
28294 * So this would not emit any signals for view transitions but just change
28295 * the current view if the given item is a top one.
28297 * @ingroup Naviframe
28299 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28301 * @brief preserve the content objects when items are popped.
28303 * @param obj The naviframe object
28304 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28306 * @see also elm_naviframe_content_preserve_on_pop_get()
28308 * @ingroup Naviframe
28310 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28312 * @brief Get a value whether preserve mode is enabled or not.
28314 * @param obj The naviframe object
28315 * @return If @c EINA_TRUE, preserve mode is enabled
28317 * @see also elm_naviframe_content_preserve_on_pop_set()
28319 * @ingroup Naviframe
28321 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28323 * @brief Get a top item on the naviframe stack
28325 * @param obj The naviframe object
28326 * @return The top item on the naviframe stack or @c NULL, if the stack is
28329 * @ingroup Naviframe
28331 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28333 * @brief Get a bottom item on the naviframe stack
28335 * @param obj The naviframe object
28336 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28339 * @ingroup Naviframe
28341 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28343 * @brief Set an item style
28345 * @param obj The naviframe item
28346 * @param item_style The current item style name. @c NULL would be default
28348 * The following styles are available for this item:
28351 * @see also elm_naviframe_item_style_get()
28353 * @ingroup Naviframe
28355 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28357 * @brief Get an item style
28359 * @param obj The naviframe item
28360 * @return The current item style name
28362 * @see also elm_naviframe_item_style_set()
28364 * @ingroup Naviframe
28366 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28368 * @brief Show/Hide the title area
28370 * @param it The naviframe item
28371 * @param visible If @c EINA_TRUE, title area will be visible, hidden
28374 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
28376 * @see also elm_naviframe_item_title_visible_get()
28378 * @ingroup Naviframe
28380 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28382 * @brief Get a value whether title area is visible or not.
28384 * @param it The naviframe item
28385 * @return If @c EINA_TRUE, title area is visible
28387 * @see also elm_naviframe_item_title_visible_set()
28389 * @ingroup Naviframe
28391 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28394 * @brief Set creating prev button automatically or not
28396 * @param obj The naviframe object
28397 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28398 * be created internally when you pass the @c NULL to the prev_btn
28399 * parameter in elm_naviframe_item_push
28401 * @see also elm_naviframe_item_push()
28403 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28405 * @brief Get a value whether prev button(back button) will be auto pushed or
28408 * @param obj The naviframe object
28409 * @return If @c EINA_TRUE, prev button will be auto pushed.
28411 * @see also elm_naviframe_item_push()
28412 * elm_naviframe_prev_btn_auto_pushed_set()
28414 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);