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, title and delete handler
199 win = elm_win_add(NULL, "hello", ELM_WIN_BASIC);
200 elm_win_title_set(win, "Hello");
201 // when the user clicks "close" on a window there is a request to delete
202 evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
205 bg = elm_bg_add(win);
206 // add object as a resize object for the window (controls window minimum
207 // size as well as gets resized if window is resized)
208 elm_win_resize_object_add(win, bg);
209 evas_object_show(bg);
211 // add a box object - default is vertical. a box holds children in a row,
212 // either horizontally or vertically. nothing more.
213 box = elm_box_add(win);
214 // make the box hotizontal
215 elm_box_horizontal_set(box, EINA_TRUE);
216 // add object as a resize object for the window (controls window minimum
217 // size as well as gets resized if window is resized)
218 elm_win_resize_object_add(win, box);
219 evas_object_show(box);
221 // add a label widget, set the text and put it in the pad frame
222 lab = elm_label_add(win);
223 // set default text of the label
224 elm_object_text_set(lab, "Hello out there world!");
225 // pack the label at the end of the box
226 elm_box_pack_end(box, lab);
227 evas_object_show(lab);
230 btn = elm_button_add(win);
231 // set default text of button to "OK"
232 elm_object_text_set(btn, "OK");
233 // pack the button at the end of the box
234 elm_box_pack_end(box, btn);
235 evas_object_show(btn);
236 // call on_done when button is clicked
237 evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
239 // now we are done, show the window
240 evas_object_show(win);
242 // run the mainloop and process events and callbacks
252 @page authors Authors
253 @author Carsten Haitzler <raster@@rasterman.com>
254 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
255 @author Cedric Bail <cedric.bail@@free.fr>
256 @author Vincent Torri <vtorri@@univ-evry.fr>
257 @author Daniel Kolesa <quaker66@@gmail.com>
258 @author Jaime Thomas <avi.thomas@@gmail.com>
259 @author Swisscom - http://www.swisscom.ch/
260 @author Christopher Michael <devilhorns@@comcast.net>
261 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
262 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
263 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
264 @author Brian Wang <brian.wang.0721@@gmail.com>
265 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
266 @author Samsung Electronics <tbd>
267 @author Samsung SAIT <tbd>
268 @author Brett Nash <nash@@nash.id.au>
269 @author Bruno Dilly <bdilly@@profusion.mobi>
270 @author Rafael Fonseca <rfonseca@@profusion.mobi>
271 @author Chuneon Park <hermet@@hermet.pe.kr>
272 @author Woohyun Jung <wh0705.jung@@samsung.com>
273 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
274 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
275 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
276 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
277 @author Gustavo Lima Chaves <glima@@profusion.mobi>
278 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
279 @author Tiago Falcão <tiago@@profusion.mobi>
280 @author Otavio Pontes <otavio@@profusion.mobi>
281 @author Viktor Kojouharov <vkojouharov@@gmail.com>
282 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
283 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
284 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
285 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
286 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
287 @author Jihoon Kim <jihoon48.kim@@samsung.com>
288 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
289 @author Tom Hacohen <tom@@stosb.com>
290 @author Aharon Hillel <a.hillel@@partner.samsung.com>
291 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
292 @author Shinwoo Kim <kimcinoo@@gmail.com>
293 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
294 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
295 @author Sung W. Park <sungwoo@gmail.com>
296 @author Thierry el Borgi <thierry@substantiel.fr>
297 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
298 @author Chanwook Jung <joey.jung@samsung.com>
299 @author Hyoyoung Chang <hyoyoung.chang@samsung.com>
300 @author Guillaume "Kuri" Friloux <guillaume.friloux@asp64.com>
301 @author Kim Yunhan <spbear@gmail.com>
303 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
304 contact with the developers and maintainers.
312 * @brief Elementary's API
317 @ELM_UNIX_DEF@ ELM_UNIX
318 @ELM_WIN32_DEF@ ELM_WIN32
319 @ELM_WINCE_DEF@ ELM_WINCE
320 @ELM_EDBUS_DEF@ ELM_EDBUS
321 @ELM_EFREET_DEF@ ELM_EFREET
322 @ELM_ETHUMB_DEF@ ELM_ETHUMB
323 @ELM_WEB_DEF@ ELM_WEB
324 @ELM_EMAP_DEF@ ELM_EMAP
325 @ELM_DEBUG_DEF@ ELM_DEBUG
326 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
327 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
329 /* Standard headers for standard system calls etc. */
334 #include <sys/types.h>
335 #include <sys/stat.h>
336 #include <sys/time.h>
337 #include <sys/param.h>
350 # ifdef ELM_LIBINTL_H
351 # include <libintl.h>
362 #if defined (ELM_WIN32) || defined (ELM_WINCE)
365 # define alloca _alloca
376 #include <Ecore_Evas.h>
377 #include <Ecore_File.h>
378 #include <Ecore_IMF.h>
379 #include <Ecore_Con.h>
388 # include <Efreet_Mime.h>
389 # include <Efreet_Trash.h>
393 # include <Ethumb_Client.h>
405 # ifdef ELEMENTARY_BUILD
407 # define EAPI __declspec(dllexport)
410 # endif /* ! DLL_EXPORT */
412 # define EAPI __declspec(dllimport)
413 # endif /* ! EFL_EVAS_BUILD */
417 # define EAPI __attribute__ ((visibility("default")))
424 #endif /* ! _WIN32 */
429 # define EAPI_MAIN EAPI
432 /* allow usage from c++ */
437 #define ELM_VERSION_MAJOR @VMAJ@
438 #define ELM_VERSION_MINOR @VMIN@
440 typedef struct _Elm_Version
448 EAPI extern Elm_Version *elm_version;
451 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
452 #define ELM_PI 3.14159265358979323846
455 * @defgroup General General
457 * @brief General Elementary API. Functions that don't relate to
458 * Elementary objects specifically.
460 * Here are documented functions which init/shutdown the library,
461 * that apply to generic Elementary objects, that deal with
462 * configuration, et cetera.
464 * @ref general_functions_example_page "This" example contemplates
465 * some of these functions.
469 * @addtogroup General
474 * Defines couple of standard Evas_Object layers to be used
475 * with evas_object_layer_set().
477 * @note whenever extending with new values, try to keep some padding
478 * to siblings so there is room for further extensions.
480 typedef enum _Elm_Object_Layer
482 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
483 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
484 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
485 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
486 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
487 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
490 /**************************************************************************/
491 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
494 * Emitted when the application has reconfigured elementary settings due
495 * to an external configuration tool asking it to.
497 EAPI extern int ELM_EVENT_CONFIG_ALL_CHANGED;
500 * Emitted when any Elementary's policy value is changed.
502 EAPI extern int ELM_EVENT_POLICY_CHANGED;
505 * @typedef Elm_Event_Policy_Changed
507 * Data on the event when an Elementary policy has changed
509 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
512 * @struct _Elm_Event_Policy_Changed
514 * Data on the event when an Elementary policy has changed
516 struct _Elm_Event_Policy_Changed
518 unsigned int policy; /**< the policy identifier */
519 int new_value; /**< value the policy had before the change */
520 int old_value; /**< new value the policy got */
524 * Policy identifiers.
526 typedef enum _Elm_Policy
528 ELM_POLICY_QUIT, /**< under which circumstances the application
529 * should quit automatically. @see
533 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
536 typedef enum _Elm_Policy_Quit
538 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
540 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
542 * window is closed */
543 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
545 typedef enum _Elm_Focus_Direction
549 } Elm_Focus_Direction;
551 typedef enum _Elm_Text_Format
553 ELM_TEXT_FORMAT_PLAIN_UTF8,
554 ELM_TEXT_FORMAT_MARKUP_UTF8
558 * Line wrapping types.
560 typedef enum _Elm_Wrap_Type
562 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
563 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
564 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
565 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
571 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
572 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
573 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
574 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
575 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
576 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
577 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
578 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
579 ELM_INPUT_PANEL_LAYOUT_INVALID
580 } Elm_Input_Panel_Layout;
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 #ELM_POLICY_QUIT on your Elementary
690 * applications, you'll 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 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, on 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 handle 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 handle 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 set 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
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 wiget 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
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 * Add @p subobj as a resize object of window @p obj.
3806 * Setting an object as a resize object of the window means that the
3807 * @p subobj child's size and position will be controlled by the window
3808 * directly. That is, the object will be resized to match the window size
3809 * and should never be moved or resized manually by the developer.
3811 * In addition, resize objects of the window control what the minimum size
3812 * of it will be, as well as whether it can or not be resized by the user.
3814 * For the end user to be able to resize a window by dragging the handles
3815 * or borders provided by the Window Manager, or using any other similar
3816 * mechanism, all of the resize objects in the window should have their
3817 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3819 * @param obj The window object
3820 * @param subobj The resize object to add
3822 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3824 * Delete @p subobj as a resize object of window @p obj.
3826 * This function removes the object @p subobj from the resize objects of
3827 * the window @p obj. It will not delete the object itself, which will be
3828 * left unmanaged and should be deleted by the developer, manually handled
3829 * or set as child of some other container.
3831 * @param obj The window object
3832 * @param subobj The resize object to add
3834 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3836 * Set the title of the window
3838 * @param obj The window object
3839 * @param title The title to set
3841 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3843 * Get the title of the window
3845 * The returned string is an internal one and should not be freed or
3846 * modified. It will also be rendered invalid if a new title is set or if
3847 * the window is destroyed.
3849 * @param obj The window object
3852 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3854 * Set the window's autodel state.
3856 * When closing the window in any way outside of the program control, like
3857 * pressing the X button in the titlebar or using a command from the
3858 * Window Manager, a "delete,request" signal is emitted to indicate that
3859 * this event occurred and the developer can take any action, which may
3860 * include, or not, destroying the window object.
3862 * When the @p autodel parameter is set, the window will be automatically
3863 * destroyed when this event occurs, after the signal is emitted.
3864 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3865 * and is up to the program to do so when it's required.
3867 * @param obj The window object
3868 * @param autodel If true, the window will automatically delete itself when
3871 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3873 * Get the window's autodel state.
3875 * @param obj The window object
3876 * @return If the window will automatically delete itself when closed
3878 * @see elm_win_autodel_set()
3880 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3882 * Activate a window object.
3884 * This function sends a request to the Window Manager to activate the
3885 * window pointed by @p obj. If honored by the WM, the window will receive
3886 * the keyboard focus.
3888 * @note This is just a request that a Window Manager may ignore, so calling
3889 * this function does not ensure in any way that the window will be the
3890 * active one after it.
3892 * @param obj The window object
3894 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3896 * Lower a window object.
3898 * Places the window pointed by @p obj at the bottom of the stack, so that
3899 * no other window is covered by it.
3901 * If elm_win_override_set() is not set, the Window Manager may ignore this
3904 * @param obj The window object
3906 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3908 * Raise a window object.
3910 * Places the window pointed by @p obj at the top of the stack, so that it's
3911 * not covered by any other window.
3913 * If elm_win_override_set() is not set, the Window Manager may ignore this
3916 * @param obj The window object
3918 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3920 * Set the borderless state of a window.
3922 * This function requests the Window Manager to not draw any decoration
3923 * around the window.
3925 * @param obj The window object
3926 * @param borderless If true, the window is borderless
3928 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3930 * Get the borderless state of a window.
3932 * @param obj The window object
3933 * @return If true, the window is borderless
3935 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3937 * Set the shaped state of a window.
3939 * Shaped windows, when supported, will render the parts of the window that
3940 * has no content, transparent.
3942 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3943 * background object or cover the entire window in any other way, or the
3944 * parts of the canvas that have no data will show framebuffer artifacts.
3946 * @param obj The window object
3947 * @param shaped If true, the window is shaped
3949 * @see elm_win_alpha_set()
3951 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3953 * Get the shaped state of a window.
3955 * @param obj The window object
3956 * @return If true, the window is shaped
3958 * @see elm_win_shaped_set()
3960 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3962 * Set the alpha channel state of a window.
3964 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3965 * possibly making parts of the window completely or partially transparent.
3966 * This is also subject to the underlying system supporting it, like for
3967 * example, running under a compositing manager. If no compositing is
3968 * available, enabling this option will instead fallback to using shaped
3969 * windows, with elm_win_shaped_set().
3971 * @param obj The window object
3972 * @param alpha If true, the window has an alpha channel
3974 * @see elm_win_alpha_set()
3976 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3978 * Get the transparency state of a window.
3980 * @param obj The window object
3981 * @return If true, the window is transparent
3983 * @see elm_win_transparent_set()
3985 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3987 * Set the transparency state of a window.
3989 * Use elm_win_alpha_set() instead.
3991 * @param obj The window object
3992 * @param transparent If true, the window is transparent
3994 * @see elm_win_alpha_set()
3996 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3998 * Get the alpha channel state of a window.
4000 * @param obj The window object
4001 * @return If true, the window has an alpha channel
4003 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4005 * Set the override state of a window.
4007 * A window with @p override set to EINA_TRUE will not be managed by the
4008 * Window Manager. This means that no decorations of any kind will be shown
4009 * for it, moving and resizing must be handled by the application, as well
4010 * as the window visibility.
4012 * This should not be used for normal windows, and even for not so normal
4013 * ones, it should only be used when there's a good reason and with a lot
4014 * of care. Mishandling override windows may result situations that
4015 * disrupt the normal workflow of the end user.
4017 * @param obj The window object
4018 * @param override If true, the window is overridden
4020 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4022 * Get the override state of a window.
4024 * @param obj The window object
4025 * @return If true, the window is overridden
4027 * @see elm_win_override_set()
4029 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4031 * Set the fullscreen state of a window.
4033 * @param obj The window object
4034 * @param fullscreen If true, the window is fullscreen
4036 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4038 * Get the fullscreen state of a window.
4040 * @param obj The window object
4041 * @return If true, the window is fullscreen
4043 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4045 * Set the maximized state of a window.
4047 * @param obj The window object
4048 * @param maximized If true, the window is maximized
4050 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4052 * Get the maximized state of a window.
4054 * @param obj The window object
4055 * @return If true, the window is maximized
4057 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4059 * Set the iconified state of a window.
4061 * @param obj The window object
4062 * @param iconified If true, the window is iconified
4064 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4066 * Get the iconified state of a window.
4068 * @param obj The window object
4069 * @return If true, the window is iconified
4071 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4073 * Set the layer of the window.
4075 * What this means exactly will depend on the underlying engine used.
4077 * In the case of X11 backed engines, the value in @p layer has the
4078 * following meanings:
4079 * @li < 3: The window will be placed below all others.
4080 * @li > 5: The window will be placed above all others.
4081 * @li other: The window will be placed in the default layer.
4083 * @param obj The window object
4084 * @param layer The layer of the window
4086 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4088 * Get the layer of the window.
4090 * @param obj The window object
4091 * @return The layer of the window
4093 * @see elm_win_layer_set()
4095 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4097 * Set the rotation of the window.
4099 * Most engines only work with multiples of 90.
4101 * This function is used to set the orientation of the window @p obj to
4102 * match that of the screen. The window itself will be resized to adjust
4103 * to the new geometry of its contents. If you want to keep the window size,
4104 * see elm_win_rotation_with_resize_set().
4106 * @param obj The window object
4107 * @param rotation The rotation of the window, in degrees (0-360),
4108 * counter-clockwise.
4110 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4112 * Rotates the window and resizes it.
4114 * Like elm_win_rotation_set(), but it also resizes the window's contents so
4115 * that they fit inside the current window geometry.
4117 * @param obj The window object
4118 * @param layer The rotation of the window in degrees (0-360),
4119 * counter-clockwise.
4121 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4123 * Get the rotation of the window.
4125 * @param obj The window object
4126 * @return The rotation of the window in degrees (0-360)
4128 * @see elm_win_rotation_set()
4129 * @see elm_win_rotation_with_resize_set()
4131 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4133 * Set the sticky state of the window.
4135 * Hints the Window Manager that the window in @p obj should be left fixed
4136 * at its position even when the virtual desktop it's on moves or changes.
4138 * @param obj The window object
4139 * @param sticky If true, the window's sticky state is enabled
4141 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4143 * Get the sticky state of the window.
4145 * @param obj The window object
4146 * @return If true, the window's sticky state is enabled
4148 * @see elm_win_sticky_set()
4150 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4152 * Set if this window is an illume conformant window
4154 * @param obj The window object
4155 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4157 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4159 * Get if this window is an illume conformant window
4161 * @param obj The window object
4162 * @return A boolean if this window is illume conformant or not
4164 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4166 * Set a window to be an illume quickpanel window
4168 * By default window objects are not quickpanel windows.
4170 * @param obj The window object
4171 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4173 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4175 * Get if this window is a quickpanel or not
4177 * @param obj The window object
4178 * @return A boolean if this window is a quickpanel or not
4180 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4182 * Set the major priority of a quickpanel window
4184 * @param obj The window object
4185 * @param priority The major priority for this quickpanel
4187 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4189 * Get the major priority of a quickpanel window
4191 * @param obj The window object
4192 * @return The major priority of this quickpanel
4194 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4196 * Set the minor priority of a quickpanel window
4198 * @param obj The window object
4199 * @param priority The minor priority for this quickpanel
4201 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4203 * Get the minor priority of a quickpanel window
4205 * @param obj The window object
4206 * @return The minor priority of this quickpanel
4208 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4210 * Set which zone this quickpanel should appear in
4212 * @param obj The window object
4213 * @param zone The requested zone for this quickpanel
4215 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4217 * Get which zone this quickpanel should appear in
4219 * @param obj The window object
4220 * @return The requested zone for this quickpanel
4222 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4224 * Set the window to be skipped by keyboard focus
4226 * This sets the window to be skipped by normal keyboard input. This means
4227 * a window manager will be asked to not focus this window as well as omit
4228 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4230 * Call this and enable it on a window BEFORE you show it for the first time,
4231 * otherwise it may have no effect.
4233 * Use this for windows that have only output information or might only be
4234 * interacted with by the mouse or fingers, and never for typing input.
4235 * Be careful that this may have side-effects like making the window
4236 * non-accessible in some cases unless the window is specially handled. Use
4239 * @param obj The window object
4240 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4242 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4244 * Send a command to the windowing environment
4246 * This is intended to work in touchscreen or small screen device
4247 * environments where there is a more simplistic window management policy in
4248 * place. This uses the window object indicated to select which part of the
4249 * environment to control (the part that this window lives in), and provides
4250 * a command and an optional parameter structure (use NULL for this if not
4253 * @param obj The window object that lives in the environment to control
4254 * @param command The command to send
4255 * @param params Optional parameters for the command
4257 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4259 * Get the inlined image object handle
4261 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4262 * then the window is in fact an evas image object inlined in the parent
4263 * canvas. You can get this object (be careful to not manipulate it as it
4264 * is under control of elementary), and use it to do things like get pixel
4265 * data, save the image to a file, etc.
4267 * @param obj The window object to get the inlined image from
4268 * @return The inlined image object, or NULL if none exists
4270 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4272 * Set the enabled status for the focus highlight in a window
4274 * This function will enable or disable the focus highlight only for the
4275 * given window, regardless of the global setting for it
4277 * @param obj The window where to enable the highlight
4278 * @param enabled The enabled value for the highlight
4280 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4282 * Get the enabled value of the focus highlight for this window
4284 * @param obj The window in which to check if the focus highlight is enabled
4286 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4288 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4290 * Set the style for the focus highlight on this window
4292 * Sets the style to use for theming the highlight of focused objects on
4293 * the given window. If @p style is NULL, the default will be used.
4295 * @param obj The window where to set the style
4296 * @param style The style to set
4298 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4300 * Get the style set for the focus highlight object
4302 * Gets the style set for this windows highilght object, or NULL if none
4305 * @param obj The window to retrieve the highlights style from
4307 * @return The style set or NULL if none was. Default is used in that case.
4309 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4311 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4312 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4313 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4314 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4315 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4316 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4317 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4319 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4320 * (blank mouse, private mouse obj, defaultmouse)
4324 * Sets the keyboard mode of the window.
4326 * @param obj The window object
4327 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4329 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4331 * Gets the keyboard mode of the window.
4333 * @param obj The window object
4334 * @return The mode, one of #Elm_Win_Keyboard_Mode
4336 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4338 * Sets whether the window is a keyboard.
4340 * @param obj The window object
4341 * @param is_keyboard If true, the window is a virtual keyboard
4343 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4345 * Gets whether the window is a keyboard.
4347 * @param obj The window object
4348 * @return If the window is a virtual keyboard
4350 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4353 * Get the screen position of a window.
4355 * @param obj The window object
4356 * @param x The int to store the x coordinate to
4357 * @param y The int to store the y coordinate to
4359 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4365 * @defgroup Inwin Inwin
4367 * @image html img/widget/inwin/preview-00.png
4368 * @image latex img/widget/inwin/preview-00.eps
4369 * @image html img/widget/inwin/preview-01.png
4370 * @image latex img/widget/inwin/preview-01.eps
4371 * @image html img/widget/inwin/preview-02.png
4372 * @image latex img/widget/inwin/preview-02.eps
4374 * An inwin is a window inside a window that is useful for a quick popup.
4375 * It does not hover.
4377 * It works by creating an object that will occupy the entire window, so it
4378 * must be created using an @ref Win "elm_win" as parent only. The inwin
4379 * object can be hidden or restacked below every other object if it's
4380 * needed to show what's behind it without destroying it. If this is done,
4381 * the elm_win_inwin_activate() function can be used to bring it back to
4382 * full visibility again.
4384 * There are three styles available in the default theme. These are:
4385 * @li default: The inwin is sized to take over most of the window it's
4387 * @li minimal: The size of the inwin will be the minimum necessary to show
4389 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4390 * possible, but it's sized vertically the most it needs to fit its\
4393 * Some examples of Inwin can be found in the following:
4394 * @li @ref inwin_example_01
4399 * Adds an inwin to the current window
4401 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4402 * Never call this function with anything other than the top-most window
4403 * as its parameter, unless you are fond of undefined behavior.
4405 * After creating the object, the widget will set itself as resize object
4406 * for the window with elm_win_resize_object_add(), so when shown it will
4407 * appear to cover almost the entire window (how much of it depends on its
4408 * content and the style used). It must not be added into other container
4409 * objects and it needs not be moved or resized manually.
4411 * @param parent The parent object
4412 * @return The new object or NULL if it cannot be created
4414 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4416 * Activates an inwin object, ensuring its visibility
4418 * This function will make sure that the inwin @p obj is completely visible
4419 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4420 * to the front. It also sets the keyboard focus to it, which will be passed
4423 * The object's theme will also receive the signal "elm,action,show" with
4426 * @param obj The inwin to activate
4428 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4430 * Set the content of an inwin object.
4432 * Once the content object is set, a previously set one will be deleted.
4433 * If you want to keep that old content object, use the
4434 * elm_win_inwin_content_unset() function.
4436 * @param obj The inwin object
4437 * @param content The object to set as content
4439 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4441 * Get the content of an inwin object.
4443 * Return the content object which is set for this widget.
4445 * The returned object is valid as long as the inwin is still alive and no
4446 * other content is set on it. Deleting the object will notify the inwin
4447 * about it and this one will be left empty.
4449 * If you need to remove an inwin's content to be reused somewhere else,
4450 * see elm_win_inwin_content_unset().
4452 * @param obj The inwin object
4453 * @return The content that is being used
4455 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4457 * Unset the content of an inwin object.
4459 * Unparent and return the content object which was set for this widget.
4461 * @param obj The inwin object
4462 * @return The content that was being used
4464 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4468 /* X specific calls - won't work on non-x engines (return 0) */
4471 * Get the Ecore_X_Window of an Evas_Object
4473 * @param obj The object
4475 * @return The Ecore_X_Window of @p obj
4479 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4481 /* smart callbacks called:
4482 * "delete,request" - the user requested to delete the window
4483 * "focus,in" - window got focus
4484 * "focus,out" - window lost focus
4485 * "moved" - window that holds the canvas was moved
4491 * @image html img/widget/bg/preview-00.png
4492 * @image latex img/widget/bg/preview-00.eps
4494 * @brief Background object, used for setting a solid color, image or Edje
4495 * group as background to a window or any container object.
4497 * The bg object is used for setting a solid background to a window or
4498 * packing into any container object. It works just like an image, but has
4499 * some properties useful to a background, like setting it to tiled,
4500 * centered, scaled or stretched.
4502 * Here is some sample code using it:
4503 * @li @ref bg_01_example_page
4504 * @li @ref bg_02_example_page
4505 * @li @ref bg_03_example_page
4509 typedef enum _Elm_Bg_Option
4511 ELM_BG_OPTION_CENTER, /**< center the background */
4512 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4513 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4514 ELM_BG_OPTION_TILE /**< tile background at its original size */
4518 * Add a new background to the parent
4520 * @param parent The parent object
4521 * @return The new object or NULL if it cannot be created
4525 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4528 * Set the file (image or edje) used for the background
4530 * @param obj The bg object
4531 * @param file The file path
4532 * @param group Optional key (group in Edje) within the file
4534 * This sets the image file used in the background object. The image (or edje)
4535 * will be stretched (retaining aspect if its an image file) to completely fill
4536 * the bg object. This may mean some parts are not visible.
4538 * @note Once the image of @p obj is set, a previously set one will be deleted,
4539 * even if @p file is NULL.
4543 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4546 * Get the file (image or edje) used for the background
4548 * @param obj The bg object
4549 * @param file The file path
4550 * @param group Optional key (group in Edje) within the file
4554 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4557 * Set the option used for the background image
4559 * @param obj The bg object
4560 * @param option The desired background option (TILE, SCALE)
4562 * This sets the option used for manipulating the display of the background
4563 * image. The image can be tiled or scaled.
4567 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4570 * Get the option used for the background image
4572 * @param obj The bg object
4573 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4577 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4579 * Set the option used for the background color
4581 * @param obj The bg object
4586 * This sets the color used for the background rectangle. Its range goes
4591 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4593 * Get the option used for the background color
4595 * @param obj The bg object
4602 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4605 * Set the overlay object used for the background object.
4607 * @param obj The bg object
4608 * @param overlay The overlay object
4610 * This provides a way for elm_bg to have an 'overlay' that will be on top
4611 * of the bg. Once the over object is set, a previously set one will be
4612 * deleted, even if you set the new one to NULL. If you want to keep that
4613 * old content object, use the elm_bg_overlay_unset() function.
4618 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4621 * Get the overlay object used for the background object.
4623 * @param obj The bg object
4624 * @return The content that is being used
4626 * Return the content object which is set for this widget
4630 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4633 * Get the overlay object used for the background object.
4635 * @param obj The bg object
4636 * @return The content that was being used
4638 * Unparent and return the overlay object which was set for this widget
4642 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4645 * Set the size of the pixmap representation of the image.
4647 * This option just makes sense if an image is going to be set in the bg.
4649 * @param obj The bg object
4650 * @param w The new width of the image pixmap representation.
4651 * @param h The new height of the image pixmap representation.
4653 * This function sets a new size for pixmap representation of the given bg
4654 * image. It allows the image to be loaded already in the specified size,
4655 * reducing the memory usage and load time when loading a big image with load
4656 * size set to a smaller size.
4658 * NOTE: this is just a hint, the real size of the pixmap may differ
4659 * depending on the type of image being loaded, being bigger than requested.
4663 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4664 /* smart callbacks called:
4668 * @defgroup Icon Icon
4670 * @image html img/widget/icon/preview-00.png
4671 * @image latex img/widget/icon/preview-00.eps
4673 * An object that provides standard icon images (delete, edit, arrows, etc.)
4674 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4676 * The icon image requested can be in the elementary theme, or in the
4677 * freedesktop.org paths. It's possible to set the order of preference from
4678 * where the image will be used.
4680 * This API is very similar to @ref Image, but with ready to use images.
4682 * Default images provided by the theme are described below.
4684 * The first list contains icons that were first intended to be used in
4685 * toolbars, but can be used in many other places too:
4701 * Now some icons that were designed to be used in menus (but again, you can
4702 * use them anywhere else):
4707 * @li menu/arrow_down
4708 * @li menu/arrow_left
4709 * @li menu/arrow_right
4718 * And here we have some media player specific icons:
4719 * @li media_player/forward
4720 * @li media_player/info
4721 * @li media_player/next
4722 * @li media_player/pause
4723 * @li media_player/play
4724 * @li media_player/prev
4725 * @li media_player/rewind
4726 * @li media_player/stop
4728 * Signals that you can add callbacks for are:
4730 * "clicked" - This is called when a user has clicked the icon
4732 * An example of usage for this API follows:
4733 * @li @ref tutorial_icon
4741 typedef enum _Elm_Icon_Type
4748 * @enum _Elm_Icon_Lookup_Order
4749 * @typedef Elm_Icon_Lookup_Order
4751 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4752 * theme, FDO paths, or both?
4756 typedef enum _Elm_Icon_Lookup_Order
4758 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4759 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4760 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4761 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4762 } Elm_Icon_Lookup_Order;
4765 * Add a new icon object to the parent.
4767 * @param parent The parent object
4768 * @return The new object or NULL if it cannot be created
4770 * @see elm_icon_file_set()
4774 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4776 * Set the file that will be used as icon.
4778 * @param obj The icon object
4779 * @param file The path to file that will be used as icon image
4780 * @param group The group that the icon belongs to in edje file
4782 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4784 * @note The icon image set by this function can be changed by
4785 * elm_icon_standard_set().
4787 * @see elm_icon_file_get()
4791 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4793 * Set a location in memory to be used as an icon
4795 * @param obj The icon object
4796 * @param img The binary data that will be used as an image
4797 * @param size The size of binary data @p img
4798 * @param format Optional format of @p img to pass to the image loader
4799 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is 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().
4808 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);
4810 * Get the file that will be used as icon.
4812 * @param obj The icon object
4813 * @param file The path to file that will be used as icon icon image
4814 * @param group The group that the icon belongs to in edje file
4816 * @see elm_icon_file_set()
4820 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4821 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4823 * Set the icon by icon standards names.
4825 * @param obj The icon object
4826 * @param name The icon name
4828 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4830 * For example, freedesktop.org defines standard icon names such as "home",
4831 * "network", etc. There can be different icon sets to match those icon
4832 * keys. The @p name given as parameter is one of these "keys", and will be
4833 * used to look in the freedesktop.org paths and elementary theme. One can
4834 * change the lookup order with elm_icon_order_lookup_set().
4836 * If name is not found in any of the expected locations and it is the
4837 * absolute path of an image file, this image will be used.
4839 * @note The icon image set by this function can be changed by
4840 * elm_icon_file_set().
4842 * @see elm_icon_standard_get()
4843 * @see elm_icon_file_set()
4847 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4849 * Get the icon name set by icon standard names.
4851 * @param obj The icon object
4852 * @return The icon name
4854 * If the icon image was set using elm_icon_file_set() instead of
4855 * elm_icon_standard_set(), then this function will return @c NULL.
4857 * @see elm_icon_standard_set()
4861 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4863 * Set the smooth effect for an icon object.
4865 * @param obj The icon object
4866 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4867 * otherwise. Default is @c EINA_TRUE.
4869 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4870 * scaling provides a better resulting image, but is slower.
4872 * The smooth scaling should be disabled when making animations that change
4873 * the icon size, since they will be faster. Animations that don't require
4874 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4875 * is already scaled, since the scaled icon image will be cached).
4877 * @see elm_icon_smooth_get()
4881 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4883 * Get the smooth effect for an icon object.
4885 * @param obj The icon object
4886 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4888 * @see elm_icon_smooth_set()
4892 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4894 * Disable scaling of this object.
4896 * @param obj The icon object.
4897 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4898 * otherwise. Default is @c EINA_FALSE.
4900 * This function disables scaling of the icon object through the function
4901 * elm_object_scale_set(). However, this does not affect the object
4902 * size/resize in any way. For that effect, take a look at
4903 * elm_icon_scale_set().
4905 * @see elm_icon_no_scale_get()
4906 * @see elm_icon_scale_set()
4907 * @see elm_object_scale_set()
4911 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4913 * Get whether scaling is disabled on the object.
4915 * @param obj The icon object
4916 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4918 * @see elm_icon_no_scale_set()
4922 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4924 * Set if the object is (up/down) resizable.
4926 * @param obj The icon object
4927 * @param scale_up A bool to set if the object is resizable up. Default is
4929 * @param scale_down A bool to set if the object is resizable down. Default
4932 * This function limits the icon object resize ability. If @p scale_up is set to
4933 * @c EINA_FALSE, the object can't have its height or width resized to a value
4934 * higher than the original icon size. Same is valid for @p scale_down.
4936 * @see elm_icon_scale_get()
4940 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4942 * Get if the object is (up/down) resizable.
4944 * @param obj The icon object
4945 * @param scale_up A bool to set if the object is resizable up
4946 * @param scale_down A bool to set if the object is resizable down
4948 * @see elm_icon_scale_set()
4952 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4954 * Get the object's image size
4956 * @param obj The icon object
4957 * @param w A pointer to store the width in
4958 * @param h A pointer to store the height in
4962 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4964 * Set if the icon fill the entire object area.
4966 * @param obj The icon object
4967 * @param fill_outside @c EINA_TRUE if the object is filled outside,
4968 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4970 * When the icon object is resized to a different aspect ratio from the
4971 * original icon image, the icon image will still keep its aspect. This flag
4972 * tells how the image should fill the object's area. They are: keep the
4973 * entire icon inside the limits of height and width of the object (@p
4974 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4975 * of the object, and the icon will fill the entire object (@p fill_outside
4978 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4979 * retain property to false. Thus, the icon image will always keep its
4980 * original aspect ratio.
4982 * @see elm_icon_fill_outside_get()
4983 * @see elm_image_fill_outside_set()
4987 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4989 * Get if the object is filled outside.
4991 * @param obj The icon object
4992 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4994 * @see elm_icon_fill_outside_set()
4998 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5000 * Set the prescale size for the icon.
5002 * @param obj The icon object
5003 * @param size The prescale size. This value is used for both width and
5006 * This function sets a new size for pixmap representation of the given
5007 * icon. It allows the icon to be loaded already in the specified size,
5008 * reducing the memory usage and load time when loading a big icon with load
5009 * size set to a smaller size.
5011 * It's equivalent to the elm_bg_load_size_set() function for bg.
5013 * @note this is just a hint, the real size of the pixmap may differ
5014 * depending on the type of icon being loaded, being bigger than requested.
5016 * @see elm_icon_prescale_get()
5017 * @see elm_bg_load_size_set()
5021 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5023 * Get the prescale size for the icon.
5025 * @param obj The icon object
5026 * @return The prescale size
5028 * @see elm_icon_prescale_set()
5032 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5034 * Sets the icon lookup order used by elm_icon_standard_set().
5036 * @param obj The icon object
5037 * @param order The icon lookup order (can be one of
5038 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5039 * or ELM_ICON_LOOKUP_THEME)
5041 * @see elm_icon_order_lookup_get()
5042 * @see Elm_Icon_Lookup_Order
5046 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5048 * Gets the icon lookup order.
5050 * @param obj The icon object
5051 * @return The icon lookup order
5053 * @see elm_icon_order_lookup_set()
5054 * @see Elm_Icon_Lookup_Order
5058 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5060 * Get if the icon supports animation or not.
5062 * @param obj The icon object
5063 * @return @c EINA_TRUE if the icon supports animation,
5064 * @c EINA_FALSE otherwise.
5066 * Return if this elm icon's image can be animated. Currently Evas only
5067 * supports gif animation. If the return value is EINA_FALSE, other
5068 * elm_icon_animated_XXX APIs won't work.
5071 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5073 * Set animation mode of the icon.
5075 * @param obj The icon object
5076 * @param anim @c EINA_TRUE if the object do animation job,
5077 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5079 * Even though elm icon's file can be animated,
5080 * sometimes appication developer want to just first page of image.
5081 * In that time, don't call this function, because default value is EINA_FALSE
5082 * Only when you want icon support anition,
5083 * use this function and set animated to EINA_TURE
5086 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5088 * Get animation mode of the icon.
5090 * @param obj The icon object
5091 * @return The animation mode of the icon object
5092 * @see elm_icon_animated_set
5095 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5097 * Set animation play mode of the icon.
5099 * @param obj The icon object
5100 * @param play @c EINA_TRUE the object play animation images,
5101 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5103 * If you want to play elm icon's animation, you set play to EINA_TURE.
5104 * For example, you make gif player using this set/get API and click event.
5106 * 1. Click event occurs
5107 * 2. Check play flag using elm_icon_animaged_play_get
5108 * 3. If elm icon was playing, set play to EINA_FALSE.
5109 * Then animation will be stopped and vice versa
5112 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5114 * Get animation play mode of the icon.
5116 * @param obj The icon object
5117 * @return The play mode of the icon object
5119 * @see elm_icon_animated_lay_get
5122 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5129 * @defgroup Image Image
5131 * @image html img/widget/image/preview-00.png
5132 * @image latex img/widget/image/preview-00.eps
5135 * An object that allows one to load an image file to it. It can be used
5136 * anywhere like any other elementary widget.
5138 * This widget provides most of the functionality provided from @ref Bg or @ref
5139 * Icon, but with a slightly different API (use the one that fits better your
5142 * The features not provided by those two other image widgets are:
5143 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5144 * @li change the object orientation with elm_image_orient_set();
5145 * @li and turning the image editable with elm_image_editable_set().
5147 * Signals that you can add callbacks for are:
5149 * @li @c "clicked" - This is called when a user has clicked the image
5151 * An example of usage for this API follows:
5152 * @li @ref tutorial_image
5161 * @enum _Elm_Image_Orient
5162 * @typedef Elm_Image_Orient
5164 * Possible orientation options for elm_image_orient_set().
5166 * @image html elm_image_orient_set.png
5167 * @image latex elm_image_orient_set.eps width=\textwidth
5171 typedef enum _Elm_Image_Orient
5173 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5174 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5175 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5176 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5177 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5178 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5179 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5180 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5184 * Add a new image to the parent.
5186 * @param parent The parent object
5187 * @return The new object or NULL if it cannot be created
5189 * @see elm_image_file_set()
5193 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5195 * Set the file that will be used as image.
5197 * @param obj The image object
5198 * @param file The path to file that will be used as image
5199 * @param group The group that the image belongs in edje file (if it's an
5202 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5204 * @see elm_image_file_get()
5208 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5210 * Get the file that will be used as image.
5212 * @param obj The image object
5213 * @param file The path to file
5214 * @param group The group that the image belongs in edje file
5216 * @see elm_image_file_set()
5220 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5222 * Set the smooth effect for an image.
5224 * @param obj The image object
5225 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5226 * otherwise. Default is @c EINA_TRUE.
5228 * Set the scaling algorithm to be used when scaling the image. Smooth
5229 * scaling provides a better resulting image, but is slower.
5231 * The smooth scaling should be disabled when making animations that change
5232 * the image size, since it will be faster. Animations that don't require
5233 * resizing of the image can keep the smooth scaling enabled (even if the
5234 * image is already scaled, since the scaled image will be cached).
5236 * @see elm_image_smooth_get()
5240 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5242 * Get the smooth effect for an image.
5244 * @param obj The image object
5245 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5247 * @see elm_image_smooth_get()
5251 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5253 * Gets the current size of the image.
5255 * @param obj The image object.
5256 * @param w Pointer to store width, or NULL.
5257 * @param h Pointer to store height, or NULL.
5259 * This is the real size of the image, not the size of the object.
5261 * On error, neither w or h will be written.
5265 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5267 * Disable scaling of this object.
5269 * @param obj The image object.
5270 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5271 * otherwise. Default is @c EINA_FALSE.
5273 * This function disables scaling of the elm_image widget through the
5274 * function elm_object_scale_set(). However, this does not affect the widget
5275 * size/resize in any way. For that effect, take a look at
5276 * elm_image_scale_set().
5278 * @see elm_image_no_scale_get()
5279 * @see elm_image_scale_set()
5280 * @see elm_object_scale_set()
5284 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5286 * Get whether scaling is disabled on the object.
5288 * @param obj The image object
5289 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5291 * @see elm_image_no_scale_set()
5295 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5297 * Set if the object is (up/down) resizable.
5299 * @param obj The image object
5300 * @param scale_up A bool to set if the object is resizable up. Default is
5302 * @param scale_down A bool to set if the object is resizable down. Default
5305 * This function limits the image resize ability. If @p scale_up is set to
5306 * @c EINA_FALSE, the object can't have its height or width resized to a value
5307 * higher than the original image size. Same is valid for @p scale_down.
5309 * @see elm_image_scale_get()
5313 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5315 * Get if the object is (up/down) resizable.
5317 * @param obj The image object
5318 * @param scale_up A bool to set if the object is resizable up
5319 * @param scale_down A bool to set if the object is resizable down
5321 * @see elm_image_scale_set()
5325 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5327 * Set if the image fill the entire object area when keeping the aspect ratio.
5329 * @param obj The image object
5330 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5331 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5333 * When the image should keep its aspect ratio even if resized to another
5334 * aspect ratio, there are two possibilities to resize it: keep the entire
5335 * image inside the limits of height and width of the object (@p fill_outside
5336 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5337 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5339 * @note This option will have no effect if
5340 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5342 * @see elm_image_fill_outside_get()
5343 * @see elm_image_aspect_ratio_retained_set()
5347 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5349 * Get if the object is filled outside
5351 * @param obj The image object
5352 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5354 * @see elm_image_fill_outside_set()
5358 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5360 * Set the prescale size for the image
5362 * @param obj The image object
5363 * @param size The prescale size. This value is used for both width and
5366 * This function sets a new size for pixmap representation of the given
5367 * image. It allows the image to be loaded already in the specified size,
5368 * reducing the memory usage and load time when loading a big image with load
5369 * size set to a smaller size.
5371 * It's equivalent to the elm_bg_load_size_set() function for bg.
5373 * @note this is just a hint, the real size of the pixmap may differ
5374 * depending on the type of image being loaded, being bigger than requested.
5376 * @see elm_image_prescale_get()
5377 * @see elm_bg_load_size_set()
5381 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5383 * Get the prescale size for the image
5385 * @param obj The image object
5386 * @return The prescale size
5388 * @see elm_image_prescale_set()
5392 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5394 * Set the image orientation.
5396 * @param obj The image object
5397 * @param orient The image orientation
5398 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5399 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5400 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5401 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
5402 * Default is #ELM_IMAGE_ORIENT_NONE.
5404 * This function allows to rotate or flip the given image.
5406 * @see elm_image_orient_get()
5407 * @see @ref Elm_Image_Orient
5411 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5413 * Get the image orientation.
5415 * @param obj The image object
5416 * @return The image orientation
5417 * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5418 * #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5419 * #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5420 * #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
5422 * @see elm_image_orient_set()
5423 * @see @ref Elm_Image_Orient
5427 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5429 * Make the image 'editable'.
5431 * @param obj Image object.
5432 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5434 * This means the image is a valid drag target for drag and drop, and can be
5435 * cut or pasted too.
5439 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5441 * Make the image 'editable'.
5443 * @param obj Image object.
5444 * @return Editability.
5446 * This means the image is a valid drag target for drag and drop, and can be
5447 * cut or pasted too.
5451 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5453 * Get the basic Evas_Image object from this object (widget).
5455 * @param obj The image object to get the inlined image from
5456 * @return The inlined image object, or NULL if none exists
5458 * This function allows one to get the underlying @c Evas_Object of type
5459 * Image from this elementary widget. It can be useful to do things like get
5460 * the pixel data, save the image to a file, etc.
5462 * @note Be careful to not manipulate it, as it is under control of
5467 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5469 * Set whether the original aspect ratio of the image should be kept on resize.
5471 * @param obj The image object.
5472 * @param retained @c EINA_TRUE if the image should retain the aspect,
5473 * @c EINA_FALSE otherwise.
5475 * The original aspect ratio (width / height) of the image is usually
5476 * distorted to match the object's size. Enabling this option will retain
5477 * this original aspect, and the way that the image is fit into the object's
5478 * area depends on the option set by elm_image_fill_outside_set().
5480 * @see elm_image_aspect_ratio_retained_get()
5481 * @see elm_image_fill_outside_set()
5485 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5487 * Get if the object retains the original aspect ratio.
5489 * @param obj The image object.
5490 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5495 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5502 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5504 typedef enum _Elm_GLView_Mode
5506 ELM_GLVIEW_ALPHA = 1,
5507 ELM_GLVIEW_DEPTH = 2,
5508 ELM_GLVIEW_STENCIL = 4
5512 * Defines a policy for the glview resizing.
5514 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5516 typedef enum _Elm_GLView_Resize_Policy
5518 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5519 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5520 } Elm_GLView_Resize_Policy;
5522 typedef enum _Elm_GLView_Render_Policy
5524 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5525 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5526 } Elm_GLView_Render_Policy;
5531 * A simple GLView widget that allows GL rendering.
5533 * Signals that you can add callbacks for are:
5539 * Add a new glview to the parent
5541 * @param parent The parent object
5542 * @return The new object or NULL if it cannot be created
5546 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5549 * Sets the size of the glview
5551 * @param obj The glview object
5552 * @param width width of the glview object
5553 * @param height height of the glview object
5557 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5560 * Gets the size of the glview.
5562 * @param obj The glview object
5563 * @param width width of the glview object
5564 * @param height height of the glview object
5566 * Note that this function returns the actual image size of the
5567 * glview. This means that when the scale policy is set to
5568 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5573 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5576 * Gets the gl api struct for gl rendering
5578 * @param obj The glview object
5579 * @return The api object or NULL if it cannot be created
5583 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5586 * Set the mode of the GLView. Supports Three simple modes.
5588 * @param obj The glview object
5589 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5590 * @return True if set properly.
5594 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5597 * Set the resize policy for the glview object.
5599 * @param obj The glview object.
5600 * @param policy The scaling policy.
5602 * By default, the resize policy is set to
5603 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5604 * destroys the previous surface and recreates the newly specified
5605 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5606 * however, glview only scales the image object and not the underlying
5611 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5614 * Set the render policy for the glview object.
5616 * @param obj The glview object.
5617 * @param policy The render policy.
5619 * By default, the render policy is set to
5620 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5621 * that during the render loop, glview is only redrawn if it needs
5622 * to be redrawn. (i.e. When it is visible) If the policy is set to
5623 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5624 * whether it is visible/need redrawing or not.
5628 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5631 * Set the init function that runs once in the main loop.
5633 * @param obj The glview object.
5634 * @param func The init function to be registered.
5636 * The registered init function gets called once during the render loop.
5640 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5643 * Set the render function that runs in the main loop.
5645 * @param obj The glview object.
5646 * @param func The delete function to be registered.
5648 * The registered del function gets called when GLView object is deleted.
5652 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5655 * Set the resize function that gets called when resize happens.
5657 * @param obj The glview object.
5658 * @param func The resize function to be registered.
5662 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5665 * Set the render function that runs in the main loop.
5667 * @param obj The glview object.
5668 * @param func The render function to be registered.
5672 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5675 * Notifies that there has been changes in the GLView.
5677 * @param obj The glview object.
5681 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5691 * @image html img/widget/box/preview-00.png
5692 * @image latex img/widget/box/preview-00.eps width=\textwidth
5694 * @image html img/box.png
5695 * @image latex img/box.eps width=\textwidth
5697 * A box arranges objects in a linear fashion, governed by a layout function
5698 * that defines the details of this arrangement.
5700 * By default, the box will use an internal function to set the layout to
5701 * a single row, either vertical or horizontal. This layout is affected
5702 * by a number of parameters, such as the homogeneous flag set by
5703 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5704 * elm_box_align_set() and the hints set to each object in the box.
5706 * For this default layout, it's possible to change the orientation with
5707 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5708 * placing its elements ordered from top to bottom. When horizontal is set,
5709 * the order will go from left to right. If the box is set to be
5710 * homogeneous, every object in it will be assigned the same space, that
5711 * of the largest object. Padding can be used to set some spacing between
5712 * the cell given to each object. The alignment of the box, set with
5713 * elm_box_align_set(), determines how the bounding box of all the elements
5714 * will be placed within the space given to the box widget itself.
5716 * The size hints of each object also affect how they are placed and sized
5717 * within the box. evas_object_size_hint_min_set() will give the minimum
5718 * size the object can have, and the box will use it as the basis for all
5719 * latter calculations. Elementary widgets set their own minimum size as
5720 * needed, so there's rarely any need to use it manually.
5722 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5723 * used to tell whether the object will be allocated the minimum size it
5724 * needs or if the space given to it should be expanded. It's important
5725 * to realize that expanding the size given to the object is not the same
5726 * thing as resizing the object. It could very well end being a small
5727 * widget floating in a much larger empty space. If not set, the weight
5728 * for objects will normally be 0.0 for both axis, meaning the widget will
5729 * not be expanded. To take as much space possible, set the weight to
5730 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5732 * Besides how much space each object is allocated, it's possible to control
5733 * how the widget will be placed within that space using
5734 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5735 * for both axis, meaning the object will be centered, but any value from
5736 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5737 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5738 * is -1.0, means the object will be resized to fill the entire space it
5741 * In addition, customized functions to define the layout can be set, which
5742 * allow the application developer to organize the objects within the box
5743 * in any number of ways.
5745 * The special elm_box_layout_transition() function can be used
5746 * to switch from one layout to another, animating the motion of the
5747 * children of the box.
5749 * @note Objects should not be added to box objects using _add() calls.
5751 * Some examples on how to use boxes follow:
5752 * @li @ref box_example_01
5753 * @li @ref box_example_02
5758 * @typedef Elm_Box_Transition
5760 * Opaque handler containing the parameters to perform an animated
5761 * transition of the layout the box uses.
5763 * @see elm_box_transition_new()
5764 * @see elm_box_layout_set()
5765 * @see elm_box_layout_transition()
5767 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5770 * Add a new box to the parent
5772 * By default, the box will be in vertical mode and non-homogeneous.
5774 * @param parent The parent object
5775 * @return The new object or NULL if it cannot be created
5777 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5779 * Set the horizontal orientation
5781 * By default, box object arranges their contents vertically from top to
5783 * By calling this function with @p horizontal as EINA_TRUE, the box will
5784 * become horizontal, arranging contents from left to right.
5786 * @note This flag is ignored if a custom layout function is set.
5788 * @param obj The box object
5789 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5790 * EINA_FALSE = vertical)
5792 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5794 * Get the horizontal orientation
5796 * @param obj The box object
5797 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5799 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5801 * Set the box to arrange its children homogeneously
5803 * If enabled, homogeneous layout makes all items the same size, according
5804 * to the size of the largest of its children.
5806 * @note This flag is ignored if a custom layout function is set.
5808 * @param obj The box object
5809 * @param homogeneous The homogeneous flag
5811 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5813 * Get whether the box is using homogeneous mode or not
5815 * @param obj The box object
5816 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5818 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5819 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5820 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5822 * Add an object to the beginning of the pack list
5824 * Pack @p subobj into the box @p obj, placing it first in the list of
5825 * children objects. The actual position the object will get on screen
5826 * depends on the layout used. If no custom layout is set, it will be at
5827 * the top or left, depending if the box is vertical or horizontal,
5830 * @param obj The box object
5831 * @param subobj The object to add to the box
5833 * @see elm_box_pack_end()
5834 * @see elm_box_pack_before()
5835 * @see elm_box_pack_after()
5836 * @see elm_box_unpack()
5837 * @see elm_box_unpack_all()
5838 * @see elm_box_clear()
5840 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5842 * Add an object at the end of the pack list
5844 * Pack @p subobj into the box @p obj, placing it last in the list of
5845 * children objects. The actual position the object will get on screen
5846 * depends on the layout used. If no custom layout is set, it will be at
5847 * the bottom or right, depending if the box is vertical or horizontal,
5850 * @param obj The box object
5851 * @param subobj The object to add to the box
5853 * @see elm_box_pack_start()
5854 * @see elm_box_pack_before()
5855 * @see elm_box_pack_after()
5856 * @see elm_box_unpack()
5857 * @see elm_box_unpack_all()
5858 * @see elm_box_clear()
5860 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5862 * Adds an object to the box before the indicated object
5864 * This will add the @p subobj to the box indicated before the object
5865 * indicated with @p before. If @p before is not already in the box, results
5866 * are undefined. Before means either to the left of the indicated object or
5867 * above it depending on orientation.
5869 * @param obj The box object
5870 * @param subobj The object to add to the box
5871 * @param before The object before which to add it
5873 * @see elm_box_pack_start()
5874 * @see elm_box_pack_end()
5875 * @see elm_box_pack_after()
5876 * @see elm_box_unpack()
5877 * @see elm_box_unpack_all()
5878 * @see elm_box_clear()
5880 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5882 * Adds an object to the box after the indicated object
5884 * This will add the @p subobj to the box indicated after the object
5885 * indicated with @p after. If @p after is not already in the box, results
5886 * are undefined. After means either to the right of the indicated object or
5887 * below it depending on orientation.
5889 * @param obj The box object
5890 * @param subobj The object to add to the box
5891 * @param after The object after which to add it
5893 * @see elm_box_pack_start()
5894 * @see elm_box_pack_end()
5895 * @see elm_box_pack_before()
5896 * @see elm_box_unpack()
5897 * @see elm_box_unpack_all()
5898 * @see elm_box_clear()
5900 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5902 * Clear the box of all children
5904 * Remove all the elements contained by the box, deleting the respective
5907 * @param obj The box object
5909 * @see elm_box_unpack()
5910 * @see elm_box_unpack_all()
5912 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5916 * Remove the object given by @p subobj from the box @p obj without
5919 * @param obj The box object
5921 * @see elm_box_unpack_all()
5922 * @see elm_box_clear()
5924 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5926 * Remove all items from the box, without deleting them
5928 * Clear the box from all children, but don't delete the respective objects.
5929 * If no other references of the box children exist, the objects will never
5930 * be deleted, and thus the application will leak the memory. Make sure
5931 * when using this function that you hold a reference to all the objects
5932 * in the box @p obj.
5934 * @param obj The box object
5936 * @see elm_box_clear()
5937 * @see elm_box_unpack()
5939 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5941 * Retrieve a list of the objects packed into the box
5943 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5944 * The order of the list corresponds to the packing order the box uses.
5946 * You must free this list with eina_list_free() once you are done with it.
5948 * @param obj The box object
5950 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5952 * Set the space (padding) between the box's elements.
5954 * Extra space in pixels that will be added between a box child and its
5955 * neighbors after its containing cell has been calculated. This padding
5956 * is set for all elements in the box, besides any possible padding that
5957 * individual elements may have through their size hints.
5959 * @param obj The box object
5960 * @param horizontal The horizontal space between elements
5961 * @param vertical The vertical space between elements
5963 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5965 * Get the space (padding) between the box's elements.
5967 * @param obj The box object
5968 * @param horizontal The horizontal space between elements
5969 * @param vertical The vertical space between elements
5971 * @see elm_box_padding_set()
5973 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5975 * Set the alignment of the whole bouding box of contents.
5977 * Sets how the bounding box containing all the elements of the box, after
5978 * their sizes and position has been calculated, will be aligned within
5979 * the space given for the whole box widget.
5981 * @param obj The box object
5982 * @param horizontal The horizontal alignment of elements
5983 * @param vertical The vertical alignment of elements
5985 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5987 * Get the alignment of the whole bouding box of contents.
5989 * @param obj The box object
5990 * @param horizontal The horizontal alignment of elements
5991 * @param vertical The vertical alignment of elements
5993 * @see elm_box_align_set()
5995 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5998 * Force the box to recalculate its children packing.
6000 * If any children was added or removed, box will not calculate the
6001 * values immediately rather leaving it to the next main loop
6002 * iteration. While this is great as it would save lots of
6003 * recalculation, whenever you need to get the position of a just
6004 * added item you must force recalculate before doing so.
6006 * @param obj The box object.
6008 EAPI void elm_box_recalculate(Evas_Object *obj);
6011 * Set the layout defining function to be used by the box
6013 * Whenever anything changes that requires the box in @p obj to recalculate
6014 * the size and position of its elements, the function @p cb will be called
6015 * to determine what the layout of the children will be.
6017 * Once a custom function is set, everything about the children layout
6018 * is defined by it. The flags set by elm_box_horizontal_set() and
6019 * elm_box_homogeneous_set() no longer have any meaning, and the values
6020 * given by elm_box_padding_set() and elm_box_align_set() are up to this
6021 * layout function to decide if they are used and how. These last two
6022 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6023 * passed to @p cb. The @c Evas_Object the function receives is not the
6024 * Elementary widget, but the internal Evas Box it uses, so none of the
6025 * functions described here can be used on it.
6027 * Any of the layout functions in @c Evas can be used here, as well as the
6028 * special elm_box_layout_transition().
6030 * The final @p data argument received by @p cb is the same @p data passed
6031 * here, and the @p free_data function will be called to free it
6032 * whenever the box is destroyed or another layout function is set.
6034 * Setting @p cb to NULL will revert back to the default layout function.
6036 * @param obj The box object
6037 * @param cb The callback function used for layout
6038 * @param data Data that will be passed to layout function
6039 * @param free_data Function called to free @p data
6041 * @see elm_box_layout_transition()
6043 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);
6045 * Special layout function that animates the transition from one layout to another
6047 * Normally, when switching the layout function for a box, this will be
6048 * reflected immediately on screen on the next render, but it's also
6049 * possible to do this through an animated transition.
6051 * This is done by creating an ::Elm_Box_Transition and setting the box
6052 * layout to this function.
6056 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6057 * evas_object_box_layout_vertical, // start
6058 * NULL, // data for initial layout
6059 * NULL, // free function for initial data
6060 * evas_object_box_layout_horizontal, // end
6061 * NULL, // data for final layout
6062 * NULL, // free function for final data
6063 * anim_end, // will be called when animation ends
6064 * NULL); // data for anim_end function\
6065 * elm_box_layout_set(box, elm_box_layout_transition, t,
6066 * elm_box_transition_free);
6069 * @note This function can only be used with elm_box_layout_set(). Calling
6070 * it directly will not have the expected results.
6072 * @see elm_box_transition_new
6073 * @see elm_box_transition_free
6074 * @see elm_box_layout_set
6076 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6078 * Create a new ::Elm_Box_Transition to animate the switch of layouts
6080 * If you want to animate the change from one layout to another, you need
6081 * to set the layout function of the box to elm_box_layout_transition(),
6082 * passing as user data to it an instance of ::Elm_Box_Transition with the
6083 * necessary information to perform this animation. The free function to
6084 * set for the layout is elm_box_transition_free().
6086 * The parameters to create an ::Elm_Box_Transition sum up to how long
6087 * will it be, in seconds, a layout function to describe the initial point,
6088 * another for the final position of the children and one function to be
6089 * called when the whole animation ends. This last function is useful to
6090 * set the definitive layout for the box, usually the same as the end
6091 * layout for the animation, but could be used to start another transition.
6093 * @param start_layout The layout function that will be used to start the animation
6094 * @param start_layout_data The data to be passed the @p start_layout function
6095 * @param start_layout_free_data Function to free @p start_layout_data
6096 * @param end_layout The layout function that will be used to end the animation
6097 * @param end_layout_free_data The data to be passed the @p end_layout function
6098 * @param end_layout_free_data Function to free @p end_layout_data
6099 * @param transition_end_cb Callback function called when animation ends
6100 * @param transition_end_data Data to be passed to @p transition_end_cb
6101 * @return An instance of ::Elm_Box_Transition
6103 * @see elm_box_transition_new
6104 * @see elm_box_layout_transition
6106 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);
6108 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6110 * This function is mostly useful as the @c free_data parameter in
6111 * elm_box_layout_set() when elm_box_layout_transition().
6113 * @param data The Elm_Box_Transition instance to be freed.
6115 * @see elm_box_transition_new
6116 * @see elm_box_layout_transition
6118 EAPI void elm_box_transition_free(void *data);
6125 * @defgroup Button Button
6127 * @image html img/widget/button/preview-00.png
6128 * @image latex img/widget/button/preview-00.eps
6129 * @image html img/widget/button/preview-01.png
6130 * @image latex img/widget/button/preview-01.eps
6131 * @image html img/widget/button/preview-02.png
6132 * @image latex img/widget/button/preview-02.eps
6134 * This is a push-button. Press it and run some function. It can contain
6135 * a simple label and icon object and it also has an autorepeat feature.
6137 * This widgets emits the following signals:
6138 * @li "clicked": the user clicked the button (press/release).
6139 * @li "repeated": the user pressed the button without releasing it.
6140 * @li "pressed": button was pressed.
6141 * @li "unpressed": button was released after being pressed.
6142 * In all three cases, the @c event parameter of the callback will be
6145 * Also, defined in the default theme, the button has the following styles
6147 * @li default: a normal button.
6148 * @li anchor: Like default, but the button fades away when the mouse is not
6149 * over it, leaving only the text or icon.
6150 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6151 * continuous look across its options.
6152 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6154 * Follow through a complete example @ref button_example_01 "here".
6158 * Add a new button to the parent's canvas
6160 * @param parent The parent object
6161 * @return The new object or NULL if it cannot be created
6163 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6165 * Set the label used in the button
6167 * The passed @p label can be NULL to clean any existing text in it and
6168 * leave the button as an icon only object.
6170 * @param obj The button object
6171 * @param label The text will be written on the button
6172 * @deprecated use elm_object_text_set() instead.
6174 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6176 * Get the label set for the button
6178 * The string returned is an internal pointer and should not be freed or
6179 * altered. It will also become invalid when the button is destroyed.
6180 * The string returned, if not NULL, is a stringshare, so if you need to
6181 * keep it around even after the button is destroyed, you can use
6182 * eina_stringshare_ref().
6184 * @param obj The button object
6185 * @return The text set to the label, or NULL if nothing is set
6186 * @deprecated use elm_object_text_set() instead.
6188 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6190 * Set the icon used for the button
6192 * Setting a new icon will delete any other that was previously set, making
6193 * any reference to them invalid. If you need to maintain the previous
6194 * object alive, unset it first with elm_button_icon_unset().
6196 * @param obj The button object
6197 * @param icon The icon object for the button
6199 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6201 * Get the icon used for the button
6203 * Return the icon object which is set for this widget. If the button is
6204 * destroyed or another icon is set, the returned object will be deleted
6205 * and any reference to it will be invalid.
6207 * @param obj The button object
6208 * @return The icon object that is being used
6210 * @see elm_button_icon_unset()
6212 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6214 * Remove the icon set without deleting it and return the object
6216 * This function drops the reference the button holds of the icon object
6217 * and returns this last object. It is used in case you want to remove any
6218 * icon, or set another one, without deleting the actual object. The button
6219 * will be left without an icon set.
6221 * @param obj The button object
6222 * @return The icon object that was being used
6224 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6226 * Turn on/off the autorepeat event generated when the button is kept pressed
6228 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6229 * signal when they are clicked.
6231 * When on, keeping a button pressed will continuously emit a @c repeated
6232 * signal until the button is released. The time it takes until it starts
6233 * emitting the signal is given by
6234 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6235 * new emission by elm_button_autorepeat_gap_timeout_set().
6237 * @param obj The button object
6238 * @param on A bool to turn on/off the event
6240 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6242 * Get whether the autorepeat feature is enabled
6244 * @param obj The button object
6245 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6247 * @see elm_button_autorepeat_set()
6249 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6251 * Set the initial timeout before the autorepeat event is generated
6253 * Sets the timeout, in seconds, since the button is pressed until the
6254 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6255 * won't be any delay and the even will be fired the moment the button is
6258 * @param obj The button object
6259 * @param t Timeout in seconds
6261 * @see elm_button_autorepeat_set()
6262 * @see elm_button_autorepeat_gap_timeout_set()
6264 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6266 * Get the initial timeout before the autorepeat event is generated
6268 * @param obj The button object
6269 * @return Timeout in seconds
6271 * @see elm_button_autorepeat_initial_timeout_set()
6273 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6275 * Set the interval between each generated autorepeat event
6277 * After the first @c repeated event is fired, all subsequent ones will
6278 * follow after a delay of @p t seconds for each.
6280 * @param obj The button object
6281 * @param t Interval in seconds
6283 * @see elm_button_autorepeat_initial_timeout_set()
6285 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6287 * Get the interval between each generated autorepeat event
6289 * @param obj The button object
6290 * @return Interval in seconds
6292 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6298 * @defgroup File_Selector_Button File Selector Button
6300 * @image html img/widget/fileselector_button/preview-00.png
6301 * @image latex img/widget/fileselector_button/preview-00.eps
6302 * @image html img/widget/fileselector_button/preview-01.png
6303 * @image latex img/widget/fileselector_button/preview-01.eps
6304 * @image html img/widget/fileselector_button/preview-02.png
6305 * @image latex img/widget/fileselector_button/preview-02.eps
6307 * This is a button that, when clicked, creates an Elementary
6308 * window (or inner window) <b> with a @ref Fileselector "file
6309 * selector widget" within</b>. When a file is chosen, the (inner)
6310 * window is closed and the button emits a signal having the
6311 * selected file as it's @c event_info.
6313 * This widget encapsulates operations on its internal file
6314 * selector on its own API. There is less control over its file
6315 * selector than that one would have instatiating one directly.
6317 * The following styles are available for this button:
6320 * @li @c "hoversel_vertical"
6321 * @li @c "hoversel_vertical_entry"
6323 * Smart callbacks one can register to:
6324 * - @c "file,chosen" - the user has selected a path, whose string
6325 * pointer comes as the @c event_info data (a stringshared
6328 * Here is an example on its usage:
6329 * @li @ref fileselector_button_example
6331 * @see @ref File_Selector_Entry for a similar widget.
6336 * Add a new file selector button widget to the given parent
6337 * Elementary (container) object
6339 * @param parent The parent object
6340 * @return a new file selector button widget handle or @c NULL, on
6343 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6346 * Set the label for a given file selector button widget
6348 * @param obj The file selector button widget
6349 * @param label The text label to be displayed on @p obj
6351 * @deprecated use elm_object_text_set() instead.
6353 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6356 * Get the label set for a given file selector button widget
6358 * @param obj The file selector button widget
6359 * @return The button label
6361 * @deprecated use elm_object_text_set() instead.
6363 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6366 * Set the icon on a given file selector button widget
6368 * @param obj The file selector button widget
6369 * @param icon The icon object for the button
6371 * Once the icon object is set, a previously set one will be
6372 * deleted. If you want to keep the latter, use the
6373 * elm_fileselector_button_icon_unset() function.
6375 * @see elm_fileselector_button_icon_get()
6377 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6380 * Get the icon set for a given file selector button widget
6382 * @param obj The file selector button widget
6383 * @return The icon object currently set on @p obj or @c NULL, if
6386 * @see elm_fileselector_button_icon_set()
6388 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6391 * Unset the icon used in a given file selector button widget
6393 * @param obj The file selector button widget
6394 * @return The icon object that was being used on @p obj or @c
6397 * Unparent and return the icon object which was set for this
6400 * @see elm_fileselector_button_icon_set()
6402 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6405 * Set the title for a given file selector button widget's window
6407 * @param obj The file selector button widget
6408 * @param title The title string
6410 * This will change the window's title, when the file selector pops
6411 * out after a click on the button. Those windows have the default
6412 * (unlocalized) value of @c "Select a file" as titles.
6414 * @note It will only take any effect if the file selector
6415 * button widget is @b not under "inwin mode".
6417 * @see elm_fileselector_button_window_title_get()
6419 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6422 * Get the title set for a given file selector button widget's
6425 * @param obj The file selector button widget
6426 * @return Title of the file selector button's window
6428 * @see elm_fileselector_button_window_title_get() for more details
6430 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6433 * Set the size of a given file selector button widget's window,
6434 * holding the file selector itself.
6436 * @param obj The file selector button widget
6437 * @param width The window's width
6438 * @param height The window's height
6440 * @note it will only take any effect if the file selector button
6441 * widget is @b not under "inwin mode". The default size for the
6442 * window (when applicable) is 400x400 pixels.
6444 * @see elm_fileselector_button_window_size_get()
6446 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6449 * Get the size of a given file selector button widget's window,
6450 * holding the file selector itself.
6452 * @param obj The file selector button widget
6453 * @param width Pointer into which to store the width value
6454 * @param height Pointer into which to store the height value
6456 * @note Use @c NULL pointers on the size values you're not
6457 * interested in: they'll be ignored by the function.
6459 * @see elm_fileselector_button_window_size_set(), for more details
6461 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6464 * Set the initial file system path for a given file selector
6467 * @param obj The file selector button widget
6468 * @param path The path string
6470 * It must be a <b>directory</b> path, which will have the contents
6471 * displayed initially in the file selector's view, when invoked
6472 * from @p obj. The default initial path is the @c "HOME"
6473 * environment variable's value.
6475 * @see elm_fileselector_button_path_get()
6477 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6480 * Get the initial file system path set for a given file selector
6483 * @param obj The file selector button widget
6484 * @return path The path string
6486 * @see elm_fileselector_button_path_set() for more details
6488 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6491 * Enable/disable a tree view in the given file selector button
6492 * widget's internal file selector
6494 * @param obj The file selector button widget
6495 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6498 * This has the same effect as elm_fileselector_expandable_set(),
6499 * but now applied to a file selector button's internal file
6502 * @note There's no way to put a file selector button's internal
6503 * file selector in "grid mode", as one may do with "pure" file
6506 * @see elm_fileselector_expandable_get()
6508 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6511 * Get whether tree view is enabled for the given file selector
6512 * button widget's internal file selector
6514 * @param obj The file selector button widget
6515 * @return @c EINA_TRUE if @p obj widget's internal file selector
6516 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6518 * @see elm_fileselector_expandable_set() for more details
6520 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6523 * Set whether a given file selector button widget's internal file
6524 * selector is to display folders only or the directory contents,
6527 * @param obj The file selector button widget
6528 * @param only @c EINA_TRUE to make @p obj widget's internal file
6529 * selector only display directories, @c EINA_FALSE to make files
6530 * to be displayed in it too
6532 * This has the same effect as elm_fileselector_folder_only_set(),
6533 * but now applied to a file selector button's internal file
6536 * @see elm_fileselector_folder_only_get()
6538 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6541 * Get whether a given file selector button widget's internal file
6542 * selector is displaying folders only or the directory contents,
6545 * @param obj The file selector button widget
6546 * @return @c EINA_TRUE if @p obj widget's internal file
6547 * selector is only displaying directories, @c EINA_FALSE if files
6548 * are being displayed in it too (and on errors)
6550 * @see elm_fileselector_button_folder_only_set() for more details
6552 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6555 * Enable/disable the file name entry box where the user can type
6556 * in a name for a file, in a given file selector button widget's
6557 * internal file selector.
6559 * @param obj The file selector button widget
6560 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6561 * file selector a "saving dialog", @c EINA_FALSE otherwise
6563 * This has the same effect as elm_fileselector_is_save_set(),
6564 * but now applied to a file selector button's internal file
6567 * @see elm_fileselector_is_save_get()
6569 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6572 * Get whether the given file selector button widget's internal
6573 * file selector is in "saving dialog" mode
6575 * @param obj The file selector button widget
6576 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6577 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6580 * @see elm_fileselector_button_is_save_set() for more details
6582 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6585 * Set whether a given file selector button widget's internal file
6586 * selector will raise an Elementary "inner window", instead of a
6587 * dedicated Elementary window. By default, it won't.
6589 * @param obj The file selector button widget
6590 * @param value @c EINA_TRUE to make it use an inner window, @c
6591 * EINA_TRUE to make it use a dedicated window
6593 * @see elm_win_inwin_add() for more information on inner windows
6594 * @see elm_fileselector_button_inwin_mode_get()
6596 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6599 * Get whether a given file selector button widget's internal file
6600 * selector will raise an Elementary "inner window", instead of a
6601 * dedicated Elementary window.
6603 * @param obj The file selector button widget
6604 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6605 * if it will use a dedicated window
6607 * @see elm_fileselector_button_inwin_mode_set() for more details
6609 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6616 * @defgroup File_Selector_Entry File Selector Entry
6618 * @image html img/widget/fileselector_entry/preview-00.png
6619 * @image latex img/widget/fileselector_entry/preview-00.eps
6621 * This is an entry made to be filled with or display a <b>file
6622 * system path string</b>. Besides the entry itself, the widget has
6623 * a @ref File_Selector_Button "file selector button" on its side,
6624 * which will raise an internal @ref Fileselector "file selector widget",
6625 * when clicked, for path selection aided by file system
6628 * This file selector may appear in an Elementary window or in an
6629 * inner window. When a file is chosen from it, the (inner) window
6630 * is closed and the selected file's path string is exposed both as
6631 * an smart event and as the new text on the entry.
6633 * This widget encapsulates operations on its internal file
6634 * selector on its own API. There is less control over its file
6635 * selector than that one would have instatiating one directly.
6637 * Smart callbacks one can register to:
6638 * - @c "changed" - The text within the entry was changed
6639 * - @c "activated" - The entry has had editing finished and
6640 * changes are to be "committed"
6641 * - @c "press" - The entry has been clicked
6642 * - @c "longpressed" - The entry has been clicked (and held) for a
6644 * - @c "clicked" - The entry has been clicked
6645 * - @c "clicked,double" - The entry has been double clicked
6646 * - @c "focused" - The entry has received focus
6647 * - @c "unfocused" - The entry has lost focus
6648 * - @c "selection,paste" - A paste action has occurred on the
6650 * - @c "selection,copy" - A copy action has occurred on the entry
6651 * - @c "selection,cut" - A cut action has occurred on the entry
6652 * - @c "unpressed" - The file selector entry's button was released
6653 * after being pressed.
6654 * - @c "file,chosen" - The user has selected a path via the file
6655 * selector entry's internal file selector, whose string pointer
6656 * comes as the @c event_info data (a stringshared string)
6658 * Here is an example on its usage:
6659 * @li @ref fileselector_entry_example
6661 * @see @ref File_Selector_Button for a similar widget.
6666 * Add a new file selector entry widget to the given parent
6667 * Elementary (container) object
6669 * @param parent The parent object
6670 * @return a new file selector entry widget handle or @c NULL, on
6673 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6676 * Set the label for a given file selector entry widget's button
6678 * @param obj The file selector entry widget
6679 * @param label The text label to be displayed on @p obj widget's
6682 * @deprecated use elm_object_text_set() instead.
6684 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6687 * Get the label set for a given file selector entry widget's button
6689 * @param obj The file selector entry widget
6690 * @return The widget button's label
6692 * @deprecated use elm_object_text_set() instead.
6694 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6697 * Set the icon on a given file selector entry widget's button
6699 * @param obj The file selector entry widget
6700 * @param icon The icon object for the entry's button
6702 * Once the icon object is set, a previously set one will be
6703 * deleted. If you want to keep the latter, use the
6704 * elm_fileselector_entry_button_icon_unset() function.
6706 * @see elm_fileselector_entry_button_icon_get()
6708 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6711 * Get the icon set for a given file selector entry widget's button
6713 * @param obj The file selector entry widget
6714 * @return The icon object currently set on @p obj widget's button
6715 * or @c NULL, if none is
6717 * @see elm_fileselector_entry_button_icon_set()
6719 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6722 * Unset the icon used in a given file selector entry widget's
6725 * @param obj The file selector entry widget
6726 * @return The icon object that was being used on @p obj widget's
6727 * button or @c NULL, on errors
6729 * Unparent and return the icon object which was set for this
6732 * @see elm_fileselector_entry_button_icon_set()
6734 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6737 * Set the title for a given file selector entry widget's window
6739 * @param obj The file selector entry widget
6740 * @param title The title string
6742 * This will change the window's title, when the file selector pops
6743 * out after a click on the entry's button. Those windows have the
6744 * default (unlocalized) value of @c "Select a file" as titles.
6746 * @note It will only take any effect if the file selector
6747 * entry widget is @b not under "inwin mode".
6749 * @see elm_fileselector_entry_window_title_get()
6751 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6754 * Get the title set for a given file selector entry widget's
6757 * @param obj The file selector entry widget
6758 * @return Title of the file selector entry's window
6760 * @see elm_fileselector_entry_window_title_get() for more details
6762 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6765 * Set the size of a given file selector entry widget's window,
6766 * holding the file selector itself.
6768 * @param obj The file selector entry widget
6769 * @param width The window's width
6770 * @param height The window's height
6772 * @note it will only take any effect if the file selector entry
6773 * widget is @b not under "inwin mode". The default size for the
6774 * window (when applicable) is 400x400 pixels.
6776 * @see elm_fileselector_entry_window_size_get()
6778 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6781 * Get the size of a given file selector entry widget's window,
6782 * holding the file selector itself.
6784 * @param obj The file selector entry widget
6785 * @param width Pointer into which to store the width value
6786 * @param height Pointer into which to store the height value
6788 * @note Use @c NULL pointers on the size values you're not
6789 * interested in: they'll be ignored by the function.
6791 * @see elm_fileselector_entry_window_size_set(), for more details
6793 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6796 * Set the initial file system path and the entry's path string for
6797 * a given file selector entry widget
6799 * @param obj The file selector entry widget
6800 * @param path The path string
6802 * It must be a <b>directory</b> path, which will have the contents
6803 * displayed initially in the file selector's view, when invoked
6804 * from @p obj. The default initial path is the @c "HOME"
6805 * environment variable's value.
6807 * @see elm_fileselector_entry_path_get()
6809 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6812 * Get the entry's path string for a given file selector entry
6815 * @param obj The file selector entry widget
6816 * @return path The path string
6818 * @see elm_fileselector_entry_path_set() for more details
6820 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6823 * Enable/disable a tree view in the given file selector entry
6824 * widget's internal file selector
6826 * @param obj The file selector entry widget
6827 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6830 * This has the same effect as elm_fileselector_expandable_set(),
6831 * but now applied to a file selector entry's internal file
6834 * @note There's no way to put a file selector entry's internal
6835 * file selector in "grid mode", as one may do with "pure" file
6838 * @see elm_fileselector_expandable_get()
6840 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6843 * Get whether tree view is enabled for the given file selector
6844 * entry widget's internal file selector
6846 * @param obj The file selector entry widget
6847 * @return @c EINA_TRUE if @p obj widget's internal file selector
6848 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6850 * @see elm_fileselector_expandable_set() for more details
6852 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6855 * Set whether a given file selector entry widget's internal file
6856 * selector is to display folders only or the directory contents,
6859 * @param obj The file selector entry widget
6860 * @param only @c EINA_TRUE to make @p obj widget's internal file
6861 * selector only display directories, @c EINA_FALSE to make files
6862 * to be displayed in it too
6864 * This has the same effect as elm_fileselector_folder_only_set(),
6865 * but now applied to a file selector entry's internal file
6868 * @see elm_fileselector_folder_only_get()
6870 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6873 * Get whether a given file selector entry widget's internal file
6874 * selector is displaying folders only or the directory contents,
6877 * @param obj The file selector entry widget
6878 * @return @c EINA_TRUE if @p obj widget's internal file
6879 * selector is only displaying directories, @c EINA_FALSE if files
6880 * are being displayed in it too (and on errors)
6882 * @see elm_fileselector_entry_folder_only_set() for more details
6884 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6887 * Enable/disable the file name entry box where the user can type
6888 * in a name for a file, in a given file selector entry widget's
6889 * internal file selector.
6891 * @param obj The file selector entry widget
6892 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6893 * file selector a "saving dialog", @c EINA_FALSE otherwise
6895 * This has the same effect as elm_fileselector_is_save_set(),
6896 * but now applied to a file selector entry's internal file
6899 * @see elm_fileselector_is_save_get()
6901 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6904 * Get whether the given file selector entry widget's internal
6905 * file selector is in "saving dialog" mode
6907 * @param obj The file selector entry widget
6908 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6909 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6912 * @see elm_fileselector_entry_is_save_set() for more details
6914 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6917 * Set whether a given file selector entry widget's internal file
6918 * selector will raise an Elementary "inner window", instead of a
6919 * dedicated Elementary window. By default, it won't.
6921 * @param obj The file selector entry widget
6922 * @param value @c EINA_TRUE to make it use an inner window, @c
6923 * EINA_TRUE to make it use a dedicated window
6925 * @see elm_win_inwin_add() for more information on inner windows
6926 * @see elm_fileselector_entry_inwin_mode_get()
6928 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6931 * Get whether a given file selector entry widget's internal file
6932 * selector will raise an Elementary "inner window", instead of a
6933 * dedicated Elementary window.
6935 * @param obj The file selector entry widget
6936 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6937 * if it will use a dedicated window
6939 * @see elm_fileselector_entry_inwin_mode_set() for more details
6941 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6944 * Set the initial file system path for a given file selector entry
6947 * @param obj The file selector entry widget
6948 * @param path The path string
6950 * It must be a <b>directory</b> path, which will have the contents
6951 * displayed initially in the file selector's view, when invoked
6952 * from @p obj. The default initial path is the @c "HOME"
6953 * environment variable's value.
6955 * @see elm_fileselector_entry_path_get()
6957 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6960 * Get the parent directory's path to the latest file selection on
6961 * a given filer selector entry widget
6963 * @param obj The file selector object
6964 * @return The (full) path of the directory of the last selection
6965 * on @p obj widget, a @b stringshared string
6967 * @see elm_fileselector_entry_path_set()
6969 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6976 * @defgroup Scroller Scroller
6978 * A scroller holds a single object and "scrolls it around". This means that
6979 * it allows the user to use a scrollbar (or a finger) to drag the viewable
6980 * region around, allowing to move through a much larger object that is
6981 * contained in the scroller. The scroiller will always have a small minimum
6982 * size by default as it won't be limited by the contents of the scroller.
6984 * Signals that you can add callbacks for are:
6985 * @li "edge,left" - the left edge of the content has been reached
6986 * @li "edge,right" - the right edge of the content has been reached
6987 * @li "edge,top" - the top edge of the content has been reached
6988 * @li "edge,bottom" - the bottom edge of the content has been reached
6989 * @li "scroll" - the content has been scrolled (moved)
6990 * @li "scroll,anim,start" - scrolling animation has started
6991 * @li "scroll,anim,stop" - scrolling animation has stopped
6992 * @li "scroll,drag,start" - dragging the contents around has started
6993 * @li "scroll,drag,stop" - dragging the contents around has stopped
6994 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6997 * @note When Elemementary is in embedded mode the scrollbars will not be
6998 * dragable, they appear merely as indicators of how much has been scrolled.
6999 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7000 * fingerscroll) won't work.
7002 * In @ref tutorial_scroller you'll find an example of how to use most of
7007 * @brief Type that controls when scrollbars should appear.
7009 * @see elm_scroller_policy_set()
7011 typedef enum _Elm_Scroller_Policy
7013 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7014 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7015 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7016 ELM_SCROLLER_POLICY_LAST
7017 } Elm_Scroller_Policy;
7019 * @brief Add a new scroller to the parent
7021 * @param parent The parent object
7022 * @return The new object or NULL if it cannot be created
7024 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7026 * @brief Set the content of the scroller widget (the object to be scrolled around).
7028 * @param obj The scroller object
7029 * @param content The new content object
7031 * Once the content object is set, a previously set one will be deleted.
7032 * If you want to keep that old content object, use the
7033 * elm_scroller_content_unset() function.
7035 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7037 * @brief Get the content of the scroller widget
7039 * @param obj The slider object
7040 * @return The content that is being used
7042 * Return the content object which is set for this widget
7044 * @see elm_scroller_content_set()
7046 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7048 * @brief Unset the content of the scroller widget
7050 * @param obj The slider object
7051 * @return The content that was being used
7053 * Unparent and return the content object which was set for this widget
7055 * @see elm_scroller_content_set()
7057 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7059 * @brief Set custom theme elements for the scroller
7061 * @param obj The scroller object
7062 * @param widget The widget name to use (default is "scroller")
7063 * @param base The base name to use (default is "base")
7065 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7067 * @brief Make the scroller minimum size limited to the minimum size of the content
7069 * @param obj The scroller object
7070 * @param w Enable limiting minimum size horizontally
7071 * @param h Enable limiting minimum size vertically
7073 * By default the scroller will be as small as its design allows,
7074 * irrespective of its content. This will make the scroller minimum size the
7075 * right size horizontally and/or vertically to perfectly fit its content in
7078 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7080 * @brief Show a specific virtual region within the scroller content object
7082 * @param obj The scroller object
7083 * @param x X coordinate of the region
7084 * @param y Y coordinate of the region
7085 * @param w Width of the region
7086 * @param h Height of the region
7088 * This will ensure all (or part if it does not fit) of the designated
7089 * region in the virtual content object (0, 0 starting at the top-left of the
7090 * virtual content object) is shown within the scroller.
7092 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);
7094 * @brief Set the scrollbar visibility policy
7096 * @param obj The scroller object
7097 * @param policy_h Horizontal scrollbar policy
7098 * @param policy_v Vertical scrollbar policy
7100 * This sets the scrollbar visibility policy for the given scroller.
7101 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7102 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7103 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7104 * respectively for the horizontal and vertical scrollbars.
7106 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7108 * @brief Gets scrollbar visibility policy
7110 * @param obj The scroller object
7111 * @param policy_h Horizontal scrollbar policy
7112 * @param policy_v Vertical scrollbar policy
7114 * @see elm_scroller_policy_set()
7116 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7118 * @brief Get the currently visible content region
7120 * @param obj The scroller object
7121 * @param x X coordinate of the region
7122 * @param y Y coordinate of the region
7123 * @param w Width of the region
7124 * @param h Height of the region
7126 * This gets the current region in the content object that is visible through
7127 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7128 * w, @p h values pointed to.
7130 * @note All coordinates are relative to the content.
7132 * @see elm_scroller_region_show()
7134 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);
7136 * @brief Get the size of the content object
7138 * @param obj The scroller object
7139 * @param w Width return
7140 * @param h Height return
7142 * This gets the size of the content object of the scroller.
7144 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7146 * @brief Set bouncing behavior
7148 * @param obj The scroller object
7149 * @param h_bounce Will the scroller bounce horizontally or not
7150 * @param v_bounce Will the scroller bounce vertically or not
7152 * When scrolling, the scroller may "bounce" when reaching an edge of the
7153 * content object. This is a visual way to indicate the end has been reached.
7154 * This is enabled by default for both axis. This will set if it is enabled
7155 * for that axis with the boolean parameters for each axis.
7157 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7159 * @brief Get the bounce mode
7161 * @param obj The Scroller object
7162 * @param h_bounce Allow bounce horizontally
7163 * @param v_bounce Allow bounce vertically
7165 * @see elm_scroller_bounce_set()
7167 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7169 * @brief Set scroll page size relative to viewport size.
7171 * @param obj The scroller object
7172 * @param h_pagerel The horizontal page relative size
7173 * @param v_pagerel The vertical page relative size
7175 * The scroller is capable of limiting scrolling by the user to "pages". That
7176 * is to jump by and only show a "whole page" at a time as if the continuous
7177 * area of the scroller content is split into page sized pieces. This sets
7178 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7179 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7180 * axis. This is mutually exclusive with page size
7181 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7182 * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
7183 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7186 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7188 * @brief Set scroll page size.
7190 * @param obj The scroller object
7191 * @param h_pagesize The horizontal page size
7192 * @param v_pagesize The vertical page size
7194 * This sets the page size to an absolute fixed value, with 0 turning it off
7197 * @see elm_scroller_page_relative_set()
7199 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7201 * @brief Get scroll current page number.
7203 * @param obj The scroller object
7204 * @param h_pagenumber The horizontal page number
7205 * @param v_pagenumber The vertical page number
7207 * The page number starts from 0. 0 is the first page.
7208 * Current page means the page which meet the top-left of the viewport.
7209 * If there are two or more pages in the viewport, it returns the number of page
7210 * which meet the top-left of the viewport.
7212 * @see elm_scroller_last_page_get()
7213 * @see elm_scroller_page_show()
7214 * @see elm_scroller_page_brint_in()
7216 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7218 * @brief Get scroll last page number.
7220 * @param obj The scroller object
7221 * @param h_pagenumber The horizontal page number
7222 * @param v_pagenumber The vertical page number
7224 * The page number starts from 0. 0 is the first page.
7225 * This returns the last page number among the pages.
7227 * @see elm_scroller_current_page_get()
7228 * @see elm_scroller_page_show()
7229 * @see elm_scroller_page_brint_in()
7231 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7233 * Show a specific virtual region within the scroller content object by page number.
7235 * @param obj The scroller object
7236 * @param h_pagenumber The horizontal page number
7237 * @param v_pagenumber The vertical page number
7239 * 0, 0 of the indicated page is located at the top-left of the viewport.
7240 * This will jump to the page directly without animation.
7245 * sc = elm_scroller_add(win);
7246 * elm_scroller_content_set(sc, content);
7247 * elm_scroller_page_relative_set(sc, 1, 0);
7248 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7249 * elm_scroller_page_show(sc, h_page + 1, v_page);
7252 * @see elm_scroller_page_bring_in()
7254 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7256 * Show a specific virtual region within the scroller content object by page number.
7258 * @param obj The scroller object
7259 * @param h_pagenumber The horizontal page number
7260 * @param v_pagenumber The vertical page number
7262 * 0, 0 of the indicated page is located at the top-left of the viewport.
7263 * This will slide to the page with animation.
7268 * sc = elm_scroller_add(win);
7269 * elm_scroller_content_set(sc, content);
7270 * elm_scroller_page_relative_set(sc, 1, 0);
7271 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7272 * elm_scroller_page_bring_in(sc, h_page, v_page);
7275 * @see elm_scroller_page_show()
7277 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7279 * @brief Show a specific virtual region within the scroller content object.
7281 * @param obj The scroller object
7282 * @param x X coordinate of the region
7283 * @param y Y coordinate of the region
7284 * @param w Width of the region
7285 * @param h Height of the region
7287 * This will ensure all (or part if it does not fit) of the designated
7288 * region in the virtual content object (0, 0 starting at the top-left of the
7289 * virtual content object) is shown within the scroller. Unlike
7290 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7291 * to this location (if configuration in general calls for transitions). It
7292 * may not jump immediately to the new location and make take a while and
7293 * show other content along the way.
7295 * @see elm_scroller_region_show()
7297 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);
7299 * @brief Set event propagation on a scroller
7301 * @param obj The scroller object
7302 * @param propagation If propagation is enabled or not
7304 * This enables or disabled event propagation from the scroller content to
7305 * the scroller and its parent. By default event propagation is disabled.
7307 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7309 * @brief Get event propagation for a scroller
7311 * @param obj The scroller object
7312 * @return The propagation state
7314 * This gets the event propagation for a scroller.
7316 * @see elm_scroller_propagate_events_set()
7318 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7320 * @brief Set scrolling gravity on a scroller
7322 * @param obj The scroller object
7323 * @param x The scrolling horizontal gravity
7324 * @param y The scrolling vertical gravity
7326 * It set scrolling gravity. It adds scrolling weight values
7327 * to the scroller. Usually it uses for stopping the scroller.
7328 * To set y as 0.0 for lower growing child objects,
7329 * even though child objects are added to bottom, the scroller doesn't move.
7330 * To set y as 1.0 for upper growing child objects. And x is horizontal gravity.
7331 * By default 0.0 for x and y.
7333 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7335 * @brief Get scrolling gravity values for a scroller
7337 * @param obj The scroller object
7338 * @param x The scrolling horizontal gravity
7339 * @param y The scrolling vertical gravity
7341 * This gets gravity values for a scroller.
7343 * @see elm_scroller_gravity_set()
7346 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7352 * @defgroup Label Label
7354 * @image html img/widget/label/preview-00.png
7355 * @image latex img/widget/label/preview-00.eps
7357 * @brief Widget to display text, with simple html-like markup.
7359 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7360 * text doesn't fit the geometry of the label it will be ellipsized or be
7361 * cut. Elementary provides several themes for this widget:
7362 * @li default - No animation
7363 * @li marker - Centers the text in the label and make it bold by default
7364 * @li slide_long - The entire text appears from the right of the screen and
7365 * slides until it disappears in the left of the screen(reappering on the
7367 * @li slide_short - The text appears in the left of the label and slides to
7368 * the right to show the overflow. When all of the text has been shown the
7369 * position is reset.
7370 * @li slide_bounce - The text appears in the left of the label and slides to
7371 * the right to show the overflow. When all of the text has been shown the
7372 * animation reverses, moving the text to the left.
7374 * Custom themes can of course invent new markup tags and style them any way
7377 * See @ref tutorial_label for a demonstration of how to use a label widget.
7381 * @brief Add a new label to the parent
7383 * @param parent The parent object
7384 * @return The new object or NULL if it cannot be created
7386 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7388 * @brief Set the label on the label object
7390 * @param obj The label object
7391 * @param label The label will be used on the label object
7392 * @deprecated See elm_object_text_set()
7394 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 */
7396 * @brief Get the label used on the label object
7398 * @param obj The label object
7399 * @return The string inside the label
7400 * @deprecated See elm_object_text_get()
7402 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7404 * @brief Set the wrapping behavior of the label
7406 * @param obj The label object
7407 * @param wrap To wrap text or not
7409 * By default no wrapping is done. Possible values for @p wrap are:
7410 * @li ELM_WRAP_NONE - No wrapping
7411 * @li ELM_WRAP_CHAR - wrap between characters
7412 * @li ELM_WRAP_WORD - wrap between words
7413 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7415 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7417 * @brief Get the wrapping behavior of the label
7419 * @param obj The label object
7422 * @see elm_label_line_wrap_set()
7424 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7426 * @brief Set wrap width of the label
7428 * @param obj The label object
7429 * @param w The wrap width in pixels at a minimum where words need to wrap
7431 * This function sets the maximum width size hint of the label.
7433 * @warning This is only relevant if the label is inside a container.
7435 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7437 * @brief Get wrap width of the label
7439 * @param obj The label object
7440 * @return The wrap width in pixels at a minimum where words need to wrap
7442 * @see elm_label_wrap_width_set()
7444 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7446 * @brief Set wrap height of the label
7448 * @param obj The label object
7449 * @param h The wrap height in pixels at a minimum where words need to wrap
7451 * This function sets the maximum height size hint of the label.
7453 * @warning This is only relevant if the label is inside a container.
7455 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7457 * @brief get wrap width of the label
7459 * @param obj The label object
7460 * @return The wrap height in pixels at a minimum where words need to wrap
7462 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7464 * @brief Set the font size on the label object.
7466 * @param obj The label object
7467 * @param size font size
7469 * @warning NEVER use this. It is for hyper-special cases only. use styles
7470 * instead. e.g. "big", "medium", "small" - or better name them by use:
7471 * "title", "footnote", "quote" etc.
7473 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7475 * @brief Set the text color on the label object
7477 * @param obj The label object
7478 * @param r Red property background color of The label object
7479 * @param g Green property background color of The label object
7480 * @param b Blue property background color of The label object
7481 * @param a Alpha property background color of The label object
7483 * @warning NEVER use this. It is for hyper-special cases only. use styles
7484 * instead. e.g. "big", "medium", "small" - or better name them by use:
7485 * "title", "footnote", "quote" etc.
7487 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);
7489 * @brief Set the text align on the label object
7491 * @param obj The label object
7492 * @param align align mode ("left", "center", "right")
7494 * @warning NEVER use this. It is for hyper-special cases only. use styles
7495 * instead. e.g. "big", "medium", "small" - or better name them by use:
7496 * "title", "footnote", "quote" etc.
7498 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7500 * @brief Set background color of the label
7502 * @param obj The label object
7503 * @param r Red property background color of The label object
7504 * @param g Green property background color of The label object
7505 * @param b Blue property background color of The label object
7506 * @param a Alpha property background alpha of The label object
7508 * @warning NEVER use this. It is for hyper-special cases only. use styles
7509 * instead. e.g. "big", "medium", "small" - or better name them by use:
7510 * "title", "footnote", "quote" etc.
7512 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);
7514 * @brief Set the ellipsis behavior of the label
7516 * @param obj The label object
7517 * @param ellipsis To ellipsis text or not
7519 * If set to true and the text doesn't fit in the label an ellipsis("...")
7520 * will be shown at the end of the widget.
7522 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7523 * choosen wrap method was ELM_WRAP_WORD.
7525 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7527 * @brief Set the text slide of the label
7529 * @param obj The label object
7530 * @param slide To start slide or stop
7532 * If set to true the text of the label will slide throught the length of
7535 * @warning This only work with the themes "slide_short", "slide_long" and
7538 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7540 * @brief Get the text slide mode of the label
7542 * @param obj The label object
7543 * @return slide slide mode value
7545 * @see elm_label_slide_set()
7547 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7549 * @brief Set the slide duration(speed) of the label
7551 * @param obj The label object
7552 * @return The duration in seconds in moving text from slide begin position
7553 * to slide end position
7555 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7557 * @brief Get the slide duration(speed) of the label
7559 * @param obj The label object
7560 * @return The duration time in moving text from slide begin position to slide end position
7562 * @see elm_label_slide_duration_set()
7564 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7570 * @defgroup Toggle Toggle
7572 * @image html img/widget/toggle/preview-00.png
7573 * @image latex img/widget/toggle/preview-00.eps
7575 * @brief A toggle is a slider which can be used to toggle between
7576 * two values. It has two states: on and off.
7578 * Signals that you can add callbacks for are:
7579 * @li "changed" - Whenever the toggle value has been changed. Is not called
7580 * until the toggle is released by the cursor (assuming it
7581 * has been triggered by the cursor in the first place).
7583 * @ref tutorial_toggle show how to use a toggle.
7587 * @brief Add a toggle to @p parent.
7589 * @param parent The parent object
7591 * @return The toggle object
7593 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7595 * @brief Sets the label to be displayed with the toggle.
7597 * @param obj The toggle object
7598 * @param label The label to be displayed
7600 * @deprecated use elm_object_text_set() instead.
7602 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7604 * @brief Gets the label of the toggle
7606 * @param obj toggle object
7607 * @return The label of the toggle
7609 * @deprecated use elm_object_text_get() instead.
7611 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7613 * @brief Set the icon used for the toggle
7615 * @param obj The toggle object
7616 * @param icon The icon object for the button
7618 * Once the icon object is set, a previously set one will be deleted
7619 * If you want to keep that old content object, use the
7620 * elm_toggle_icon_unset() function.
7622 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7624 * @brief Get the icon used for the toggle
7626 * @param obj The toggle object
7627 * @return The icon object that is being used
7629 * Return the icon object which is set for this widget.
7631 * @see elm_toggle_icon_set()
7633 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7635 * @brief Unset the icon used for the toggle
7637 * @param obj The toggle object
7638 * @return The icon object that was being used
7640 * Unparent and return the icon object which was set for this widget.
7642 * @see elm_toggle_icon_set()
7644 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7646 * @brief Sets the labels to be associated with the on and off states of the toggle.
7648 * @param obj The toggle object
7649 * @param onlabel The label displayed when the toggle is in the "on" state
7650 * @param offlabel The label displayed when the toggle is in the "off" state
7652 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7654 * @brief Gets the labels associated with the on and off states of the toggle.
7656 * @param obj The toggle object
7657 * @param onlabel A char** to place the onlabel of @p obj into
7658 * @param offlabel A char** to place the offlabel of @p obj into
7660 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7662 * @brief Sets the state of the toggle to @p state.
7664 * @param obj The toggle object
7665 * @param state The state of @p obj
7667 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7669 * @brief Gets the state of the toggle to @p state.
7671 * @param obj The toggle object
7672 * @return The state of @p obj
7674 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7676 * @brief Sets the state pointer of the toggle to @p statep.
7678 * @param obj The toggle object
7679 * @param statep The state pointer of @p obj
7681 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7687 * @defgroup Frame Frame
7689 * @image html img/widget/frame/preview-00.png
7690 * @image latex img/widget/frame/preview-00.eps
7692 * @brief Frame is a widget that holds some content and has a title.
7694 * The default look is a frame with a title, but Frame supports multple
7702 * @li outdent_bottom
7704 * Of all this styles only default shows the title. Frame emits no signals.
7706 * For a detailed example see the @ref tutorial_frame.
7711 * @brief Add a new frame to the parent
7713 * @param parent The parent object
7714 * @return The new object or NULL if it cannot be created
7716 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7718 * @brief Set the frame label
7720 * @param obj The frame object
7721 * @param label The label of this frame object
7723 * @deprecated use elm_object_text_set() instead.
7725 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7727 * @brief Get the frame label
7729 * @param obj The frame object
7731 * @return The label of this frame objet or NULL if unable to get frame
7733 * @deprecated use elm_object_text_get() instead.
7735 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7737 * @brief Set the content of the frame widget
7739 * Once the content object is set, a previously set one will be deleted.
7740 * If you want to keep that old content object, use the
7741 * elm_frame_content_unset() function.
7743 * @param obj The frame object
7744 * @param content The content will be filled in this frame object
7746 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7748 * @brief Get the content of the frame widget
7750 * Return the content object which is set for this widget
7752 * @param obj The frame object
7753 * @return The content that is being used
7755 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7757 * @brief Unset the content of the frame widget
7759 * Unparent and return the content object which was set for this widget
7761 * @param obj The frame object
7762 * @return The content that was being used
7764 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7770 * @defgroup Table Table
7772 * A container widget to arrange other widgets in a table where items can
7773 * also span multiple columns or rows - even overlap (and then be raised or
7774 * lowered accordingly to adjust stacking if they do overlap).
7776 * The followin are examples of how to use a table:
7777 * @li @ref tutorial_table_01
7778 * @li @ref tutorial_table_02
7783 * @brief Add a new table to the parent
7785 * @param parent The parent object
7786 * @return The new object or NULL if it cannot be created
7788 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7790 * @brief Set the homogeneous layout in the table
7792 * @param obj The layout object
7793 * @param homogeneous A boolean to set if the layout is homogeneous in the
7794 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7796 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7798 * @brief Get the current table homogeneous mode.
7800 * @param obj The table object
7801 * @return A boolean to indicating if the layout is homogeneous in the table
7802 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7804 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7806 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7808 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7810 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7812 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7814 * @brief Set padding between cells.
7816 * @param obj The layout object.
7817 * @param horizontal set the horizontal padding.
7818 * @param vertical set the vertical padding.
7820 * Default value is 0.
7822 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7824 * @brief Get padding between cells.
7826 * @param obj The layout object.
7827 * @param horizontal set the horizontal padding.
7828 * @param vertical set the vertical padding.
7830 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7832 * @brief Add a subobject on the table with the coordinates passed
7834 * @param obj The table object
7835 * @param subobj The subobject to be added to the table
7836 * @param x Row number
7837 * @param y Column number
7841 * @note All positioning inside the table is relative to rows and columns, so
7842 * a value of 0 for x and y, means the top left cell of the table, and a
7843 * value of 1 for w and h means @p subobj only takes that 1 cell.
7845 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7847 * @brief Remove child from table.
7849 * @param obj The table object
7850 * @param subobj The subobject
7852 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7854 * @brief Faster way to remove all child objects from a table object.
7856 * @param obj The table object
7857 * @param clear If true, will delete children, else just remove from table.
7859 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7861 * @brief Set the packing location of an existing child of the table
7863 * @param subobj The subobject to be modified in the table
7864 * @param x Row number
7865 * @param y Column number
7869 * Modifies the position of an object already in the table.
7871 * @note All positioning inside the table is relative to rows and columns, so
7872 * a value of 0 for x and y, means the top left cell of the table, and a
7873 * value of 1 for w and h means @p subobj only takes that 1 cell.
7875 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7877 * @brief Get the packing location of an existing child of the table
7879 * @param subobj The subobject to be modified in the table
7880 * @param x Row number
7881 * @param y Column number
7885 * @see elm_table_pack_set()
7887 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7893 * @defgroup Gengrid Gengrid (Generic grid)
7895 * This widget aims to position objects in a grid layout while
7896 * actually creating and rendering only the visible ones, using the
7897 * same idea as the @ref Genlist "genlist": the user defines a @b
7898 * class for each item, specifying functions that will be called at
7899 * object creation, deletion, etc. When those items are selected by
7900 * the user, a callback function is issued. Users may interact with
7901 * a gengrid via the mouse (by clicking on items to select them and
7902 * clicking on the grid's viewport and swiping to pan the whole
7903 * view) or via the keyboard, navigating through item with the
7906 * @section Gengrid_Layouts Gengrid layouts
7908 * Gengrids may layout its items in one of two possible layouts:
7912 * When in "horizontal mode", items will be placed in @b columns,
7913 * from top to bottom and, when the space for a column is filled,
7914 * another one is started on the right, thus expanding the grid
7915 * horizontally, making for horizontal scrolling. When in "vertical
7916 * mode" , though, items will be placed in @b rows, from left to
7917 * right and, when the space for a row is filled, another one is
7918 * started below, thus expanding the grid vertically (and making
7919 * for vertical scrolling).
7921 * @section Gengrid_Items Gengrid items
7923 * An item in a gengrid can have 0 or more text labels (they can be
7924 * regular text or textblock Evas objects - that's up to the style
7925 * to determine), 0 or more icons (which are simply objects
7926 * swallowed into the gengrid item's theming Edje object) and 0 or
7927 * more <b>boolean states</b>, which have the behavior left to the
7928 * user to define. The Edje part names for each of these properties
7929 * will be looked up, in the theme file for the gengrid, under the
7930 * Edje (string) data items named @c "labels", @c "icons" and @c
7931 * "states", respectively. For each of those properties, if more
7932 * than one part is provided, they must have names listed separated
7933 * by spaces in the data fields. For the default gengrid item
7934 * theme, we have @b one label part (@c "elm.text"), @b two icon
7935 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7938 * A gengrid item may be at one of several styles. Elementary
7939 * provides one by default - "default", but this can be extended by
7940 * system or application custom themes/overlays/extensions (see
7941 * @ref Theme "themes" for more details).
7943 * @section Gengrid_Item_Class Gengrid item classes
7945 * In order to have the ability to add and delete items on the fly,
7946 * gengrid implements a class (callback) system where the
7947 * application provides a structure with information about that
7948 * type of item (gengrid may contain multiple different items with
7949 * different classes, states and styles). Gengrid will call the
7950 * functions in this struct (methods) when an item is "realized"
7951 * (i.e., created dynamically, while the user is scrolling the
7952 * grid). All objects will simply be deleted when no longer needed
7953 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7954 * contains the following members:
7955 * - @c item_style - This is a constant string and simply defines
7956 * the name of the item style. It @b must be specified and the
7957 * default should be @c "default".
7958 * - @c func.label_get - This function is called when an item
7959 * object is actually created. The @c data parameter will point to
7960 * the same data passed to elm_gengrid_item_append() and related
7961 * item creation functions. The @c obj parameter is the gengrid
7962 * object itself, while the @c part one is the name string of one
7963 * of the existing text parts in the Edje group implementing the
7964 * item's theme. This function @b must return a strdup'()ed string,
7965 * as the caller will free() it when done. See
7966 * #Elm_Gengrid_Item_Label_Get_Cb.
7967 * - @c func.icon_get - This function is called when an item object
7968 * is actually created. The @c data parameter will point to the
7969 * same data passed to elm_gengrid_item_append() and related item
7970 * creation functions. The @c obj parameter is the gengrid object
7971 * itself, while the @c part one is the name string of one of the
7972 * existing (icon) swallow parts in the Edje group implementing the
7973 * item's theme. It must return @c NULL, when no icon is desired,
7974 * or a valid object handle, otherwise. The object will be deleted
7975 * by the gengrid on its deletion or when the item is "unrealized".
7976 * See #Elm_Gengrid_Item_Icon_Get_Cb.
7977 * - @c func.state_get - This function is called when an item
7978 * object is actually created. The @c data parameter will point to
7979 * the same data passed to elm_gengrid_item_append() and related
7980 * item creation functions. The @c obj parameter is the gengrid
7981 * object itself, while the @c part one is the name string of one
7982 * of the state parts in the Edje group implementing the item's
7983 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7984 * true/on. Gengrids will emit a signal to its theming Edje object
7985 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7986 * "source" arguments, respectively, when the state is true (the
7987 * default is false), where @c XXX is the name of the (state) part.
7988 * See #Elm_Gengrid_Item_State_Get_Cb.
7989 * - @c func.del - This is called when elm_gengrid_item_del() is
7990 * called on an item or elm_gengrid_clear() is called on the
7991 * gengrid. This is intended for use when gengrid items are
7992 * deleted, so any data attached to the item (e.g. its data
7993 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7995 * @section Gengrid_Usage_Hints Usage hints
7997 * If the user wants to have multiple items selected at the same
7998 * time, elm_gengrid_multi_select_set() will permit it. If the
7999 * gengrid is single-selection only (the default), then
8000 * elm_gengrid_select_item_get() will return the selected item or
8001 * @c NULL, if none is selected. If the gengrid is under
8002 * multi-selection, then elm_gengrid_selected_items_get() will
8003 * return a list (that is only valid as long as no items are
8004 * modified (added, deleted, selected or unselected) of child items
8007 * If an item changes (internal (boolean) state, label or icon
8008 * changes), then use elm_gengrid_item_update() to have gengrid
8009 * update the item with the new state. A gengrid will re-"realize"
8010 * the item, thus calling the functions in the
8011 * #Elm_Gengrid_Item_Class set for that item.
8013 * To programmatically (un)select an item, use
8014 * elm_gengrid_item_selected_set(). To get its selected state use
8015 * elm_gengrid_item_selected_get(). To make an item disabled
8016 * (unable to be selected and appear differently) use
8017 * elm_gengrid_item_disabled_set() to set this and
8018 * elm_gengrid_item_disabled_get() to get the disabled state.
8020 * Grid cells will only have their selection smart callbacks called
8021 * when firstly getting selected. Any further clicks will do
8022 * nothing, unless you enable the "always select mode", with
8023 * elm_gengrid_always_select_mode_set(), thus making every click to
8024 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8025 * turn off the ability to select items entirely in the widget and
8026 * they will neither appear selected nor call the selection smart
8029 * Remember that you can create new styles and add your own theme
8030 * augmentation per application with elm_theme_extension_add(). If
8031 * you absolutely must have a specific style that overrides any
8032 * theme the user or system sets up you can use
8033 * elm_theme_overlay_add() to add such a file.
8035 * @section Gengrid_Smart_Events Gengrid smart events
8037 * Smart events that you can add callbacks for are:
8038 * - @c "activated" - The user has double-clicked or pressed
8039 * (enter|return|spacebar) on an item. The @c event_info parameter
8040 * is the gengrid item that was activated.
8041 * - @c "clicked,double" - The user has double-clicked an item.
8042 * The @c event_info parameter is the gengrid item that was double-clicked.
8043 * - @c "longpressed" - This is called when the item is pressed for a certain
8044 * amount of time. By default it's 1 second.
8045 * - @c "selected" - The user has made an item selected. The
8046 * @c event_info parameter is the gengrid item that was selected.
8047 * - @c "unselected" - The user has made an item unselected. The
8048 * @c event_info parameter is the gengrid item that was unselected.
8049 * - @c "realized" - This is called when the item in the gengrid
8050 * has its implementing Evas object instantiated, de facto. @c
8051 * event_info is the gengrid item that was created. The object
8052 * may be deleted at any time, so it is highly advised to the
8053 * caller @b not to use the object pointer returned from
8054 * elm_gengrid_item_object_get(), because it may point to freed
8056 * - @c "unrealized" - This is called when the implementing Evas
8057 * object for this item is deleted. @c event_info is the gengrid
8058 * item that was deleted.
8059 * - @c "changed" - Called when an item is added, removed, resized
8060 * or moved and when the gengrid is resized or gets "horizontal"
8062 * - @c "scroll,anim,start" - This is called when scrolling animation has
8064 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8066 * - @c "drag,start,up" - Called when the item in the gengrid has
8067 * been dragged (not scrolled) up.
8068 * - @c "drag,start,down" - Called when the item in the gengrid has
8069 * been dragged (not scrolled) down.
8070 * - @c "drag,start,left" - Called when the item in the gengrid has
8071 * been dragged (not scrolled) left.
8072 * - @c "drag,start,right" - Called when the item in the gengrid has
8073 * been dragged (not scrolled) right.
8074 * - @c "drag,stop" - Called when the item in the gengrid has
8075 * stopped being dragged.
8076 * - @c "drag" - Called when the item in the gengrid is being
8078 * - @c "scroll" - called when the content has been scrolled
8080 * - @c "scroll,drag,start" - called when dragging the content has
8082 * - @c "scroll,drag,stop" - called when dragging the content has
8084 * - @c "scroll,edge,top" - This is called when the gengrid is scrolled until
8086 * - @c "scroll,edge,bottom" - This is called when the gengrid is scrolled
8087 * until the bottom edge.
8088 * - @c "scroll,edge,left" - This is called when the gengrid is scrolled
8089 * until the left edge.
8090 * - @c "scroll,edge,right" - This is called when the gengrid is scrolled
8091 * until the right edge.
8093 * List of gengrid examples:
8094 * @li @ref gengrid_example
8098 * @addtogroup Gengrid
8102 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8103 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8104 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8105 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
8106 typedef Evas_Object *(*Elm_Gengrid_Item_Icon_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for gengrid item classes. */
8107 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. */
8108 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
8110 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
8111 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
8112 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
8113 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
8116 * @struct _Elm_Gengrid_Item_Class
8118 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8121 struct _Elm_Gengrid_Item_Class
8123 const char *item_style;
8124 struct _Elm_Gengrid_Item_Class_Func
8126 Elm_Gengrid_Item_Label_Get_Cb label_get;
8127 Elm_Gengrid_Item_Icon_Get_Cb icon_get;
8128 Elm_Gengrid_Item_State_Get_Cb state_get;
8129 Elm_Gengrid_Item_Del_Cb del;
8131 }; /**< #Elm_Gengrid_Item_Class member definitions */
8134 * Add a new gengrid widget to the given parent Elementary
8135 * (container) object
8137 * @param parent The parent object
8138 * @return a new gengrid widget handle or @c NULL, on errors
8140 * This function inserts a new gengrid widget on the canvas.
8142 * @see elm_gengrid_item_size_set()
8143 * @see elm_gengrid_group_item_size_set()
8144 * @see elm_gengrid_horizontal_set()
8145 * @see elm_gengrid_item_append()
8146 * @see elm_gengrid_item_del()
8147 * @see elm_gengrid_clear()
8151 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8154 * Set the size for the items of a given gengrid widget
8156 * @param obj The gengrid object.
8157 * @param w The items' width.
8158 * @param h The items' height;
8160 * A gengrid, after creation, has still no information on the size
8161 * to give to each of its cells. So, you most probably will end up
8162 * with squares one @ref Fingers "finger" wide, the default
8163 * size. Use this function to force a custom size for you items,
8164 * making them as big as you wish.
8166 * @see elm_gengrid_item_size_get()
8170 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8173 * Get the size set for the items of a given gengrid widget
8175 * @param obj The gengrid object.
8176 * @param w Pointer to a variable where to store the items' width.
8177 * @param h Pointer to a variable where to store the items' height.
8179 * @note Use @c NULL pointers on the size values you're not
8180 * interested in: they'll be ignored by the function.
8182 * @see elm_gengrid_item_size_get() for more details
8186 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8189 * Set the size for the group items of a given gengrid widget
8191 * @param obj The gengrid object.
8192 * @param w The group items' width.
8193 * @param h The group items' height;
8195 * A gengrid, after creation, has still no information on the size
8196 * to give to each of its cells. So, you most probably will end up
8197 * with squares one @ref Fingers "finger" wide, the default
8198 * size. Use this function to force a custom size for you group items,
8199 * making them as big as you wish.
8201 * @see elm_gengrid_group_item_size_get()
8205 EAPI void elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8208 * Get the size set for the group items of a given gengrid widget
8210 * @param obj The gengrid object.
8211 * @param w Pointer to a variable where to store the group items' width.
8212 * @param h Pointer to a variable where to store the group items' height.
8214 * @note Use @c NULL pointers on the size values you're not
8215 * interested in: they'll be ignored by the function.
8217 * @see elm_gengrid_group_item_size_get() for more details
8221 EAPI void elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8224 * Set the items grid's alignment within a given gengrid widget
8226 * @param obj The gengrid object.
8227 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8228 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8230 * This sets the alignment of the whole grid of items of a gengrid
8231 * within its given viewport. By default, those values are both
8232 * 0.5, meaning that the gengrid will have its items grid placed
8233 * exactly in the middle of its viewport.
8235 * @note If given alignment values are out of the cited ranges,
8236 * they'll be changed to the nearest boundary values on the valid
8239 * @see elm_gengrid_align_get()
8243 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8246 * Get the items grid's alignment values within a given gengrid
8249 * @param obj The gengrid object.
8250 * @param align_x Pointer to a variable where to store the
8251 * horizontal alignment.
8252 * @param align_y Pointer to a variable where to store the vertical
8255 * @note Use @c NULL pointers on the alignment values you're not
8256 * interested in: they'll be ignored by the function.
8258 * @see elm_gengrid_align_set() for more details
8262 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8265 * Set whether a given gengrid widget is or not able have items
8268 * @param obj The gengrid object
8269 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8270 * @c EINA_FALSE to turn it off
8272 * If a gengrid is set to allow reordering, a click held for more
8273 * than 0.5 over a given item will highlight it specially,
8274 * signalling the gengrid has entered the reordering state. From
8275 * that time on, the user will be able to, while still holding the
8276 * mouse button down, move the item freely in the gengrid's
8277 * viewport, replacing to said item to the locations it goes to.
8278 * The replacements will be animated and, whenever the user
8279 * releases the mouse button, the item being replaced gets a new
8280 * definitive place in the grid.
8282 * @see elm_gengrid_reorder_mode_get()
8286 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8289 * Get whether a given gengrid widget is or not able have items
8292 * @param obj The gengrid object
8293 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8296 * @see elm_gengrid_reorder_mode_set() for more details
8300 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8303 * Append a new item in a given gengrid widget.
8305 * @param obj The gengrid object.
8306 * @param gic The item class for the item.
8307 * @param data The item data.
8308 * @param func Convenience function called when the item is
8310 * @param func_data Data to be passed to @p func.
8311 * @return A handle to the item added or @c NULL, on errors.
8313 * This adds an item to the beginning of the gengrid.
8315 * @see elm_gengrid_item_prepend()
8316 * @see elm_gengrid_item_insert_before()
8317 * @see elm_gengrid_item_insert_after()
8318 * @see elm_gengrid_item_del()
8322 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);
8325 * Prepend a new item in a given gengrid widget.
8327 * @param obj The gengrid object.
8328 * @param gic The item class for the item.
8329 * @param data The item data.
8330 * @param func Convenience function called when the item is
8332 * @param func_data Data to be passed to @p func.
8333 * @return A handle to the item added or @c NULL, on errors.
8335 * This adds an item to the end of the gengrid.
8337 * @see elm_gengrid_item_append()
8338 * @see elm_gengrid_item_insert_before()
8339 * @see elm_gengrid_item_insert_after()
8340 * @see elm_gengrid_item_del()
8344 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);
8347 * Insert an item before another in a gengrid widget
8349 * @param obj The gengrid object.
8350 * @param gic The item class for the item.
8351 * @param data The item data.
8352 * @param relative The item to place this new one before.
8353 * @param func Convenience function called when the item is
8355 * @param func_data Data to be passed to @p func.
8356 * @return A handle to the item added or @c NULL, on errors.
8358 * This inserts an item before another in the gengrid.
8360 * @see elm_gengrid_item_append()
8361 * @see elm_gengrid_item_prepend()
8362 * @see elm_gengrid_item_insert_after()
8363 * @see elm_gengrid_item_del()
8367 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);
8370 * Insert an item after another in a gengrid widget
8372 * @param obj The gengrid object.
8373 * @param gic The item class for the item.
8374 * @param data The item data.
8375 * @param relative The item to place this new one after.
8376 * @param func Convenience function called when the item is
8378 * @param func_data Data to be passed to @p func.
8379 * @return A handle to the item added or @c NULL, on errors.
8381 * This inserts an item after another in the gengrid.
8383 * @see elm_gengrid_item_append()
8384 * @see elm_gengrid_item_prepend()
8385 * @see elm_gengrid_item_insert_after()
8386 * @see elm_gengrid_item_del()
8390 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);
8392 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);
8394 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);
8397 * Set whether items on a given gengrid widget are to get their
8398 * selection callbacks issued for @b every subsequent selection
8399 * click on them or just for the first click.
8401 * @param obj The gengrid object
8402 * @param always_select @c EINA_TRUE to make items "always
8403 * selected", @c EINA_FALSE, otherwise
8405 * By default, grid items will only call their selection callback
8406 * function when firstly getting selected, any subsequent further
8407 * clicks will do nothing. With this call, you make those
8408 * subsequent clicks also to issue the selection callbacks.
8410 * @note <b>Double clicks</b> will @b always be reported on items.
8412 * @see elm_gengrid_always_select_mode_get()
8416 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8419 * Get whether items on a given gengrid widget have their selection
8420 * callbacks issued for @b every subsequent selection click on them
8421 * or just for the first click.
8423 * @param obj The gengrid object.
8424 * @return @c EINA_TRUE if the gengrid items are "always selected",
8425 * @c EINA_FALSE, otherwise
8427 * @see elm_gengrid_always_select_mode_set() for more details
8431 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8434 * Set whether items on a given gengrid widget can be selected or not.
8436 * @param obj The gengrid object
8437 * @param no_select @c EINA_TRUE to make items selectable,
8438 * @c EINA_FALSE otherwise
8440 * This will make items in @p obj selectable or not. In the latter
8441 * case, any user interaction on the gengrid items will neither make
8442 * them appear selected nor them call their selection callback
8445 * @see elm_gengrid_no_select_mode_get()
8449 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8452 * Get whether items on a given gengrid widget can be selected or
8455 * @param obj The gengrid object
8456 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8459 * @see elm_gengrid_no_select_mode_set() for more details
8463 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8466 * Enable or disable multi-selection in a given gengrid widget
8468 * @param obj The gengrid object.
8469 * @param multi @c EINA_TRUE, to enable multi-selection,
8470 * @c EINA_FALSE to disable it.
8472 * Multi-selection is the ability for one to have @b more than one
8473 * item selected, on a given gengrid, simultaneously. When it is
8474 * enabled, a sequence of clicks on different items will make them
8475 * all selected, progressively. A click on an already selected item
8476 * will unselect it. If interecting via the keyboard,
8477 * multi-selection is enabled while holding the "Shift" key.
8479 * @note By default, multi-selection is @b disabled on gengrids
8481 * @see elm_gengrid_multi_select_get()
8485 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8488 * Get whether multi-selection is enabled or disabled for a given
8491 * @param obj The gengrid object.
8492 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8493 * EINA_FALSE otherwise
8495 * @see elm_gengrid_multi_select_set() for more details
8499 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8502 * Enable or disable bouncing effect for a given gengrid widget
8504 * @param obj The gengrid object
8505 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8506 * @c EINA_FALSE to disable it
8507 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8508 * @c EINA_FALSE to disable it
8510 * The bouncing effect occurs whenever one reaches the gengrid's
8511 * edge's while panning it -- it will scroll past its limits a
8512 * little bit and return to the edge again, in a animated for,
8515 * @note By default, gengrids have bouncing enabled on both axis
8517 * @see elm_gengrid_bounce_get()
8521 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8524 * Get whether bouncing effects are enabled or disabled, for a
8525 * given gengrid widget, on each axis
8527 * @param obj The gengrid object
8528 * @param h_bounce Pointer to a variable where to store the
8529 * horizontal bouncing flag.
8530 * @param v_bounce Pointer to a variable where to store the
8531 * vertical bouncing flag.
8533 * @see elm_gengrid_bounce_set() for more details
8537 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8540 * Set a given gengrid widget's scrolling page size, relative to
8541 * its viewport size.
8543 * @param obj The gengrid object
8544 * @param h_pagerel The horizontal page (relative) size
8545 * @param v_pagerel The vertical page (relative) size
8547 * The gengrid's scroller is capable of binding scrolling by the
8548 * user to "pages". It means that, while scrolling and, specially
8549 * after releasing the mouse button, the grid will @b snap to the
8550 * nearest displaying page's area. When page sizes are set, the
8551 * grid's continuous content area is split into (equal) page sized
8554 * This function sets the size of a page <b>relatively to the
8555 * viewport dimensions</b> of the gengrid, for each axis. A value
8556 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8557 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8558 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8559 * 1.0. Values beyond those will make it behave behave
8560 * inconsistently. If you only want one axis to snap to pages, use
8561 * the value @c 0.0 for the other one.
8563 * There is a function setting page size values in @b absolute
8564 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8565 * is mutually exclusive to this one.
8567 * @see elm_gengrid_page_relative_get()
8571 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8574 * Get a given gengrid widget's scrolling page size, relative to
8575 * its viewport size.
8577 * @param obj The gengrid object
8578 * @param h_pagerel Pointer to a variable where to store the
8579 * horizontal page (relative) size
8580 * @param v_pagerel Pointer to a variable where to store the
8581 * vertical page (relative) size
8583 * @see elm_gengrid_page_relative_set() for more details
8587 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8590 * Set a given gengrid widget's scrolling page size
8592 * @param obj The gengrid object
8593 * @param h_pagerel The horizontal page size, in pixels
8594 * @param v_pagerel The vertical page size, in pixels
8596 * The gengrid's scroller is capable of binding scrolling by the
8597 * user to "pages". It means that, while scrolling and, specially
8598 * after releasing the mouse button, the grid will @b snap to the
8599 * nearest displaying page's area. When page sizes are set, the
8600 * grid's continuous content area is split into (equal) page sized
8603 * This function sets the size of a page of the gengrid, in pixels,
8604 * for each axis. Sane usable values are, between @c 0 and the
8605 * dimensions of @p obj, for each axis. Values beyond those will
8606 * make it behave behave inconsistently. If you only want one axis
8607 * to snap to pages, use the value @c 0 for the other one.
8609 * There is a function setting page size values in @b relative
8610 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8611 * use is mutually exclusive to this one.
8615 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8618 * @brief Get gengrid current page number.
8620 * @param obj The gengrid object
8621 * @param h_pagenumber The horizontal page number
8622 * @param v_pagenumber The vertical page number
8624 * The page number starts from 0. 0 is the first page.
8625 * Current page means the page which meet the top-left of the viewport.
8626 * If there are two or more pages in the viewport, it returns the number of page
8627 * which meet the top-left of the viewport.
8629 * @see elm_gengrid_last_page_get()
8630 * @see elm_gengrid_page_show()
8631 * @see elm_gengrid_page_brint_in()
8633 EAPI void elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8636 * @brief Get scroll last page number.
8638 * @param obj The gengrid object
8639 * @param h_pagenumber The horizontal page number
8640 * @param v_pagenumber The vertical page number
8642 * The page number starts from 0. 0 is the first page.
8643 * This returns the last page number among the pages.
8645 * @see elm_gengrid_current_page_get()
8646 * @see elm_gengrid_page_show()
8647 * @see elm_gengrid_page_brint_in()
8649 EAPI void elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8652 * Show a specific virtual region within the gengrid content object by page number.
8654 * @param obj The gengrid object
8655 * @param h_pagenumber The horizontal page number
8656 * @param v_pagenumber The vertical page number
8658 * 0, 0 of the indicated page is located at the top-left of the viewport.
8659 * This will jump to the page directly without animation.
8664 * sc = elm_gengrid_add(win);
8665 * elm_gengrid_content_set(sc, content);
8666 * elm_gengrid_page_relative_set(sc, 1, 0);
8667 * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8668 * elm_gengrid_page_show(sc, h_page + 1, v_page);
8671 * @see elm_gengrid_page_bring_in()
8673 EAPI void elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8676 * Show a specific virtual region within the gengrid content object by page number.
8678 * @param obj The gengrid object
8679 * @param h_pagenumber The horizontal page number
8680 * @param v_pagenumber The vertical page number
8682 * 0, 0 of the indicated page is located at the top-left of the viewport.
8683 * This will slide to the page with animation.
8688 * sc = elm_gengrid_add(win);
8689 * elm_gengrid_content_set(sc, content);
8690 * elm_gengrid_page_relative_set(sc, 1, 0);
8691 * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8692 * elm_gengrid_page_bring_in(sc, h_page, v_page);
8695 * @see elm_gengrid_page_show()
8697 EAPI void elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8700 * Set for what direction a given gengrid widget will expand while
8701 * placing its items.
8703 * @param obj The gengrid object.
8704 * @param setting @c EINA_TRUE to make the gengrid expand
8705 * horizontally, @c EINA_FALSE to expand vertically.
8707 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8708 * in @b columns, from top to bottom and, when the space for a
8709 * column is filled, another one is started on the right, thus
8710 * expanding the grid horizontally. When in "vertical mode"
8711 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8712 * to right and, when the space for a row is filled, another one is
8713 * started below, thus expanding the grid vertically.
8715 * @see elm_gengrid_horizontal_get()
8719 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8722 * Get for what direction a given gengrid widget will expand while
8723 * placing its items.
8725 * @param obj The gengrid object.
8726 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8727 * @c EINA_FALSE if it's set to expand vertically.
8729 * @see elm_gengrid_horizontal_set() for more detais
8733 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8736 * Get the first item in a given gengrid widget
8738 * @param obj The gengrid object
8739 * @return The first item's handle or @c NULL, if there are no
8740 * items in @p obj (and on errors)
8742 * This returns the first item in the @p obj's internal list of
8745 * @see elm_gengrid_last_item_get()
8749 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8752 * Get the last item in a given gengrid widget
8754 * @param obj The gengrid object
8755 * @return The last item's handle or @c NULL, if there are no
8756 * items in @p obj (and on errors)
8758 * This returns the last item in the @p obj's internal list of
8761 * @see elm_gengrid_first_item_get()
8765 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8768 * Get the @b next item in a gengrid widget's internal list of items,
8769 * given a handle to one of those items.
8771 * @param item The gengrid item to fetch next from
8772 * @return The item after @p item, or @c NULL if there's none (and
8775 * This returns the item placed after the @p item, on the container
8778 * @see elm_gengrid_item_prev_get()
8782 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8785 * Get the @b previous item in a gengrid widget's internal list of items,
8786 * given a handle to one of those items.
8788 * @param item The gengrid item to fetch previous from
8789 * @return The item before @p item, or @c NULL if there's none (and
8792 * This returns the item placed before the @p item, on the container
8795 * @see elm_gengrid_item_next_get()
8799 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8802 * Get the gengrid object's handle which contains a given gengrid
8805 * @param item The item to fetch the container from
8806 * @return The gengrid (parent) object
8808 * This returns the gengrid object itself that an item belongs to.
8812 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8815 * Remove a gengrid item from the its parent, deleting it.
8817 * @param item The item to be removed.
8818 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8820 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8825 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8828 * Update the contents of a given gengrid item
8830 * @param item The gengrid item
8832 * This updates an item by calling all the item class functions
8833 * again to get the icons, labels and states. Use this when the
8834 * original item data has changed and you want thta changes to be
8839 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8840 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8841 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8844 * Return the data associated to a given gengrid item
8846 * @param item The gengrid item.
8847 * @return the data associated to this item.
8849 * This returns the @c data value passed on the
8850 * elm_gengrid_item_append() and related item addition calls.
8852 * @see elm_gengrid_item_append()
8853 * @see elm_gengrid_item_data_set()
8857 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8860 * Set the data associated to a given gengrid item
8862 * @param item The gengrid item
8863 * @param data The new data pointer to set on it
8865 * This @b overrides the @c data value passed on the
8866 * elm_gengrid_item_append() and related item addition calls. This
8867 * function @b won't call elm_gengrid_item_update() automatically,
8868 * so you'd issue it afterwards if you want to hove the item
8869 * updated to reflect the that new data.
8871 * @see elm_gengrid_item_data_get()
8875 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8878 * Get a given gengrid item's position, relative to the whole
8879 * gengrid's grid area.
8881 * @param item The Gengrid item.
8882 * @param x Pointer to variable where to store the item's <b>row
8884 * @param y Pointer to variable where to store the item's <b>column
8887 * This returns the "logical" position of the item whithin the
8888 * gengrid. For example, @c (0, 1) would stand for first row,
8893 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8896 * Set whether a given gengrid item is selected or not
8898 * @param item The gengrid item
8899 * @param selected Use @c EINA_TRUE, to make it selected, @c
8900 * EINA_FALSE to make it unselected
8902 * This sets the selected state of an item. If multi selection is
8903 * not enabled on the containing gengrid and @p selected is @c
8904 * EINA_TRUE, any other previously selected items will get
8905 * unselected in favor of this new one.
8907 * @see elm_gengrid_item_selected_get()
8911 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8914 * Get whether a given gengrid item is selected or not
8916 * @param item The gengrid item
8917 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8919 * @see elm_gengrid_item_selected_set() for more details
8923 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8926 * Get the real Evas object created to implement the view of a
8927 * given gengrid item
8929 * @param item The gengrid item.
8930 * @return the Evas object implementing this item's view.
8932 * This returns the actual Evas object used to implement the
8933 * specified gengrid item's view. This may be @c NULL, as it may
8934 * not have been created or may have been deleted, at any time, by
8935 * the gengrid. <b>Do not modify this object</b> (move, resize,
8936 * show, hide, etc.), as the gengrid is controlling it. This
8937 * function is for querying, emitting custom signals or hooking
8938 * lower level callbacks for events on that object. Do not delete
8939 * this object under any circumstances.
8941 * @see elm_gengrid_item_data_get()
8945 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8948 * Show the portion of a gengrid's internal grid containing a given
8949 * item, @b immediately.
8951 * @param item The item to display
8953 * This causes gengrid to @b redraw its viewport's contents to the
8954 * region contining the given @p item item, if it is not fully
8957 * @see elm_gengrid_item_bring_in()
8961 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8964 * Animatedly bring in, to the visible are of a gengrid, a given
8967 * @param item The gengrid item to display
8969 * This causes gengrig to jump to the given @p item item and show
8970 * it (by scrolling), if it is not fully visible. This will use
8971 * animation to do so and take a period of time to complete.
8973 * @see elm_gengrid_item_show()
8977 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8980 * Set whether a given gengrid item is disabled or not.
8982 * @param item The gengrid item
8983 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8984 * to enable it back.
8986 * A disabled item cannot be selected or unselected. It will also
8987 * change its appearance, to signal the user it's disabled.
8989 * @see elm_gengrid_item_disabled_get()
8993 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8996 * Get whether a given gengrid item is disabled or not.
8998 * @param item The gengrid item
8999 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9002 * @see elm_gengrid_item_disabled_set() for more details
9006 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9009 * Set the text to be shown in a given gengrid item's tooltips.
9011 * @param item The gengrid item
9012 * @param text The text to set in the content
9014 * This call will setup the text to be used as tooltip to that item
9015 * (analogous to elm_object_tooltip_text_set(), but being item
9016 * tooltips with higher precedence than object tooltips). It can
9017 * have only one tooltip at a time, so any previous tooltip data
9022 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9025 * Set the content to be shown in a given gengrid item's tooltips
9027 * @param item The gengrid item.
9028 * @param func The function returning the tooltip contents.
9029 * @param data What to provide to @a func as callback data/context.
9030 * @param del_cb Called when data is not needed anymore, either when
9031 * another callback replaces @p func, the tooltip is unset with
9032 * elm_gengrid_item_tooltip_unset() or the owner @p item
9033 * dies. This callback receives as its first parameter the
9034 * given @p data, being @c event_info the item handle.
9036 * This call will setup the tooltip's contents to @p item
9037 * (analogous to elm_object_tooltip_content_cb_set(), but being
9038 * item tooltips with higher precedence than object tooltips). It
9039 * can have only one tooltip at a time, so any previous tooltip
9040 * content will get removed. @p func (with @p data) will be called
9041 * every time Elementary needs to show the tooltip and it should
9042 * return a valid Evas object, which will be fully managed by the
9043 * tooltip system, getting deleted when the tooltip is gone.
9047 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);
9050 * Unset a tooltip from a given gengrid item
9052 * @param item gengrid item to remove a previously set tooltip from.
9054 * This call removes any tooltip set on @p item. The callback
9055 * provided as @c del_cb to
9056 * elm_gengrid_item_tooltip_content_cb_set() will be called to
9057 * notify it is not used anymore (and have resources cleaned, if
9060 * @see elm_gengrid_item_tooltip_content_cb_set()
9064 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9067 * Set a different @b style for a given gengrid item's tooltip.
9069 * @param item gengrid item with tooltip set
9070 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9071 * "default", @c "transparent", etc)
9073 * Tooltips can have <b>alternate styles</b> to be displayed on,
9074 * which are defined by the theme set on Elementary. This function
9075 * works analogously as elm_object_tooltip_style_set(), but here
9076 * applied only to gengrid item objects. The default style for
9077 * tooltips is @c "default".
9079 * @note before you set a style you should define a tooltip with
9080 * elm_gengrid_item_tooltip_content_cb_set() or
9081 * elm_gengrid_item_tooltip_text_set()
9083 * @see elm_gengrid_item_tooltip_style_get()
9087 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9090 * Get the style set a given gengrid item's tooltip.
9092 * @param item gengrid item with tooltip already set on.
9093 * @return style the theme style in use, which defaults to
9094 * "default". If the object does not have a tooltip set,
9095 * then @c NULL is returned.
9097 * @see elm_gengrid_item_tooltip_style_set() for more details
9101 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9103 * @brief Disable size restrictions on an object's tooltip
9104 * @param item The tooltip's anchor object
9105 * @param disable If EINA_TRUE, size restrictions are disabled
9106 * @return EINA_FALSE on failure, EINA_TRUE on success
9108 * This function allows a tooltip to expand beyond its parant window's canvas.
9109 * It will instead be limited only by the size of the display.
9111 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9113 * @brief Retrieve size restriction state of an object's tooltip
9114 * @param item The tooltip's anchor object
9115 * @return If EINA_TRUE, size restrictions are disabled
9117 * This function returns whether a tooltip is allowed to expand beyond
9118 * its parant window's canvas.
9119 * It will instead be limited only by the size of the display.
9121 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9123 * Set the type of mouse pointer/cursor decoration to be shown,
9124 * when the mouse pointer is over the given gengrid widget item
9126 * @param item gengrid item to customize cursor on
9127 * @param cursor the cursor type's name
9129 * This function works analogously as elm_object_cursor_set(), but
9130 * here the cursor's changing area is restricted to the item's
9131 * area, and not the whole widget's. Note that that item cursors
9132 * have precedence over widget cursors, so that a mouse over @p
9133 * item will always show cursor @p type.
9135 * If this function is called twice for an object, a previously set
9136 * cursor will be unset on the second call.
9138 * @see elm_object_cursor_set()
9139 * @see elm_gengrid_item_cursor_get()
9140 * @see elm_gengrid_item_cursor_unset()
9144 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9147 * Get the type of mouse pointer/cursor decoration set to be shown,
9148 * when the mouse pointer is over the given gengrid widget item
9150 * @param item gengrid item with custom cursor set
9151 * @return the cursor type's name or @c NULL, if no custom cursors
9152 * were set to @p item (and on errors)
9154 * @see elm_object_cursor_get()
9155 * @see elm_gengrid_item_cursor_set() for more details
9156 * @see elm_gengrid_item_cursor_unset()
9160 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9163 * Unset any custom mouse pointer/cursor decoration set to be
9164 * shown, when the mouse pointer is over the given gengrid widget
9165 * item, thus making it show the @b default cursor again.
9167 * @param item a gengrid item
9169 * Use this call to undo any custom settings on this item's cursor
9170 * decoration, bringing it back to defaults (no custom style set).
9172 * @see elm_object_cursor_unset()
9173 * @see elm_gengrid_item_cursor_set() for more details
9177 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9180 * Set a different @b style for a given custom cursor set for a
9183 * @param item gengrid item with custom cursor set
9184 * @param style the <b>theme style</b> to use (e.g. @c "default",
9185 * @c "transparent", etc)
9187 * This function only makes sense when one is using custom mouse
9188 * cursor decorations <b>defined in a theme file</b> , which can
9189 * have, given a cursor name/type, <b>alternate styles</b> on
9190 * it. It works analogously as elm_object_cursor_style_set(), but
9191 * here applied only to gengrid item objects.
9193 * @warning Before you set a cursor style you should have defined a
9194 * custom cursor previously on the item, with
9195 * elm_gengrid_item_cursor_set()
9197 * @see elm_gengrid_item_cursor_engine_only_set()
9198 * @see elm_gengrid_item_cursor_style_get()
9202 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9205 * Get the current @b style set for a given gengrid item's custom
9208 * @param item gengrid item with custom cursor set.
9209 * @return style the cursor style in use. If the object does not
9210 * have a cursor set, then @c NULL is returned.
9212 * @see elm_gengrid_item_cursor_style_set() for more details
9216 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9219 * Set if the (custom) cursor for a given gengrid item should be
9220 * searched in its theme, also, or should only rely on the
9223 * @param item item with custom (custom) cursor already set on
9224 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9225 * only on those provided by the rendering engine, @c EINA_FALSE to
9226 * have them searched on the widget's theme, as well.
9228 * @note This call is of use only if you've set a custom cursor
9229 * for gengrid items, with elm_gengrid_item_cursor_set().
9231 * @note By default, cursors will only be looked for between those
9232 * provided by the rendering engine.
9236 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9239 * Get if the (custom) cursor for a given gengrid item is being
9240 * searched in its theme, also, or is only relying on the rendering
9243 * @param item a gengrid item
9244 * @return @c EINA_TRUE, if cursors are being looked for only on
9245 * those provided by the rendering engine, @c EINA_FALSE if they
9246 * are being searched on the widget's theme, as well.
9248 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9252 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9255 * Remove all items from a given gengrid widget
9257 * @param obj The gengrid object.
9259 * This removes (and deletes) all items in @p obj, leaving it
9262 * @see elm_gengrid_item_del(), to remove just one item.
9266 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9269 * Get the selected item in a given gengrid widget
9271 * @param obj The gengrid object.
9272 * @return The selected item's handleor @c NULL, if none is
9273 * selected at the moment (and on errors)
9275 * This returns the selected item in @p obj. If multi selection is
9276 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9277 * the first item in the list is selected, which might not be very
9278 * useful. For that case, see elm_gengrid_selected_items_get().
9282 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9285 * Get <b>a list</b> of selected items in a given gengrid
9287 * @param obj The gengrid object.
9288 * @return The list of selected items or @c NULL, if none is
9289 * selected at the moment (and on errors)
9291 * This returns a list of the selected items, in the order that
9292 * they appear in the grid. This list is only valid as long as no
9293 * more items are selected or unselected (or unselected implictly
9294 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9297 * @see elm_gengrid_selected_item_get()
9301 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9308 * @defgroup Clock Clock
9310 * @image html img/widget/clock/preview-00.png
9311 * @image latex img/widget/clock/preview-00.eps
9313 * This is a @b digital clock widget. In its default theme, it has a
9314 * vintage "flipping numbers clock" appearance, which will animate
9315 * sheets of individual algarisms individually as time goes by.
9317 * A newly created clock will fetch system's time (already
9318 * considering local time adjustments) to start with, and will tick
9319 * accondingly. It may or may not show seconds.
9321 * Clocks have an @b edition mode. When in it, the sheets will
9322 * display extra arrow indications on the top and bottom and the
9323 * user may click on them to raise or lower the time values. After
9324 * it's told to exit edition mode, it will keep ticking with that
9325 * new time set (it keeps the difference from local time).
9327 * Also, when under edition mode, user clicks on the cited arrows
9328 * which are @b held for some time will make the clock to flip the
9329 * sheet, thus editing the time, continuosly and automatically for
9330 * the user. The interval between sheet flips will keep growing in
9331 * time, so that it helps the user to reach a time which is distant
9334 * The time display is, by default, in military mode (24h), but an
9335 * am/pm indicator may be optionally shown, too, when it will
9338 * Smart callbacks one can register to:
9339 * - "changed" - the clock's user changed the time
9341 * Here is an example on its usage:
9342 * @li @ref clock_example
9351 * Identifiers for which clock digits should be editable, when a
9352 * clock widget is in edition mode. Values may be ORed together to
9353 * make a mask, naturally.
9355 * @see elm_clock_edit_set()
9356 * @see elm_clock_digit_edit_set()
9358 typedef enum _Elm_Clock_Digedit
9360 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9361 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9362 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9363 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9364 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9365 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9366 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9367 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9368 } Elm_Clock_Digedit;
9371 * Add a new clock widget to the given parent Elementary
9372 * (container) object
9374 * @param parent The parent object
9375 * @return a new clock widget handle or @c NULL, on errors
9377 * This function inserts a new clock widget on the canvas.
9381 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9384 * Set a clock widget's time, programmatically
9386 * @param obj The clock widget object
9387 * @param hrs The hours to set
9388 * @param min The minutes to set
9389 * @param sec The secondes to set
9391 * This function updates the time that is showed by the clock
9394 * Values @b must be set within the following ranges:
9395 * - 0 - 23, for hours
9396 * - 0 - 59, for minutes
9397 * - 0 - 59, for seconds,
9399 * even if the clock is not in "military" mode.
9401 * @warning The behavior for values set out of those ranges is @b
9406 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9409 * Get a clock widget's time values
9411 * @param obj The clock object
9412 * @param[out] hrs Pointer to the variable to get the hours value
9413 * @param[out] min Pointer to the variable to get the minutes value
9414 * @param[out] sec Pointer to the variable to get the seconds value
9416 * This function gets the time set for @p obj, returning
9417 * it on the variables passed as the arguments to function
9419 * @note Use @c NULL pointers on the time values you're not
9420 * interested in: they'll be ignored by the function.
9424 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9427 * Set whether a given clock widget is under <b>edition mode</b> or
9428 * under (default) displaying-only mode.
9430 * @param obj The clock object
9431 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9432 * put it back to "displaying only" mode
9434 * This function makes a clock's time to be editable or not <b>by
9435 * user interaction</b>. When in edition mode, clocks @b stop
9436 * ticking, until one brings them back to canonical mode. The
9437 * elm_clock_digit_edit_set() function will influence which digits
9438 * of the clock will be editable. By default, all of them will be
9439 * (#ELM_CLOCK_NONE).
9441 * @note am/pm sheets, if being shown, will @b always be editable
9442 * under edition mode.
9444 * @see elm_clock_edit_get()
9448 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9451 * Retrieve whether a given clock widget is under <b>edition
9452 * mode</b> or under (default) displaying-only mode.
9454 * @param obj The clock object
9455 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9458 * This function retrieves whether the clock's time can be edited
9459 * or not by user interaction.
9461 * @see elm_clock_edit_set() for more details
9465 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9468 * Set what digits of the given clock widget should be editable
9469 * when in edition mode.
9471 * @param obj The clock object
9472 * @param digedit Bit mask indicating the digits to be editable
9473 * (values in #Elm_Clock_Digedit).
9475 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9476 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9479 * @see elm_clock_digit_edit_get()
9483 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9486 * Retrieve what digits of the given clock widget should be
9487 * editable when in edition mode.
9489 * @param obj The clock object
9490 * @return Bit mask indicating the digits to be editable
9491 * (values in #Elm_Clock_Digedit).
9493 * @see elm_clock_digit_edit_set() for more details
9497 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9500 * Set if the given clock widget must show hours in military or
9503 * @param obj The clock object
9504 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9507 * This function sets if the clock must show hours in military or
9508 * am/pm mode. In some countries like Brazil the military mode
9509 * (00-24h-format) is used, in opposition to the USA, where the
9510 * am/pm mode is more commonly used.
9512 * @see elm_clock_show_am_pm_get()
9516 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9519 * Get if the given clock widget shows hours in military or am/pm
9522 * @param obj The clock object
9523 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9526 * This function gets if the clock shows hours in military or am/pm
9529 * @see elm_clock_show_am_pm_set() for more details
9533 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9536 * Set if the given clock widget must show time with seconds or not
9538 * @param obj The clock object
9539 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9541 * This function sets if the given clock must show or not elapsed
9542 * seconds. By default, they are @b not shown.
9544 * @see elm_clock_show_seconds_get()
9548 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9551 * Get whether the given clock widget is showing time with seconds
9554 * @param obj The clock object
9555 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9557 * This function gets whether @p obj is showing or not the elapsed
9560 * @see elm_clock_show_seconds_set()
9564 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9567 * Set the interval on time updates for an user mouse button hold
9568 * on clock widgets' time edition.
9570 * @param obj The clock object
9571 * @param interval The (first) interval value in seconds
9573 * This interval value is @b decreased while the user holds the
9574 * mouse pointer either incrementing or decrementing a given the
9575 * clock digit's value.
9577 * This helps the user to get to a given time distant from the
9578 * current one easier/faster, as it will start to flip quicker and
9579 * quicker on mouse button holds.
9581 * The calculation for the next flip interval value, starting from
9582 * the one set with this call, is the previous interval divided by
9583 * 1.05, so it decreases a little bit.
9585 * The default starting interval value for automatic flips is
9588 * @see elm_clock_interval_get()
9592 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9595 * Get the interval on time updates for an user mouse button hold
9596 * on clock widgets' time edition.
9598 * @param obj The clock object
9599 * @return The (first) interval value, in seconds, set on it
9601 * @see elm_clock_interval_set() for more details
9605 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9612 * @defgroup Layout Layout
9614 * @image html img/widget/layout/preview-00.png
9615 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9617 * @image html img/layout-predefined.png
9618 * @image latex img/layout-predefined.eps width=\textwidth
9620 * This is a container widget that takes a standard Edje design file and
9621 * wraps it very thinly in a widget.
9623 * An Edje design (theme) file has a very wide range of possibilities to
9624 * describe the behavior of elements added to the Layout. Check out the Edje
9625 * documentation and the EDC reference to get more information about what can
9626 * be done with Edje.
9628 * Just like @ref List, @ref Box, and other container widgets, any
9629 * object added to the Layout will become its child, meaning that it will be
9630 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9632 * The Layout widget can contain as many Contents, Boxes or Tables as
9633 * described in its theme file. For instance, objects can be added to
9634 * different Tables by specifying the respective Table part names. The same
9635 * is valid for Content and Box.
9637 * The objects added as child of the Layout will behave as described in the
9638 * part description where they were added. There are 3 possible types of
9639 * parts where a child can be added:
9641 * @section secContent Content (SWALLOW part)
9643 * Only one object can be added to the @c SWALLOW part (but you still can
9644 * have many @c SWALLOW parts and one object on each of them). Use the @c
9645 * elm_layout_content_* set of functions to set, retrieve and unset objects
9646 * as content of the @c SWALLOW. After being set to this part, the object
9647 * size, position, visibility, clipping and other description properties
9648 * will be totally controled by the description of the given part (inside
9649 * the Edje theme file).
9651 * One can use @c evas_object_size_hint_* functions on the child to have some
9652 * kind of control over its behavior, but the resulting behavior will still
9653 * depend heavily on the @c SWALLOW part description.
9655 * The Edje theme also can change the part description, based on signals or
9656 * scripts running inside the theme. This change can also be animated. All of
9657 * this will affect the child object set as content accordingly. The object
9658 * size will be changed if the part size is changed, it will animate move if
9659 * the part is moving, and so on.
9661 * The following picture demonstrates a Layout widget with a child object
9662 * added to its @c SWALLOW:
9664 * @image html layout_swallow.png
9665 * @image latex layout_swallow.eps width=\textwidth
9667 * @section secBox Box (BOX part)
9669 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9670 * allows one to add objects to the box and have them distributed along its
9671 * area, accordingly to the specified @a layout property (now by @a layout we
9672 * mean the chosen layouting design of the Box, not the Layout widget
9675 * A similar effect for having a box with its position, size and other things
9676 * controled by the Layout theme would be to create an Elementary @ref Box
9677 * widget and add it as a Content in the @c SWALLOW part.
9679 * The main difference of using the Layout Box is that its behavior, the box
9680 * properties like layouting format, padding, align, etc. will be all
9681 * controled by the theme. This means, for example, that a signal could be
9682 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9683 * handled the signal by changing the box padding, or align, or both. Using
9684 * the Elementary @ref Box widget is not necessarily harder or easier, it
9685 * just depends on the circunstances and requirements.
9687 * The Layout Box can be used through the @c elm_layout_box_* set of
9690 * The following picture demonstrates a Layout widget with many child objects
9691 * added to its @c BOX part:
9693 * @image html layout_box.png
9694 * @image latex layout_box.eps width=\textwidth
9696 * @section secTable Table (TABLE part)
9698 * Just like the @ref secBox, the Layout Table is very similar to the
9699 * Elementary @ref Table widget. It allows one to add objects to the Table
9700 * specifying the row and column where the object should be added, and any
9701 * column or row span if necessary.
9703 * Again, we could have this design by adding a @ref Table widget to the @c
9704 * SWALLOW part using elm_layout_content_set(). The same difference happens
9705 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9706 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9708 * The Layout Table can be used through the @c elm_layout_table_* set of
9711 * The following picture demonstrates a Layout widget with many child objects
9712 * added to its @c TABLE part:
9714 * @image html layout_table.png
9715 * @image latex layout_table.eps width=\textwidth
9717 * @section secPredef Predefined Layouts
9719 * Another interesting thing about the Layout widget is that it offers some
9720 * predefined themes that come with the default Elementary theme. These
9721 * themes can be set by the call elm_layout_theme_set(), and provide some
9722 * basic functionality depending on the theme used.
9724 * Most of them already send some signals, some already provide a toolbar or
9725 * back and next buttons.
9727 * These are available predefined theme layouts. All of them have class = @c
9728 * layout, group = @c application, and style = one of the following options:
9730 * @li @c toolbar-content - application with toolbar and main content area
9731 * @li @c toolbar-content-back - application with toolbar and main content
9732 * area with a back button and title area
9733 * @li @c toolbar-content-back-next - application with toolbar and main
9734 * content area with a back and next buttons and title area
9735 * @li @c content-back - application with a main content area with a back
9736 * button and title area
9737 * @li @c content-back-next - application with a main content area with a
9738 * back and next buttons and title area
9739 * @li @c toolbar-vbox - application with toolbar and main content area as a
9741 * @li @c toolbar-table - application with toolbar and main content area as a
9744 * @section secExamples Examples
9746 * Some examples of the Layout widget can be found here:
9747 * @li @ref layout_example_01
9748 * @li @ref layout_example_02
9749 * @li @ref layout_example_03
9750 * @li @ref layout_example_edc
9755 * Add a new layout to the parent
9757 * @param parent The parent object
9758 * @return The new object or NULL if it cannot be created
9760 * @see elm_layout_file_set()
9761 * @see elm_layout_theme_set()
9765 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9767 * Set the file that will be used as layout
9769 * @param obj The layout object
9770 * @param file The path to file (edj) that will be used as layout
9771 * @param group The group that the layout belongs in edje file
9773 * @return (1 = success, 0 = error)
9777 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9779 * Set the edje group from the elementary theme that will be used as layout
9781 * @param obj The layout object
9782 * @param clas the clas of the group
9783 * @param group the group
9784 * @param style the style to used
9786 * @return (1 = success, 0 = error)
9790 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9792 * Set the layout content.
9794 * @param obj The layout object
9795 * @param swallow The swallow part name in the edje file
9796 * @param content The child that will be added in this layout object
9798 * Once the content object is set, a previously set one will be deleted.
9799 * If you want to keep that old content object, use the
9800 * elm_layout_content_unset() function.
9802 * @note In an Edje theme, the part used as a content container is called @c
9803 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9804 * expected to be a part name just like the second parameter of
9805 * elm_layout_box_append().
9807 * @see elm_layout_box_append()
9808 * @see elm_layout_content_get()
9809 * @see elm_layout_content_unset()
9814 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9816 * Get the child object in the given content part.
9818 * @param obj The layout object
9819 * @param swallow The SWALLOW part to get its content
9821 * @return The swallowed object or NULL if none or an error occurred
9823 * @see elm_layout_content_set()
9827 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9829 * Unset the layout content.
9831 * @param obj The layout object
9832 * @param swallow The swallow part name in the edje file
9833 * @return The content that was being used
9835 * Unparent and return the content object which was set for this part.
9837 * @see elm_layout_content_set()
9841 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9843 * Set the text of the given part
9845 * @param obj The layout object
9846 * @param part The TEXT part where to set the text
9847 * @param text The text to set
9850 * @deprecated use elm_object_text_* instead.
9852 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9854 * Get the text set in the given part
9856 * @param obj The layout object
9857 * @param part The TEXT part to retrieve the text off
9859 * @return The text set in @p part
9862 * @deprecated use elm_object_text_* instead.
9864 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9866 * Append child to layout box part.
9868 * @param obj the layout object
9869 * @param part the box part to which the object will be appended.
9870 * @param child the child object to append to box.
9872 * Once the object is appended, it will become child of the layout. Its
9873 * lifetime will be bound to the layout, whenever the layout dies the child
9874 * will be deleted automatically. One should use elm_layout_box_remove() to
9875 * make this layout forget about the object.
9877 * @see elm_layout_box_prepend()
9878 * @see elm_layout_box_insert_before()
9879 * @see elm_layout_box_insert_at()
9880 * @see elm_layout_box_remove()
9884 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9886 * Prepend child to layout box part.
9888 * @param obj the layout object
9889 * @param part the box part to prepend.
9890 * @param child the child object to prepend to box.
9892 * Once the object is prepended, it will become child of the layout. Its
9893 * lifetime will be bound to the layout, whenever the layout dies the child
9894 * will be deleted automatically. One should use elm_layout_box_remove() to
9895 * make this layout forget about the object.
9897 * @see elm_layout_box_append()
9898 * @see elm_layout_box_insert_before()
9899 * @see elm_layout_box_insert_at()
9900 * @see elm_layout_box_remove()
9904 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9906 * Insert child to layout box part before a reference object.
9908 * @param obj the layout object
9909 * @param part the box part to insert.
9910 * @param child the child object to insert into box.
9911 * @param reference another reference object to insert before in box.
9913 * Once the object is inserted, it will become child of the layout. Its
9914 * lifetime will be bound to the layout, whenever the layout dies the child
9915 * will be deleted automatically. One should use elm_layout_box_remove() to
9916 * make this layout forget about the object.
9918 * @see elm_layout_box_append()
9919 * @see elm_layout_box_prepend()
9920 * @see elm_layout_box_insert_before()
9921 * @see elm_layout_box_remove()
9925 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9927 * Insert child to layout box part at a given position.
9929 * @param obj the layout object
9930 * @param part the box part to insert.
9931 * @param child the child object to insert into box.
9932 * @param pos the numeric position >=0 to insert the child.
9934 * Once the object is inserted, it will become child of the layout. Its
9935 * lifetime will be bound to the layout, whenever the layout dies the child
9936 * will be deleted automatically. One should use elm_layout_box_remove() to
9937 * make this layout forget about the object.
9939 * @see elm_layout_box_append()
9940 * @see elm_layout_box_prepend()
9941 * @see elm_layout_box_insert_before()
9942 * @see elm_layout_box_remove()
9946 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9948 * Remove a child of the given part box.
9950 * @param obj The layout object
9951 * @param part The box part name to remove child.
9952 * @param child The object to remove from box.
9953 * @return The object that was being used, or NULL if not found.
9955 * The object will be removed from the box part and its lifetime will
9956 * not be handled by the layout anymore. This is equivalent to
9957 * elm_layout_content_unset() for box.
9959 * @see elm_layout_box_append()
9960 * @see elm_layout_box_remove_all()
9964 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9966 * Remove all child of the given part box.
9968 * @param obj The layout object
9969 * @param part The box part name to remove child.
9970 * @param clear If EINA_TRUE, then all objects will be deleted as
9971 * well, otherwise they will just be removed and will be
9972 * dangling on the canvas.
9974 * The objects will be removed from the box part and their lifetime will
9975 * not be handled by the layout anymore. This is equivalent to
9976 * elm_layout_box_remove() for all box children.
9978 * @see elm_layout_box_append()
9979 * @see elm_layout_box_remove()
9983 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9985 * Insert child to layout table part.
9987 * @param obj the layout object
9988 * @param part the box part to pack child.
9989 * @param child_obj the child object to pack into table.
9990 * @param col the column to which the child should be added. (>= 0)
9991 * @param row the row to which the child should be added. (>= 0)
9992 * @param colspan how many columns should be used to store this object. (>=
9994 * @param rowspan how many rows should be used to store this object. (>= 1)
9996 * Once the object is inserted, it will become child of the table. Its
9997 * lifetime will be bound to the layout, and whenever the layout dies the
9998 * child will be deleted automatically. One should use
9999 * elm_layout_table_remove() to make this layout forget about the object.
10001 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10002 * more space than a single cell. For instance, the following code:
10004 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10007 * Would result in an object being added like the following picture:
10009 * @image html layout_colspan.png
10010 * @image latex layout_colspan.eps width=\textwidth
10012 * @see elm_layout_table_unpack()
10013 * @see elm_layout_table_clear()
10017 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);
10019 * Unpack (remove) a child of the given part table.
10021 * @param obj The layout object
10022 * @param part The table part name to remove child.
10023 * @param child_obj The object to remove from table.
10024 * @return The object that was being used, or NULL if not found.
10026 * The object will be unpacked from the table part and its lifetime
10027 * will not be handled by the layout anymore. This is equivalent to
10028 * elm_layout_content_unset() for table.
10030 * @see elm_layout_table_pack()
10031 * @see elm_layout_table_clear()
10035 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10037 * Remove all child of the given part table.
10039 * @param obj The layout object
10040 * @param part The table part name to remove child.
10041 * @param clear If EINA_TRUE, then all objects will be deleted as
10042 * well, otherwise they will just be removed and will be
10043 * dangling on the canvas.
10045 * The objects will be removed from the table part and their lifetime will
10046 * not be handled by the layout anymore. This is equivalent to
10047 * elm_layout_table_unpack() for all table children.
10049 * @see elm_layout_table_pack()
10050 * @see elm_layout_table_unpack()
10054 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10056 * Get the edje layout
10058 * @param obj The layout object
10060 * @return A Evas_Object with the edje layout settings loaded
10061 * with function elm_layout_file_set
10063 * This returns the edje object. It is not expected to be used to then
10064 * swallow objects via edje_object_part_swallow() for example. Use
10065 * elm_layout_content_set() instead so child object handling and sizing is
10068 * @note This function should only be used if you really need to call some
10069 * low level Edje function on this edje object. All the common stuff (setting
10070 * text, emitting signals, hooking callbacks to signals, etc.) can be done
10071 * with proper elementary functions.
10073 * @see elm_object_signal_callback_add()
10074 * @see elm_object_signal_emit()
10075 * @see elm_object_text_part_set()
10076 * @see elm_layout_content_set()
10077 * @see elm_layout_box_append()
10078 * @see elm_layout_table_pack()
10079 * @see elm_layout_data_get()
10083 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10085 * Get the edje data from the given layout
10087 * @param obj The layout object
10088 * @param key The data key
10090 * @return The edje data string
10092 * This function fetches data specified inside the edje theme of this layout.
10093 * This function return NULL if data is not found.
10095 * In EDC this comes from a data block within the group block that @p
10096 * obj was loaded from. E.g.
10103 * item: "key1" "value1";
10104 * item: "key2" "value2";
10112 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10116 * @param obj The layout object
10118 * Manually forces a sizing re-evaluation. This is useful when the minimum
10119 * size required by the edje theme of this layout has changed. The change on
10120 * the minimum size required by the edje theme is not immediately reported to
10121 * the elementary layout, so one needs to call this function in order to tell
10122 * the widget (layout) that it needs to reevaluate its own size.
10124 * The minimum size of the theme is calculated based on minimum size of
10125 * parts, the size of elements inside containers like box and table, etc. All
10126 * of this can change due to state changes, and that's when this function
10127 * should be called.
10129 * Also note that a standard signal of "size,eval" "elm" emitted from the
10130 * edje object will cause this to happen too.
10134 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10137 * Sets a specific cursor for an edje part.
10139 * @param obj The layout object.
10140 * @param part_name a part from loaded edje group.
10141 * @param cursor cursor name to use, see Elementary_Cursor.h
10143 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10144 * part not exists or it has "mouse_events: 0".
10148 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10151 * Get the cursor to be shown when mouse is over an edje part
10153 * @param obj The layout object.
10154 * @param part_name a part from loaded edje group.
10155 * @return the cursor name.
10159 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10162 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10164 * @param obj The layout object.
10165 * @param part_name a part from loaded edje group, that had a cursor set
10166 * with elm_layout_part_cursor_set().
10170 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10173 * Sets a specific cursor style for an edje part.
10175 * @param obj The layout object.
10176 * @param part_name a part from loaded edje group.
10177 * @param style the theme style to use (default, transparent, ...)
10179 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10180 * part not exists or it did not had a cursor set.
10184 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10187 * Gets a specific cursor style for an edje part.
10189 * @param obj The layout object.
10190 * @param part_name a part from loaded edje group.
10192 * @return the theme style in use, defaults to "default". If the
10193 * object does not have a cursor set, then NULL is returned.
10197 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10200 * Sets if the cursor set should be searched on the theme or should use
10201 * the provided by the engine, only.
10203 * @note before you set if should look on theme you should define a
10204 * cursor with elm_layout_part_cursor_set(). By default it will only
10205 * look for cursors provided by the engine.
10207 * @param obj The layout object.
10208 * @param part_name a part from loaded edje group.
10209 * @param engine_only if cursors should be just provided by the engine
10210 * or should also search on widget's theme as well
10212 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10213 * part not exists or it did not had a cursor set.
10217 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);
10220 * Gets a specific cursor engine_only for an edje part.
10222 * @param obj The layout object.
10223 * @param part_name a part from loaded edje group.
10225 * @return whenever the cursor is just provided by engine or also from theme.
10229 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10232 * @def elm_layout_icon_set
10233 * Convienience macro to set the icon object in a layout that follows the
10234 * Elementary naming convention for its parts.
10238 #define elm_layout_icon_set(_ly, _obj) \
10241 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
10242 if ((_obj)) sig = "elm,state,icon,visible"; \
10243 else sig = "elm,state,icon,hidden"; \
10244 elm_object_signal_emit((_ly), sig, "elm"); \
10248 * @def elm_layout_icon_get
10249 * Convienience macro to get the icon object from a layout that follows the
10250 * Elementary naming convention for its parts.
10254 #define elm_layout_icon_get(_ly) \
10255 elm_layout_content_get((_ly), "elm.swallow.icon")
10258 * @def elm_layout_end_set
10259 * Convienience macro to set the end object in a layout that follows the
10260 * Elementary naming convention for its parts.
10264 #define elm_layout_end_set(_ly, _obj) \
10267 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
10268 if ((_obj)) sig = "elm,state,end,visible"; \
10269 else sig = "elm,state,end,hidden"; \
10270 elm_object_signal_emit((_ly), sig, "elm"); \
10274 * @def elm_layout_end_get
10275 * Convienience macro to get the end object in a layout that follows the
10276 * Elementary naming convention for its parts.
10280 #define elm_layout_end_get(_ly) \
10281 elm_layout_content_get((_ly), "elm.swallow.end")
10284 * @def elm_layout_label_set
10285 * Convienience macro to set the label in a layout that follows the
10286 * Elementary naming convention for its parts.
10289 * @deprecated use elm_object_text_* instead.
10291 #define elm_layout_label_set(_ly, _txt) \
10292 elm_layout_text_set((_ly), "elm.text", (_txt))
10295 * @def elm_layout_label_get
10296 * Convienience macro to get the label in a layout that follows the
10297 * Elementary naming convention for its parts.
10300 * @deprecated use elm_object_text_* instead.
10302 #define elm_layout_label_get(_ly) \
10303 elm_layout_text_get((_ly), "elm.text")
10305 /* smart callbacks called:
10306 * "theme,changed" - when elm theme is changed.
10310 * @defgroup Notify Notify
10312 * @image html img/widget/notify/preview-00.png
10313 * @image latex img/widget/notify/preview-00.eps
10315 * Display a container in a particular region of the parent(top, bottom,
10316 * etc. A timeout can be set to automatically hide the notify. This is so
10317 * that, after an evas_object_show() on a notify object, if a timeout was set
10318 * on it, it will @b automatically get hidden after that time.
10320 * Signals that you can add callbacks for are:
10321 * @li "timeout" - when timeout happens on notify and it's hidden
10322 * @li "block,clicked" - when a click outside of the notify happens
10324 * @ref tutorial_notify show usage of the API.
10329 * @brief Possible orient values for notify.
10331 * This values should be used in conjunction to elm_notify_orient_set() to
10332 * set the position in which the notify should appear(relative to its parent)
10333 * and in conjunction with elm_notify_orient_get() to know where the notify
10336 typedef enum _Elm_Notify_Orient
10338 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10339 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10340 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10341 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10342 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10343 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10344 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10345 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10346 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10347 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10348 } Elm_Notify_Orient;
10350 * @brief Add a new notify to the parent
10352 * @param parent The parent object
10353 * @return The new object or NULL if it cannot be created
10355 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10357 * @brief Set the content of the notify widget
10359 * @param obj The notify object
10360 * @param content The content will be filled in this notify object
10362 * Once the content object is set, a previously set one will be deleted. If
10363 * you want to keep that old content object, use the
10364 * elm_notify_content_unset() function.
10366 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10368 * @brief Unset the content of the notify widget
10370 * @param obj The notify object
10371 * @return The content that was being used
10373 * Unparent and return the content object which was set for this widget
10375 * @see elm_notify_content_set()
10377 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10379 * @brief Return the content of the notify widget
10381 * @param obj The notify object
10382 * @return The content that is being used
10384 * @see elm_notify_content_set()
10386 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10388 * @brief Set the notify parent
10390 * @param obj The notify object
10391 * @param content The new parent
10393 * Once the parent object is set, a previously set one will be disconnected
10396 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10398 * @brief Get the notify parent
10400 * @param obj The notify object
10401 * @return The parent
10403 * @see elm_notify_parent_set()
10405 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10407 * @brief Set the orientation
10409 * @param obj The notify object
10410 * @param orient The new orientation
10412 * Sets the position in which the notify will appear in its parent.
10414 * @see @ref Elm_Notify_Orient for possible values.
10416 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10418 * @brief Return the orientation
10419 * @param obj The notify object
10420 * @return The orientation of the notification
10422 * @see elm_notify_orient_set()
10423 * @see Elm_Notify_Orient
10425 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10427 * @brief Set the time interval after which the notify window is going to be
10430 * @param obj The notify object
10431 * @param time The timeout in seconds
10433 * This function sets a timeout and starts the timer controlling when the
10434 * notify is hidden. Since calling evas_object_show() on a notify restarts
10435 * the timer controlling when the notify is hidden, setting this before the
10436 * notify is shown will in effect mean starting the timer when the notify is
10439 * @note Set a value <= 0.0 to disable a running timer.
10441 * @note If the value > 0.0 and the notify is previously visible, the
10442 * timer will be started with this value, canceling any running timer.
10444 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10446 * @brief Return the timeout value (in seconds)
10447 * @param obj the notify object
10449 * @see elm_notify_timeout_set()
10451 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10453 * @brief Sets whether events should be passed to by a click outside
10456 * @param obj The notify object
10457 * @param repeats EINA_TRUE Events are repeats, else no
10459 * When true if the user clicks outside the window the events will be caught
10460 * by the others widgets, else the events are blocked.
10462 * @note The default value is EINA_TRUE.
10464 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10466 * @brief Return true if events are repeat below the notify object
10467 * @param obj the notify object
10469 * @see elm_notify_repeat_events_set()
10471 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10477 * @defgroup Hover Hover
10479 * @image html img/widget/hover/preview-00.png
10480 * @image latex img/widget/hover/preview-00.eps
10482 * A Hover object will hover over its @p parent object at the @p target
10483 * location. Anything in the background will be given a darker coloring to
10484 * indicate that the hover object is on top (at the default theme). When the
10485 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10486 * clicked that @b doesn't cause the hover to be dismissed.
10488 * @note The hover object will take up the entire space of @p target
10491 * Elementary has the following styles for the hover widget:
10495 * @li hoversel_vertical
10497 * The following are the available position for content:
10509 * Signals that you can add callbacks for are:
10510 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10511 * @li "smart,changed" - a content object placed under the "smart"
10512 * policy was replaced to a new slot direction.
10514 * See @ref tutorial_hover for more information.
10518 typedef enum _Elm_Hover_Axis
10520 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10521 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10522 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10523 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10526 * @brief Adds a hover object to @p parent
10528 * @param parent The parent object
10529 * @return The hover object or NULL if one could not be created
10531 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10533 * @brief Sets the target object for the hover.
10535 * @param obj The hover object
10536 * @param target The object to center the hover onto. The hover
10538 * This function will cause the hover to be centered on the target object.
10540 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10542 * @brief Gets the target object for the hover.
10544 * @param obj The hover object
10545 * @param parent The object to locate the hover over.
10547 * @see elm_hover_target_set()
10549 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10551 * @brief Sets the parent object for the hover.
10553 * @param obj The hover object
10554 * @param parent The object to locate the hover over.
10556 * This function will cause the hover to take up the entire space that the
10557 * parent object fills.
10559 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10561 * @brief Gets the parent object for the hover.
10563 * @param obj The hover object
10564 * @return The parent object to locate the hover over.
10566 * @see elm_hover_parent_set()
10568 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10570 * @brief Sets the content of the hover object and the direction in which it
10573 * @param obj The hover object
10574 * @param swallow The direction that the object will be displayed
10575 * at. Accepted values are "left", "top-left", "top", "top-right",
10576 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10578 * @param content The content to place at @p swallow
10580 * Once the content object is set for a given direction, a previously
10581 * set one (on the same direction) will be deleted. If you want to
10582 * keep that old content object, use the elm_hover_content_unset()
10585 * All directions may have contents at the same time, except for
10586 * "smart". This is a special placement hint and its use case
10587 * independs of the calculations coming from
10588 * elm_hover_best_content_location_get(). Its use is for cases when
10589 * one desires only one hover content, but with a dinamic special
10590 * placement within the hover area. The content's geometry, whenever
10591 * it changes, will be used to decide on a best location not
10592 * extrapolating the hover's parent object view to show it in (still
10593 * being the hover's target determinant of its medium part -- move and
10594 * resize it to simulate finger sizes, for example). If one of the
10595 * directions other than "smart" are used, a previously content set
10596 * using it will be deleted, and vice-versa.
10598 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10600 * @brief Get the content of the hover object, in a given direction.
10602 * Return the content object which was set for this widget in the
10603 * @p swallow direction.
10605 * @param obj The hover object
10606 * @param swallow The direction that the object was display at.
10607 * @return The content that was being used
10609 * @see elm_hover_content_set()
10611 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10613 * @brief Unset the content of the hover object, in a given direction.
10615 * Unparent and return the content object set at @p swallow direction.
10617 * @param obj The hover object
10618 * @param swallow The direction that the object was display at.
10619 * @return The content that was being used.
10621 * @see elm_hover_content_set()
10623 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10625 * @brief Returns the best swallow location for content in the hover.
10627 * @param obj The hover object
10628 * @param pref_axis The preferred orientation axis for the hover object to use
10629 * @return The edje location to place content into the hover or @c
10632 * Best is defined here as the location at which there is the most available
10635 * @p pref_axis may be one of
10636 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10637 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10638 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10639 * - @c ELM_HOVER_AXIS_BOTH -- both
10641 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10642 * nescessarily be along the horizontal axis("left" or "right"). If
10643 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10644 * be along the vertical axis("top" or "bottom"). Chossing
10645 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10646 * returned position may be in either axis.
10648 * @see elm_hover_content_set()
10650 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10657 * @defgroup Entry Entry
10659 * @image html img/widget/entry/preview-00.png
10660 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10661 * @image html img/widget/entry/preview-01.png
10662 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10663 * @image html img/widget/entry/preview-02.png
10664 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10665 * @image html img/widget/entry/preview-03.png
10666 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10668 * An entry is a convenience widget which shows a box that the user can
10669 * enter text into. Entries by default don't scroll, so they grow to
10670 * accomodate the entire text, resizing the parent window as needed. This
10671 * can be changed with the elm_entry_scrollable_set() function.
10673 * They can also be single line or multi line (the default) and when set
10674 * to multi line mode they support text wrapping in any of the modes
10675 * indicated by #Elm_Wrap_Type.
10677 * Other features include password mode, filtering of inserted text with
10678 * elm_entry_text_filter_append() and related functions, inline "items" and
10679 * formatted markup text.
10681 * @section entry-markup Formatted text
10683 * The markup tags supported by the Entry are defined by the theme, but
10684 * even when writing new themes or extensions it's a good idea to stick to
10685 * a sane default, to maintain coherency and avoid application breakages.
10686 * Currently defined by the default theme are the following tags:
10687 * @li \<br\>: Inserts a line break.
10688 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10690 * @li \<tab\>: Inserts a tab.
10691 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10693 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10694 * @li \<link\>...\</link\>: Underlines the enclosed text.
10695 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10697 * @section entry-special Special markups
10699 * Besides those used to format text, entries support two special markup
10700 * tags used to insert clickable portions of text or items inlined within
10703 * @subsection entry-anchors Anchors
10705 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10706 * \</a\> tags and an event will be generated when this text is clicked,
10710 * This text is outside <a href=anc-01>but this one is an anchor</a>
10713 * The @c href attribute in the opening tag gives the name that will be
10714 * used to identify the anchor and it can be any valid utf8 string.
10716 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10717 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10718 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10719 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10722 * @subsection entry-items Items
10724 * Inlined in the text, any other @c Evas_Object can be inserted by using
10725 * \<item\> tags this way:
10728 * <item size=16x16 vsize=full href=emoticon/haha></item>
10731 * Just like with anchors, the @c href identifies each item, but these need,
10732 * in addition, to indicate their size, which is done using any one of
10733 * @c size, @c absize or @c relsize attributes. These attributes take their
10734 * value in the WxH format, where W is the width and H the height of the
10737 * @li absize: Absolute pixel size for the item. Whatever value is set will
10738 * be the item's size regardless of any scale value the object may have
10739 * been set to. The final line height will be adjusted to fit larger items.
10740 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10742 * @li relsize: Size is adjusted for the item to fit within the current
10745 * Besides their size, items are specificed a @c vsize value that affects
10746 * how their final size and position are calculated. The possible values
10748 * @li ascent: Item will be placed within the line's baseline and its
10749 * ascent. That is, the height between the line where all characters are
10750 * positioned and the highest point in the line. For @c size and @c absize
10751 * items, the descent value will be added to the total line height to make
10752 * them fit. @c relsize items will be adjusted to fit within this space.
10753 * @li full: Items will be placed between the descent and ascent, or the
10754 * lowest point in the line and its highest.
10756 * The next image shows different configurations of items and how they
10757 * are the previously mentioned options affect their sizes. In all cases,
10758 * the green line indicates the ascent, blue for the baseline and red for
10761 * @image html entry_item.png
10762 * @image latex entry_item.eps width=\textwidth
10764 * And another one to show how size differs from absize. In the first one,
10765 * the scale value is set to 1.0, while the second one is using one of 2.0.
10767 * @image html entry_item_scale.png
10768 * @image latex entry_item_scale.eps width=\textwidth
10770 * After the size for an item is calculated, the entry will request an
10771 * object to place in its space. For this, the functions set with
10772 * elm_entry_item_provider_append() and related functions will be called
10773 * in order until one of them returns a @c non-NULL value. If no providers
10774 * are available, or all of them return @c NULL, then the entry falls back
10775 * to one of the internal defaults, provided the name matches with one of
10778 * All of the following are currently supported:
10781 * - emoticon/angry-shout
10782 * - emoticon/crazy-laugh
10783 * - emoticon/evil-laugh
10785 * - emoticon/goggle-smile
10786 * - emoticon/grumpy
10787 * - emoticon/grumpy-smile
10788 * - emoticon/guilty
10789 * - emoticon/guilty-smile
10791 * - emoticon/half-smile
10792 * - emoticon/happy-panting
10794 * - emoticon/indifferent
10796 * - emoticon/knowing-grin
10798 * - emoticon/little-bit-sorry
10799 * - emoticon/love-lots
10801 * - emoticon/minimal-smile
10802 * - emoticon/not-happy
10803 * - emoticon/not-impressed
10805 * - emoticon/opensmile
10808 * - emoticon/squint-laugh
10809 * - emoticon/surprised
10810 * - emoticon/suspicious
10811 * - emoticon/tongue-dangling
10812 * - emoticon/tongue-poke
10814 * - emoticon/unhappy
10815 * - emoticon/very-sorry
10818 * - emoticon/worried
10821 * Alternatively, an item may reference an image by its path, using
10822 * the URI form @c file:///path/to/an/image.png and the entry will then
10823 * use that image for the item.
10825 * @section entry-files Loading and saving files
10827 * Entries have convinience functions to load text from a file and save
10828 * changes back to it after a short delay. The automatic saving is enabled
10829 * by default, but can be disabled with elm_entry_autosave_set() and files
10830 * can be loaded directly as plain text or have any markup in them
10831 * recognized. See elm_entry_file_set() for more details.
10833 * @section entry-signals Emitted signals
10835 * This widget emits the following signals:
10837 * @li "changed": The text within the entry was changed.
10838 * @li "changed,user": The text within the entry was changed because of user interaction.
10839 * @li "activated": The enter key was pressed on a single line entry.
10840 * @li "press": A mouse button has been pressed on the entry.
10841 * @li "longpressed": A mouse button has been pressed and held for a couple
10843 * @li "clicked": The entry has been clicked (mouse press and release).
10844 * @li "clicked,double": The entry has been double clicked.
10845 * @li "clicked,triple": The entry has been triple clicked.
10846 * @li "focused": The entry has received focus.
10847 * @li "unfocused": The entry has lost focus.
10848 * @li "selection,paste": A paste of the clipboard contents was requested.
10849 * @li "selection,copy": A copy of the selected text into the clipboard was
10851 * @li "selection,cut": A cut of the selected text into the clipboard was
10853 * @li "selection,start": A selection has begun and no previous selection
10855 * @li "selection,changed": The current selection has changed.
10856 * @li "selection,cleared": The current selection has been cleared.
10857 * @li "cursor,changed": The cursor has changed position.
10858 * @li "anchor,clicked": An anchor has been clicked. The event_info
10859 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10860 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10861 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10862 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10863 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10864 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10865 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10866 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10867 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10868 * @li "preedit,changed": The preedit string has changed.
10870 * @section entry-examples
10872 * An overview of the Entry API can be seen in @ref entry_example_01
10877 * @typedef Elm_Entry_Anchor_Info
10879 * The info sent in the callback for the "anchor,clicked" signals emitted
10882 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10884 * @struct _Elm_Entry_Anchor_Info
10886 * The info sent in the callback for the "anchor,clicked" signals emitted
10889 struct _Elm_Entry_Anchor_Info
10891 const char *name; /**< The name of the anchor, as stated in its href */
10892 int button; /**< The mouse button used to click on it */
10893 Evas_Coord x, /**< Anchor geometry, relative to canvas */
10894 y, /**< Anchor geometry, relative to canvas */
10895 w, /**< Anchor geometry, relative to canvas */
10896 h; /**< Anchor geometry, relative to canvas */
10899 * @typedef Elm_Entry_Filter_Cb
10900 * This callback type is used by entry filters to modify text.
10901 * @param data The data specified as the last param when adding the filter
10902 * @param entry The entry object
10903 * @param text A pointer to the location of the text being filtered. This data can be modified,
10904 * but any additional allocations must be managed by the user.
10905 * @see elm_entry_text_filter_append
10906 * @see elm_entry_text_filter_prepend
10908 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10911 * This adds an entry to @p parent object.
10913 * By default, entries are:
10917 * @li autosave is enabled
10919 * @param parent The parent object
10920 * @return The new object or NULL if it cannot be created
10922 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10924 * Sets the entry to single line mode.
10926 * In single line mode, entries don't ever wrap when the text reaches the
10927 * edge, and instead they keep growing horizontally. Pressing the @c Enter
10928 * key will generate an @c "activate" event instead of adding a new line.
10930 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10931 * and pressing enter will break the text into a different line
10932 * without generating any events.
10934 * @param obj The entry object
10935 * @param single_line If true, the text in the entry
10936 * will be on a single line.
10938 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10940 * Gets whether the entry is set to be single line.
10942 * @param obj The entry object
10943 * @return single_line If true, the text in the entry is set to display
10944 * on a single line.
10946 * @see elm_entry_single_line_set()
10948 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10950 * Sets the entry to password mode.
10952 * In password mode, entries are implicitly single line and the display of
10953 * any text in them is replaced with asterisks (*).
10955 * @param obj The entry object
10956 * @param password If true, password mode is enabled.
10958 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10960 * Gets whether the entry is set to password mode.
10962 * @param obj The entry object
10963 * @return If true, the entry is set to display all characters
10964 * as asterisks (*).
10966 * @see elm_entry_password_set()
10968 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10970 * This sets the text displayed within the entry to @p entry.
10972 * @param obj The entry object
10973 * @param entry The text to be displayed
10975 * @deprecated Use elm_object_text_set() instead.
10977 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10979 * This returns the text currently shown in object @p entry.
10980 * See also elm_entry_entry_set().
10982 * @param obj The entry object
10983 * @return The currently displayed text or NULL on failure
10985 * @deprecated Use elm_object_text_get() instead.
10987 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10989 * Appends @p entry to the text of the entry.
10991 * Adds the text in @p entry to the end of any text already present in the
10994 * The appended text is subject to any filters set for the widget.
10996 * @param obj The entry object
10997 * @param entry The text to be displayed
10999 * @see elm_entry_text_filter_append()
11001 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11003 * Gets whether the entry is empty.
11005 * Empty means no text at all. If there are any markup tags, like an item
11006 * tag for which no provider finds anything, and no text is displayed, this
11007 * function still returns EINA_FALSE.
11009 * @param obj The entry object
11010 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11012 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11014 * Gets any selected text within the entry.
11016 * If there's any selected text in the entry, this function returns it as
11017 * a string in markup format. NULL is returned if no selection exists or
11018 * if an error occurred.
11020 * The returned value points to an internal string and should not be freed
11021 * or modified in any way. If the @p entry object is deleted or its
11022 * contents are changed, the returned pointer should be considered invalid.
11024 * @param obj The entry object
11025 * @return The selected text within the entry or NULL on failure
11027 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11029 * Inserts the given text into the entry at the current cursor position.
11031 * This inserts text at the cursor position as if it was typed
11032 * by the user (note that this also allows markup which a user
11033 * can't just "type" as it would be converted to escaped text, so this
11034 * call can be used to insert things like emoticon items or bold push/pop
11035 * tags, other font and color change tags etc.)
11037 * If any selection exists, it will be replaced by the inserted text.
11039 * The inserted text is subject to any filters set for the widget.
11041 * @param obj The entry object
11042 * @param entry The text to insert
11044 * @see elm_entry_text_filter_append()
11046 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11048 * Set the line wrap type to use on multi-line entries.
11050 * Sets the wrap type used by the entry to any of the specified in
11051 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11052 * line (without inserting a line break or paragraph separator) when it
11053 * reaches the far edge of the widget.
11055 * Note that this only makes sense for multi-line entries. A widget set
11056 * to be single line will never wrap.
11058 * @param obj The entry object
11059 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11061 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11063 * Gets the wrap mode the entry was set to use.
11065 * @param obj The entry object
11066 * @return Wrap type
11068 * @see also elm_entry_line_wrap_set()
11070 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11072 * Sets if the entry is to be editable or not.
11074 * By default, entries are editable and when focused, any text input by the
11075 * user will be inserted at the current cursor position. But calling this
11076 * function with @p editable as EINA_FALSE will prevent the user from
11077 * inputting text into the entry.
11079 * The only way to change the text of a non-editable entry is to use
11080 * elm_object_text_set(), elm_entry_entry_insert() and other related
11083 * @param obj The entry object
11084 * @param editable If EINA_TRUE, user input will be inserted in the entry,
11085 * if not, the entry is read-only and no user input is allowed.
11087 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11089 * Gets whether the entry is editable or not.
11091 * @param obj The entry object
11092 * @return If true, the entry is editable by the user.
11093 * If false, it is not editable by the user
11095 * @see elm_entry_editable_set()
11097 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11099 * This drops any existing text selection within the entry.
11101 * @param obj The entry object
11103 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11105 * This selects all text within the entry.
11107 * @param obj The entry object
11109 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11111 * This moves the cursor one place to the right within the entry.
11113 * @param obj The entry object
11114 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11116 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11118 * This moves the cursor one place to the left within the entry.
11120 * @param obj The entry object
11121 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11123 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11125 * This moves the cursor one line up within the entry.
11127 * @param obj The entry object
11128 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11130 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11132 * This moves the cursor one line down within the entry.
11134 * @param obj The entry object
11135 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11137 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11139 * This moves the cursor to the beginning of the entry.
11141 * @param obj The entry object
11143 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11145 * This moves the cursor to the end of the entry.
11147 * @param obj The entry object
11149 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11151 * This moves the cursor to the beginning of the current line.
11153 * @param obj The entry object
11155 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11157 * This moves the cursor to the end of the current line.
11159 * @param obj The entry object
11161 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11163 * This begins a selection within the entry as though
11164 * the user were holding down the mouse button to make a selection.
11166 * @param obj The entry object
11168 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11170 * This ends a selection within the entry as though
11171 * the user had just released the mouse button while making a selection.
11173 * @param obj The entry object
11175 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11177 * Gets whether a format node exists at the current cursor position.
11179 * A format node is anything that defines how the text is rendered. It can
11180 * be a visible format node, such as a line break or a paragraph separator,
11181 * or an invisible one, such as bold begin or end tag.
11182 * This function returns whether any format node exists at the current
11185 * @param obj The entry object
11186 * @return EINA_TRUE if the current cursor position contains a format node,
11187 * EINA_FALSE otherwise.
11189 * @see elm_entry_cursor_is_visible_format_get()
11191 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11193 * Gets if the current cursor position holds a visible format node.
11195 * @param obj The entry object
11196 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11197 * if it's an invisible one or no format exists.
11199 * @see elm_entry_cursor_is_format_get()
11201 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11203 * Gets the character pointed by the cursor at its current position.
11205 * This function returns a string with the utf8 character stored at the
11206 * current cursor position.
11207 * Only the text is returned, any format that may exist will not be part
11208 * of the return value.
11210 * @param obj The entry object
11211 * @return The text pointed by the cursors.
11213 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11215 * This function returns the geometry of the cursor.
11217 * It's useful if you want to draw something on the cursor (or where it is),
11218 * or for example in the case of scrolled entry where you want to show the
11221 * @param obj The entry object
11222 * @param x returned geometry
11223 * @param y returned geometry
11224 * @param w returned geometry
11225 * @param h returned geometry
11226 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11228 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);
11230 * Sets the cursor position in the entry to the given value
11232 * The value in @p pos is the index of the character position within the
11233 * contents of the string as returned by elm_entry_cursor_pos_get().
11235 * @param obj The entry object
11236 * @param pos The position of the cursor
11238 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11240 * Retrieves the current position of the cursor in the entry
11242 * @param obj The entry object
11243 * @return The cursor position
11245 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11247 * This executes a "cut" action on the selected text in the entry.
11249 * @param obj The entry object
11251 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11253 * This executes a "copy" action on the selected text in the entry.
11255 * @param obj The entry object
11257 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11259 * This executes a "paste" action in the entry.
11261 * @param obj The entry object
11263 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11265 * This clears and frees the items in a entry's contextual (longpress)
11268 * @param obj The entry object
11270 * @see elm_entry_context_menu_item_add()
11272 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11274 * This adds an item to the entry's contextual menu.
11276 * A longpress on an entry will make the contextual menu show up, if this
11277 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11278 * By default, this menu provides a few options like enabling selection mode,
11279 * which is useful on embedded devices that need to be explicit about it,
11280 * and when a selection exists it also shows the copy and cut actions.
11282 * With this function, developers can add other options to this menu to
11283 * perform any action they deem necessary.
11285 * @param obj The entry object
11286 * @param label The item's text label
11287 * @param icon_file The item's icon file
11288 * @param icon_type The item's icon type
11289 * @param func The callback to execute when the item is clicked
11290 * @param data The data to associate with the item for related functions
11292 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);
11294 * This disables the entry's contextual (longpress) menu.
11296 * @param obj The entry object
11297 * @param disabled If true, the menu is disabled
11299 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11301 * This returns whether the entry's contextual (longpress) menu is
11304 * @param obj The entry object
11305 * @return If true, the menu is disabled
11307 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11309 * This appends a custom item provider to the list for that entry
11311 * This appends the given callback. The list is walked from beginning to end
11312 * with each function called given the item href string in the text. If the
11313 * function returns an object handle other than NULL (it should create an
11314 * object to do this), then this object is used to replace that item. If
11315 * not the next provider is called until one provides an item object, or the
11316 * default provider in entry does.
11318 * @param obj The entry object
11319 * @param func The function called to provide the item object
11320 * @param data The data passed to @p func
11322 * @see @ref entry-items
11324 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);
11326 * This prepends a custom item provider to the list for that entry
11328 * This prepends the given callback. See elm_entry_item_provider_append() for
11331 * @param obj The entry object
11332 * @param func The function called to provide the item object
11333 * @param data The data passed to @p func
11335 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);
11337 * This removes a custom item provider to the list for that entry
11339 * This removes the given callback. See elm_entry_item_provider_append() for
11342 * @param obj The entry object
11343 * @param func The function called to provide the item object
11344 * @param data The data passed to @p func
11346 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);
11348 * Append a filter function for text inserted in the entry
11350 * Append the given callback to the list. This functions will be called
11351 * whenever any text is inserted into the entry, with the text to be inserted
11352 * as a parameter. The callback function is free to alter the text in any way
11353 * it wants, but it must remember to free the given pointer and update it.
11354 * If the new text is to be discarded, the function can free it and set its
11355 * text parameter to NULL. This will also prevent any following filters from
11358 * @param obj The entry object
11359 * @param func The function to use as text filter
11360 * @param data User data to pass to @p func
11362 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11364 * Prepend a filter function for text insdrted in the entry
11366 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11367 * for more information
11369 * @param obj The entry object
11370 * @param func The function to use as text filter
11371 * @param data User data to pass to @p func
11373 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11375 * Remove a filter from the list
11377 * Removes the given callback from the filter list. See
11378 * elm_entry_text_filter_append() for more information.
11380 * @param obj The entry object
11381 * @param func The filter function to remove
11382 * @param data The user data passed when adding the function
11384 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11386 * This converts a markup (HTML-like) string into UTF-8.
11388 * The returned string is a malloc'ed buffer and it should be freed when
11389 * not needed anymore.
11391 * @param s The string (in markup) to be converted
11392 * @return The converted string (in UTF-8). It should be freed.
11394 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11396 * This converts a UTF-8 string into markup (HTML-like).
11398 * The returned string is a malloc'ed buffer and it should be freed when
11399 * not needed anymore.
11401 * @param s The string (in UTF-8) to be converted
11402 * @return The converted string (in markup). It should be freed.
11404 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11406 * This sets the file (and implicitly loads it) for the text to display and
11407 * then edit. All changes are written back to the file after a short delay if
11408 * the entry object is set to autosave (which is the default).
11410 * If the entry had any other file set previously, any changes made to it
11411 * will be saved if the autosave feature is enabled, otherwise, the file
11412 * will be silently discarded and any non-saved changes will be lost.
11414 * @param obj The entry object
11415 * @param file The path to the file to load and save
11416 * @param format The file format
11418 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11420 * Gets the file being edited by the entry.
11422 * This function can be used to retrieve any file set on the entry for
11423 * edition, along with the format used to load and save it.
11425 * @param obj The entry object
11426 * @param file The path to the file to load and save
11427 * @param format The file format
11429 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11431 * This function writes any changes made to the file set with
11432 * elm_entry_file_set()
11434 * @param obj The entry object
11436 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11438 * This sets the entry object to 'autosave' the loaded text file or not.
11440 * @param obj The entry object
11441 * @param autosave Autosave the loaded file or not
11443 * @see elm_entry_file_set()
11445 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11447 * This gets the entry object's 'autosave' status.
11449 * @param obj The entry object
11450 * @return Autosave the loaded file or not
11452 * @see elm_entry_file_set()
11454 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11456 * Control pasting of text and images for the widget.
11458 * Normally the entry allows both text and images to be pasted. By setting
11459 * textonly to be true, this prevents images from being pasted.
11461 * Note this only changes the behaviour of text.
11463 * @param obj The entry object
11464 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11465 * text+image+other.
11467 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11469 * Getting elm_entry text paste/drop mode.
11471 * In textonly mode, only text may be pasted or dropped into the widget.
11473 * @param obj The entry object
11474 * @return If the widget only accepts text from pastes.
11476 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11478 * Enable or disable scrolling in entry
11480 * Normally the entry is not scrollable unless you enable it with this call.
11482 * @param obj The entry object
11483 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11485 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11487 * Get the scrollable state of the entry
11489 * Normally the entry is not scrollable. This gets the scrollable state
11490 * of the entry. See elm_entry_scrollable_set() for more information.
11492 * @param obj The entry object
11493 * @return The scrollable state
11495 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11497 * This sets a widget to be displayed to the left of a scrolled entry.
11499 * @param obj The scrolled entry object
11500 * @param icon The widget to display on the left side of the scrolled
11503 * @note A previously set widget will be destroyed.
11504 * @note If the object being set does not have minimum size hints set,
11505 * it won't get properly displayed.
11507 * @see elm_entry_end_set()
11509 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11511 * Gets the leftmost widget of the scrolled entry. This object is
11512 * owned by the scrolled entry and should not be modified.
11514 * @param obj The scrolled entry object
11515 * @return the left widget inside the scroller
11517 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11519 * Unset the leftmost widget of the scrolled entry, unparenting and
11522 * @param obj The scrolled entry object
11523 * @return the previously set icon sub-object of this entry, on
11526 * @see elm_entry_icon_set()
11528 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11530 * Sets the visibility of the left-side widget of the scrolled entry,
11531 * set by elm_entry_icon_set().
11533 * @param obj The scrolled entry object
11534 * @param setting EINA_TRUE if the object should be displayed,
11535 * EINA_FALSE if not.
11537 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11539 * This sets a widget to be displayed to the end of a scrolled entry.
11541 * @param obj The scrolled entry object
11542 * @param end The widget to display on the right side of the scrolled
11545 * @note A previously set widget will be destroyed.
11546 * @note If the object being set does not have minimum size hints set,
11547 * it won't get properly displayed.
11549 * @see elm_entry_icon_set
11551 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11553 * Gets the endmost widget of the scrolled entry. This object is owned
11554 * by the scrolled entry and should not be modified.
11556 * @param obj The scrolled entry object
11557 * @return the right widget inside the scroller
11559 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11561 * Unset the endmost widget of the scrolled entry, unparenting and
11564 * @param obj The scrolled entry object
11565 * @return the previously set icon sub-object of this entry, on
11568 * @see elm_entry_icon_set()
11570 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11572 * Sets the visibility of the end widget of the scrolled entry, set by
11573 * elm_entry_end_set().
11575 * @param obj The scrolled entry object
11576 * @param setting EINA_TRUE if the object should be displayed,
11577 * EINA_FALSE if not.
11579 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11581 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11584 * Setting an entry to single-line mode with elm_entry_single_line_set()
11585 * will automatically disable the display of scrollbars when the entry
11586 * moves inside its scroller.
11588 * @param obj The scrolled entry object
11589 * @param h The horizontal scrollbar policy to apply
11590 * @param v The vertical scrollbar policy to apply
11592 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11594 * This enables/disables bouncing within the entry.
11596 * This function sets whether the entry will bounce when scrolling reaches
11597 * the end of the contained entry.
11599 * @param obj The scrolled entry object
11600 * @param h The horizontal bounce state
11601 * @param v The vertical bounce state
11603 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11605 * Get the bounce mode
11607 * @param obj The Entry object
11608 * @param h_bounce Allow bounce horizontally
11609 * @param v_bounce Allow bounce vertically
11611 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11613 /* pre-made filters for entries */
11615 * @typedef Elm_Entry_Filter_Limit_Size
11617 * Data for the elm_entry_filter_limit_size() entry filter.
11619 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11621 * @struct _Elm_Entry_Filter_Limit_Size
11623 * Data for the elm_entry_filter_limit_size() entry filter.
11625 struct _Elm_Entry_Filter_Limit_Size
11627 int max_char_count; /**< The maximum number of characters allowed. */
11628 int max_byte_count; /**< The maximum number of bytes allowed*/
11631 * Filter inserted text based on user defined character and byte limits
11633 * Add this filter to an entry to limit the characters that it will accept
11634 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11635 * The funtion works on the UTF-8 representation of the string, converting
11636 * it from the set markup, thus not accounting for any format in it.
11638 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11639 * it as data when setting the filter. In it, it's possible to set limits
11640 * by character count or bytes (any of them is disabled if 0), and both can
11641 * be set at the same time. In that case, it first checks for characters,
11644 * The function will cut the inserted text in order to allow only the first
11645 * number of characters that are still allowed. The cut is made in
11646 * characters, even when limiting by bytes, in order to always contain
11647 * valid ones and avoid half unicode characters making it in.
11649 * This filter, like any others, does not apply when setting the entry text
11650 * directly with elm_object_text_set() (or the deprecated
11651 * elm_entry_entry_set()).
11653 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11655 * @typedef Elm_Entry_Filter_Accept_Set
11657 * Data for the elm_entry_filter_accept_set() entry filter.
11659 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11661 * @struct _Elm_Entry_Filter_Accept_Set
11663 * Data for the elm_entry_filter_accept_set() entry filter.
11665 struct _Elm_Entry_Filter_Accept_Set
11667 const char *accepted; /**< Set of characters accepted in the entry. */
11668 const char *rejected; /**< Set of characters rejected from the entry. */
11671 * Filter inserted text based on accepted or rejected sets of characters
11673 * Add this filter to an entry to restrict the set of accepted characters
11674 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11675 * This structure contains both accepted and rejected sets, but they are
11676 * mutually exclusive.
11678 * The @c accepted set takes preference, so if it is set, the filter will
11679 * only work based on the accepted characters, ignoring anything in the
11680 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11682 * In both cases, the function filters by matching utf8 characters to the
11683 * raw markup text, so it can be used to remove formatting tags.
11685 * This filter, like any others, does not apply when setting the entry text
11686 * directly with elm_object_text_set() (or the deprecated
11687 * elm_entry_entry_set()).
11689 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11691 * Set the input panel layout of the entry
11693 * @param obj The entry object
11694 * @param layout layout type
11696 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11698 * Get the input panel layout of the entry
11700 * @param obj The entry object
11701 * @return layout type
11703 * @see elm_entry_input_panel_layout_set
11705 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11710 /* composite widgets - these basically put together basic widgets above
11711 * in convenient packages that do more than basic stuff */
11715 * @defgroup Anchorview Anchorview
11717 * @image html img/widget/anchorview/preview-00.png
11718 * @image latex img/widget/anchorview/preview-00.eps
11720 * Anchorview is for displaying text that contains markup with anchors
11721 * like <c>\<a href=1234\>something\</\></c> in it.
11723 * Besides being styled differently, the anchorview widget provides the
11724 * necessary functionality so that clicking on these anchors brings up a
11725 * popup with user defined content such as "call", "add to contacts" or
11726 * "open web page". This popup is provided using the @ref Hover widget.
11728 * This widget is very similar to @ref Anchorblock, so refer to that
11729 * widget for an example. The only difference Anchorview has is that the
11730 * widget is already provided with scrolling functionality, so if the
11731 * text set to it is too large to fit in the given space, it will scroll,
11732 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11733 * text can be displayed.
11735 * This widget emits the following signals:
11736 * @li "anchor,clicked": will be called when an anchor is clicked. The
11737 * @p event_info parameter on the callback will be a pointer of type
11738 * ::Elm_Entry_Anchorview_Info.
11740 * See @ref Anchorblock for an example on how to use both of them.
11749 * @typedef Elm_Entry_Anchorview_Info
11751 * The info sent in the callback for "anchor,clicked" signals emitted by
11752 * the Anchorview widget.
11754 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11756 * @struct _Elm_Entry_Anchorview_Info
11758 * The info sent in the callback for "anchor,clicked" signals emitted by
11759 * the Anchorview widget.
11761 struct _Elm_Entry_Anchorview_Info
11763 const char *name; /**< Name of the anchor, as indicated in its href
11765 int button; /**< The mouse button used to click on it */
11766 Evas_Object *hover; /**< The hover object to use for the popup */
11768 Evas_Coord x, y, w, h;
11769 } anchor, /**< Geometry selection of text used as anchor */
11770 hover_parent; /**< Geometry of the object used as parent by the
11772 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11773 for content on the left side of
11774 the hover. Before calling the
11775 callback, the widget will make the
11776 necessary calculations to check
11777 which sides are fit to be set with
11778 content, based on the position the
11779 hover is activated and its distance
11780 to the edges of its parent object
11782 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11783 the right side of the hover.
11784 See @ref hover_left */
11785 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11786 of the hover. See @ref hover_left */
11787 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11788 below the hover. See @ref
11792 * Add a new Anchorview object
11794 * @param parent The parent object
11795 * @return The new object or NULL if it cannot be created
11797 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11799 * Set the text to show in the anchorview
11801 * Sets the text of the anchorview to @p text. This text can include markup
11802 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11803 * text that will be specially styled and react to click events, ended with
11804 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11805 * "anchor,clicked" signal that you can attach a callback to with
11806 * evas_object_smart_callback_add(). The name of the anchor given in the
11807 * event info struct will be the one set in the href attribute, in this
11808 * case, anchorname.
11810 * Other markup can be used to style the text in different ways, but it's
11811 * up to the style defined in the theme which tags do what.
11812 * @deprecated use elm_object_text_set() instead.
11814 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11816 * Get the markup text set for the anchorview
11818 * Retrieves the text set on the anchorview, with markup tags included.
11820 * @param obj The anchorview object
11821 * @return The markup text set or @c NULL if nothing was set or an error
11823 * @deprecated use elm_object_text_set() instead.
11825 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11827 * Set the parent of the hover popup
11829 * Sets the parent object to use by the hover created by the anchorview
11830 * when an anchor is clicked. See @ref Hover for more details on this.
11831 * If no parent is set, the same anchorview object will be used.
11833 * @param obj The anchorview object
11834 * @param parent The object to use as parent for the hover
11836 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11838 * Get the parent of the hover popup
11840 * Get the object used as parent for the hover created by the anchorview
11841 * widget. See @ref Hover for more details on this.
11843 * @param obj The anchorview object
11844 * @return The object used as parent for the hover, NULL if none is set.
11846 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11848 * Set the style that the hover should use
11850 * When creating the popup hover, anchorview will request that it's
11851 * themed according to @p style.
11853 * @param obj The anchorview object
11854 * @param style The style to use for the underlying hover
11856 * @see elm_object_style_set()
11858 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11860 * Get the style that the hover should use
11862 * Get the style the hover created by anchorview will use.
11864 * @param obj The anchorview object
11865 * @return The style to use by the hover. NULL means the default is used.
11867 * @see elm_object_style_set()
11869 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11871 * Ends the hover popup in the anchorview
11873 * When an anchor is clicked, the anchorview widget will create a hover
11874 * object to use as a popup with user provided content. This function
11875 * terminates this popup, returning the anchorview to its normal state.
11877 * @param obj The anchorview object
11879 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11881 * Set bouncing behaviour when the scrolled content reaches an edge
11883 * Tell the internal scroller object whether it should bounce or not
11884 * when it reaches the respective edges for each axis.
11886 * @param obj The anchorview object
11887 * @param h_bounce Whether to bounce or not in the horizontal axis
11888 * @param v_bounce Whether to bounce or not in the vertical axis
11890 * @see elm_scroller_bounce_set()
11892 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11894 * Get the set bouncing behaviour of the internal scroller
11896 * Get whether the internal scroller should bounce when the edge of each
11897 * axis is reached scrolling.
11899 * @param obj The anchorview object
11900 * @param h_bounce Pointer where to store the bounce state of the horizontal
11902 * @param v_bounce Pointer where to store the bounce state of the vertical
11905 * @see elm_scroller_bounce_get()
11907 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11909 * Appends a custom item provider to the given anchorview
11911 * Appends the given function to the list of items providers. This list is
11912 * called, one function at a time, with the given @p data pointer, the
11913 * anchorview object and, in the @p item parameter, the item name as
11914 * referenced in its href string. Following functions in the list will be
11915 * called in order until one of them returns something different to NULL,
11916 * which should be an Evas_Object which will be used in place of the item
11919 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11920 * href=item/name\>\</item\>
11922 * @param obj The anchorview object
11923 * @param func The function to add to the list of providers
11924 * @param data User data that will be passed to the callback function
11926 * @see elm_entry_item_provider_append()
11928 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);
11930 * Prepend a custom item provider to the given anchorview
11932 * Like elm_anchorview_item_provider_append(), but it adds the function
11933 * @p func to the beginning of the list, instead of the end.
11935 * @param obj The anchorview object
11936 * @param func The function to add to the list of providers
11937 * @param data User data that will be passed to the callback function
11939 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);
11941 * Remove a custom item provider from the list of the given anchorview
11943 * Removes the function and data pairing that matches @p func and @p data.
11944 * That is, unless the same function and same user data are given, the
11945 * function will not be removed from the list. This allows us to add the
11946 * same callback several times, with different @p data pointers and be
11947 * able to remove them later without conflicts.
11949 * @param obj The anchorview object
11950 * @param func The function to remove from the list
11951 * @param data The data matching the function to remove from the list
11953 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);
11960 * @defgroup Anchorblock Anchorblock
11962 * @image html img/widget/anchorblock/preview-00.png
11963 * @image latex img/widget/anchorblock/preview-00.eps
11965 * Anchorblock is for displaying text that contains markup with anchors
11966 * like <c>\<a href=1234\>something\</\></c> in it.
11968 * Besides being styled differently, the anchorblock widget provides the
11969 * necessary functionality so that clicking on these anchors brings up a
11970 * popup with user defined content such as "call", "add to contacts" or
11971 * "open web page". This popup is provided using the @ref Hover widget.
11973 * This widget emits the following signals:
11974 * @li "anchor,clicked": will be called when an anchor is clicked. The
11975 * @p event_info parameter on the callback will be a pointer of type
11976 * ::Elm_Entry_Anchorblock_Info.
11982 * Since examples are usually better than plain words, we might as well
11983 * try @ref tutorial_anchorblock_example "one".
11986 * @addtogroup Anchorblock
11990 * @typedef Elm_Entry_Anchorblock_Info
11992 * The info sent in the callback for "anchor,clicked" signals emitted by
11993 * the Anchorblock widget.
11995 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11997 * @struct _Elm_Entry_Anchorblock_Info
11999 * The info sent in the callback for "anchor,clicked" signals emitted by
12000 * the Anchorblock widget.
12002 struct _Elm_Entry_Anchorblock_Info
12004 const char *name; /**< Name of the anchor, as indicated in its href
12006 int button; /**< The mouse button used to click on it */
12007 Evas_Object *hover; /**< The hover object to use for the popup */
12009 Evas_Coord x, y, w, h;
12010 } anchor, /**< Geometry selection of text used as anchor */
12011 hover_parent; /**< Geometry of the object used as parent by the
12013 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12014 for content on the left side of
12015 the hover. Before calling the
12016 callback, the widget will make the
12017 necessary calculations to check
12018 which sides are fit to be set with
12019 content, based on the position the
12020 hover is activated and its distance
12021 to the edges of its parent object
12023 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12024 the right side of the hover.
12025 See @ref hover_left */
12026 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12027 of the hover. See @ref hover_left */
12028 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12029 below the hover. See @ref
12033 * Add a new Anchorblock object
12035 * @param parent The parent object
12036 * @return The new object or NULL if it cannot be created
12038 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12040 * Set the text to show in the anchorblock
12042 * Sets the text of the anchorblock to @p text. This text can include markup
12043 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12044 * of text that will be specially styled and react to click events, ended
12045 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12046 * "anchor,clicked" signal that you can attach a callback to with
12047 * evas_object_smart_callback_add(). The name of the anchor given in the
12048 * event info struct will be the one set in the href attribute, in this
12049 * case, anchorname.
12051 * Other markup can be used to style the text in different ways, but it's
12052 * up to the style defined in the theme which tags do what.
12053 * @deprecated use elm_object_text_set() instead.
12055 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12057 * Get the markup text set for the anchorblock
12059 * Retrieves the text set on the anchorblock, with markup tags included.
12061 * @param obj The anchorblock object
12062 * @return The markup text set or @c NULL if nothing was set or an error
12064 * @deprecated use elm_object_text_set() instead.
12066 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12068 * Set the parent of the hover popup
12070 * Sets the parent object to use by the hover created by the anchorblock
12071 * when an anchor is clicked. See @ref Hover for more details on this.
12073 * @param obj The anchorblock object
12074 * @param parent The object to use as parent for the hover
12076 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12078 * Get the parent of the hover popup
12080 * Get the object used as parent for the hover created by the anchorblock
12081 * widget. See @ref Hover for more details on this.
12082 * If no parent is set, the same anchorblock object will be used.
12084 * @param obj The anchorblock object
12085 * @return The object used as parent for the hover, NULL if none is set.
12087 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12089 * Set the style that the hover should use
12091 * When creating the popup hover, anchorblock will request that it's
12092 * themed according to @p style.
12094 * @param obj The anchorblock object
12095 * @param style The style to use for the underlying hover
12097 * @see elm_object_style_set()
12099 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12101 * Get the style that the hover should use
12103 * Get the style the hover created by anchorblock will use.
12105 * @param obj The anchorblock object
12106 * @return The style to use by the hover. NULL means the default is used.
12108 * @see elm_object_style_set()
12110 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12112 * Ends the hover popup in the anchorblock
12114 * When an anchor is clicked, the anchorblock widget will create a hover
12115 * object to use as a popup with user provided content. This function
12116 * terminates this popup, returning the anchorblock to its normal state.
12118 * @param obj The anchorblock object
12120 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12122 * Appends a custom item provider to the given anchorblock
12124 * Appends the given function to the list of items providers. This list is
12125 * called, one function at a time, with the given @p data pointer, the
12126 * anchorblock object and, in the @p item parameter, the item name as
12127 * referenced in its href string. Following functions in the list will be
12128 * called in order until one of them returns something different to NULL,
12129 * which should be an Evas_Object which will be used in place of the item
12132 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12133 * href=item/name\>\</item\>
12135 * @param obj The anchorblock object
12136 * @param func The function to add to the list of providers
12137 * @param data User data that will be passed to the callback function
12139 * @see elm_entry_item_provider_append()
12141 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);
12143 * Prepend a custom item provider to the given anchorblock
12145 * Like elm_anchorblock_item_provider_append(), but it adds the function
12146 * @p func to the beginning of the list, instead of the end.
12148 * @param obj The anchorblock object
12149 * @param func The function to add to the list of providers
12150 * @param data User data that will be passed to the callback function
12152 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);
12154 * Remove a custom item provider from the list of the given anchorblock
12156 * Removes the function and data pairing that matches @p func and @p data.
12157 * That is, unless the same function and same user data are given, the
12158 * function will not be removed from the list. This allows us to add the
12159 * same callback several times, with different @p data pointers and be
12160 * able to remove them later without conflicts.
12162 * @param obj The anchorblock object
12163 * @param func The function to remove from the list
12164 * @param data The data matching the function to remove from the list
12166 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);
12172 * @defgroup Bubble Bubble
12174 * @image html img/widget/bubble/preview-00.png
12175 * @image latex img/widget/bubble/preview-00.eps
12176 * @image html img/widget/bubble/preview-01.png
12177 * @image latex img/widget/bubble/preview-01.eps
12178 * @image html img/widget/bubble/preview-02.png
12179 * @image latex img/widget/bubble/preview-02.eps
12181 * @brief The Bubble is a widget to show text similarly to how speech is
12182 * represented in comics.
12184 * The bubble widget contains 5 important visual elements:
12185 * @li The frame is a rectangle with rounded rectangles and an "arrow".
12186 * @li The @p icon is an image to which the frame's arrow points to.
12187 * @li The @p label is a text which appears to the right of the icon if the
12188 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12190 * @li The @p info is a text which appears to the right of the label. Info's
12191 * font is of a ligther color than label.
12192 * @li The @p content is an evas object that is shown inside the frame.
12194 * The position of the arrow, icon, label and info depends on which corner is
12195 * selected. The four available corners are:
12196 * @li "top_left" - Default
12198 * @li "bottom_left"
12199 * @li "bottom_right"
12201 * Signals that you can add callbacks for are:
12202 * @li "clicked" - This is called when a user has clicked the bubble.
12204 * For an example of using a buble see @ref bubble_01_example_page "this".
12209 * Add a new bubble to the parent
12211 * @param parent The parent object
12212 * @return The new object or NULL if it cannot be created
12214 * This function adds a text bubble to the given parent evas object.
12216 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12218 * Set the label of the bubble
12220 * @param obj The bubble object
12221 * @param label The string to set in the label
12223 * This function sets the title of the bubble. Where this appears depends on
12224 * the selected corner.
12225 * @deprecated use elm_object_text_set() instead.
12227 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12229 * Get the label of the bubble
12231 * @param obj The bubble object
12232 * @return The string of set in the label
12234 * This function gets the title of the bubble.
12235 * @deprecated use elm_object_text_get() instead.
12237 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12239 * Set the info of the bubble
12241 * @param obj The bubble object
12242 * @param info The given info about the bubble
12244 * This function sets the info of the bubble. Where this appears depends on
12245 * the selected corner.
12246 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12248 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12250 * Get the info of the bubble
12252 * @param obj The bubble object
12254 * @return The "info" string of the bubble
12256 * This function gets the info text.
12257 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12259 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12261 * Set the content to be shown in the bubble
12263 * Once the content object is set, a previously set one will be deleted.
12264 * If you want to keep the old content object, use the
12265 * elm_bubble_content_unset() function.
12267 * @param obj The bubble object
12268 * @param content The given content of the bubble
12270 * This function sets the content shown on the middle of the bubble.
12272 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12274 * Get the content shown in the bubble
12276 * Return the content object which is set for this widget.
12278 * @param obj The bubble object
12279 * @return The content that is being used
12281 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12283 * Unset the content shown in the bubble
12285 * Unparent and return the content object which was set for this widget.
12287 * @param obj The bubble object
12288 * @return The content that was being used
12290 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12292 * Set the icon of the bubble
12294 * Once the icon object is set, a previously set one will be deleted.
12295 * If you want to keep the old content object, use the
12296 * elm_icon_content_unset() function.
12298 * @param obj The bubble object
12299 * @param icon The given icon for the bubble
12301 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12303 * Get the icon of the bubble
12305 * @param obj The bubble object
12306 * @return The icon for the bubble
12308 * This function gets the icon shown on the top left of bubble.
12310 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12312 * Unset the icon of the bubble
12314 * Unparent and return the icon object which was set for this widget.
12316 * @param obj The bubble object
12317 * @return The icon that was being used
12319 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12321 * Set the corner of the bubble
12323 * @param obj The bubble object.
12324 * @param corner The given corner for the bubble.
12326 * This function sets the corner of the bubble. The corner will be used to
12327 * determine where the arrow in the frame points to and where label, icon and
12330 * Possible values for corner are:
12331 * @li "top_left" - Default
12333 * @li "bottom_left"
12334 * @li "bottom_right"
12336 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12338 * Get the corner of the bubble
12340 * @param obj The bubble object.
12341 * @return The given corner for the bubble.
12343 * This function gets the selected corner of the bubble.
12345 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12351 * @defgroup Photo Photo
12353 * For displaying the photo of a person (contact). Simple yet
12354 * with a very specific purpose.
12356 * Signals that you can add callbacks for are:
12358 * "clicked" - This is called when a user has clicked the photo
12359 * "drag,start" - Someone started dragging the image out of the object
12360 * "drag,end" - Dragged item was dropped (somewhere)
12366 * Add a new photo to the parent
12368 * @param parent The parent object
12369 * @return The new object or NULL if it cannot be created
12373 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12376 * Set the file that will be used as photo
12378 * @param obj The photo object
12379 * @param file The path to file that will be used as photo
12381 * @return (1 = success, 0 = error)
12385 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12388 * Set the file that will be used as thumbnail in the photo.
12390 * @param obj The photo object.
12391 * @param file The path to file that will be used as thumb.
12392 * @param group The key used in case of an EET file.
12396 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12399 * Set the size that will be used on the photo
12401 * @param obj The photo object
12402 * @param size The size that the photo will be
12406 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12409 * Set if the photo should be completely visible or not.
12411 * @param obj The photo object
12412 * @param fill if true the photo will be completely visible
12416 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12419 * Set editability of the photo.
12421 * An editable photo can be dragged to or from, and can be cut or
12422 * pasted too. Note that pasting an image or dropping an item on
12423 * the image will delete the existing content.
12425 * @param obj The photo object.
12426 * @param set To set of clear editablity.
12428 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12434 /* gesture layer */
12436 * @defgroup Elm_Gesture_Layer Gesture Layer
12437 * Gesture Layer Usage:
12439 * Use Gesture Layer to detect gestures.
12440 * The advantage is that you don't have to implement
12441 * gesture detection, just set callbacks of gesture state.
12442 * By using gesture layer we make standard interface.
12444 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12445 * with a parent object parameter.
12446 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12447 * call. Usually with same object as target (2nd parameter).
12449 * Now you need to tell gesture layer what gestures you follow.
12450 * This is done with @ref elm_gesture_layer_cb_set call.
12451 * By setting the callback you actually saying to gesture layer:
12452 * I would like to know when the gesture @ref Elm_Gesture_Types
12453 * switches to state @ref Elm_Gesture_State.
12455 * Next, you need to implement the actual action that follows the input
12456 * in your callback.
12458 * Note that if you like to stop being reported about a gesture, just set
12459 * all callbacks referring this gesture to NULL.
12460 * (again with @ref elm_gesture_layer_cb_set)
12462 * The information reported by gesture layer to your callback is depending
12463 * on @ref Elm_Gesture_Types:
12464 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12465 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12466 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12468 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12469 * @ref ELM_GESTURE_MOMENTUM.
12471 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12472 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12473 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12474 * Note that we consider a flick as a line-gesture that should be completed
12475 * in flick-time-limit as defined in @ref Config.
12477 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12479 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12482 * Gesture Layer Tweaks:
12484 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12485 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12487 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12488 * so gesture starts when user touches (a *DOWN event) touch-surface
12489 * and ends when no fingers touches surface (a *UP event).
12493 * @enum _Elm_Gesture_Types
12494 * Enum of supported gesture types.
12495 * @ingroup Elm_Gesture_Layer
12497 enum _Elm_Gesture_Types
12499 ELM_GESTURE_FIRST = 0,
12501 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12502 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12503 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12504 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12506 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12508 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12509 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12511 ELM_GESTURE_ZOOM, /**< Zoom */
12512 ELM_GESTURE_ROTATE, /**< Rotate */
12518 * @typedef Elm_Gesture_Types
12519 * gesture types enum
12520 * @ingroup Elm_Gesture_Layer
12522 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12525 * @enum _Elm_Gesture_State
12526 * Enum of gesture states.
12527 * @ingroup Elm_Gesture_Layer
12529 enum _Elm_Gesture_State
12531 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12532 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12533 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12534 ELM_GESTURE_STATE_END, /**< Gesture completed */
12535 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12539 * @typedef Elm_Gesture_State
12540 * gesture states enum
12541 * @ingroup Elm_Gesture_Layer
12543 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12546 * @struct _Elm_Gesture_Taps_Info
12547 * Struct holds taps info for user
12548 * @ingroup Elm_Gesture_Layer
12550 struct _Elm_Gesture_Taps_Info
12552 Evas_Coord x, y; /**< Holds center point between fingers */
12553 unsigned int n; /**< Number of fingers tapped */
12554 unsigned int timestamp; /**< event timestamp */
12558 * @typedef Elm_Gesture_Taps_Info
12559 * holds taps info for user
12560 * @ingroup Elm_Gesture_Layer
12562 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12565 * @struct _Elm_Gesture_Momentum_Info
12566 * Struct holds momentum info for user
12567 * x1 and y1 are not necessarily in sync
12568 * x1 holds x value of x direction starting point
12569 * and same holds for y1.
12570 * This is noticeable when doing V-shape movement
12571 * @ingroup Elm_Gesture_Layer
12573 struct _Elm_Gesture_Momentum_Info
12574 { /* Report line ends, timestamps, and momentum computed */
12575 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12576 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12577 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12578 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12580 unsigned int tx; /**< Timestamp of start of final x-swipe */
12581 unsigned int ty; /**< Timestamp of start of final y-swipe */
12583 Evas_Coord mx; /**< Momentum on X */
12584 Evas_Coord my; /**< Momentum on Y */
12588 * @typedef Elm_Gesture_Momentum_Info
12589 * holds momentum info for user
12590 * @ingroup Elm_Gesture_Layer
12592 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12595 * @struct _Elm_Gesture_Line_Info
12596 * Struct holds line info for user
12597 * @ingroup Elm_Gesture_Layer
12599 struct _Elm_Gesture_Line_Info
12600 { /* Report line ends, timestamps, and momentum computed */
12601 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12602 unsigned int n; /**< Number of fingers (lines) */
12603 /* FIXME should be radians, bot degrees */
12604 double angle; /**< Angle (direction) of lines */
12608 * @typedef Elm_Gesture_Line_Info
12609 * Holds line info for user
12610 * @ingroup Elm_Gesture_Layer
12612 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12615 * @struct _Elm_Gesture_Zoom_Info
12616 * Struct holds zoom info for user
12617 * @ingroup Elm_Gesture_Layer
12619 struct _Elm_Gesture_Zoom_Info
12621 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12622 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12623 double zoom; /**< Zoom value: 1.0 means no zoom */
12624 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12628 * @typedef Elm_Gesture_Zoom_Info
12629 * Holds zoom info for user
12630 * @ingroup Elm_Gesture_Layer
12632 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12635 * @struct _Elm_Gesture_Rotate_Info
12636 * Struct holds rotation info for user
12637 * @ingroup Elm_Gesture_Layer
12639 struct _Elm_Gesture_Rotate_Info
12641 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12642 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12643 double base_angle; /**< Holds start-angle */
12644 double angle; /**< Rotation value: 0.0 means no rotation */
12645 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12649 * @typedef Elm_Gesture_Rotate_Info
12650 * Holds rotation info for user
12651 * @ingroup Elm_Gesture_Layer
12653 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12656 * @typedef Elm_Gesture_Event_Cb
12657 * User callback used to stream gesture info from gesture layer
12658 * @param data user data
12659 * @param event_info gesture report info
12660 * Returns a flag field to be applied on the causing event.
12661 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12662 * upon the event, in an irreversible way.
12664 * @ingroup Elm_Gesture_Layer
12666 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12669 * Use function to set callbacks to be notified about
12670 * change of state of gesture.
12671 * When a user registers a callback with this function
12672 * this means this gesture has to be tested.
12674 * When ALL callbacks for a gesture are set to NULL
12675 * it means user isn't interested in gesture-state
12676 * and it will not be tested.
12678 * @param obj Pointer to gesture-layer.
12679 * @param idx The gesture you would like to track its state.
12680 * @param cb callback function pointer.
12681 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12682 * @param data user info to be sent to callback (usually, Smart Data)
12684 * @ingroup Elm_Gesture_Layer
12686 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);
12689 * Call this function to get repeat-events settings.
12691 * @param obj Pointer to gesture-layer.
12693 * @return repeat events settings.
12694 * @see elm_gesture_layer_hold_events_set()
12695 * @ingroup Elm_Gesture_Layer
12697 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12700 * This function called in order to make gesture-layer repeat events.
12701 * Set this of you like to get the raw events only if gestures were not detected.
12702 * Clear this if you like gesture layer to fwd events as testing gestures.
12704 * @param obj Pointer to gesture-layer.
12705 * @param r Repeat: TRUE/FALSE
12707 * @ingroup Elm_Gesture_Layer
12709 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12712 * This function sets step-value for zoom action.
12713 * Set step to any positive value.
12714 * Cancel step setting by setting to 0.0
12716 * @param obj Pointer to gesture-layer.
12717 * @param s new zoom step value.
12719 * @ingroup Elm_Gesture_Layer
12721 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12724 * This function sets step-value for rotate action.
12725 * Set step to any positive value.
12726 * Cancel step setting by setting to 0.0
12728 * @param obj Pointer to gesture-layer.
12729 * @param s new roatate step value.
12731 * @ingroup Elm_Gesture_Layer
12733 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12736 * This function called to attach gesture-layer to an Evas_Object.
12737 * @param obj Pointer to gesture-layer.
12738 * @param t Pointer to underlying object (AKA Target)
12740 * @return TRUE, FALSE on success, failure.
12742 * @ingroup Elm_Gesture_Layer
12744 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12747 * Call this function to construct a new gesture-layer object.
12748 * This does not activate the gesture layer. You have to
12749 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12751 * @param parent the parent object.
12753 * @return Pointer to new gesture-layer object.
12755 * @ingroup Elm_Gesture_Layer
12757 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12760 * @defgroup Thumb Thumb
12762 * @image html img/widget/thumb/preview-00.png
12763 * @image latex img/widget/thumb/preview-00.eps
12765 * A thumb object is used for displaying the thumbnail of an image or video.
12766 * You must have compiled Elementary with Ethumb_Client support and the DBus
12767 * service must be present and auto-activated in order to have thumbnails to
12770 * Once the thumbnail object becomes visible, it will check if there is a
12771 * previously generated thumbnail image for the file set on it. If not, it
12772 * will start generating this thumbnail.
12774 * Different config settings will cause different thumbnails to be generated
12775 * even on the same file.
12777 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12778 * Ethumb documentation to change this path, and to see other configuration
12781 * Signals that you can add callbacks for are:
12783 * - "clicked" - This is called when a user has clicked the thumb without dragging
12785 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12786 * - "press" - This is called when a user has pressed down the thumb.
12787 * - "generate,start" - The thumbnail generation started.
12788 * - "generate,stop" - The generation process stopped.
12789 * - "generate,error" - The generation failed.
12790 * - "load,error" - The thumbnail image loading failed.
12792 * available styles:
12796 * An example of use of thumbnail:
12798 * - @ref thumb_example_01
12802 * @addtogroup Thumb
12807 * @enum _Elm_Thumb_Animation_Setting
12808 * @typedef Elm_Thumb_Animation_Setting
12810 * Used to set if a video thumbnail is animating or not.
12814 typedef enum _Elm_Thumb_Animation_Setting
12816 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12817 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
12818 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
12819 ELM_THUMB_ANIMATION_LAST
12820 } Elm_Thumb_Animation_Setting;
12823 * Add a new thumb object to the parent.
12825 * @param parent The parent object.
12826 * @return The new object or NULL if it cannot be created.
12828 * @see elm_thumb_file_set()
12829 * @see elm_thumb_ethumb_client_get()
12833 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12835 * Reload thumbnail if it was generated before.
12837 * @param obj The thumb object to reload
12839 * This is useful if the ethumb client configuration changed, like its
12840 * size, aspect or any other property one set in the handle returned
12841 * by elm_thumb_ethumb_client_get().
12843 * If the options didn't change, the thumbnail won't be generated again, but
12844 * the old one will still be used.
12846 * @see elm_thumb_file_set()
12850 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12852 * Set the file that will be used as thumbnail.
12854 * @param obj The thumb object.
12855 * @param file The path to file that will be used as thumb.
12856 * @param key The key used in case of an EET file.
12858 * The file can be an image or a video (in that case, acceptable extensions are:
12859 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12860 * function elm_thumb_animate().
12862 * @see elm_thumb_file_get()
12863 * @see elm_thumb_reload()
12864 * @see elm_thumb_animate()
12868 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12870 * Get the image or video path and key used to generate the thumbnail.
12872 * @param obj The thumb object.
12873 * @param file Pointer to filename.
12874 * @param key Pointer to key.
12876 * @see elm_thumb_file_set()
12877 * @see elm_thumb_path_get()
12881 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12883 * Get the path and key to the image or video generated by ethumb.
12885 * One just need to make sure that the thumbnail was generated before getting
12886 * its path; otherwise, the path will be NULL. One way to do that is by asking
12887 * for the path when/after the "generate,stop" smart callback is called.
12889 * @param obj The thumb object.
12890 * @param file Pointer to thumb path.
12891 * @param key Pointer to thumb key.
12893 * @see elm_thumb_file_get()
12897 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12899 * Set the animation state for the thumb object. If its content is an animated
12900 * video, you may start/stop the animation or tell it to play continuously and
12903 * @param obj The thumb object.
12904 * @param setting The animation setting.
12906 * @see elm_thumb_file_set()
12910 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12912 * Get the animation state for the thumb object.
12914 * @param obj The thumb object.
12915 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12918 * @see elm_thumb_animate_set()
12922 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12924 * Get the ethumb_client handle so custom configuration can be made.
12926 * @return Ethumb_Client instance or NULL.
12928 * This must be called before the objects are created to be sure no object is
12929 * visible and no generation started.
12931 * Example of usage:
12934 * #include <Elementary.h>
12935 * #ifndef ELM_LIB_QUICKLAUNCH
12937 * elm_main(int argc, char **argv)
12939 * Ethumb_Client *client;
12941 * elm_need_ethumb();
12945 * client = elm_thumb_ethumb_client_get();
12948 * ERR("could not get ethumb_client");
12951 * ethumb_client_size_set(client, 100, 100);
12952 * ethumb_client_crop_align_set(client, 0.5, 0.5);
12955 * // Create elm_thumb objects here
12965 * @note There's only one client handle for Ethumb, so once a configuration
12966 * change is done to it, any other request for thumbnails (for any thumbnail
12967 * object) will use that configuration. Thus, this configuration is global.
12971 EAPI void *elm_thumb_ethumb_client_get(void);
12973 * Get the ethumb_client connection state.
12975 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12978 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
12980 * Make the thumbnail 'editable'.
12982 * @param obj Thumb object.
12983 * @param set Turn on or off editability. Default is @c EINA_FALSE.
12985 * This means the thumbnail is a valid drag target for drag and drop, and can be
12986 * cut or pasted too.
12988 * @see elm_thumb_editable_get()
12992 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12994 * Make the thumbnail 'editable'.
12996 * @param obj Thumb object.
12997 * @return Editability.
12999 * This means the thumbnail is a valid drag target for drag and drop, and can be
13000 * cut or pasted too.
13002 * @see elm_thumb_editable_set()
13006 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13013 * @defgroup Web Web
13015 * @image html img/widget/web/preview-00.png
13016 * @image latex img/widget/web/preview-00.eps
13018 * A web object is used for displaying web pages (HTML/CSS/JS)
13019 * using WebKit-EFL. You must have compiled Elementary with
13022 * Signals that you can add callbacks for are:
13023 * @li "download,request": A file download has been requested. Event info is
13024 * a pointer to a Elm_Web_Download
13025 * @li "editorclient,contents,changed": Editor client's contents changed
13026 * @li "editorclient,selection,changed": Editor client's selection changed
13027 * @li "frame,created": A new frame was created. Event info is an
13028 * Evas_Object which can be handled with WebKit's ewk_frame API
13029 * @li "icon,received": An icon was received by the main frame
13030 * @li "inputmethod,changed": Input method changed. Event info is an
13031 * Eina_Bool indicating whether it's enabled or not
13032 * @li "js,windowobject,clear": JS window object has been cleared
13033 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13034 * is a char *link[2], where the first string contains the URL the link
13035 * points to, and the second one the title of the link
13036 * @li "link,hover,out": Mouse cursor left the link
13037 * @li "load,document,finished": Loading of a document finished. Event info
13038 * is the frame that finished loading
13039 * @li "load,error": Load failed. Event info is a pointer to
13040 * Elm_Web_Frame_Load_Error
13041 * @li "load,finished": Load finished. Event info is NULL on success, on
13042 * error it's a pointer to Elm_Web_Frame_Load_Error
13043 * @li "load,newwindow,show": A new window was created and is ready to be
13045 * @li "load,progress": Overall load progress. Event info is a pointer to
13046 * a double containing a value between 0.0 and 1.0
13047 * @li "load,provisional": Started provisional load
13048 * @li "load,started": Loading of a document started
13049 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13050 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13051 * the menubar is visible, or EINA_FALSE in case it's not
13052 * @li "menubar,visible,set": Informs menubar visibility. Event info is
13053 * an Eina_Bool indicating the visibility
13054 * @li "popup,created": A dropdown widget was activated, requesting its
13055 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13056 * @li "popup,willdelete": The web object is ready to destroy the popup
13057 * object created. Event info is a pointer to Elm_Web_Menu
13058 * @li "ready": Page is fully loaded
13059 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13060 * info is a pointer to Eina_Bool where the visibility state should be set
13061 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13062 * is an Eina_Bool with the visibility state set
13063 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13064 * a string with the new text
13065 * @li "statusbar,visible,get": Queries visibility of the status bar.
13066 * Event info is a pointer to Eina_Bool where the visibility state should be
13068 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13069 * an Eina_Bool with the visibility value
13070 * @li "title,changed": Title of the main frame changed. Event info is a
13071 * string with the new title
13072 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13073 * is a pointer to Eina_Bool where the visibility state should be set
13074 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13075 * info is an Eina_Bool with the visibility state
13076 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13077 * a string with the text to show
13078 * @li "uri,changed": URI of the main frame changed. Event info is a string
13080 * @li "view,resized": The web object internal's view changed sized
13081 * @li "windows,close,request": A JavaScript request to close the current
13082 * window was requested
13083 * @li "zoom,animated,end": Animated zoom finished
13085 * available styles:
13088 * An example of use of web:
13090 * - @ref web_example_01 TBD
13099 * Structure used to report load errors.
13101 * Load errors are reported as signal by elm_web. All the strings are
13102 * temporary references and should @b not be used after the signal
13103 * callback returns. If it's required, make copies with strdup() or
13104 * eina_stringshare_add() (they are not even guaranteed to be
13105 * stringshared, so must use eina_stringshare_add() and not
13106 * eina_stringshare_ref()).
13108 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13110 * Structure used to report load errors.
13112 * Load errors are reported as signal by elm_web. All the strings are
13113 * temporary references and should @b not be used after the signal
13114 * callback returns. If it's required, make copies with strdup() or
13115 * eina_stringshare_add() (they are not even guaranteed to be
13116 * stringshared, so must use eina_stringshare_add() and not
13117 * eina_stringshare_ref()).
13119 struct _Elm_Web_Frame_Load_Error
13121 int code; /**< Numeric error code */
13122 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13123 const char *domain; /**< Error domain name */
13124 const char *description; /**< Error description (already localized) */
13125 const char *failing_url; /**< The URL that failed to load */
13126 Evas_Object *frame; /**< Frame object that produced the error */
13130 * The possibles types that the items in a menu can be
13132 typedef enum _Elm_Web_Menu_Item_Type
13134 ELM_WEB_MENU_SEPARATOR,
13135 ELM_WEB_MENU_GROUP,
13136 ELM_WEB_MENU_OPTION
13137 } Elm_Web_Menu_Item_Type;
13140 * Structure describing the items in a menu
13142 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13144 * Structure describing the items in a menu
13146 struct _Elm_Web_Menu_Item
13148 const char *text; /**< The text for the item */
13149 Elm_Web_Menu_Item_Type type; /**< The type of the item */
13153 * Structure describing the menu of a popup
13155 * This structure will be passed as the @c event_info for the "popup,create"
13156 * signal, which is emitted when a dropdown menu is opened. Users wanting
13157 * to handle these popups by themselves should listen to this signal and
13158 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13159 * property as @c EINA_FALSE means that the user will not handle the popup
13160 * and the default implementation will be used.
13162 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13163 * will be emitted to notify the user that it can destroy any objects and
13164 * free all data related to it.
13166 * @see elm_web_popup_selected_set()
13167 * @see elm_web_popup_destroy()
13169 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13171 * Structure describing the menu of a popup
13173 * This structure will be passed as the @c event_info for the "popup,create"
13174 * signal, which is emitted when a dropdown menu is opened. Users wanting
13175 * to handle these popups by themselves should listen to this signal and
13176 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13177 * property as @c EINA_FALSE means that the user will not handle the popup
13178 * and the default implementation will be used.
13180 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13181 * will be emitted to notify the user that it can destroy any objects and
13182 * free all data related to it.
13184 * @see elm_web_popup_selected_set()
13185 * @see elm_web_popup_destroy()
13187 struct _Elm_Web_Menu
13189 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13190 int x; /**< The X position of the popup, relative to the elm_web object */
13191 int y; /**< The Y position of the popup, relative to the elm_web object */
13192 int width; /**< Width of the popup menu */
13193 int height; /**< Height of the popup menu */
13195 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. */
13198 typedef struct _Elm_Web_Download Elm_Web_Download;
13199 struct _Elm_Web_Download
13205 * Types of zoom available.
13207 typedef enum _Elm_Web_Zoom_Mode
13209 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13210 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13211 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13212 ELM_WEB_ZOOM_MODE_LAST
13213 } Elm_Web_Zoom_Mode;
13215 * Opaque handler containing the features (such as statusbar, menubar, etc)
13216 * that are to be set on a newly requested window.
13218 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13220 * Callback type for the create_window hook.
13222 * The function parameters are:
13223 * @li @p data User data pointer set when setting the hook function
13224 * @li @p obj The elm_web object requesting the new window
13225 * @li @p js Set to @c EINA_TRUE if the request was originated from
13226 * JavaScript. @c EINA_FALSE otherwise.
13227 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13228 * the features requested for the new window.
13230 * The returned value of the function should be the @c elm_web widget where
13231 * the request will be loaded. That is, if a new window or tab is created,
13232 * the elm_web widget in it should be returned, and @b NOT the window
13234 * Returning @c NULL should cancel the request.
13236 * @see elm_web_window_create_hook_set()
13238 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13240 * Callback type for the JS alert hook.
13242 * The function parameters are:
13243 * @li @p data User data pointer set when setting the hook function
13244 * @li @p obj The elm_web object requesting the new window
13245 * @li @p message The message to show in the alert dialog
13247 * The function should return the object representing the alert dialog.
13248 * Elm_Web will run a second main loop to handle the dialog and normal
13249 * flow of the application will be restored when the object is deleted, so
13250 * the user should handle the popup properly in order to delete the object
13251 * when the action is finished.
13252 * If the function returns @c NULL the popup will be ignored.
13254 * @see elm_web_dialog_alert_hook_set()
13256 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13258 * Callback type for the JS confirm hook.
13260 * The function parameters are:
13261 * @li @p data User data pointer set when setting the hook function
13262 * @li @p obj The elm_web object requesting the new window
13263 * @li @p message The message to show in the confirm dialog
13264 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13265 * the user selected @c Ok, @c EINA_FALSE otherwise.
13267 * The function should return the object representing the confirm dialog.
13268 * Elm_Web will run a second main loop to handle the dialog and normal
13269 * flow of the application will be restored when the object is deleted, so
13270 * the user should handle the popup properly in order to delete the object
13271 * when the action is finished.
13272 * If the function returns @c NULL the popup will be ignored.
13274 * @see elm_web_dialog_confirm_hook_set()
13276 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13278 * Callback type for the JS prompt hook.
13280 * The function parameters are:
13281 * @li @p data User data pointer set when setting the hook function
13282 * @li @p obj The elm_web object requesting the new window
13283 * @li @p message The message to show in the prompt dialog
13284 * @li @p def_value The default value to present the user in the entry
13285 * @li @p value Pointer where to store the value given by the user. Must
13286 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13287 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13288 * the user selected @c Ok, @c EINA_FALSE otherwise.
13290 * The function should return the object representing the prompt dialog.
13291 * Elm_Web will run a second main loop to handle the dialog and normal
13292 * flow of the application will be restored when the object is deleted, so
13293 * the user should handle the popup properly in order to delete the object
13294 * when the action is finished.
13295 * If the function returns @c NULL the popup will be ignored.
13297 * @see elm_web_dialog_prompt_hook_set()
13299 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13301 * Callback type for the JS file selector hook.
13303 * The function parameters are:
13304 * @li @p data User data pointer set when setting the hook function
13305 * @li @p obj The elm_web object requesting the new window
13306 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13307 * @li @p accept_types Mime types accepted
13308 * @li @p selected Pointer where to store the list of malloc'ed strings
13309 * containing the path to each file selected. Must be @c NULL if the file
13310 * dialog is cancelled
13311 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13312 * the user selected @c Ok, @c EINA_FALSE otherwise.
13314 * The function should return the object representing the file selector
13316 * Elm_Web will run a second main loop to handle the dialog and normal
13317 * flow of the application will be restored when the object is deleted, so
13318 * the user should handle the popup properly in order to delete the object
13319 * when the action is finished.
13320 * If the function returns @c NULL the popup will be ignored.
13322 * @see elm_web_dialog_file selector_hook_set()
13324 typedef Evas_Object *(*Elm_Web_Dialog_File_Selector)(void *data, Evas_Object *obj, Eina_Bool allows_multiple, const char *accept_types, Eina_List **selected, Eina_Bool *ret);
13326 * Callback type for the JS console message hook.
13328 * When a console message is added from JavaScript, any set function to the
13329 * console message hook will be called for the user to handle. There is no
13330 * default implementation of this hook.
13332 * The function parameters are:
13333 * @li @p data User data pointer set when setting the hook function
13334 * @li @p obj The elm_web object that originated the message
13335 * @li @p message The message sent
13336 * @li @p line_number The line number
13337 * @li @p source_id Source id
13339 * @see elm_web_console_message_hook_set()
13341 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13343 * Add a new web object to the parent.
13345 * @param parent The parent object.
13346 * @return The new object or NULL if it cannot be created.
13348 * @see elm_web_uri_set()
13349 * @see elm_web_webkit_view_get()
13351 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13354 * Get internal ewk_view object from web object.
13356 * Elementary may not provide some low level features of EWebKit,
13357 * instead of cluttering the API with proxy methods we opted to
13358 * return the internal reference. Be careful using it as it may
13359 * interfere with elm_web behavior.
13361 * @param obj The web object.
13362 * @return The internal ewk_view object or NULL if it does not
13363 * exist. (Failure to create or Elementary compiled without
13366 * @see elm_web_add()
13368 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13371 * Sets the function to call when a new window is requested
13373 * This hook will be called when a request to create a new window is
13374 * issued from the web page loaded.
13375 * There is no default implementation for this feature, so leaving this
13376 * unset or passing @c NULL in @p func will prevent new windows from
13379 * @param obj The web object where to set the hook function
13380 * @param func The hook function to be called when a window is requested
13381 * @param data User data
13383 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13385 * Sets the function to call when an alert dialog
13387 * This hook will be called when a JavaScript alert dialog is requested.
13388 * If no function is set or @c NULL is passed in @p func, the default
13389 * implementation will take place.
13391 * @param obj The web object where to set the hook function
13392 * @param func The callback function to be used
13393 * @param data User data
13395 * @see elm_web_inwin_mode_set()
13397 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13399 * Sets the function to call when an confirm dialog
13401 * This hook will be called when a JavaScript confirm dialog is requested.
13402 * If no function is set or @c NULL is passed in @p func, the default
13403 * implementation will take place.
13405 * @param obj The web object where to set the hook function
13406 * @param func The callback function to be used
13407 * @param data User data
13409 * @see elm_web_inwin_mode_set()
13411 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13413 * Sets the function to call when an prompt dialog
13415 * This hook will be called when a JavaScript prompt dialog is requested.
13416 * If no function is set or @c NULL is passed in @p func, the default
13417 * implementation will take place.
13419 * @param obj The web object where to set the hook function
13420 * @param func The callback function to be used
13421 * @param data User data
13423 * @see elm_web_inwin_mode_set()
13425 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13427 * Sets the function to call when an file selector dialog
13429 * This hook will be called when a JavaScript file selector dialog is
13431 * If no function is set or @c NULL is passed in @p func, the default
13432 * implementation will take place.
13434 * @param obj The web object where to set the hook function
13435 * @param func The callback function to be used
13436 * @param data User data
13438 * @see elm_web_inwin_mode_set()
13440 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13442 * Sets the function to call when a console message is emitted from JS
13444 * This hook will be called when a console message is emitted from
13445 * JavaScript. There is no default implementation for this feature.
13447 * @param obj The web object where to set the hook function
13448 * @param func The callback function to be used
13449 * @param data User data
13451 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13453 * Gets the status of the tab propagation
13455 * @param obj The web object to query
13456 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13458 * @see elm_web_tab_propagate_set()
13460 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13462 * Sets whether to use tab propagation
13464 * If tab propagation is enabled, whenever the user presses the Tab key,
13465 * Elementary will handle it and switch focus to the next widget.
13466 * The default value is disabled, where WebKit will handle the Tab key to
13467 * cycle focus though its internal objects, jumping to the next widget
13468 * only when that cycle ends.
13470 * @param obj The web object
13471 * @param propagate Whether to propagate Tab keys to Elementary or not
13473 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13475 * Sets the URI for the web object
13477 * It must be a full URI, with resource included, in the form
13478 * http://www.enlightenment.org or file:///tmp/something.html
13480 * @param obj The web object
13481 * @param uri The URI to set
13482 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13484 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13486 * Gets the current URI for the object
13488 * The returned string must not be freed and is guaranteed to be
13491 * @param obj The web object
13492 * @return A stringshared internal string with the current URI, or NULL on
13495 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13497 * Gets the current title
13499 * The returned string must not be freed and is guaranteed to be
13502 * @param obj The web object
13503 * @return A stringshared internal string with the current title, or NULL on
13506 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13508 * Sets the background color to be used by the web object
13510 * This is the color that will be used by default when the loaded page
13511 * does not set it's own. Color values are pre-multiplied.
13513 * @param obj The web object
13514 * @param r Red component
13515 * @param g Green component
13516 * @param b Blue component
13517 * @param a Alpha component
13519 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13521 * Gets the background color to be used by the web object
13523 * This is the color that will be used by default when the loaded page
13524 * does not set it's own. Color values are pre-multiplied.
13526 * @param obj The web object
13527 * @param r Red component
13528 * @param g Green component
13529 * @param b Blue component
13530 * @param a Alpha component
13532 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13534 * Gets a copy of the currently selected text
13536 * The string returned must be freed by the user when it's done with it.
13538 * @param obj The web object
13539 * @return A newly allocated string, or NULL if nothing is selected or an
13542 EAPI char *elm_view_selection_get(const Evas_Object *obj);
13544 * Tells the web object which index in the currently open popup was selected
13546 * When the user handles the popup creation from the "popup,created" signal,
13547 * it needs to tell the web object which item was selected by calling this
13548 * function with the index corresponding to the item.
13550 * @param obj The web object
13551 * @param index The index selected
13553 * @see elm_web_popup_destroy()
13555 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
13557 * Dismisses an open dropdown popup
13559 * When the popup from a dropdown widget is to be dismissed, either after
13560 * selecting an option or to cancel it, this function must be called, which
13561 * will later emit an "popup,willdelete" signal to notify the user that
13562 * any memory and objects related to this popup can be freed.
13564 * @param obj The web object
13565 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13566 * if there was no menu to destroy
13568 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
13570 * Searches the given string in a document.
13572 * @param obj The web object where to search the text
13573 * @param string String to search
13574 * @param case_sensitive If search should be case sensitive or not
13575 * @param forward If search is from cursor and on or backwards
13576 * @param wrap If search should wrap at the end
13578 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13581 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13583 * Marks matches of the given string in a document.
13585 * @param obj The web object where to search text
13586 * @param string String to match
13587 * @param case_sensitive If match should be case sensitive or not
13588 * @param highlight If matches should be highlighted
13589 * @param limit Maximum amount of matches, or zero to unlimited
13591 * @return number of matched @a string
13593 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13595 * Clears all marked matches in the document
13597 * @param obj The web object
13599 * @return EINA_TRUE on success, EINA_FALSE otherwise
13601 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
13603 * Sets whether to highlight the matched marks
13605 * If enabled, marks set with elm_web_text_matches_mark() will be
13608 * @param obj The web object
13609 * @param highlight Whether to highlight the marks or not
13611 * @return EINA_TRUE on success, EINA_FALSE otherwise
13613 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13615 * Gets whether highlighting marks is enabled
13617 * @param The web object
13619 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13622 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
13624 * Gets the overall loading progress of the page
13626 * Returns the estimated loading progress of the page, with a value between
13627 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13628 * included in the page.
13630 * @param The web object
13632 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13635 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
13637 * Stops loading the current page
13639 * Cancels the loading of the current page in the web object. This will
13640 * cause a "load,error" signal to be emitted, with the is_cancellation
13641 * flag set to EINA_TRUE.
13643 * @param obj The web object
13645 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13647 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
13649 * Requests a reload of the current document in the object
13651 * @param obj The web object
13653 * @return EINA_TRUE on success, EINA_FALSE otherwise
13655 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
13657 * Requests a reload of the current document, avoiding any existing caches
13659 * @param obj The web object
13661 * @return EINA_TRUE on success, EINA_FALSE otherwise
13663 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
13665 * Goes back one step in the browsing history
13667 * This is equivalent to calling elm_web_object_navigate(obj, -1);
13669 * @param obj The web object
13671 * @return EINA_TRUE on success, EINA_FALSE otherwise
13673 * @see elm_web_history_enable_set()
13674 * @see elm_web_back_possible()
13675 * @see elm_web_forward()
13676 * @see elm_web_navigate()
13678 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
13680 * Goes forward one step in the browsing history
13682 * This is equivalent to calling elm_web_object_navigate(obj, 1);
13684 * @param obj The web object
13686 * @return EINA_TRUE on success, EINA_FALSE otherwise
13688 * @see elm_web_history_enable_set()
13689 * @see elm_web_forward_possible()
13690 * @see elm_web_back()
13691 * @see elm_web_navigate()
13693 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
13695 * Jumps the given number of steps in the browsing history
13697 * The @p steps value can be a negative integer to back in history, or a
13698 * positive to move forward.
13700 * @param obj The web object
13701 * @param steps The number of steps to jump
13703 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13704 * history exists to jump the given number of steps
13706 * @see elm_web_history_enable_set()
13707 * @see elm_web_navigate_possible()
13708 * @see elm_web_back()
13709 * @see elm_web_forward()
13711 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
13713 * Queries whether it's possible to go back in history
13715 * @param obj The web object
13717 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13720 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
13722 * Queries whether it's possible to go forward in history
13724 * @param obj The web object
13726 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13729 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
13731 * Queries whether it's possible to jump the given number of steps
13733 * The @p steps value can be a negative integer to back in history, or a
13734 * positive to move forward.
13736 * @param obj The web object
13737 * @param steps The number of steps to check for
13739 * @return EINA_TRUE if enough history exists to perform the given jump,
13740 * EINA_FALSE otherwise
13742 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
13744 * Gets whether browsing history is enabled for the given object
13746 * @param obj The web object
13748 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13750 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
13752 * Enables or disables the browsing history
13754 * @param obj The web object
13755 * @param enable Whether to enable or disable the browsing history
13757 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13759 * Sets the zoom level of the web object
13761 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
13762 * values meaning zoom in and lower meaning zoom out. This function will
13763 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
13764 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
13766 * @param obj The web object
13767 * @param zoom The zoom level to set
13769 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
13771 * Gets the current zoom level set on the web object
13773 * Note that this is the zoom level set on the web object and not that
13774 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
13775 * the two zoom levels should match, but for the other two modes the
13776 * Webkit zoom is calculated internally to match the chosen mode without
13777 * changing the zoom level set for the web object.
13779 * @param obj The web object
13781 * @return The zoom level set on the object
13783 EAPI double elm_web_zoom_get(const Evas_Object *obj);
13785 * Sets the zoom mode to use
13787 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
13788 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
13790 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
13791 * with the elm_web_zoom_set() function.
13792 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
13793 * make sure the entirety of the web object's contents are shown.
13794 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
13795 * fit the contents in the web object's size, without leaving any space
13798 * @param obj The web object
13799 * @param mode The mode to set
13801 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
13803 * Gets the currently set zoom mode
13805 * @param obj The web object
13807 * @return The current zoom mode set for the object, or
13808 * ::ELM_WEB_ZOOM_MODE_LAST on error
13810 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
13812 * Shows the given region in the web object
13814 * @param obj The web object
13815 * @param x The x coordinate of the region to show
13816 * @param y The y coordinate of the region to show
13817 * @param w The width of the region to show
13818 * @param h The height of the region to show
13820 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
13822 * Brings in the region to the visible area
13824 * Like elm_web_region_show(), but it animates the scrolling of the object
13827 * @param obj The web object
13828 * @param x The x coordinate of the region to show
13829 * @param y The y coordinate of the region to show
13830 * @param w The width of the region to show
13831 * @param h The height of the region to show
13833 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
13835 * Sets the default dialogs to use an Inwin instead of a normal window
13837 * If set, then the default implementation for the JavaScript dialogs and
13838 * file selector will be opened in an Inwin. Otherwise they will use a
13839 * normal separated window.
13841 * @param obj The web object
13842 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
13844 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
13846 * Gets whether Inwin mode is set for the current object
13848 * @param obj The web object
13850 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
13852 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
13854 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
13855 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
13856 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);
13857 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
13864 * @defgroup Hoversel Hoversel
13866 * @image html img/widget/hoversel/preview-00.png
13867 * @image latex img/widget/hoversel/preview-00.eps
13869 * A hoversel is a button that pops up a list of items (automatically
13870 * choosing the direction to display) that have a label and, optionally, an
13871 * icon to select from. It is a convenience widget to avoid the need to do
13872 * all the piecing together yourself. It is intended for a small number of
13873 * items in the hoversel menu (no more than 8), though is capable of many
13876 * Signals that you can add callbacks for are:
13877 * "clicked" - the user clicked the hoversel button and popped up the sel
13878 * "selected" - an item in the hoversel list is selected. event_info is the item
13879 * "dismissed" - the hover is dismissed
13881 * See @ref tutorial_hoversel for an example.
13884 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
13886 * @brief Add a new Hoversel object
13888 * @param parent The parent object
13889 * @return The new object or NULL if it cannot be created
13891 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13893 * @brief This sets the hoversel to expand horizontally.
13895 * @param obj The hoversel object
13896 * @param horizontal If true, the hover will expand horizontally to the
13899 * @note The initial button will display horizontally regardless of this
13902 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
13904 * @brief This returns whether the hoversel is set to expand horizontally.
13906 * @param obj The hoversel object
13907 * @return If true, the hover will expand horizontally to the right.
13909 * @see elm_hoversel_horizontal_set()
13911 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13913 * @brief Set the Hover parent
13915 * @param obj The hoversel object
13916 * @param parent The parent to use
13918 * Sets the hover parent object, the area that will be darkened when the
13919 * hoversel is clicked. Should probably be the window that the hoversel is
13920 * in. See @ref Hover objects for more information.
13922 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13924 * @brief Get the Hover parent
13926 * @param obj The hoversel object
13927 * @return The used parent
13929 * Gets the hover parent object.
13931 * @see elm_hoversel_hover_parent_set()
13933 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13935 * @brief Set the hoversel button label
13937 * @param obj The hoversel object
13938 * @param label The label text.
13940 * This sets the label of the button that is always visible (before it is
13941 * clicked and expanded).
13943 * @deprecated elm_object_text_set()
13945 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13947 * @brief Get the hoversel button label
13949 * @param obj The hoversel object
13950 * @return The label text.
13952 * @deprecated elm_object_text_get()
13954 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13956 * @brief Set the icon of the hoversel button
13958 * @param obj The hoversel object
13959 * @param icon The icon object
13961 * Sets the icon of the button that is always visible (before it is clicked
13962 * and expanded). Once the icon object is set, a previously set one will be
13963 * deleted, if you want to keep that old content object, use the
13964 * elm_hoversel_icon_unset() function.
13966 * @see elm_button_icon_set()
13968 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13970 * @brief Get the icon of the hoversel button
13972 * @param obj The hoversel object
13973 * @return The icon object
13975 * Get the icon of the button that is always visible (before it is clicked
13976 * and expanded). Also see elm_button_icon_get().
13978 * @see elm_hoversel_icon_set()
13980 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13982 * @brief Get and unparent the icon of the hoversel button
13984 * @param obj The hoversel object
13985 * @return The icon object that was being used
13987 * Unparent and return the icon of the button that is always visible
13988 * (before it is clicked and expanded).
13990 * @see elm_hoversel_icon_set()
13991 * @see elm_button_icon_unset()
13993 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13995 * @brief This triggers the hoversel popup from code, the same as if the user
13996 * had clicked the button.
13998 * @param obj The hoversel object
14000 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14002 * @brief This dismisses the hoversel popup as if the user had clicked
14003 * outside the hover.
14005 * @param obj The hoversel object
14007 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14009 * @brief Returns whether the hoversel is expanded.
14011 * @param obj The hoversel object
14012 * @return This will return EINA_TRUE if the hoversel is expanded or
14013 * EINA_FALSE if it is not expanded.
14015 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14017 * @brief This will remove all the children items from the hoversel.
14019 * @param obj The hoversel object
14021 * @warning Should @b not be called while the hoversel is active; use
14022 * elm_hoversel_expanded_get() to check first.
14024 * @see elm_hoversel_item_del_cb_set()
14025 * @see elm_hoversel_item_del()
14027 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14029 * @brief Get the list of items within the given hoversel.
14031 * @param obj The hoversel object
14032 * @return Returns a list of Elm_Hoversel_Item*
14034 * @see elm_hoversel_item_add()
14036 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14038 * @brief Add an item to the hoversel button
14040 * @param obj The hoversel object
14041 * @param label The text label to use for the item (NULL if not desired)
14042 * @param icon_file An image file path on disk to use for the icon or standard
14043 * icon name (NULL if not desired)
14044 * @param icon_type The icon type if relevant
14045 * @param func Convenience function to call when this item is selected
14046 * @param data Data to pass to item-related functions
14047 * @return A handle to the item added.
14049 * This adds an item to the hoversel to show when it is clicked. Note: if you
14050 * need to use an icon from an edje file then use
14051 * elm_hoversel_item_icon_set() right after the this function, and set
14052 * icon_file to NULL here.
14054 * For more information on what @p icon_file and @p icon_type are see the
14055 * @ref Icon "icon documentation".
14057 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);
14059 * @brief Delete an item from the hoversel
14061 * @param item The item to delete
14063 * This deletes the item from the hoversel (should not be called while the
14064 * hoversel is active; use elm_hoversel_expanded_get() to check first).
14066 * @see elm_hoversel_item_add()
14067 * @see elm_hoversel_item_del_cb_set()
14069 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14071 * @brief Set the function to be called when an item from the hoversel is
14074 * @param item The item to set the callback on
14075 * @param func The function called
14077 * That function will receive these parameters:
14078 * @li void *item_data
14079 * @li Evas_Object *the_item_object
14080 * @li Elm_Hoversel_Item *the_object_struct
14082 * @see elm_hoversel_item_add()
14084 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14086 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14087 * that will be passed to associated function callbacks.
14089 * @param item The item to get the data from
14090 * @return The data pointer set with elm_hoversel_item_add()
14092 * @see elm_hoversel_item_add()
14094 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14096 * @brief This returns the label text of the given hoversel item.
14098 * @param item The item to get the label
14099 * @return The label text of the hoversel item
14101 * @see elm_hoversel_item_add()
14103 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14105 * @brief This sets the icon for the given hoversel item.
14107 * @param item The item to set the icon
14108 * @param icon_file An image file path on disk to use for the icon or standard
14110 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14111 * to NULL if the icon is not an edje file
14112 * @param icon_type The icon type
14114 * The icon can be loaded from the standard set, from an image file, or from
14117 * @see elm_hoversel_item_add()
14119 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);
14121 * @brief Get the icon object of the hoversel item
14123 * @param item The item to get the icon from
14124 * @param icon_file The image file path on disk used for the icon or standard
14126 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14127 * if the icon is not an edje file
14128 * @param icon_type The icon type
14130 * @see elm_hoversel_item_icon_set()
14131 * @see elm_hoversel_item_add()
14133 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);
14139 * @defgroup Toolbar Toolbar
14140 * @ingroup Elementary
14142 * @image html img/widget/toolbar/preview-00.png
14143 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14145 * @image html img/toolbar.png
14146 * @image latex img/toolbar.eps width=\textwidth
14148 * A toolbar is a widget that displays a list of items inside
14149 * a box. It can be scrollable, show a menu with items that don't fit
14150 * to toolbar size or even crop them.
14152 * Only one item can be selected at a time.
14154 * Items can have multiple states, or show menus when selected by the user.
14156 * Smart callbacks one can listen to:
14157 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14159 * Available styles for it:
14161 * - @c "transparent" - no background or shadow, just show the content
14163 * List of examples:
14164 * @li @ref toolbar_example_01
14165 * @li @ref toolbar_example_02
14166 * @li @ref toolbar_example_03
14170 * @addtogroup Toolbar
14175 * @enum _Elm_Toolbar_Shrink_Mode
14176 * @typedef Elm_Toolbar_Shrink_Mode
14178 * Set toolbar's items display behavior, it can be scrollabel,
14179 * show a menu with exceeding items, or simply hide them.
14181 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14184 * Values <b> don't </b> work as bitmask, only one can be choosen.
14186 * @see elm_toolbar_mode_shrink_set()
14187 * @see elm_toolbar_mode_shrink_get()
14191 typedef enum _Elm_Toolbar_Shrink_Mode
14193 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14194 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14195 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14196 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
14197 } Elm_Toolbar_Shrink_Mode;
14199 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(). */
14201 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(). */
14204 * Add a new toolbar widget to the given parent Elementary
14205 * (container) object.
14207 * @param parent The parent object.
14208 * @return a new toolbar widget handle or @c NULL, on errors.
14210 * This function inserts a new toolbar widget on the canvas.
14214 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14217 * Set the icon size, in pixels, to be used by toolbar items.
14219 * @param obj The toolbar object
14220 * @param icon_size The icon size in pixels
14222 * @note Default value is @c 32. It reads value from elm config.
14224 * @see elm_toolbar_icon_size_get()
14228 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14231 * Get the icon size, in pixels, to be used by toolbar items.
14233 * @param obj The toolbar object.
14234 * @return The icon size in pixels.
14236 * @see elm_toolbar_icon_size_set() for details.
14240 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14243 * Sets icon lookup order, for toolbar items' icons.
14245 * @param obj The toolbar object.
14246 * @param order The icon lookup order.
14248 * Icons added before calling this function will not be affected.
14249 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14251 * @see elm_toolbar_icon_order_lookup_get()
14255 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14258 * Gets the icon lookup order.
14260 * @param obj The toolbar object.
14261 * @return The icon lookup order.
14263 * @see elm_toolbar_icon_order_lookup_set() for details.
14267 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14270 * Set whether the toolbar should always have an item selected.
14272 * @param obj The toolbar object.
14273 * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14276 * This will cause the toolbar to always have an item selected, and clicking
14277 * the selected item will not cause a selected event to be emitted. Enabling this mode
14278 * will immediately select the first toolbar item.
14280 * Always-selected is disabled by default.
14282 * @see elm_toolbar_always_select_mode_get().
14286 EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14289 * Get whether the toolbar should always have an item selected.
14291 * @param obj The toolbar object.
14292 * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14293 * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14295 * @see elm_toolbar_always_select_mode_set() for details.
14299 EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14302 * Set whether the toolbar items' should be selected by the user or not.
14304 * @param obj The toolbar object.
14305 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14308 * This will turn off the ability to select items entirely and they will
14309 * neither appear selected nor emit selected signals. The clicked
14310 * callback function will still be called.
14312 * Selection is enabled by default.
14314 * @see elm_toolbar_no_select_mode_get().
14318 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14321 * Set whether the toolbar items' should be selected by the user or not.
14323 * @param obj The toolbar object.
14324 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14325 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14327 * @see elm_toolbar_no_select_mode_set() for details.
14331 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14334 * Append item to the toolbar.
14336 * @param obj The toolbar object.
14337 * @param icon A string with icon name or the absolute path of an image file.
14338 * @param label The label of the item.
14339 * @param func The function to call when the item is clicked.
14340 * @param data The data to associate with the item for related callbacks.
14341 * @return The created item or @c NULL upon failure.
14343 * A new item will be created and appended to the toolbar, i.e., will
14344 * be set as @b last item.
14346 * Items created with this method can be deleted with
14347 * elm_toolbar_item_del().
14349 * Associated @p data can be properly freed when item is deleted if a
14350 * callback function is set with elm_toolbar_item_del_cb_set().
14352 * If a function is passed as argument, it will be called everytime this item
14353 * is selected, i.e., the user clicks over an unselected item.
14354 * If such function isn't needed, just passing
14355 * @c NULL as @p func is enough. The same should be done for @p data.
14357 * Toolbar will load icon image from fdo or current theme.
14358 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14359 * If an absolute path is provided it will load it direct from a file.
14361 * @see elm_toolbar_item_icon_set()
14362 * @see elm_toolbar_item_del()
14363 * @see elm_toolbar_item_del_cb_set()
14367 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);
14370 * Prepend item to the toolbar.
14372 * @param obj The toolbar object.
14373 * @param icon A string with icon name or the absolute path of an image file.
14374 * @param label The label of the item.
14375 * @param func The function to call when the item is clicked.
14376 * @param data The data to associate with the item for related callbacks.
14377 * @return The created item or @c NULL upon failure.
14379 * A new item will be created and prepended to the toolbar, i.e., will
14380 * be set as @b first item.
14382 * Items created with this method can be deleted with
14383 * elm_toolbar_item_del().
14385 * Associated @p data can be properly freed when item is deleted if a
14386 * callback function is set with elm_toolbar_item_del_cb_set().
14388 * If a function is passed as argument, it will be called everytime this item
14389 * is selected, i.e., the user clicks over an unselected item.
14390 * If such function isn't needed, just passing
14391 * @c NULL as @p func is enough. The same should be done for @p data.
14393 * Toolbar will load icon image from fdo or current theme.
14394 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14395 * If an absolute path is provided it will load it direct from a file.
14397 * @see elm_toolbar_item_icon_set()
14398 * @see elm_toolbar_item_del()
14399 * @see elm_toolbar_item_del_cb_set()
14403 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);
14406 * Insert a new item into the toolbar object before item @p before.
14408 * @param obj The toolbar object.
14409 * @param before The toolbar item to insert before.
14410 * @param icon A string with icon name or the absolute path of an image file.
14411 * @param label The label of the item.
14412 * @param func The function to call when the item is clicked.
14413 * @param data The data to associate with the item for related callbacks.
14414 * @return The created item or @c NULL upon failure.
14416 * A new item will be created and added to the toolbar. Its position in
14417 * this toolbar will be just before item @p before.
14419 * Items created with this method can be deleted with
14420 * elm_toolbar_item_del().
14422 * Associated @p data can be properly freed when item is deleted if a
14423 * callback function is set with elm_toolbar_item_del_cb_set().
14425 * If a function is passed as argument, it will be called everytime this item
14426 * is selected, i.e., the user clicks over an unselected item.
14427 * If such function isn't needed, just passing
14428 * @c NULL as @p func is enough. The same should be done for @p data.
14430 * Toolbar will load icon image from fdo or current theme.
14431 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14432 * If an absolute path is provided it will load it direct from a file.
14434 * @see elm_toolbar_item_icon_set()
14435 * @see elm_toolbar_item_del()
14436 * @see elm_toolbar_item_del_cb_set()
14440 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);
14443 * Insert a new item into the toolbar object after item @p after.
14445 * @param obj The toolbar object.
14446 * @param before The toolbar item to insert before.
14447 * @param icon A string with icon name or the absolute path of an image file.
14448 * @param label The label of the item.
14449 * @param func The function to call when the item is clicked.
14450 * @param data The data to associate with the item for related callbacks.
14451 * @return The created item or @c NULL upon failure.
14453 * A new item will be created and added to the toolbar. Its position in
14454 * this toolbar will be just after item @p after.
14456 * Items created with this method can be deleted with
14457 * elm_toolbar_item_del().
14459 * Associated @p data can be properly freed when item is deleted if a
14460 * callback function is set with elm_toolbar_item_del_cb_set().
14462 * If a function is passed as argument, it will be called everytime this item
14463 * is selected, i.e., the user clicks over an unselected item.
14464 * If such function isn't needed, just passing
14465 * @c NULL as @p func is enough. The same should be done for @p data.
14467 * Toolbar will load icon image from fdo or current theme.
14468 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14469 * If an absolute path is provided it will load it direct from a file.
14471 * @see elm_toolbar_item_icon_set()
14472 * @see elm_toolbar_item_del()
14473 * @see elm_toolbar_item_del_cb_set()
14477 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);
14480 * Get the first item in the given toolbar widget's list of
14483 * @param obj The toolbar object
14484 * @return The first item or @c NULL, if it has no items (and on
14487 * @see elm_toolbar_item_append()
14488 * @see elm_toolbar_last_item_get()
14492 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14495 * Get the last item in the given toolbar widget's list of
14498 * @param obj The toolbar object
14499 * @return The last item or @c NULL, if it has no items (and on
14502 * @see elm_toolbar_item_prepend()
14503 * @see elm_toolbar_first_item_get()
14507 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14510 * Get the item after @p item in toolbar.
14512 * @param item The toolbar item.
14513 * @return The item after @p item, or @c NULL if none or on failure.
14515 * @note If it is the last item, @c NULL will be returned.
14517 * @see elm_toolbar_item_append()
14521 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14524 * Get the item before @p item in toolbar.
14526 * @param item The toolbar item.
14527 * @return The item before @p item, or @c NULL if none or on failure.
14529 * @note If it is the first item, @c NULL will be returned.
14531 * @see elm_toolbar_item_prepend()
14535 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14538 * Get the toolbar object from an item.
14540 * @param item The item.
14541 * @return The toolbar object.
14543 * This returns the toolbar object itself that an item belongs to.
14547 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14550 * Set the priority of a toolbar item.
14552 * @param item The toolbar item.
14553 * @param priority The item priority. The default is zero.
14555 * This is used only when the toolbar shrink mode is set to
14556 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14557 * When space is less than required, items with low priority
14558 * will be removed from the toolbar and added to a dynamically-created menu,
14559 * while items with higher priority will remain on the toolbar,
14560 * with the same order they were added.
14562 * @see elm_toolbar_item_priority_get()
14566 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14569 * Get the priority of a toolbar item.
14571 * @param item The toolbar item.
14572 * @return The @p item priority, or @c 0 on failure.
14574 * @see elm_toolbar_item_priority_set() for details.
14578 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14581 * Get the label of item.
14583 * @param item The item of toolbar.
14584 * @return The label of item.
14586 * The return value is a pointer to the label associated to @p item when
14587 * it was created, with function elm_toolbar_item_append() or similar,
14589 * with function elm_toolbar_item_label_set. If no label
14590 * was passed as argument, it will return @c NULL.
14592 * @see elm_toolbar_item_label_set() for more details.
14593 * @see elm_toolbar_item_append()
14597 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14600 * Set the label of item.
14602 * @param item The item of toolbar.
14603 * @param text The label of item.
14605 * The label to be displayed by the item.
14606 * Label will be placed at icons bottom (if set).
14608 * If a label was passed as argument on item creation, with function
14609 * elm_toolbar_item_append() or similar, it will be already
14610 * displayed by the item.
14612 * @see elm_toolbar_item_label_get()
14613 * @see elm_toolbar_item_append()
14617 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14620 * Return the data associated with a given toolbar widget item.
14622 * @param item The toolbar widget item handle.
14623 * @return The data associated with @p item.
14625 * @see elm_toolbar_item_data_set()
14629 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14632 * Set the data associated with a given toolbar widget item.
14634 * @param item The toolbar widget item handle.
14635 * @param data The new data pointer to set to @p item.
14637 * This sets new item data on @p item.
14639 * @warning The old data pointer won't be touched by this function, so
14640 * the user had better to free that old data himself/herself.
14644 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14647 * Returns a pointer to a toolbar item by its label.
14649 * @param obj The toolbar object.
14650 * @param label The label of the item to find.
14652 * @return The pointer to the toolbar item matching @p label or @c NULL
14657 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14660 * Get whether the @p item is selected or not.
14662 * @param item The toolbar item.
14663 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14664 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14666 * @see elm_toolbar_selected_item_set() for details.
14667 * @see elm_toolbar_item_selected_get()
14671 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14674 * Set the selected state of an item.
14676 * @param item The toolbar item
14677 * @param selected The selected state
14679 * This sets the selected state of the given item @p it.
14680 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14682 * If a new item is selected the previosly selected will be unselected.
14683 * Previoulsy selected item can be get with function
14684 * elm_toolbar_selected_item_get().
14686 * Selected items will be highlighted.
14688 * @see elm_toolbar_item_selected_get()
14689 * @see elm_toolbar_selected_item_get()
14693 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14696 * Get the selected item.
14698 * @param obj The toolbar object.
14699 * @return The selected toolbar item.
14701 * The selected item can be unselected with function
14702 * elm_toolbar_item_selected_set().
14704 * The selected item always will be highlighted on toolbar.
14706 * @see elm_toolbar_selected_items_get()
14710 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14713 * Set the icon associated with @p item.
14715 * @param obj The parent of this item.
14716 * @param item The toolbar item.
14717 * @param icon A string with icon name or the absolute path of an image file.
14719 * Toolbar will load icon image from fdo or current theme.
14720 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14721 * If an absolute path is provided it will load it direct from a file.
14723 * @see elm_toolbar_icon_order_lookup_set()
14724 * @see elm_toolbar_icon_order_lookup_get()
14728 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14731 * Get the string used to set the icon of @p item.
14733 * @param item The toolbar item.
14734 * @return The string associated with the icon object.
14736 * @see elm_toolbar_item_icon_set() for details.
14740 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14743 * Get the object of @p item.
14745 * @param item The toolbar item.
14746 * @return The object
14750 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14753 * Get the icon object of @p item.
14755 * @param item The toolbar item.
14756 * @return The icon object
14758 * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14762 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14765 * Set the icon associated with @p item to an image in a binary buffer.
14767 * @param item The toolbar item.
14768 * @param img The binary data that will be used as an image
14769 * @param size The size of binary data @p img
14770 * @param format Optional format of @p img to pass to the image loader
14771 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
14773 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
14775 * @note The icon image set by this function can be changed by
14776 * elm_toolbar_item_icon_set().
14780 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);
14783 * Delete them item from the toolbar.
14785 * @param item The item of toolbar to be deleted.
14787 * @see elm_toolbar_item_append()
14788 * @see elm_toolbar_item_del_cb_set()
14792 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14795 * Set the function called when a toolbar item is freed.
14797 * @param item The item to set the callback on.
14798 * @param func The function called.
14800 * If there is a @p func, then it will be called prior item's memory release.
14801 * That will be called with the following arguments:
14803 * @li item's Evas object;
14806 * This way, a data associated to a toolbar item could be properly freed.
14810 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14813 * Get a value whether toolbar item is disabled or not.
14815 * @param item The item.
14816 * @return The disabled state.
14818 * @see elm_toolbar_item_disabled_set() for more details.
14822 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14825 * Sets the disabled/enabled state of a toolbar item.
14827 * @param item The item.
14828 * @param disabled The disabled state.
14830 * A disabled item cannot be selected or unselected. It will also
14831 * change its appearance (generally greyed out). This sets the
14832 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
14837 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14840 * Set or unset item as a separator.
14842 * @param item The toolbar item.
14843 * @param setting @c EINA_TRUE to set item @p item as separator or
14844 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
14846 * Items aren't set as separator by default.
14848 * If set as separator it will display separator theme, so won't display
14851 * @see elm_toolbar_item_separator_get()
14855 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
14858 * Get a value whether item is a separator or not.
14860 * @param item The toolbar item.
14861 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
14862 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
14864 * @see elm_toolbar_item_separator_set() for details.
14868 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14871 * Set the shrink state of toolbar @p obj.
14873 * @param obj The toolbar object.
14874 * @param shrink_mode Toolbar's items display behavior.
14876 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
14877 * but will enforce a minimun size so all the items will fit, won't scroll
14878 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
14879 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
14880 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
14884 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
14887 * Get the shrink mode of toolbar @p obj.
14889 * @param obj The toolbar object.
14890 * @return Toolbar's items display behavior.
14892 * @see elm_toolbar_mode_shrink_set() for details.
14896 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14899 * Enable/disable homogenous mode.
14901 * @param obj The toolbar object
14902 * @param homogeneous Assume the items within the toolbar are of the
14903 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14905 * This will enable the homogeneous mode where items are of the same size.
14906 * @see elm_toolbar_homogeneous_get()
14910 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
14913 * Get whether the homogenous mode is enabled.
14915 * @param obj The toolbar object.
14916 * @return Assume the items within the toolbar are of the same height
14917 * and width (EINA_TRUE = on, EINA_FALSE = off).
14919 * @see elm_toolbar_homogeneous_set()
14923 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14926 * Enable/disable homogenous mode.
14928 * @param obj The toolbar object
14929 * @param homogeneous Assume the items within the toolbar are of the
14930 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14932 * This will enable the homogeneous mode where items are of the same size.
14933 * @see elm_toolbar_homogeneous_get()
14935 * @deprecated use elm_toolbar_homogeneous_set() instead.
14939 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
14942 * Get whether the homogenous mode is enabled.
14944 * @param obj The toolbar object.
14945 * @return Assume the items within the toolbar are of the same height
14946 * and width (EINA_TRUE = on, EINA_FALSE = off).
14948 * @see elm_toolbar_homogeneous_set()
14949 * @deprecated use elm_toolbar_homogeneous_get() instead.
14953 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14956 * Set the parent object of the toolbar items' menus.
14958 * @param obj The toolbar object.
14959 * @param parent The parent of the menu objects.
14961 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
14963 * For more details about setting the parent for toolbar menus, see
14964 * elm_menu_parent_set().
14966 * @see elm_menu_parent_set() for details.
14967 * @see elm_toolbar_item_menu_set() for details.
14971 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14974 * Get the parent object of the toolbar items' menus.
14976 * @param obj The toolbar object.
14977 * @return The parent of the menu objects.
14979 * @see elm_toolbar_menu_parent_set() for details.
14983 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14986 * Set the alignment of the items.
14988 * @param obj The toolbar object.
14989 * @param align The new alignment, a float between <tt> 0.0 </tt>
14990 * and <tt> 1.0 </tt>.
14992 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
14993 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
14996 * Centered items by default.
14998 * @see elm_toolbar_align_get()
15002 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15005 * Get the alignment of the items.
15007 * @param obj The toolbar object.
15008 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15011 * @see elm_toolbar_align_set() for details.
15015 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15018 * Set whether the toolbar item opens a menu.
15020 * @param item The toolbar item.
15021 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15023 * A toolbar item can be set to be a menu, using this function.
15025 * Once it is set to be a menu, it can be manipulated through the
15026 * menu-like function elm_toolbar_menu_parent_set() and the other
15027 * elm_menu functions, using the Evas_Object @c menu returned by
15028 * elm_toolbar_item_menu_get().
15030 * So, items to be displayed in this item's menu should be added with
15031 * elm_menu_item_add().
15033 * The following code exemplifies the most basic usage:
15035 * tb = elm_toolbar_add(win)
15036 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15037 * elm_toolbar_item_menu_set(item, EINA_TRUE);
15038 * elm_toolbar_menu_parent_set(tb, win);
15039 * menu = elm_toolbar_item_menu_get(item);
15040 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15041 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15045 * @see elm_toolbar_item_menu_get()
15049 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15052 * Get toolbar item's menu.
15054 * @param item The toolbar item.
15055 * @return Item's menu object or @c NULL on failure.
15057 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15058 * this function will set it.
15060 * @see elm_toolbar_item_menu_set() for details.
15064 EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15067 * Add a new state to @p item.
15069 * @param item The item.
15070 * @param icon A string with icon name or the absolute path of an image file.
15071 * @param label The label of the new state.
15072 * @param func The function to call when the item is clicked when this
15073 * state is selected.
15074 * @param data The data to associate with the state.
15075 * @return The toolbar item state, or @c NULL upon failure.
15077 * Toolbar will load icon image from fdo or current theme.
15078 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15079 * If an absolute path is provided it will load it direct from a file.
15081 * States created with this function can be removed with
15082 * elm_toolbar_item_state_del().
15084 * @see elm_toolbar_item_state_del()
15085 * @see elm_toolbar_item_state_sel()
15086 * @see elm_toolbar_item_state_get()
15090 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);
15093 * Delete a previoulsy added state to @p item.
15095 * @param item The toolbar item.
15096 * @param state The state to be deleted.
15097 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15099 * @see elm_toolbar_item_state_add()
15101 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15104 * Set @p state as the current state of @p it.
15106 * @param it The item.
15107 * @param state The state to use.
15108 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15110 * If @p state is @c NULL, it won't select any state and the default item's
15111 * icon and label will be used. It's the same behaviour than
15112 * elm_toolbar_item_state_unser().
15114 * @see elm_toolbar_item_state_unset()
15118 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15121 * Unset the state of @p it.
15123 * @param it The item.
15125 * The default icon and label from this item will be displayed.
15127 * @see elm_toolbar_item_state_set() for more details.
15131 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15134 * Get the current state of @p it.
15136 * @param item The item.
15137 * @return The selected state or @c NULL if none is selected or on failure.
15139 * @see elm_toolbar_item_state_set() for details.
15140 * @see elm_toolbar_item_state_unset()
15141 * @see elm_toolbar_item_state_add()
15145 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15148 * Get the state after selected state in toolbar's @p item.
15150 * @param it The toolbar item to change state.
15151 * @return The state after current state, or @c NULL on failure.
15153 * If last state is selected, this function will return first state.
15155 * @see elm_toolbar_item_state_set()
15156 * @see elm_toolbar_item_state_add()
15160 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15163 * Get the state before selected state in toolbar's @p item.
15165 * @param it The toolbar item to change state.
15166 * @return The state before current state, or @c NULL on failure.
15168 * If first state is selected, this function will return last state.
15170 * @see elm_toolbar_item_state_set()
15171 * @see elm_toolbar_item_state_add()
15175 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15178 * Set the text to be shown in a given toolbar item's tooltips.
15180 * @param item Target item.
15181 * @param text The text to set in the content.
15183 * Setup the text as tooltip to object. The item can have only one tooltip,
15184 * so any previous tooltip data - set with this function or
15185 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15187 * @see elm_object_tooltip_text_set() for more details.
15191 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15194 * Set the content to be shown in the tooltip item.
15196 * Setup the tooltip to item. The item can have only one tooltip,
15197 * so any previous tooltip data is removed. @p func(with @p data) will
15198 * be called every time that need show the tooltip and it should
15199 * return a valid Evas_Object. This object is then managed fully by
15200 * tooltip system and is deleted when the tooltip is gone.
15202 * @param item the toolbar item being attached a tooltip.
15203 * @param func the function used to create the tooltip contents.
15204 * @param data what to provide to @a func as callback data/context.
15205 * @param del_cb called when data is not needed anymore, either when
15206 * another callback replaces @a func, the tooltip is unset with
15207 * elm_toolbar_item_tooltip_unset() or the owner @a item
15208 * dies. This callback receives as the first parameter the
15209 * given @a data, and @c event_info is the item.
15211 * @see elm_object_tooltip_content_cb_set() for more details.
15215 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);
15218 * Unset tooltip from item.
15220 * @param item toolbar item to remove previously set tooltip.
15222 * Remove tooltip from item. The callback provided as del_cb to
15223 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15224 * it is not used anymore.
15226 * @see elm_object_tooltip_unset() for more details.
15227 * @see elm_toolbar_item_tooltip_content_cb_set()
15231 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15234 * Sets a different style for this item tooltip.
15236 * @note before you set a style you should define a tooltip with
15237 * elm_toolbar_item_tooltip_content_cb_set() or
15238 * elm_toolbar_item_tooltip_text_set()
15240 * @param item toolbar item with tooltip already set.
15241 * @param style the theme style to use (default, transparent, ...)
15243 * @see elm_object_tooltip_style_set() for more details.
15247 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15250 * Get the style for this item tooltip.
15252 * @param item toolbar item with tooltip already set.
15253 * @return style the theme style in use, defaults to "default". If the
15254 * object does not have a tooltip set, then NULL is returned.
15256 * @see elm_object_tooltip_style_get() for more details.
15257 * @see elm_toolbar_item_tooltip_style_set()
15261 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15264 * Set the type of mouse pointer/cursor decoration to be shown,
15265 * when the mouse pointer is over the given toolbar widget item
15267 * @param item toolbar item to customize cursor on
15268 * @param cursor the cursor type's name
15270 * This function works analogously as elm_object_cursor_set(), but
15271 * here the cursor's changing area is restricted to the item's
15272 * area, and not the whole widget's. Note that that item cursors
15273 * have precedence over widget cursors, so that a mouse over an
15274 * item with custom cursor set will always show @b that cursor.
15276 * If this function is called twice for an object, a previously set
15277 * cursor will be unset on the second call.
15279 * @see elm_object_cursor_set()
15280 * @see elm_toolbar_item_cursor_get()
15281 * @see elm_toolbar_item_cursor_unset()
15285 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15288 * Get the type of mouse pointer/cursor decoration set to be shown,
15289 * when the mouse pointer is over the given toolbar widget item
15291 * @param item toolbar item with custom cursor set
15292 * @return the cursor type's name or @c NULL, if no custom cursors
15293 * were set to @p item (and on errors)
15295 * @see elm_object_cursor_get()
15296 * @see elm_toolbar_item_cursor_set()
15297 * @see elm_toolbar_item_cursor_unset()
15301 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15304 * Unset any custom mouse pointer/cursor decoration set to be
15305 * shown, when the mouse pointer is over the given toolbar widget
15306 * item, thus making it show the @b default cursor again.
15308 * @param item a toolbar item
15310 * Use this call to undo any custom settings on this item's cursor
15311 * decoration, bringing it back to defaults (no custom style set).
15313 * @see elm_object_cursor_unset()
15314 * @see elm_toolbar_item_cursor_set()
15318 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15321 * Set a different @b style for a given custom cursor set for a
15324 * @param item toolbar item with custom cursor set
15325 * @param style the <b>theme style</b> to use (e.g. @c "default",
15326 * @c "transparent", etc)
15328 * This function only makes sense when one is using custom mouse
15329 * cursor decorations <b>defined in a theme file</b>, which can have,
15330 * given a cursor name/type, <b>alternate styles</b> on it. It
15331 * works analogously as elm_object_cursor_style_set(), but here
15332 * applyed only to toolbar item objects.
15334 * @warning Before you set a cursor style you should have definen a
15335 * custom cursor previously on the item, with
15336 * elm_toolbar_item_cursor_set()
15338 * @see elm_toolbar_item_cursor_engine_only_set()
15339 * @see elm_toolbar_item_cursor_style_get()
15343 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15346 * Get the current @b style set for a given toolbar item's custom
15349 * @param item toolbar item with custom cursor set.
15350 * @return style the cursor style in use. If the object does not
15351 * have a cursor set, then @c NULL is returned.
15353 * @see elm_toolbar_item_cursor_style_set() for more details
15357 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15360 * Set if the (custom)cursor for a given toolbar item should be
15361 * searched in its theme, also, or should only rely on the
15362 * rendering engine.
15364 * @param item item with custom (custom) cursor already set on
15365 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15366 * only on those provided by the rendering engine, @c EINA_FALSE to
15367 * have them searched on the widget's theme, as well.
15369 * @note This call is of use only if you've set a custom cursor
15370 * for toolbar items, with elm_toolbar_item_cursor_set().
15372 * @note By default, cursors will only be looked for between those
15373 * provided by the rendering engine.
15377 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15380 * Get if the (custom) cursor for a given toolbar item is being
15381 * searched in its theme, also, or is only relying on the rendering
15384 * @param item a toolbar item
15385 * @return @c EINA_TRUE, if cursors are being looked for only on
15386 * those provided by the rendering engine, @c EINA_FALSE if they
15387 * are being searched on the widget's theme, as well.
15389 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15393 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15396 * Change a toolbar's orientation
15397 * @param obj The toolbar object
15398 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15399 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15402 EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15405 * Get a toolbar's orientation
15406 * @param obj The toolbar object
15407 * @return If @c EINA_TRUE, the toolbar is vertical
15408 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15411 EAPI Eina_Bool elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
15418 * @defgroup Tooltips Tooltips
15420 * The Tooltip is an (internal, for now) smart object used to show a
15421 * content in a frame on mouse hover of objects(or widgets), with
15422 * tips/information about them.
15427 EAPI double elm_tooltip_delay_get(void);
15428 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15429 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15430 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15431 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15432 EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15433 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15434 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);
15435 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15436 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15437 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15438 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
15439 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
15446 * @defgroup Cursors Cursors
15448 * The Elementary cursor is an internal smart object used to
15449 * customize the mouse cursor displayed over objects (or
15450 * widgets). In the most common scenario, the cursor decoration
15451 * comes from the graphical @b engine Elementary is running
15452 * on. Those engines may provide different decorations for cursors,
15453 * and Elementary provides functions to choose them (think of X11
15454 * cursors, as an example).
15456 * There's also the possibility of, besides using engine provided
15457 * cursors, also use ones coming from Edje theming files. Both
15458 * globally and per widget, Elementary makes it possible for one to
15459 * make the cursors lookup to be held on engines only or on
15460 * Elementary's theme file, too.
15466 * Set the cursor to be shown when mouse is over the object
15468 * Set the cursor that will be displayed when mouse is over the
15469 * object. The object can have only one cursor set to it, so if
15470 * this function is called twice for an object, the previous set
15472 * If using X cursors, a definition of all the valid cursor names
15473 * is listed on Elementary_Cursors.h. If an invalid name is set
15474 * the default cursor will be used.
15476 * @param obj the object being set a cursor.
15477 * @param cursor the cursor name to be used.
15481 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15484 * Get the cursor to be shown when mouse is over the object
15486 * @param obj an object with cursor already set.
15487 * @return the cursor name.
15491 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15494 * Unset cursor for object
15496 * Unset cursor for object, and set the cursor to default if the mouse
15497 * was over this object.
15499 * @param obj Target object
15500 * @see elm_object_cursor_set()
15504 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15507 * Sets a different style for this object cursor.
15509 * @note before you set a style you should define a cursor with
15510 * elm_object_cursor_set()
15512 * @param obj an object with cursor already set.
15513 * @param style the theme style to use (default, transparent, ...)
15517 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15520 * Get the style for this object cursor.
15522 * @param obj an object with cursor already set.
15523 * @return style the theme style in use, defaults to "default". If the
15524 * object does not have a cursor set, then NULL is returned.
15528 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15531 * Set if the cursor set should be searched on the theme or should use
15532 * the provided by the engine, only.
15534 * @note before you set if should look on theme you should define a cursor
15535 * with elm_object_cursor_set(). By default it will only look for cursors
15536 * provided by the engine.
15538 * @param obj an object with cursor already set.
15539 * @param engine_only boolean to define it cursors should be looked only
15540 * between the provided by the engine or searched on widget's theme as well.
15544 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15547 * Get the cursor engine only usage for this object cursor.
15549 * @param obj an object with cursor already set.
15550 * @return engine_only boolean to define it cursors should be
15551 * looked only between the provided by the engine or searched on
15552 * widget's theme as well. If the object does not have a cursor
15553 * set, then EINA_FALSE is returned.
15557 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15560 * Get the configured cursor engine only usage
15562 * This gets the globally configured exclusive usage of engine cursors.
15564 * @return 1 if only engine cursors should be used
15567 EAPI int elm_cursor_engine_only_get(void);
15570 * Set the configured cursor engine only usage
15572 * This sets the globally configured exclusive usage of engine cursors.
15573 * It won't affect cursors set before changing this value.
15575 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15576 * look for them on theme before.
15577 * @return EINA_TRUE if value is valid and setted (0 or 1)
15580 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
15587 * @defgroup Menu Menu
15589 * @image html img/widget/menu/preview-00.png
15590 * @image latex img/widget/menu/preview-00.eps
15592 * A menu is a list of items displayed above its parent. When the menu is
15593 * showing its parent is darkened. Each item can have a sub-menu. The menu
15594 * object can be used to display a menu on a right click event, in a toolbar,
15597 * Signals that you can add callbacks for are:
15598 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15599 * event_info is NULL.
15601 * @see @ref tutorial_menu
15604 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15606 * @brief Add a new menu to the parent
15608 * @param parent The parent object.
15609 * @return The new object or NULL if it cannot be created.
15611 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15613 * @brief Set the parent for the given menu widget
15615 * @param obj The menu object.
15616 * @param parent The new parent.
15618 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15620 * @brief Get the parent for the given menu widget
15622 * @param obj The menu object.
15623 * @return The parent.
15625 * @see elm_menu_parent_set()
15627 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15629 * @brief Move the menu to a new position
15631 * @param obj The menu object.
15632 * @param x The new position.
15633 * @param y The new position.
15635 * Sets the top-left position of the menu to (@p x,@p y).
15637 * @note @p x and @p y coordinates are relative to parent.
15639 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15641 * @brief Close a opened menu
15643 * @param obj the menu object
15646 * Hides the menu and all it's sub-menus.
15648 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15650 * @brief Returns a list of @p item's items.
15652 * @param obj The menu object
15653 * @return An Eina_List* of @p item's items
15655 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15657 * @brief Get the Evas_Object of an Elm_Menu_Item
15659 * @param item The menu item object.
15660 * @return The edje object containing the swallowed content
15662 * @warning Don't manipulate this object!
15664 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15666 * @brief Add an item at the end of the given menu widget
15668 * @param obj The menu object.
15669 * @param parent The parent menu item (optional)
15670 * @param icon A icon display on the item. The icon will be destryed by the menu.
15671 * @param label The label of the item.
15672 * @param func Function called when the user select the item.
15673 * @param data Data sent by the callback.
15674 * @return Returns the new item.
15676 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);
15678 * @brief Add an object swallowed in an item at the end of the given menu
15681 * @param obj The menu object.
15682 * @param parent The parent menu item (optional)
15683 * @param subobj The object to swallow
15684 * @param func Function called when the user select the item.
15685 * @param data Data sent by the callback.
15686 * @return Returns the new item.
15688 * Add an evas object as an item to the menu.
15690 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);
15692 * @brief Set the label of a menu item
15694 * @param item The menu item object.
15695 * @param label The label to set for @p item
15697 * @warning Don't use this funcion on items created with
15698 * elm_menu_item_add_object() or elm_menu_item_separator_add().
15700 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15702 * @brief Get the label of a menu item
15704 * @param item The menu item object.
15705 * @return The label of @p item
15707 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15709 * @brief Set the icon of a menu item to the standard icon with name @p icon
15711 * @param item The menu item object.
15712 * @param icon The icon object to set for the content of @p item
15714 * Once this icon is set, any previously set icon will be deleted.
15716 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15718 * @brief Get the string representation from the icon of a menu item
15720 * @param item The menu item object.
15721 * @return The string representation of @p item's icon or NULL
15723 * @see elm_menu_item_object_icon_name_set()
15725 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15727 * @brief Set the content object of a menu item
15729 * @param item The menu item object
15730 * @param The content object or NULL
15731 * @return EINA_TRUE on success, else EINA_FALSE
15733 * Use this function to change the object swallowed by a menu item, deleting
15734 * any previously swallowed object.
15736 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
15738 * @brief Get the content object of a menu item
15740 * @param item The menu item object
15741 * @return The content object or NULL
15742 * @note If @p item was added with elm_menu_item_add_object, this
15743 * function will return the object passed, else it will return the
15746 * @see elm_menu_item_object_content_set()
15748 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15750 * @brief Set the selected state of @p item.
15752 * @param item The menu item object.
15753 * @param selected The selected/unselected state of the item
15755 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15757 * @brief Get the selected state of @p item.
15759 * @param item The menu item object.
15760 * @return The selected/unselected state of the item
15762 * @see elm_menu_item_selected_set()
15764 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15766 * @brief Set the disabled state of @p item.
15768 * @param item The menu item object.
15769 * @param disabled The enabled/disabled state of the item
15771 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15773 * @brief Get the disabled state of @p item.
15775 * @param item The menu item object.
15776 * @return The enabled/disabled state of the item
15778 * @see elm_menu_item_disabled_set()
15780 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15782 * @brief Add a separator item to menu @p obj under @p parent.
15784 * @param obj The menu object
15785 * @param parent The item to add the separator under
15786 * @return The created item or NULL on failure
15788 * This is item is a @ref Separator.
15790 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
15792 * @brief Returns whether @p item is a separator.
15794 * @param item The item to check
15795 * @return If true, @p item is a separator
15797 * @see elm_menu_item_separator_add()
15799 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15801 * @brief Deletes an item from the menu.
15803 * @param item The item to delete.
15805 * @see elm_menu_item_add()
15807 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15809 * @brief Set the function called when a menu item is deleted.
15811 * @param item The item to set the callback on
15812 * @param func The function called
15814 * @see elm_menu_item_add()
15815 * @see elm_menu_item_del()
15817 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15819 * @brief Returns the data associated with menu item @p item.
15821 * @param item The item
15822 * @return The data associated with @p item or NULL if none was set.
15824 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
15826 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15828 * @brief Sets the data to be associated with menu item @p item.
15830 * @param item The item
15831 * @param data The data to be associated with @p item
15833 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
15835 * @brief Returns a list of @p item's subitems.
15837 * @param item The item
15838 * @return An Eina_List* of @p item's subitems
15840 * @see elm_menu_add()
15842 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15844 * @brief Get the position of a menu item
15846 * @param item The menu item
15847 * @return The item's index
15849 * This function returns the index position of a menu item in a menu.
15850 * For a sub-menu, this number is relative to the first item in the sub-menu.
15852 * @note Index values begin with 0
15854 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
15856 * @brief @brief Return a menu item's owner menu
15858 * @param item The menu item
15859 * @return The menu object owning @p item, or NULL on failure
15861 * Use this function to get the menu object owning an item.
15863 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
15865 * @brief Get the selected item in the menu
15867 * @param obj The menu object
15868 * @return The selected item, or NULL if none
15870 * @see elm_menu_item_selected_get()
15871 * @see elm_menu_item_selected_set()
15873 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15875 * @brief Get the last item in the menu
15877 * @param obj The menu object
15878 * @return The last item, or NULL if none
15880 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15882 * @brief Get the first item in the menu
15884 * @param obj The menu object
15885 * @return The first item, or NULL if none
15887 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15889 * @brief Get the next item in the menu.
15891 * @param item The menu item object.
15892 * @return The item after it, or NULL if none
15894 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15896 * @brief Get the previous item in the menu.
15898 * @param item The menu item object.
15899 * @return The item before it, or NULL if none
15901 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15907 * @defgroup List List
15908 * @ingroup Elementary
15910 * @image html img/widget/list/preview-00.png
15911 * @image latex img/widget/list/preview-00.eps width=\textwidth
15913 * @image html img/list.png
15914 * @image latex img/list.eps width=\textwidth
15916 * A list widget is a container whose children are displayed vertically or
15917 * horizontally, in order, and can be selected.
15918 * The list can accept only one or multiple items selection. Also has many
15919 * modes of items displaying.
15921 * A list is a very simple type of list widget. For more robust
15922 * lists, @ref Genlist should probably be used.
15924 * Smart callbacks one can listen to:
15925 * - @c "activated" - The user has double-clicked or pressed
15926 * (enter|return|spacebar) on an item. The @c event_info parameter
15927 * is the item that was activated.
15928 * - @c "clicked,double" - The user has double-clicked an item.
15929 * The @c event_info parameter is the item that was double-clicked.
15930 * - "selected" - when the user selected an item
15931 * - "unselected" - when the user unselected an item
15932 * - "longpressed" - an item in the list is long-pressed
15933 * - "scroll,edge,top" - the list is scrolled until the top edge
15934 * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
15935 * - "scroll,edge,left" - the list is scrolled until the left edge
15936 * - "scroll,edge,right" - the list is scrolled until the right edge
15938 * Available styles for it:
15941 * List of examples:
15942 * @li @ref list_example_01
15943 * @li @ref list_example_02
15944 * @li @ref list_example_03
15953 * @enum _Elm_List_Mode
15954 * @typedef Elm_List_Mode
15956 * Set list's resize behavior, transverse axis scroll and
15957 * items cropping. See each mode's description for more details.
15959 * @note Default value is #ELM_LIST_SCROLL.
15961 * Values <b> don't </b> work as bitmask, only one can be choosen.
15963 * @see elm_list_mode_set()
15964 * @see elm_list_mode_get()
15968 typedef enum _Elm_List_Mode
15970 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. */
15971 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). */
15972 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. */
15973 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. */
15974 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
15977 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(). */
15980 * Add a new list widget to the given parent Elementary
15981 * (container) object.
15983 * @param parent The parent object.
15984 * @return a new list widget handle or @c NULL, on errors.
15986 * This function inserts a new list widget on the canvas.
15990 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15995 * @param obj The list object
15997 * @note Call before running show() on the list object.
15998 * @warning If not called, it won't display the list properly.
16001 * li = elm_list_add(win);
16002 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16003 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16005 * evas_object_show(li);
16010 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16013 * Enable or disable multiple items selection on the list object.
16015 * @param obj The list object
16016 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16019 * Disabled by default. If disabled, the user can select a single item of
16020 * the list each time. Selected items are highlighted on list.
16021 * If enabled, many items can be selected.
16023 * If a selected item is selected again, it will be unselected.
16025 * @see elm_list_multi_select_get()
16029 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16032 * Get a value whether multiple items selection is enabled or not.
16034 * @see elm_list_multi_select_set() for details.
16036 * @param obj The list object.
16037 * @return @c EINA_TRUE means multiple items selection is enabled.
16038 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16039 * @c EINA_FALSE is returned.
16043 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16046 * Set which mode to use for the list object.
16048 * @param obj The list object
16049 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16050 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16052 * Set list's resize behavior, transverse axis scroll and
16053 * items cropping. See each mode's description for more details.
16055 * @note Default value is #ELM_LIST_SCROLL.
16057 * Only one can be set, if a previous one was set, it will be changed
16058 * by the new mode set. Bitmask won't work as well.
16060 * @see elm_list_mode_get()
16064 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16067 * Get the mode the list is at.
16069 * @param obj The list object
16070 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16071 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16073 * @note see elm_list_mode_set() for more information.
16077 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16080 * Enable or disable horizontal mode on the list object.
16082 * @param obj The list object.
16083 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16084 * disable it, i.e., to enable vertical mode.
16086 * @note Vertical mode is set by default.
16088 * On horizontal mode items are displayed on list from left to right,
16089 * instead of from top to bottom. Also, the list will scroll horizontally.
16090 * Each item will presents left icon on top and right icon, or end, at
16093 * @see elm_list_horizontal_get()
16097 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16100 * Get a value whether horizontal mode is enabled or not.
16102 * @param obj The list object.
16103 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16104 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16105 * @c EINA_FALSE is returned.
16107 * @see elm_list_horizontal_set() for details.
16111 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16114 * Enable or disable always select mode on the list object.
16116 * @param obj The list object
16117 * @param always_select @c EINA_TRUE to enable always select mode or
16118 * @c EINA_FALSE to disable it.
16120 * @note Always select mode is disabled by default.
16122 * Default behavior of list items is to only call its callback function
16123 * the first time it's pressed, i.e., when it is selected. If a selected
16124 * item is pressed again, and multi-select is disabled, it won't call
16125 * this function (if multi-select is enabled it will unselect the item).
16127 * If always select is enabled, it will call the callback function
16128 * everytime a item is pressed, so it will call when the item is selected,
16129 * and again when a selected item is pressed.
16131 * @see elm_list_always_select_mode_get()
16132 * @see elm_list_multi_select_set()
16136 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16139 * Get a value whether always select mode is enabled or not, meaning that
16140 * an item will always call its callback function, even if already selected.
16142 * @param obj The list object
16143 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16144 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16145 * @c EINA_FALSE is returned.
16147 * @see elm_list_always_select_mode_set() for details.
16151 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16154 * Set bouncing behaviour when the scrolled content reaches an edge.
16156 * Tell the internal scroller object whether it should bounce or not
16157 * when it reaches the respective edges for each axis.
16159 * @param obj The list object
16160 * @param h_bounce Whether to bounce or not in the horizontal axis.
16161 * @param v_bounce Whether to bounce or not in the vertical axis.
16163 * @see elm_scroller_bounce_set()
16167 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16170 * Get the bouncing behaviour of the internal scroller.
16172 * Get whether the internal scroller should bounce when the edge of each
16173 * axis is reached scrolling.
16175 * @param obj The list object.
16176 * @param h_bounce Pointer where to store the bounce state of the horizontal
16178 * @param v_bounce Pointer where to store the bounce state of the vertical
16181 * @see elm_scroller_bounce_get()
16182 * @see elm_list_bounce_set()
16186 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16189 * Set the scrollbar policy.
16191 * @param obj The list object
16192 * @param policy_h Horizontal scrollbar policy.
16193 * @param policy_v Vertical scrollbar policy.
16195 * This sets the scrollbar visibility policy for the given scroller.
16196 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16197 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16198 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16199 * This applies respectively for the horizontal and vertical scrollbars.
16201 * The both are disabled by default, i.e., are set to
16202 * #ELM_SCROLLER_POLICY_OFF.
16206 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16209 * Get the scrollbar policy.
16211 * @see elm_list_scroller_policy_get() for details.
16213 * @param obj The list object.
16214 * @param policy_h Pointer where to store horizontal scrollbar policy.
16215 * @param policy_v Pointer where to store vertical scrollbar policy.
16219 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);
16222 * Append a new item to the list object.
16224 * @param obj The list object.
16225 * @param label The label of the list item.
16226 * @param icon The icon object to use for the left side of the item. An
16227 * icon can be any Evas object, but usually it is an icon created
16228 * with elm_icon_add().
16229 * @param end The icon object to use for the right side of the item. An
16230 * icon can be any Evas object.
16231 * @param func The function to call when the item is clicked.
16232 * @param data The data to associate with the item for related callbacks.
16234 * @return The created item or @c NULL upon failure.
16236 * A new item will be created and appended to the list, i.e., will
16237 * be set as @b last item.
16239 * Items created with this method can be deleted with
16240 * elm_list_item_del().
16242 * Associated @p data can be properly freed when item is deleted if a
16243 * callback function is set with elm_list_item_del_cb_set().
16245 * If a function is passed as argument, it will be called everytime this item
16246 * is selected, i.e., the user clicks over an unselected item.
16247 * If always select is enabled it will call this function every time
16248 * user clicks over an item (already selected or not).
16249 * If such function isn't needed, just passing
16250 * @c NULL as @p func is enough. The same should be done for @p data.
16252 * Simple example (with no function callback or data associated):
16254 * li = elm_list_add(win);
16255 * ic = elm_icon_add(win);
16256 * elm_icon_file_set(ic, "path/to/image", NULL);
16257 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16258 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16260 * evas_object_show(li);
16263 * @see elm_list_always_select_mode_set()
16264 * @see elm_list_item_del()
16265 * @see elm_list_item_del_cb_set()
16266 * @see elm_list_clear()
16267 * @see elm_icon_add()
16271 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);
16274 * Prepend a new item to the list object.
16276 * @param obj The list object.
16277 * @param label The label of the list item.
16278 * @param icon The icon object to use for the left side of the item. An
16279 * icon can be any Evas object, but usually it is an icon created
16280 * with elm_icon_add().
16281 * @param end The icon object to use for the right side of the item. An
16282 * icon can be any Evas object.
16283 * @param func The function to call when the item is clicked.
16284 * @param data The data to associate with the item for related callbacks.
16286 * @return The created item or @c NULL upon failure.
16288 * A new item will be created and prepended to the list, i.e., will
16289 * be set as @b first item.
16291 * Items created with this method can be deleted with
16292 * elm_list_item_del().
16294 * Associated @p data can be properly freed when item is deleted if a
16295 * callback function is set with elm_list_item_del_cb_set().
16297 * If a function is passed as argument, it will be called everytime this item
16298 * is selected, i.e., the user clicks over an unselected item.
16299 * If always select is enabled it will call this function every time
16300 * user clicks over an item (already selected or not).
16301 * If such function isn't needed, just passing
16302 * @c NULL as @p func is enough. The same should be done for @p data.
16304 * @see elm_list_item_append() for a simple code example.
16305 * @see elm_list_always_select_mode_set()
16306 * @see elm_list_item_del()
16307 * @see elm_list_item_del_cb_set()
16308 * @see elm_list_clear()
16309 * @see elm_icon_add()
16313 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);
16316 * Insert a new item into the list object before item @p before.
16318 * @param obj The list object.
16319 * @param before The list item to insert before.
16320 * @param label The label of the list item.
16321 * @param icon The icon object to use for the left side of the item. An
16322 * icon can be any Evas object, but usually it is an icon created
16323 * with elm_icon_add().
16324 * @param end The icon object to use for the right side of the item. An
16325 * icon can be any Evas object.
16326 * @param func The function to call when the item is clicked.
16327 * @param data The data to associate with the item for related callbacks.
16329 * @return The created item or @c NULL upon failure.
16331 * A new item will be created and added to the list. Its position in
16332 * this list will be just before item @p before.
16334 * Items created with this method can be deleted with
16335 * elm_list_item_del().
16337 * Associated @p data can be properly freed when item is deleted if a
16338 * callback function is set with elm_list_item_del_cb_set().
16340 * If a function is passed as argument, it will be called everytime this item
16341 * is selected, i.e., the user clicks over an unselected item.
16342 * If always select is enabled it will call this function every time
16343 * user clicks over an item (already selected or not).
16344 * If such function isn't needed, just passing
16345 * @c NULL as @p func is enough. The same should be done for @p data.
16347 * @see elm_list_item_append() for a simple code example.
16348 * @see elm_list_always_select_mode_set()
16349 * @see elm_list_item_del()
16350 * @see elm_list_item_del_cb_set()
16351 * @see elm_list_clear()
16352 * @see elm_icon_add()
16356 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);
16359 * Insert a new item into the list object after item @p after.
16361 * @param obj The list object.
16362 * @param after The list item to insert after.
16363 * @param label The label of the list item.
16364 * @param icon The icon object to use for the left side of the item. An
16365 * icon can be any Evas object, but usually it is an icon created
16366 * with elm_icon_add().
16367 * @param end The icon object to use for the right side of the item. An
16368 * icon can be any Evas object.
16369 * @param func The function to call when the item is clicked.
16370 * @param data The data to associate with the item for related callbacks.
16372 * @return The created item or @c NULL upon failure.
16374 * A new item will be created and added to the list. Its position in
16375 * this list will be just after item @p after.
16377 * Items created with this method can be deleted with
16378 * elm_list_item_del().
16380 * Associated @p data can be properly freed when item is deleted if a
16381 * callback function is set with elm_list_item_del_cb_set().
16383 * If a function is passed as argument, it will be called everytime this item
16384 * is selected, i.e., the user clicks over an unselected item.
16385 * If always select is enabled it will call this function every time
16386 * user clicks over an item (already selected or not).
16387 * If such function isn't needed, just passing
16388 * @c NULL as @p func is enough. The same should be done for @p data.
16390 * @see elm_list_item_append() for a simple code example.
16391 * @see elm_list_always_select_mode_set()
16392 * @see elm_list_item_del()
16393 * @see elm_list_item_del_cb_set()
16394 * @see elm_list_clear()
16395 * @see elm_icon_add()
16399 EAPI Elm_List_Item *elm_list_item_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);
16402 * Insert a new item into the sorted list object.
16404 * @param obj The list object.
16405 * @param label The label of the list item.
16406 * @param icon The icon object to use for the left side of the item. An
16407 * icon can be any Evas object, but usually it is an icon created
16408 * with elm_icon_add().
16409 * @param end The icon object to use for the right side of the item. An
16410 * icon can be any Evas object.
16411 * @param func The function to call when the item is clicked.
16412 * @param data The data to associate with the item for related callbacks.
16413 * @param cmp_func The comparing function to be used to sort list
16414 * items <b>by #Elm_List_Item item handles</b>. This function will
16415 * receive two items and compare them, returning a non-negative integer
16416 * if the second item should be place after the first, or negative value
16417 * if should be placed before.
16419 * @return The created item or @c NULL upon failure.
16421 * @note This function inserts values into a list object assuming it was
16422 * sorted and the result will be sorted.
16424 * A new item will be created and added to the list. Its position in
16425 * this list will be found comparing the new item with previously inserted
16426 * items using function @p cmp_func.
16428 * Items created with this method can be deleted with
16429 * elm_list_item_del().
16431 * Associated @p data can be properly freed when item is deleted if a
16432 * callback function is set with elm_list_item_del_cb_set().
16434 * If a function is passed as argument, it will be called everytime this item
16435 * is selected, i.e., the user clicks over an unselected item.
16436 * If always select is enabled it will call this function every time
16437 * user clicks over an item (already selected or not).
16438 * If such function isn't needed, just passing
16439 * @c NULL as @p func is enough. The same should be done for @p data.
16441 * @see elm_list_item_append() for a simple code example.
16442 * @see elm_list_always_select_mode_set()
16443 * @see elm_list_item_del()
16444 * @see elm_list_item_del_cb_set()
16445 * @see elm_list_clear()
16446 * @see elm_icon_add()
16450 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);
16453 * Remove all list's items.
16455 * @param obj The list object
16457 * @see elm_list_item_del()
16458 * @see elm_list_item_append()
16462 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16465 * Get a list of all the list items.
16467 * @param obj The list object
16468 * @return An @c Eina_List of list items, #Elm_List_Item,
16469 * or @c NULL on failure.
16471 * @see elm_list_item_append()
16472 * @see elm_list_item_del()
16473 * @see elm_list_clear()
16477 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16480 * Get the selected item.
16482 * @param obj The list object.
16483 * @return The selected list item.
16485 * The selected item can be unselected with function
16486 * elm_list_item_selected_set().
16488 * The selected item always will be highlighted on list.
16490 * @see elm_list_selected_items_get()
16494 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16497 * Return a list of the currently selected list items.
16499 * @param obj The list object.
16500 * @return An @c Eina_List of list items, #Elm_List_Item,
16501 * or @c NULL on failure.
16503 * Multiple items can be selected if multi select is enabled. It can be
16504 * done with elm_list_multi_select_set().
16506 * @see elm_list_selected_item_get()
16507 * @see elm_list_multi_select_set()
16511 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16514 * Set the selected state of an item.
16516 * @param item The list item
16517 * @param selected The selected state
16519 * This sets the selected state of the given item @p it.
16520 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16522 * If a new item is selected the previosly selected will be unselected,
16523 * unless multiple selection is enabled with elm_list_multi_select_set().
16524 * Previoulsy selected item can be get with function
16525 * elm_list_selected_item_get().
16527 * Selected items will be highlighted.
16529 * @see elm_list_item_selected_get()
16530 * @see elm_list_selected_item_get()
16531 * @see elm_list_multi_select_set()
16535 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16538 * Get whether the @p item is selected or not.
16540 * @param item The list item.
16541 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16542 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16544 * @see elm_list_selected_item_set() for details.
16545 * @see elm_list_item_selected_get()
16549 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16552 * Set or unset item as a separator.
16554 * @param it The list item.
16555 * @param setting @c EINA_TRUE to set item @p it as separator or
16556 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16558 * Items aren't set as separator by default.
16560 * If set as separator it will display separator theme, so won't display
16563 * @see elm_list_item_separator_get()
16567 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16570 * Get a value whether item is a separator or not.
16572 * @see elm_list_item_separator_set() for details.
16574 * @param it The list item.
16575 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16576 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16580 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16583 * Show @p item in the list view.
16585 * @param item The list item to be shown.
16587 * It won't animate list until item is visible. If such behavior is wanted,
16588 * use elm_list_bring_in() intead.
16592 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16595 * Bring in the given item to list view.
16597 * @param item The item.
16599 * This causes list to jump to the given item @p item and show it
16600 * (by scrolling), if it is not fully visible.
16602 * This may use animation to do so and take a period of time.
16604 * If animation isn't wanted, elm_list_item_show() can be used.
16608 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16611 * Delete them item from the list.
16613 * @param item The item of list to be deleted.
16615 * If deleting all list items is required, elm_list_clear()
16616 * should be used instead of getting items list and deleting each one.
16618 * @see elm_list_clear()
16619 * @see elm_list_item_append()
16620 * @see elm_list_item_del_cb_set()
16624 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16627 * Set the function called when a list item is freed.
16629 * @param item The item to set the callback on
16630 * @param func The function called
16632 * If there is a @p func, then it will be called prior item's memory release.
16633 * That will be called with the following arguments:
16635 * @li item's Evas object;
16638 * This way, a data associated to a list item could be properly freed.
16642 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16645 * Get the data associated to the item.
16647 * @param item The list item
16648 * @return The data associated to @p item
16650 * The return value is a pointer to data associated to @p item when it was
16651 * created, with function elm_list_item_append() or similar. If no data
16652 * was passed as argument, it will return @c NULL.
16654 * @see elm_list_item_append()
16658 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16661 * Get the left side icon associated to the item.
16663 * @param item The list item
16664 * @return The left side icon associated to @p item
16666 * The return value is a pointer to the icon associated to @p item when
16668 * created, with function elm_list_item_append() or similar, or later
16669 * with function elm_list_item_icon_set(). If no icon
16670 * was passed as argument, it will return @c NULL.
16672 * @see elm_list_item_append()
16673 * @see elm_list_item_icon_set()
16677 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16680 * Set the left side icon associated to the item.
16682 * @param item The list item
16683 * @param icon The left side icon object to associate with @p item
16685 * The icon object to use at left side of the item. An
16686 * icon can be any Evas object, but usually it is an icon created
16687 * with elm_icon_add().
16689 * Once the icon object is set, a previously set one will be deleted.
16690 * @warning Setting the same icon for two items will cause the icon to
16691 * dissapear from the first item.
16693 * If an icon was passed as argument on item creation, with function
16694 * elm_list_item_append() or similar, it will be already
16695 * associated to the item.
16697 * @see elm_list_item_append()
16698 * @see elm_list_item_icon_get()
16702 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16705 * Get the right side icon associated to the item.
16707 * @param item The list item
16708 * @return The right side icon associated to @p item
16710 * The return value is a pointer to the icon associated to @p item when
16712 * created, with function elm_list_item_append() or similar, or later
16713 * with function elm_list_item_icon_set(). If no icon
16714 * was passed as argument, it will return @c NULL.
16716 * @see elm_list_item_append()
16717 * @see elm_list_item_icon_set()
16721 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16724 * Set the right side icon associated to the item.
16726 * @param item The list item
16727 * @param end The right side icon object to associate with @p item
16729 * The icon object to use at right side of the item. An
16730 * icon can be any Evas object, but usually it is an icon created
16731 * with elm_icon_add().
16733 * Once the icon object is set, a previously set one will be deleted.
16734 * @warning Setting the same icon for two items will cause the icon to
16735 * dissapear from the first item.
16737 * If an icon was passed as argument on item creation, with function
16738 * elm_list_item_append() or similar, it will be already
16739 * associated to the item.
16741 * @see elm_list_item_append()
16742 * @see elm_list_item_end_get()
16746 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
16749 * Gets the base object of the item.
16751 * @param item The list item
16752 * @return The base object associated with @p item
16754 * Base object is the @c Evas_Object that represents that item.
16758 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16759 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16762 * Get the label of item.
16764 * @param item The item of list.
16765 * @return The label of item.
16767 * The return value is a pointer to the label associated to @p item when
16768 * it was created, with function elm_list_item_append(), or later
16769 * with function elm_list_item_label_set. If no label
16770 * was passed as argument, it will return @c NULL.
16772 * @see elm_list_item_label_set() for more details.
16773 * @see elm_list_item_append()
16777 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16780 * Set the label of item.
16782 * @param item The item of list.
16783 * @param text The label of item.
16785 * The label to be displayed by the item.
16786 * Label will be placed between left and right side icons (if set).
16788 * If a label was passed as argument on item creation, with function
16789 * elm_list_item_append() or similar, it will be already
16790 * displayed by the item.
16792 * @see elm_list_item_label_get()
16793 * @see elm_list_item_append()
16797 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16801 * Get the item before @p it in list.
16803 * @param it The list item.
16804 * @return The item before @p it, or @c NULL if none or on failure.
16806 * @note If it is the first item, @c NULL will be returned.
16808 * @see elm_list_item_append()
16809 * @see elm_list_items_get()
16813 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16816 * Get the item after @p it in list.
16818 * @param it The list item.
16819 * @return The item after @p it, or @c NULL if none or on failure.
16821 * @note If it is the last item, @c NULL will be returned.
16823 * @see elm_list_item_append()
16824 * @see elm_list_items_get()
16828 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16831 * Sets the disabled/enabled state of a list item.
16833 * @param it The item.
16834 * @param disabled The disabled state.
16836 * A disabled item cannot be selected or unselected. It will also
16837 * change its appearance (generally greyed out). This sets the
16838 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
16843 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16846 * Get a value whether list item is disabled or not.
16848 * @param it The item.
16849 * @return The disabled state.
16851 * @see elm_list_item_disabled_set() for more details.
16855 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16858 * Set the text to be shown in a given list item's tooltips.
16860 * @param item Target item.
16861 * @param text The text to set in the content.
16863 * Setup the text as tooltip to object. The item can have only one tooltip,
16864 * so any previous tooltip data - set with this function or
16865 * elm_list_item_tooltip_content_cb_set() - is removed.
16867 * @see elm_object_tooltip_text_set() for more details.
16871 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16875 * @brief Disable size restrictions on an object's tooltip
16876 * @param item The tooltip's anchor object
16877 * @param disable If EINA_TRUE, size restrictions are disabled
16878 * @return EINA_FALSE on failure, EINA_TRUE on success
16880 * This function allows a tooltip to expand beyond its parant window's canvas.
16881 * It will instead be limited only by the size of the display.
16883 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
16885 * @brief Retrieve size restriction state of an object's tooltip
16886 * @param obj The tooltip's anchor object
16887 * @return If EINA_TRUE, size restrictions are disabled
16889 * This function returns whether a tooltip is allowed to expand beyond
16890 * its parant window's canvas.
16891 * It will instead be limited only by the size of the display.
16893 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16896 * Set the content to be shown in the tooltip item.
16898 * Setup the tooltip to item. The item can have only one tooltip,
16899 * so any previous tooltip data is removed. @p func(with @p data) will
16900 * be called every time that need show the tooltip and it should
16901 * return a valid Evas_Object. This object is then managed fully by
16902 * tooltip system and is deleted when the tooltip is gone.
16904 * @param item the list item being attached a tooltip.
16905 * @param func the function used to create the tooltip contents.
16906 * @param data what to provide to @a func as callback data/context.
16907 * @param del_cb called when data is not needed anymore, either when
16908 * another callback replaces @a func, the tooltip is unset with
16909 * elm_list_item_tooltip_unset() or the owner @a item
16910 * dies. This callback receives as the first parameter the
16911 * given @a data, and @c event_info is the item.
16913 * @see elm_object_tooltip_content_cb_set() for more details.
16917 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);
16920 * Unset tooltip from item.
16922 * @param item list item to remove previously set tooltip.
16924 * Remove tooltip from item. The callback provided as del_cb to
16925 * elm_list_item_tooltip_content_cb_set() will be called to notify
16926 * it is not used anymore.
16928 * @see elm_object_tooltip_unset() for more details.
16929 * @see elm_list_item_tooltip_content_cb_set()
16933 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16936 * Sets a different style for this item tooltip.
16938 * @note before you set a style you should define a tooltip with
16939 * elm_list_item_tooltip_content_cb_set() or
16940 * elm_list_item_tooltip_text_set()
16942 * @param item list item with tooltip already set.
16943 * @param style the theme style to use (default, transparent, ...)
16945 * @see elm_object_tooltip_style_set() for more details.
16949 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
16952 * Get the style for this item tooltip.
16954 * @param item list item with tooltip already set.
16955 * @return style the theme style in use, defaults to "default". If the
16956 * object does not have a tooltip set, then NULL is returned.
16958 * @see elm_object_tooltip_style_get() for more details.
16959 * @see elm_list_item_tooltip_style_set()
16963 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16966 * Set the type of mouse pointer/cursor decoration to be shown,
16967 * when the mouse pointer is over the given list widget item
16969 * @param item list item to customize cursor on
16970 * @param cursor the cursor type's name
16972 * This function works analogously as elm_object_cursor_set(), but
16973 * here the cursor's changing area is restricted to the item's
16974 * area, and not the whole widget's. Note that that item cursors
16975 * have precedence over widget cursors, so that a mouse over an
16976 * item with custom cursor set will always show @b that cursor.
16978 * If this function is called twice for an object, a previously set
16979 * cursor will be unset on the second call.
16981 * @see elm_object_cursor_set()
16982 * @see elm_list_item_cursor_get()
16983 * @see elm_list_item_cursor_unset()
16987 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
16990 * Get the type of mouse pointer/cursor decoration set to be shown,
16991 * when the mouse pointer is over the given list widget item
16993 * @param item list item with custom cursor set
16994 * @return the cursor type's name or @c NULL, if no custom cursors
16995 * were set to @p item (and on errors)
16997 * @see elm_object_cursor_get()
16998 * @see elm_list_item_cursor_set()
16999 * @see elm_list_item_cursor_unset()
17003 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17006 * Unset any custom mouse pointer/cursor decoration set to be
17007 * shown, when the mouse pointer is over the given list widget
17008 * item, thus making it show the @b default cursor again.
17010 * @param item a list item
17012 * Use this call to undo any custom settings on this item's cursor
17013 * decoration, bringing it back to defaults (no custom style set).
17015 * @see elm_object_cursor_unset()
17016 * @see elm_list_item_cursor_set()
17020 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17023 * Set a different @b style for a given custom cursor set for a
17026 * @param item list item with custom cursor set
17027 * @param style the <b>theme style</b> to use (e.g. @c "default",
17028 * @c "transparent", etc)
17030 * This function only makes sense when one is using custom mouse
17031 * cursor decorations <b>defined in a theme file</b>, which can have,
17032 * given a cursor name/type, <b>alternate styles</b> on it. It
17033 * works analogously as elm_object_cursor_style_set(), but here
17034 * applyed only to list item objects.
17036 * @warning Before you set a cursor style you should have definen a
17037 * custom cursor previously on the item, with
17038 * elm_list_item_cursor_set()
17040 * @see elm_list_item_cursor_engine_only_set()
17041 * @see elm_list_item_cursor_style_get()
17045 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17048 * Get the current @b style set for a given list item's custom
17051 * @param item list item with custom cursor set.
17052 * @return style the cursor style in use. If the object does not
17053 * have a cursor set, then @c NULL is returned.
17055 * @see elm_list_item_cursor_style_set() for more details
17059 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17062 * Set if the (custom)cursor for a given list item should be
17063 * searched in its theme, also, or should only rely on the
17064 * rendering engine.
17066 * @param item item with custom (custom) cursor already set on
17067 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17068 * only on those provided by the rendering engine, @c EINA_FALSE to
17069 * have them searched on the widget's theme, as well.
17071 * @note This call is of use only if you've set a custom cursor
17072 * for list items, with elm_list_item_cursor_set().
17074 * @note By default, cursors will only be looked for between those
17075 * provided by the rendering engine.
17079 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17082 * Get if the (custom) cursor for a given list item is being
17083 * searched in its theme, also, or is only relying on the rendering
17086 * @param item a list item
17087 * @return @c EINA_TRUE, if cursors are being looked for only on
17088 * those provided by the rendering engine, @c EINA_FALSE if they
17089 * are being searched on the widget's theme, as well.
17091 * @see elm_list_item_cursor_engine_only_set(), for more details
17095 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17102 * @defgroup Slider Slider
17103 * @ingroup Elementary
17105 * @image html img/widget/slider/preview-00.png
17106 * @image latex img/widget/slider/preview-00.eps width=\textwidth
17108 * The slider adds a dragable “slider” widget for selecting the value of
17109 * something within a range.
17111 * A slider can be horizontal or vertical. It can contain an Icon and has a
17112 * primary label as well as a units label (that is formatted with floating
17113 * point values and thus accepts a printf-style format string, like
17114 * “%1.2f units”. There is also an indicator string that may be somewhere
17115 * else (like on the slider itself) that also accepts a format string like
17116 * units. Label, Icon Unit and Indicator strings/objects are optional.
17118 * A slider may be inverted which means values invert, with high vales being
17119 * on the left or top and low values on the right or bottom (as opposed to
17120 * normally being low on the left or top and high on the bottom and right).
17122 * The slider should have its minimum and maximum values set by the
17123 * application with elm_slider_min_max_set() and value should also be set by
17124 * the application before use with elm_slider_value_set(). The span of the
17125 * slider is its length (horizontally or vertically). This will be scaled by
17126 * the object or applications scaling factor. At any point code can query the
17127 * slider for its value with elm_slider_value_get().
17129 * Smart callbacks one can listen to:
17130 * - "changed" - Whenever the slider value is changed by the user.
17131 * - "slider,drag,start" - dragging the slider indicator around has started.
17132 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17133 * - "delay,changed" - A short time after the value is changed by the user.
17134 * This will be called only when the user stops dragging for
17135 * a very short period or when they release their
17136 * finger/mouse, so it avoids possibly expensive reactions to
17137 * the value change.
17139 * Available styles for it:
17142 * Here is an example on its usage:
17143 * @li @ref slider_example
17147 * @addtogroup Slider
17152 * Add a new slider widget to the given parent Elementary
17153 * (container) object.
17155 * @param parent The parent object.
17156 * @return a new slider widget handle or @c NULL, on errors.
17158 * This function inserts a new slider widget on the canvas.
17162 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17165 * Set the label of a given slider widget
17167 * @param obj The progress bar object
17168 * @param label The text label string, in UTF-8
17171 * @deprecated use elm_object_text_set() instead.
17173 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17176 * Get the label of a given slider widget
17178 * @param obj The progressbar object
17179 * @return The text label string, in UTF-8
17182 * @deprecated use elm_object_text_get() instead.
17184 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17187 * Set the icon object of the slider object.
17189 * @param obj The slider object.
17190 * @param icon The icon object.
17192 * On horizontal mode, icon is placed at left, and on vertical mode,
17195 * @note Once the icon object is set, a previously set one will be deleted.
17196 * If you want to keep that old content object, use the
17197 * elm_slider_icon_unset() function.
17199 * @warning If the object being set does not have minimum size hints set,
17200 * it won't get properly displayed.
17204 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17207 * Unset an icon set on a given slider widget.
17209 * @param obj The slider object.
17210 * @return The icon object that was being used, if any was set, or
17211 * @c NULL, otherwise (and on errors).
17213 * On horizontal mode, icon is placed at left, and on vertical mode,
17216 * This call will unparent and return the icon object which was set
17217 * for this widget, previously, on success.
17219 * @see elm_slider_icon_set() for more details
17220 * @see elm_slider_icon_get()
17224 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17227 * Retrieve the icon object set for a given slider widget.
17229 * @param obj The slider object.
17230 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17231 * otherwise (and on errors).
17233 * On horizontal mode, icon is placed at left, and on vertical mode,
17236 * @see elm_slider_icon_set() for more details
17237 * @see elm_slider_icon_unset()
17241 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17244 * Set the end object of the slider object.
17246 * @param obj The slider object.
17247 * @param end The end object.
17249 * On horizontal mode, end is placed at left, and on vertical mode,
17250 * placed at bottom.
17252 * @note Once the icon object is set, a previously set one will be deleted.
17253 * If you want to keep that old content object, use the
17254 * elm_slider_end_unset() function.
17256 * @warning If the object being set does not have minimum size hints set,
17257 * it won't get properly displayed.
17261 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17264 * Unset an end object set on a given slider widget.
17266 * @param obj The slider object.
17267 * @return The end object that was being used, if any was set, or
17268 * @c NULL, otherwise (and on errors).
17270 * On horizontal mode, end is placed at left, and on vertical mode,
17271 * placed at bottom.
17273 * This call will unparent and return the icon object which was set
17274 * for this widget, previously, on success.
17276 * @see elm_slider_end_set() for more details.
17277 * @see elm_slider_end_get()
17281 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17284 * Retrieve the end object set for a given slider widget.
17286 * @param obj The slider object.
17287 * @return The end object's handle, if @p obj had one set, or @c NULL,
17288 * otherwise (and on errors).
17290 * On horizontal mode, icon is placed at right, and on vertical mode,
17291 * placed at bottom.
17293 * @see elm_slider_end_set() for more details.
17294 * @see elm_slider_end_unset()
17298 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17301 * Set the (exact) length of the bar region of a given slider widget.
17303 * @param obj The slider object.
17304 * @param size The length of the slider's bar region.
17306 * This sets the minimum width (when in horizontal mode) or height
17307 * (when in vertical mode) of the actual bar area of the slider
17308 * @p obj. This in turn affects the object's minimum size. Use
17309 * this when you're not setting other size hints expanding on the
17310 * given direction (like weight and alignment hints) and you would
17311 * like it to have a specific size.
17313 * @note Icon, end, label, indicator and unit text around @p obj
17314 * will require their
17315 * own space, which will make @p obj to require more the @p size,
17318 * @see elm_slider_span_size_get()
17322 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17325 * Get the length set for the bar region of a given slider widget
17327 * @param obj The slider object.
17328 * @return The length of the slider's bar region.
17330 * If that size was not set previously, with
17331 * elm_slider_span_size_set(), this call will return @c 0.
17335 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17338 * Set the format string for the unit label.
17340 * @param obj The slider object.
17341 * @param format The format string for the unit display.
17343 * Unit label is displayed all the time, if set, after slider's bar.
17344 * In horizontal mode, at right and in vertical mode, at bottom.
17346 * If @c NULL, unit label won't be visible. If not it sets the format
17347 * string for the label text. To the label text is provided a floating point
17348 * value, so the label text can display up to 1 floating point value.
17349 * Note that this is optional.
17351 * Use a format string such as "%1.2f meters" for example, and it will
17352 * display values like: "3.14 meters" for a value equal to 3.14159.
17354 * Default is unit label disabled.
17356 * @see elm_slider_indicator_format_get()
17360 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17363 * Get the unit label format of the slider.
17365 * @param obj The slider object.
17366 * @return The unit label format string in UTF-8.
17368 * Unit label is displayed all the time, if set, after slider's bar.
17369 * In horizontal mode, at right and in vertical mode, at bottom.
17371 * @see elm_slider_unit_format_set() for more
17372 * information on how this works.
17376 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17379 * Set the format string for the indicator label.
17381 * @param obj The slider object.
17382 * @param indicator The format string for the indicator display.
17384 * The slider may display its value somewhere else then unit label,
17385 * for example, above the slider knob that is dragged around. This function
17386 * sets the format string used for this.
17388 * If @c NULL, indicator label won't be visible. If not it sets the format
17389 * string for the label text. To the label text is provided a floating point
17390 * value, so the label text can display up to 1 floating point value.
17391 * Note that this is optional.
17393 * Use a format string such as "%1.2f meters" for example, and it will
17394 * display values like: "3.14 meters" for a value equal to 3.14159.
17396 * Default is indicator label disabled.
17398 * @see elm_slider_indicator_format_get()
17402 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17405 * Get the indicator label format of the slider.
17407 * @param obj The slider object.
17408 * @return The indicator label format string in UTF-8.
17410 * The slider may display its value somewhere else then unit label,
17411 * for example, above the slider knob that is dragged around. This function
17412 * gets the format string used for this.
17414 * @see elm_slider_indicator_format_set() for more
17415 * information on how this works.
17419 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17422 * Set the format function pointer for the indicator label
17424 * @param obj The slider object.
17425 * @param func The indicator format function.
17426 * @param free_func The freeing function for the format string.
17428 * Set the callback function to format the indicator string.
17430 * @see elm_slider_indicator_format_set() for more info on how this works.
17434 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);
17437 * Set the format function pointer for the units label
17439 * @param obj The slider object.
17440 * @param func The units format function.
17441 * @param free_func The freeing function for the format string.
17443 * Set the callback function to format the indicator string.
17445 * @see elm_slider_units_format_set() for more info on how this works.
17449 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);
17452 * Set the orientation of a given slider widget.
17454 * @param obj The slider object.
17455 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17456 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17458 * Use this function to change how your slider is to be
17459 * disposed: vertically or horizontally.
17461 * By default it's displayed horizontally.
17463 * @see elm_slider_horizontal_get()
17467 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17470 * Retrieve the orientation of a given slider widget
17472 * @param obj The slider object.
17473 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17474 * @c EINA_FALSE if it's @b vertical (and on errors).
17476 * @see elm_slider_horizontal_set() for more details.
17480 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17483 * Set the minimum and maximum values for the slider.
17485 * @param obj The slider object.
17486 * @param min The minimum value.
17487 * @param max The maximum value.
17489 * Define the allowed range of values to be selected by the user.
17491 * If actual value is less than @p min, it will be updated to @p min. If it
17492 * is bigger then @p max, will be updated to @p max. Actual value can be
17493 * get with elm_slider_value_get().
17495 * By default, min is equal to 0.0, and max is equal to 1.0.
17497 * @warning Maximum must be greater than minimum, otherwise behavior
17500 * @see elm_slider_min_max_get()
17504 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17507 * Get the minimum and maximum values of the slider.
17509 * @param obj The slider object.
17510 * @param min Pointer where to store the minimum value.
17511 * @param max Pointer where to store the maximum value.
17513 * @note If only one value is needed, the other pointer can be passed
17516 * @see elm_slider_min_max_set() for details.
17520 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17523 * Set the value the slider displays.
17525 * @param obj The slider object.
17526 * @param val The value to be displayed.
17528 * Value will be presented on the unit label following format specified with
17529 * elm_slider_unit_format_set() and on indicator with
17530 * elm_slider_indicator_format_set().
17532 * @warning The value must to be between min and max values. This values
17533 * are set by elm_slider_min_max_set().
17535 * @see elm_slider_value_get()
17536 * @see elm_slider_unit_format_set()
17537 * @see elm_slider_indicator_format_set()
17538 * @see elm_slider_min_max_set()
17542 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17545 * Get the value displayed by the spinner.
17547 * @param obj The spinner object.
17548 * @return The value displayed.
17550 * @see elm_spinner_value_set() for details.
17554 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17557 * Invert a given slider widget's displaying values order
17559 * @param obj The slider object.
17560 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17561 * @c EINA_FALSE to bring it back to default, non-inverted values.
17563 * A slider may be @b inverted, in which state it gets its
17564 * values inverted, with high vales being on the left or top and
17565 * low values on the right or bottom, as opposed to normally have
17566 * the low values on the former and high values on the latter,
17567 * respectively, for horizontal and vertical modes.
17569 * @see elm_slider_inverted_get()
17573 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17576 * Get whether a given slider widget's displaying values are
17579 * @param obj The slider object.
17580 * @return @c EINA_TRUE, if @p obj has inverted values,
17581 * @c EINA_FALSE otherwise (and on errors).
17583 * @see elm_slider_inverted_set() for more details.
17587 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17590 * Set whether to enlarge slider indicator (augmented knob) or not.
17592 * @param obj The slider object.
17593 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17594 * let the knob always at default size.
17596 * By default, indicator will be bigger while dragged by the user.
17598 * @warning It won't display values set with
17599 * elm_slider_indicator_format_set() if you disable indicator.
17603 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17606 * Get whether a given slider widget's enlarging indicator or not.
17608 * @param obj The slider object.
17609 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17610 * @c EINA_FALSE otherwise (and on errors).
17612 * @see elm_slider_indicator_show_set() for details.
17616 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17623 * @addtogroup Actionslider Actionslider
17625 * @image html img/widget/actionslider/preview-00.png
17626 * @image latex img/widget/actionslider/preview-00.eps
17628 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
17629 * properties. The indicator is the element the user drags to choose a label.
17630 * When the position is set with magnet, when released the indicator will be
17631 * moved to it if it's nearest the magnetized position.
17633 * @note By default all positions are set as enabled.
17635 * Signals that you can add callbacks for are:
17637 * "selected" - when user selects an enabled position (the label is passed
17640 * "pos_changed" - when the indicator reaches any of the positions("left",
17641 * "right" or "center").
17643 * See an example of actionslider usage @ref actionslider_example_page "here"
17646 typedef enum _Elm_Actionslider_Pos
17648 ELM_ACTIONSLIDER_NONE = 0,
17649 ELM_ACTIONSLIDER_LEFT = 1 << 0,
17650 ELM_ACTIONSLIDER_CENTER = 1 << 1,
17651 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
17652 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
17653 } Elm_Actionslider_Pos;
17656 * Add a new actionslider to the parent.
17658 * @param parent The parent object
17659 * @return The new actionslider object or NULL if it cannot be created
17661 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17663 * Set actionslider labels.
17665 * @param obj The actionslider object
17666 * @param left_label The label to be set on the left.
17667 * @param center_label The label to be set on the center.
17668 * @param right_label The label to be set on the right.
17669 * @deprecated use elm_object_text_set() instead.
17671 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);
17673 * Get actionslider labels.
17675 * @param obj The actionslider object
17676 * @param left_label A char** to place the left_label of @p obj into.
17677 * @param center_label A char** to place the center_label of @p obj into.
17678 * @param right_label A char** to place the right_label of @p obj into.
17679 * @deprecated use elm_object_text_set() instead.
17681 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);
17683 * Get actionslider selected label.
17685 * @param obj The actionslider object
17686 * @return The selected label
17688 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17690 * Set actionslider indicator position.
17692 * @param obj The actionslider object.
17693 * @param pos The position of the indicator.
17695 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17697 * Get actionslider indicator position.
17699 * @param obj The actionslider object.
17700 * @return The position of the indicator.
17702 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17704 * Set actionslider magnet position. To make multiple positions magnets @c or
17705 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
17707 * @param obj The actionslider object.
17708 * @param pos Bit mask indicating the magnet positions.
17710 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17712 * Get actionslider magnet position.
17714 * @param obj The actionslider object.
17715 * @return The positions with magnet property.
17717 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17719 * Set actionslider enabled position. To set multiple positions as enabled @c or
17720 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
17722 * @note All the positions are enabled by default.
17724 * @param obj The actionslider object.
17725 * @param pos Bit mask indicating the enabled positions.
17727 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17729 * Get actionslider enabled position.
17731 * @param obj The actionslider object.
17732 * @return The enabled positions.
17734 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17736 * Set the label used on the indicator.
17738 * @param obj The actionslider object
17739 * @param label The label to be set on the indicator.
17740 * @deprecated use elm_object_text_set() instead.
17742 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17744 * Get the label used on the indicator object.
17746 * @param obj The actionslider object
17747 * @return The indicator label
17748 * @deprecated use elm_object_text_get() instead.
17750 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
17756 * @defgroup Genlist Genlist
17758 * @image html img/widget/genlist/preview-00.png
17759 * @image latex img/widget/genlist/preview-00.eps
17760 * @image html img/genlist.png
17761 * @image latex img/genlist.eps
17763 * This widget aims to have more expansive list than the simple list in
17764 * Elementary that could have more flexible items and allow many more entries
17765 * while still being fast and low on memory usage. At the same time it was
17766 * also made to be able to do tree structures. But the price to pay is more
17767 * complexity when it comes to usage. If all you want is a simple list with
17768 * icons and a single label, use the normal @ref List object.
17770 * Genlist has a fairly large API, mostly because it's relatively complex,
17771 * trying to be both expansive, powerful and efficient. First we will begin
17772 * an overview on the theory behind genlist.
17774 * @section Genlist_Item_Class Genlist item classes - creating items
17776 * In order to have the ability to add and delete items on the fly, genlist
17777 * implements a class (callback) system where the application provides a
17778 * structure with information about that type of item (genlist may contain
17779 * multiple different items with different classes, states and styles).
17780 * Genlist will call the functions in this struct (methods) when an item is
17781 * "realized" (i.e., created dynamically, while the user is scrolling the
17782 * grid). All objects will simply be deleted when no longer needed with
17783 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
17784 * following members:
17785 * - @c item_style - This is a constant string and simply defines the name
17786 * of the item style. It @b must be specified and the default should be @c
17788 * - @c mode_item_style - This is a constant string and simply defines the
17789 * name of the style that will be used for mode animations. It can be left
17790 * as @c NULL if you don't plan to use Genlist mode. See
17791 * elm_genlist_item_mode_set() for more info.
17793 * - @c func - A struct with pointers to functions that will be called when
17794 * an item is going to be actually created. All of them receive a @c data
17795 * parameter that will point to the same data passed to
17796 * elm_genlist_item_append() and related item creation functions, and a @c
17797 * obj parameter that points to the genlist object itself.
17799 * The function pointers inside @c func are @c label_get, @c icon_get, @c
17800 * state_get and @c del. The 3 first functions also receive a @c part
17801 * parameter described below. A brief description of these functions follows:
17803 * - @c label_get - The @c part parameter is the name string of one of the
17804 * existing text parts in the Edje group implementing the item's theme.
17805 * This function @b must return a strdup'()ed string, as the caller will
17806 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
17807 * - @c icon_get - The @c part parameter is the name string of one of the
17808 * existing (icon) swallow parts in the Edje group implementing the item's
17809 * theme. It must return @c NULL, when no icon is desired, or a valid
17810 * object handle, otherwise. The object will be deleted by the genlist on
17811 * its deletion or when the item is "unrealized". See
17812 * #Elm_Genlist_Item_Icon_Get_Cb.
17813 * - @c func.state_get - The @c part parameter is the name string of one of
17814 * the state parts in the Edje group implementing the item's theme. Return
17815 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
17816 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
17817 * and @c "elm" as "emission" and "source" arguments, respectively, when
17818 * the state is true (the default is false), where @c XXX is the name of
17819 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
17820 * - @c func.del - This is intended for use when genlist items are deleted,
17821 * so any data attached to the item (e.g. its data parameter on creation)
17822 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
17824 * available item styles:
17826 * - default_style - The text part is a textblock
17828 * @image html img/widget/genlist/preview-04.png
17829 * @image latex img/widget/genlist/preview-04.eps
17833 * @image html img/widget/genlist/preview-01.png
17834 * @image latex img/widget/genlist/preview-01.eps
17836 * - icon_top_text_bottom
17838 * @image html img/widget/genlist/preview-02.png
17839 * @image latex img/widget/genlist/preview-02.eps
17843 * @image html img/widget/genlist/preview-03.png
17844 * @image latex img/widget/genlist/preview-03.eps
17846 * @section Genlist_Items Structure of items
17848 * An item in a genlist can have 0 or more text labels (they can be regular
17849 * text or textblock Evas objects - that's up to the style to determine), 0
17850 * or more icons (which are simply objects swallowed into the genlist item's
17851 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
17852 * behavior left to the user to define. The Edje part names for each of
17853 * these properties will be looked up, in the theme file for the genlist,
17854 * under the Edje (string) data items named @c "labels", @c "icons" and @c
17855 * "states", respectively. For each of those properties, if more than one
17856 * part is provided, they must have names listed separated by spaces in the
17857 * data fields. For the default genlist item theme, we have @b one label
17858 * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
17859 * "elm.swallow.end") and @b no state parts.
17861 * A genlist item may be at one of several styles. Elementary provides one
17862 * by default - "default", but this can be extended by system or application
17863 * custom themes/overlays/extensions (see @ref Theme "themes" for more
17866 * @section Genlist_Manipulation Editing and Navigating
17868 * Items can be added by several calls. All of them return a @ref
17869 * Elm_Genlist_Item handle that is an internal member inside the genlist.
17870 * They all take a data parameter that is meant to be used for a handle to
17871 * the applications internal data (eg the struct with the original item
17872 * data). The parent parameter is the parent genlist item this belongs to if
17873 * it is a tree or an indexed group, and NULL if there is no parent. The
17874 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
17875 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
17876 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
17877 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
17878 * is set then this item is group index item that is displayed at the top
17879 * until the next group comes. The func parameter is a convenience callback
17880 * that is called when the item is selected and the data parameter will be
17881 * the func_data parameter, obj be the genlist object and event_info will be
17882 * the genlist item.
17884 * elm_genlist_item_append() adds an item to the end of the list, or if
17885 * there is a parent, to the end of all the child items of the parent.
17886 * elm_genlist_item_prepend() is the same but adds to the beginning of
17887 * the list or children list. elm_genlist_item_insert_before() inserts at
17888 * item before another item and elm_genlist_item_insert_after() inserts after
17889 * the indicated item.
17891 * The application can clear the list with elm_genlist_clear() which deletes
17892 * all the items in the list and elm_genlist_item_del() will delete a specific
17893 * item. elm_genlist_item_subitems_clear() will clear all items that are
17894 * children of the indicated parent item.
17896 * To help inspect list items you can jump to the item at the top of the list
17897 * with elm_genlist_first_item_get() which will return the item pointer, and
17898 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
17899 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
17900 * and previous items respectively relative to the indicated item. Using
17901 * these calls you can walk the entire item list/tree. Note that as a tree
17902 * the items are flattened in the list, so elm_genlist_item_parent_get() will
17903 * let you know which item is the parent (and thus know how to skip them if
17906 * @section Genlist_Muti_Selection Multi-selection
17908 * If the application wants multiple items to be able to be selected,
17909 * elm_genlist_multi_select_set() can enable this. If the list is
17910 * single-selection only (the default), then elm_genlist_selected_item_get()
17911 * will return the selected item, if any, or NULL I none is selected. If the
17912 * list is multi-select then elm_genlist_selected_items_get() will return a
17913 * list (that is only valid as long as no items are modified (added, deleted,
17914 * selected or unselected)).
17916 * @section Genlist_Usage_Hints Usage hints
17918 * There are also convenience functions. elm_genlist_item_genlist_get() will
17919 * return the genlist object the item belongs to. elm_genlist_item_show()
17920 * will make the scroller scroll to show that specific item so its visible.
17921 * elm_genlist_item_data_get() returns the data pointer set by the item
17922 * creation functions.
17924 * If an item changes (state of boolean changes, label or icons change),
17925 * then use elm_genlist_item_update() to have genlist update the item with
17926 * the new state. Genlist will re-realize the item thus call the functions
17927 * in the _Elm_Genlist_Item_Class for that item.
17929 * To programmatically (un)select an item use elm_genlist_item_selected_set().
17930 * To get its selected state use elm_genlist_item_selected_get(). Similarly
17931 * to expand/contract an item and get its expanded state, use
17932 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
17933 * again to make an item disabled (unable to be selected and appear
17934 * differently) use elm_genlist_item_disabled_set() to set this and
17935 * elm_genlist_item_disabled_get() to get the disabled state.
17937 * In general to indicate how the genlist should expand items horizontally to
17938 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
17939 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
17940 * mode means that if items are too wide to fit, the scroller will scroll
17941 * horizontally. Otherwise items are expanded to fill the width of the
17942 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
17943 * to the viewport width and limited to that size. This can be combined with
17944 * a different style that uses edjes' ellipsis feature (cutting text off like
17947 * Items will only call their selection func and callback when first becoming
17948 * selected. Any further clicks will do nothing, unless you enable always
17949 * select with elm_genlist_always_select_mode_set(). This means even if
17950 * selected, every click will make the selected callbacks be called.
17951 * elm_genlist_no_select_mode_set() will turn off the ability to select
17952 * items entirely and they will neither appear selected nor call selected
17953 * callback functions.
17955 * Remember that you can create new styles and add your own theme augmentation
17956 * per application with elm_theme_extension_add(). If you absolutely must
17957 * have a specific style that overrides any theme the user or system sets up
17958 * you can use elm_theme_overlay_add() to add such a file.
17960 * @section Genlist_Implementation Implementation
17962 * Evas tracks every object you create. Every time it processes an event
17963 * (mouse move, down, up etc.) it needs to walk through objects and find out
17964 * what event that affects. Even worse every time it renders display updates,
17965 * in order to just calculate what to re-draw, it needs to walk through many
17966 * many many objects. Thus, the more objects you keep active, the more
17967 * overhead Evas has in just doing its work. It is advisable to keep your
17968 * active objects to the minimum working set you need. Also remember that
17969 * object creation and deletion carries an overhead, so there is a
17970 * middle-ground, which is not easily determined. But don't keep massive lists
17971 * of objects you can't see or use. Genlist does this with list objects. It
17972 * creates and destroys them dynamically as you scroll around. It groups them
17973 * into blocks so it can determine the visibility etc. of a whole block at
17974 * once as opposed to having to walk the whole list. This 2-level list allows
17975 * for very large numbers of items to be in the list (tests have used up to
17976 * 2,000,000 items). Also genlist employs a queue for adding items. As items
17977 * may be different sizes, every item added needs to be calculated as to its
17978 * size and thus this presents a lot of overhead on populating the list, this
17979 * genlist employs a queue. Any item added is queued and spooled off over
17980 * time, actually appearing some time later, so if your list has many members
17981 * you may find it takes a while for them to all appear, with your process
17982 * consuming a lot of CPU while it is busy spooling.
17984 * Genlist also implements a tree structure, but it does so with callbacks to
17985 * the application, with the application filling in tree structures when
17986 * requested (allowing for efficient building of a very deep tree that could
17987 * even be used for file-management). See the above smart signal callbacks for
17990 * @section Genlist_Smart_Events Genlist smart events
17992 * Signals that you can add callbacks for are:
17993 * - @c "activated" - The user has double-clicked or pressed
17994 * (enter|return|spacebar) on an item. The @c event_info parameter is the
17995 * item that was activated.
17996 * - @c "clicked,double" - The user has double-clicked an item. The @c
17997 * event_info parameter is the item that was double-clicked.
17998 * - @c "selected" - This is called when a user has made an item selected.
17999 * The event_info parameter is the genlist item that was selected.
18000 * - @c "unselected" - This is called when a user has made an item
18001 * unselected. The event_info parameter is the genlist item that was
18003 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18004 * called and the item is now meant to be expanded. The event_info
18005 * parameter is the genlist item that was indicated to expand. It is the
18006 * job of this callback to then fill in the child items.
18007 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18008 * called and the item is now meant to be contracted. The event_info
18009 * parameter is the genlist item that was indicated to contract. It is the
18010 * job of this callback to then delete the child items.
18011 * - @c "expand,request" - This is called when a user has indicated they want
18012 * to expand a tree branch item. The callback should decide if the item can
18013 * expand (has any children) and then call elm_genlist_item_expanded_set()
18014 * appropriately to set the state. The event_info parameter is the genlist
18015 * item that was indicated to expand.
18016 * - @c "contract,request" - This is called when a user has indicated they
18017 * want to contract a tree branch item. The callback should decide if the
18018 * item can contract (has any children) and then call
18019 * elm_genlist_item_expanded_set() appropriately to set the state. The
18020 * event_info parameter is the genlist item that was indicated to contract.
18021 * - @c "realized" - This is called when the item in the list is created as a
18022 * real evas object. event_info parameter is the genlist item that was
18023 * created. The object may be deleted at any time, so it is up to the
18024 * caller to not use the object pointer from elm_genlist_item_object_get()
18025 * in a way where it may point to freed objects.
18026 * - @c "unrealized" - This is called just before an item is unrealized.
18027 * After this call icon objects provided will be deleted and the item
18028 * object itself delete or be put into a floating cache.
18029 * - @c "drag,start,up" - This is called when the item in the list has been
18030 * dragged (not scrolled) up.
18031 * - @c "drag,start,down" - This is called when the item in the list has been
18032 * dragged (not scrolled) down.
18033 * - @c "drag,start,left" - This is called when the item in the list has been
18034 * dragged (not scrolled) left.
18035 * - @c "drag,start,right" - This is called when the item in the list has
18036 * been dragged (not scrolled) right.
18037 * - @c "drag,stop" - This is called when the item in the list has stopped
18039 * - @c "drag" - This is called when the item in the list is being dragged.
18040 * - @c "longpressed" - This is called when the item is pressed for a certain
18041 * amount of time. By default it's 1 second.
18042 * - @c "scroll,anim,start" - This is called when scrolling animation has
18044 * - @c "scroll,anim,stop" - This is called when scrolling animation has
18046 * - @c "scroll,drag,start" - This is called when dragging the content has
18048 * - @c "scroll,drag,stop" - This is called when dragging the content has
18050 * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
18052 * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
18053 * until the bottom edge.
18054 * - @c "scroll,edge,left" - This is called when the genlist is scrolled
18055 * until the left edge.
18056 * - @c "scroll,edge,right" - This is called when the genlist is scrolled
18057 * until the right edge.
18058 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18060 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18062 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18064 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18066 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18067 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
18068 * multi-touch pinched in.
18069 * - @c "swipe" - This is called when the genlist is swiped.
18071 * @section Genlist_Examples Examples
18073 * Here is a list of examples that use the genlist, trying to show some of
18074 * its capabilities:
18075 * - @ref genlist_example_01
18076 * - @ref genlist_example_02
18077 * - @ref genlist_example_03
18078 * - @ref genlist_example_04
18079 * - @ref genlist_example_05
18083 * @addtogroup Genlist
18088 * @enum _Elm_Genlist_Item_Flags
18089 * @typedef Elm_Genlist_Item_Flags
18091 * Defines if the item is of any special type (has subitems or it's the
18092 * index of a group), or is just a simple item.
18096 typedef enum _Elm_Genlist_Item_Flags
18098 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18099 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18100 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18101 } Elm_Genlist_Item_Flags;
18102 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
18103 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18104 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
18105 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
18106 typedef Evas_Object *(*Elm_Genlist_Item_Icon_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for genlist item classes. */
18107 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. */
18108 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
18109 typedef void (*GenlistItemMovedFunc) (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
18111 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
18112 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
18113 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
18114 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
18117 * @struct _Elm_Genlist_Item_Class
18119 * Genlist item class definition structs.
18121 * This struct contains the style and fetching functions that will define the
18122 * contents of each item.
18124 * @see @ref Genlist_Item_Class
18126 struct _Elm_Genlist_Item_Class
18128 const char *item_style; /**< style of this class. */
18131 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
18132 Elm_Genlist_Item_Icon_Get_Cb icon_get; /**< Icon fetching class function for genlist item classes. */
18133 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
18134 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
18135 GenlistItemMovedFunc moved; // TODO: do not use this. change this to smart callback.
18137 const char *mode_item_style;
18141 * Add a new genlist widget to the given parent Elementary
18142 * (container) object
18144 * @param parent The parent object
18145 * @return a new genlist widget handle or @c NULL, on errors
18147 * This function inserts a new genlist widget on the canvas.
18149 * @see elm_genlist_item_append()
18150 * @see elm_genlist_item_del()
18151 * @see elm_genlist_clear()
18155 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18157 * Remove all items from a given genlist widget.
18159 * @param obj The genlist object
18161 * This removes (and deletes) all items in @p obj, leaving it empty.
18163 * @see elm_genlist_item_del(), to remove just one item.
18167 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18169 * Enable or disable multi-selection in the genlist
18171 * @param obj The genlist object
18172 * @param multi Multi-select enable/disable. Default is disabled.
18174 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18175 * the list. This allows more than 1 item to be selected. To retrieve the list
18176 * of selected items, use elm_genlist_selected_items_get().
18178 * @see elm_genlist_selected_items_get()
18179 * @see elm_genlist_multi_select_get()
18183 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18185 * Gets if multi-selection in genlist is enabled or disabled.
18187 * @param obj The genlist object
18188 * @return Multi-select enabled/disabled
18189 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18191 * @see elm_genlist_multi_select_set()
18195 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18197 * This sets the horizontal stretching mode.
18199 * @param obj The genlist object
18200 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18202 * This sets the mode used for sizing items horizontally. Valid modes
18203 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18204 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18205 * the scroller will scroll horizontally. Otherwise items are expanded
18206 * to fill the width of the viewport of the scroller. If it is
18207 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18208 * limited to that size.
18210 * @see elm_genlist_horizontal_get()
18214 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18215 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18217 * Gets the horizontal stretching mode.
18219 * @param obj The genlist object
18220 * @return The mode to use
18221 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18223 * @see elm_genlist_horizontal_set()
18227 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18228 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18230 * Set the always select mode.
18232 * @param obj The genlist object
18233 * @param always_select The always select mode (@c EINA_TRUE = on, @c
18234 * EINA_FALSE = off). Default is @c EINA_FALSE.
18236 * Items will only call their selection func and callback when first
18237 * becoming selected. Any further clicks will do nothing, unless you
18238 * enable always select with elm_genlist_always_select_mode_set().
18239 * This means that, even if selected, every click will make the selected
18240 * callbacks be called.
18242 * @see elm_genlist_always_select_mode_get()
18246 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18248 * Get the always select mode.
18250 * @param obj The genlist object
18251 * @return The always select mode
18252 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18254 * @see elm_genlist_always_select_mode_set()
18258 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18260 * Enable/disable the no select mode.
18262 * @param obj The genlist object
18263 * @param no_select The no select mode
18264 * (EINA_TRUE = on, EINA_FALSE = off)
18266 * This will turn off the ability to select items entirely and they
18267 * will neither appear selected nor call selected callback functions.
18269 * @see elm_genlist_no_select_mode_get()
18273 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18275 * Gets whether the no select mode is enabled.
18277 * @param obj The genlist object
18278 * @return The no select mode
18279 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18281 * @see elm_genlist_no_select_mode_set()
18285 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18287 * Enable/disable compress mode.
18289 * @param obj The genlist object
18290 * @param compress The compress mode
18291 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18293 * This will enable the compress mode where items are "compressed"
18294 * horizontally to fit the genlist scrollable viewport width. This is
18295 * special for genlist. Do not rely on
18296 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18297 * work as genlist needs to handle it specially.
18299 * @see elm_genlist_compress_mode_get()
18303 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18305 * Get whether the compress mode is enabled.
18307 * @param obj The genlist object
18308 * @return The compress mode
18309 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18311 * @see elm_genlist_compress_mode_set()
18315 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18317 * Enable/disable height-for-width mode.
18319 * @param obj The genlist object
18320 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18321 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18323 * With height-for-width mode the item width will be fixed (restricted
18324 * to a minimum of) to the list width when calculating its size in
18325 * order to allow the height to be calculated based on it. This allows,
18326 * for instance, text block to wrap lines if the Edje part is
18327 * configured with "text.min: 0 1".
18329 * @note This mode will make list resize slower as it will have to
18330 * recalculate every item height again whenever the list width
18333 * @note When height-for-width mode is enabled, it also enables
18334 * compress mode (see elm_genlist_compress_mode_set()) and
18335 * disables homogeneous (see elm_genlist_homogeneous_set()).
18339 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18341 * Get whether the height-for-width mode is enabled.
18343 * @param obj The genlist object
18344 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18349 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18351 * Enable/disable horizontal and vertical bouncing effect.
18353 * @param obj The genlist object
18354 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18355 * EINA_FALSE = off). Default is @c EINA_FALSE.
18356 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18357 * EINA_FALSE = off). Default is @c EINA_TRUE.
18359 * This will enable or disable the scroller bouncing effect for the
18360 * genlist. See elm_scroller_bounce_set() for details.
18362 * @see elm_scroller_bounce_set()
18363 * @see elm_genlist_bounce_get()
18367 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18369 * Get whether the horizontal and vertical bouncing effect is enabled.
18371 * @param obj The genlist object
18372 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18374 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18377 * @see elm_genlist_bounce_set()
18381 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18383 * Enable/disable homogenous mode.
18385 * @param obj The genlist object
18386 * @param homogeneous Assume the items within the genlist are of the
18387 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18390 * This will enable the homogeneous mode where items are of the same
18391 * height and width so that genlist may do the lazy-loading at its
18392 * maximum (which increases the performance for scrolling the list). This
18393 * implies 'compressed' mode.
18395 * @see elm_genlist_compress_mode_set()
18396 * @see elm_genlist_homogeneous_get()
18400 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18402 * Get whether the homogenous mode is enabled.
18404 * @param obj The genlist object
18405 * @return Assume the items within the genlist are of the same height
18406 * and width (EINA_TRUE = on, EINA_FALSE = off)
18408 * @see elm_genlist_homogeneous_set()
18412 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18414 * Set the maximum number of items within an item block
18416 * @param obj The genlist object
18417 * @param n Maximum number of items within an item block. Default is 32.
18419 * This will configure the block count to tune to the target with
18420 * particular performance matrix.
18422 * A block of objects will be used to reduce the number of operations due to
18423 * many objects in the screen. It can determine the visibility, or if the
18424 * object has changed, it theme needs to be updated, etc. doing this kind of
18425 * calculation to the entire block, instead of per object.
18427 * The default value for the block count is enough for most lists, so unless
18428 * you know you will have a lot of objects visible in the screen at the same
18429 * time, don't try to change this.
18431 * @see elm_genlist_block_count_get()
18432 * @see @ref Genlist_Implementation
18436 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18438 * Get the maximum number of items within an item block
18440 * @param obj The genlist object
18441 * @return Maximum number of items within an item block
18443 * @see elm_genlist_block_count_set()
18447 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18449 * Set the timeout in seconds for the longpress event.
18451 * @param obj The genlist object
18452 * @param timeout timeout in seconds. Default is 1.
18454 * This option will change how long it takes to send an event "longpressed"
18455 * after the mouse down signal is sent to the list. If this event occurs, no
18456 * "clicked" event will be sent.
18458 * @see elm_genlist_longpress_timeout_set()
18462 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18464 * Get the timeout in seconds for the longpress event.
18466 * @param obj The genlist object
18467 * @return timeout in seconds
18469 * @see elm_genlist_longpress_timeout_get()
18473 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18475 * Append a new item in a given genlist widget.
18477 * @param obj The genlist object
18478 * @param itc The item class for the item
18479 * @param data The item data
18480 * @param parent The parent item, or NULL if none
18481 * @param flags Item flags
18482 * @param func Convenience function called when the item is selected
18483 * @param func_data Data passed to @p func above.
18484 * @return A handle to the item added or @c NULL if not possible
18486 * This adds the given item to the end of the list or the end of
18487 * the children list if the @p parent is given.
18489 * @see elm_genlist_item_prepend()
18490 * @see elm_genlist_item_insert_before()
18491 * @see elm_genlist_item_insert_after()
18492 * @see elm_genlist_item_del()
18496 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);
18498 * Prepend a new item in a given genlist widget.
18500 * @param obj The genlist object
18501 * @param itc The item class for the item
18502 * @param data The item data
18503 * @param parent The parent item, or NULL if none
18504 * @param flags Item flags
18505 * @param func Convenience function called when the item is selected
18506 * @param func_data Data passed to @p func above.
18507 * @return A handle to the item added or NULL if not possible
18509 * This adds an item to the beginning of the list or beginning of the
18510 * children of the parent if given.
18512 * @see elm_genlist_item_append()
18513 * @see elm_genlist_item_insert_before()
18514 * @see elm_genlist_item_insert_after()
18515 * @see elm_genlist_item_del()
18519 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);
18521 * Insert an item before another in a genlist widget
18523 * @param obj The genlist object
18524 * @param itc The item class for the item
18525 * @param data The item data
18526 * @param before The item to place this new one before.
18527 * @param flags Item flags
18528 * @param func Convenience function called when the item is selected
18529 * @param func_data Data passed to @p func above.
18530 * @return A handle to the item added or @c NULL if not possible
18532 * This inserts an item before another in the list. It will be in the
18533 * same tree level or group as the item it is inserted before.
18535 * @see elm_genlist_item_append()
18536 * @see elm_genlist_item_prepend()
18537 * @see elm_genlist_item_insert_after()
18538 * @see elm_genlist_item_del()
18542 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);
18544 * Insert an item after another in a genlist widget
18546 * @param obj The genlist object
18547 * @param itc The item class for the item
18548 * @param data The item data
18549 * @param after The item to place this new one after.
18550 * @param flags Item flags
18551 * @param func Convenience function called when the item is selected
18552 * @param func_data Data passed to @p func above.
18553 * @return A handle to the item added or @c NULL if not possible
18555 * This inserts an item after another in the list. It will be in the
18556 * same tree level or group as the item it is inserted after.
18558 * @see elm_genlist_item_append()
18559 * @see elm_genlist_item_prepend()
18560 * @see elm_genlist_item_insert_before()
18561 * @see elm_genlist_item_del()
18565 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);
18567 * Insert a new item into the sorted genlist object
18569 * @param obj The genlist object
18570 * @param itc The item class for the item
18571 * @param data The item data
18572 * @param parent The parent item, or NULL if none
18573 * @param flags Item flags
18574 * @param comp The function called for the sort
18575 * @param func Convenience function called when item selected
18576 * @param func_data Data passed to @p func above.
18577 * @return A handle to the item added or NULL if not possible
18581 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);
18582 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);
18583 /* operations to retrieve existing items */
18585 * Get the selectd item in the genlist.
18587 * @param obj The genlist object
18588 * @return The selected item, or NULL if none is selected.
18590 * This gets the selected item in the list (if multi-selection is enabled, only
18591 * the item that was first selected in the list is returned - which is not very
18592 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18595 * If no item is selected, NULL is returned.
18597 * @see elm_genlist_selected_items_get()
18601 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18603 * Get a list of selected items in the genlist.
18605 * @param obj The genlist object
18606 * @return The list of selected items, or NULL if none are selected.
18608 * It returns a list of the selected items. This list pointer is only valid so
18609 * long as the selection doesn't change (no items are selected or unselected, or
18610 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18611 * pointers. The order of the items in this list is the order which they were
18612 * selected, i.e. the first item in this list is the first item that was
18613 * selected, and so on.
18615 * @note If not in multi-select mode, consider using function
18616 * elm_genlist_selected_item_get() instead.
18618 * @see elm_genlist_multi_select_set()
18619 * @see elm_genlist_selected_item_get()
18623 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18625 * Get a list of realized items in genlist
18627 * @param obj The genlist object
18628 * @return The list of realized items, nor NULL if none are realized.
18630 * This returns a list of the realized items in the genlist. The list
18631 * contains Elm_Genlist_Item pointers. The list must be freed by the
18632 * caller when done with eina_list_free(). The item pointers in the
18633 * list are only valid so long as those items are not deleted or the
18634 * genlist is not deleted.
18636 * @see elm_genlist_realized_items_update()
18640 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18642 * Get the item that is at the x, y canvas coords.
18644 * @param obj The gelinst object.
18645 * @param x The input x coordinate
18646 * @param y The input y coordinate
18647 * @param posret The position relative to the item returned here
18648 * @return The item at the coordinates or NULL if none
18650 * This returns the item at the given coordinates (which are canvas
18651 * relative, not object-relative). If an item is at that coordinate,
18652 * that item handle is returned, and if @p posret is not NULL, the
18653 * integer pointed to is set to a value of -1, 0 or 1, depending if
18654 * the coordinate is on the upper portion of that item (-1), on the
18655 * middle section (0) or on the lower part (1). If NULL is returned as
18656 * an item (no item found there), then posret may indicate -1 or 1
18657 * based if the coordinate is above or below all items respectively in
18662 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);
18664 * Get the first item in the genlist
18666 * This returns the first item in the list.
18668 * @param obj The genlist object
18669 * @return The first item, or NULL if none
18673 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18675 * Get the last item in the genlist
18677 * This returns the last item in the list.
18679 * @return The last item, or NULL if none
18683 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18685 * Set the scrollbar policy
18687 * @param obj The genlist object
18688 * @param policy_h Horizontal scrollbar policy.
18689 * @param policy_v Vertical scrollbar policy.
18691 * This sets the scrollbar visibility policy for the given genlist
18692 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
18693 * made visible if it is needed, and otherwise kept hidden.
18694 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
18695 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
18696 * respectively for the horizontal and vertical scrollbars. Default is
18697 * #ELM_SMART_SCROLLER_POLICY_AUTO
18699 * @see elm_genlist_scroller_policy_get()
18703 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
18705 * Get the scrollbar policy
18707 * @param obj The genlist object
18708 * @param policy_h Pointer to store the horizontal scrollbar policy.
18709 * @param policy_v Pointer to store the vertical scrollbar policy.
18711 * @see elm_genlist_scroller_policy_set()
18715 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);
18717 * Get the @b next item in a genlist widget's internal list of items,
18718 * given a handle to one of those items.
18720 * @param item The genlist item to fetch next from
18721 * @return The item after @p item, or @c NULL if there's none (and
18724 * This returns the item placed after the @p item, on the container
18727 * @see elm_genlist_item_prev_get()
18731 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18733 * Get the @b previous item in a genlist widget's internal list of items,
18734 * given a handle to one of those items.
18736 * @param item The genlist item to fetch previous from
18737 * @return The item before @p item, or @c NULL if there's none (and
18740 * This returns the item placed before the @p item, on the container
18743 * @see elm_genlist_item_next_get()
18747 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18749 * Get the genlist object's handle which contains a given genlist
18752 * @param item The item to fetch the container from
18753 * @return The genlist (parent) object
18755 * This returns the genlist object itself that an item belongs to.
18759 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18761 * Get the parent item of the given item
18763 * @param it The item
18764 * @return The parent of the item or @c NULL if it has no parent.
18766 * This returns the item that was specified as parent of the item @p it on
18767 * elm_genlist_item_append() and insertion related functions.
18771 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18773 * Remove all sub-items (children) of the given item
18775 * @param it The item
18777 * This removes all items that are children (and their descendants) of the
18778 * given item @p it.
18780 * @see elm_genlist_clear()
18781 * @see elm_genlist_item_del()
18785 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18787 * Set whether a given genlist item is selected or not
18789 * @param it The item
18790 * @param selected Use @c EINA_TRUE, to make it selected, @c
18791 * EINA_FALSE to make it unselected
18793 * This sets the selected state of an item. If multi selection is
18794 * not enabled on the containing genlist and @p selected is @c
18795 * EINA_TRUE, any other previously selected items will get
18796 * unselected in favor of this new one.
18798 * @see elm_genlist_item_selected_get()
18802 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
18804 * Get whether a given genlist item is selected or not
18806 * @param it The item
18807 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
18809 * @see elm_genlist_item_selected_set() for more details
18813 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18815 * Sets the expanded state of an item.
18817 * @param it The item
18818 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
18820 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
18823 * The theme will respond to this change visually, and a signal "expanded" or
18824 * "contracted" will be sent from the genlist with a pointer to the item that
18825 * has been expanded/contracted.
18827 * Calling this function won't show or hide any child of this item (if it is
18828 * a parent). You must manually delete and create them on the callbacks fo
18829 * the "expanded" or "contracted" signals.
18831 * @see elm_genlist_item_expanded_get()
18835 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
18837 * Get the expanded state of an item
18839 * @param it The item
18840 * @return The expanded state
18842 * This gets the expanded state of an item.
18844 * @see elm_genlist_item_expanded_set()
18848 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18850 * Get the depth of expanded item
18852 * @param it The genlist item object
18853 * @return The depth of expanded item
18857 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18859 * Set whether a given genlist item is disabled or not.
18861 * @param it The item
18862 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
18863 * to enable it back.
18865 * A disabled item cannot be selected or unselected. It will also
18866 * change its appearance, to signal the user it's disabled.
18868 * @see elm_genlist_item_disabled_get()
18872 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
18874 * Get whether a given genlist item is disabled or not.
18876 * @param it The item
18877 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
18880 * @see elm_genlist_item_disabled_set() for more details
18884 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18886 * Sets the display only state of an item.
18888 * @param it The item
18889 * @param display_only @c EINA_TRUE if the item is display only, @c
18890 * EINA_FALSE otherwise.
18892 * A display only item cannot be selected or unselected. It is for
18893 * display only and not selecting or otherwise clicking, dragging
18894 * etc. by the user, thus finger size rules will not be applied to
18897 * It's good to set group index items to display only state.
18899 * @see elm_genlist_item_display_only_get()
18903 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
18905 * Get the display only state of an item
18907 * @param it The item
18908 * @return @c EINA_TRUE if the item is display only, @c
18909 * EINA_FALSE otherwise.
18911 * @see elm_genlist_item_display_only_set()
18915 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18917 * Show the portion of a genlist's internal list containing a given
18918 * item, immediately.
18920 * @param it The item to display
18922 * This causes genlist to jump to the given item @p it and show it (by
18923 * immediately scrolling to that position), if it is not fully visible.
18925 * @see elm_genlist_item_bring_in()
18926 * @see elm_genlist_item_top_show()
18927 * @see elm_genlist_item_middle_show()
18931 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18933 * Animatedly bring in, to the visible are of a genlist, a given
18936 * @param it The item to display
18938 * This causes genlist to jump to the given item @p it and show it (by
18939 * animatedly scrolling), if it is not fully visible. This may use animation
18940 * to do so and take a period of time
18942 * @see elm_genlist_item_show()
18943 * @see elm_genlist_item_top_bring_in()
18944 * @see elm_genlist_item_middle_bring_in()
18948 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18950 * Show the portion of a genlist's internal list containing a given
18951 * item, immediately.
18953 * @param it The item to display
18955 * This causes genlist to jump to the given item @p it and show it (by
18956 * immediately scrolling to that position), if it is not fully visible.
18958 * The item will be positioned at the top of the genlist viewport.
18960 * @see elm_genlist_item_show()
18961 * @see elm_genlist_item_top_bring_in()
18965 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18967 * Animatedly bring in, to the visible are of a genlist, a given
18970 * @param it The item
18972 * This causes genlist to jump to the given item @p it and show it (by
18973 * animatedly scrolling), if it is not fully visible. This may use animation
18974 * to do so and take a period of time
18976 * The item will be positioned at the top of the genlist viewport.
18978 * @see elm_genlist_item_bring_in()
18979 * @see elm_genlist_item_top_show()
18983 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18985 * Show the portion of a genlist's internal list containing a given
18986 * item, immediately.
18988 * @param it The item to display
18990 * This causes genlist to jump to the given item @p it and show it (by
18991 * immediately scrolling to that position), if it is not fully visible.
18993 * The item will be positioned at the middle of the genlist viewport.
18995 * @see elm_genlist_item_show()
18996 * @see elm_genlist_item_middle_bring_in()
19000 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19002 * Animatedly bring in, to the visible are of a genlist, a given
19005 * @param it The item
19007 * This causes genlist to jump to the given item @p it and show it (by
19008 * animatedly scrolling), if it is not fully visible. This may use animation
19009 * to do so and take a period of time
19011 * The item will be positioned at the middle of the genlist viewport.
19013 * @see elm_genlist_item_bring_in()
19014 * @see elm_genlist_item_middle_show()
19018 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19020 * Remove a genlist item from the its parent, deleting it.
19022 * @param item The item to be removed.
19023 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19025 * @see elm_genlist_clear(), to remove all items in a genlist at
19030 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19032 * Return the data associated to a given genlist item
19034 * @param item The genlist item.
19035 * @return the data associated to this item.
19037 * This returns the @c data value passed on the
19038 * elm_genlist_item_append() and related item addition calls.
19040 * @see elm_genlist_item_append()
19041 * @see elm_genlist_item_data_set()
19045 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19047 * Set the data associated to a given genlist item
19049 * @param item The genlist item
19050 * @param data The new data pointer to set on it
19052 * This @b overrides the @c data value passed on the
19053 * elm_genlist_item_append() and related item addition calls. This
19054 * function @b won't call elm_genlist_item_update() automatically,
19055 * so you'd issue it afterwards if you want to hove the item
19056 * updated to reflect the that new data.
19058 * @see elm_genlist_item_data_get()
19062 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19064 * Tells genlist to "orphan" icons fetchs by the item class
19066 * @param it The item
19068 * This instructs genlist to release references to icons in the item,
19069 * meaning that they will no longer be managed by genlist and are
19070 * floating "orphans" that can be re-used elsewhere if the user wants
19075 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19077 * Get the real Evas object created to implement the view of a
19078 * given genlist item
19080 * @param item The genlist item.
19081 * @return the Evas object implementing this item's view.
19083 * This returns the actual Evas object used to implement the
19084 * specified genlist item's view. This may be @c NULL, as it may
19085 * not have been created or may have been deleted, at any time, by
19086 * the genlist. <b>Do not modify this object</b> (move, resize,
19087 * show, hide, etc.), as the genlist is controlling it. This
19088 * function is for querying, emitting custom signals or hooking
19089 * lower level callbacks for events on that object. Do not delete
19090 * this object under any circumstances.
19092 * @see elm_genlist_item_data_get()
19096 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19098 * Update the contents of an item
19100 * @param it The item
19102 * This updates an item by calling all the item class functions again
19103 * to get the icons, labels and states. Use this when the original
19104 * item data has changed and the changes are desired to be reflected.
19106 * Use elm_genlist_realized_items_update() to update all already realized
19109 * @see elm_genlist_realized_items_update()
19113 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19115 * Update the item class of an item
19117 * @param it The item
19118 * @param itc The item class for the item
19120 * This sets another class fo the item, changing the way that it is
19121 * displayed. After changing the item class, elm_genlist_item_update() is
19122 * called on the item @p it.
19126 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19127 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19129 * Set the text to be shown in a given genlist item's tooltips.
19131 * @param item The genlist item
19132 * @param text The text to set in the content
19134 * This call will setup the text to be used as tooltip to that item
19135 * (analogous to elm_object_tooltip_text_set(), but being item
19136 * tooltips with higher precedence than object tooltips). It can
19137 * have only one tooltip at a time, so any previous tooltip data
19138 * will get removed.
19140 * In order to set an icon or something else as a tooltip, look at
19141 * elm_genlist_item_tooltip_content_cb_set().
19145 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19147 * Set the content to be shown in a given genlist item's tooltips
19149 * @param item The genlist item.
19150 * @param func The function returning the tooltip contents.
19151 * @param data What to provide to @a func as callback data/context.
19152 * @param del_cb Called when data is not needed anymore, either when
19153 * another callback replaces @p func, the tooltip is unset with
19154 * elm_genlist_item_tooltip_unset() or the owner @p item
19155 * dies. This callback receives as its first parameter the
19156 * given @p data, being @c event_info the item handle.
19158 * This call will setup the tooltip's contents to @p item
19159 * (analogous to elm_object_tooltip_content_cb_set(), but being
19160 * item tooltips with higher precedence than object tooltips). It
19161 * can have only one tooltip at a time, so any previous tooltip
19162 * content will get removed. @p func (with @p data) will be called
19163 * every time Elementary needs to show the tooltip and it should
19164 * return a valid Evas object, which will be fully managed by the
19165 * tooltip system, getting deleted when the tooltip is gone.
19167 * In order to set just a text as a tooltip, look at
19168 * elm_genlist_item_tooltip_text_set().
19172 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);
19174 * Unset a tooltip from a given genlist item
19176 * @param item genlist item to remove a previously set tooltip from.
19178 * This call removes any tooltip set on @p item. The callback
19179 * provided as @c del_cb to
19180 * elm_genlist_item_tooltip_content_cb_set() will be called to
19181 * notify it is not used anymore (and have resources cleaned, if
19184 * @see elm_genlist_item_tooltip_content_cb_set()
19188 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19190 * Set a different @b style for a given genlist item's tooltip.
19192 * @param item genlist item with tooltip set
19193 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19194 * "default", @c "transparent", etc)
19196 * Tooltips can have <b>alternate styles</b> to be displayed on,
19197 * which are defined by the theme set on Elementary. This function
19198 * works analogously as elm_object_tooltip_style_set(), but here
19199 * applied only to genlist item objects. The default style for
19200 * tooltips is @c "default".
19202 * @note before you set a style you should define a tooltip with
19203 * elm_genlist_item_tooltip_content_cb_set() or
19204 * elm_genlist_item_tooltip_text_set()
19206 * @see elm_genlist_item_tooltip_style_get()
19210 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19212 * Get the style set a given genlist item's tooltip.
19214 * @param item genlist item with tooltip already set on.
19215 * @return style the theme style in use, which defaults to
19216 * "default". If the object does not have a tooltip set,
19217 * then @c NULL is returned.
19219 * @see elm_genlist_item_tooltip_style_set() for more details
19223 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19225 * @brief Disable size restrictions on an object's tooltip
19226 * @param item The tooltip's anchor object
19227 * @param disable If EINA_TRUE, size restrictions are disabled
19228 * @return EINA_FALSE on failure, EINA_TRUE on success
19230 * This function allows a tooltip to expand beyond its parant window's canvas.
19231 * It will instead be limited only by the size of the display.
19233 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19235 * @brief Retrieve size restriction state of an object's tooltip
19236 * @param item The tooltip's anchor object
19237 * @return If EINA_TRUE, size restrictions are disabled
19239 * This function returns whether a tooltip is allowed to expand beyond
19240 * its parant window's canvas.
19241 * It will instead be limited only by the size of the display.
19243 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19245 * Set the type of mouse pointer/cursor decoration to be shown,
19246 * when the mouse pointer is over the given genlist widget item
19248 * @param item genlist item to customize cursor on
19249 * @param cursor the cursor type's name
19251 * This function works analogously as elm_object_cursor_set(), but
19252 * here the cursor's changing area is restricted to the item's
19253 * area, and not the whole widget's. Note that that item cursors
19254 * have precedence over widget cursors, so that a mouse over @p
19255 * item will always show cursor @p type.
19257 * If this function is called twice for an object, a previously set
19258 * cursor will be unset on the second call.
19260 * @see elm_object_cursor_set()
19261 * @see elm_genlist_item_cursor_get()
19262 * @see elm_genlist_item_cursor_unset()
19266 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19268 * Get the type of mouse pointer/cursor decoration set to be shown,
19269 * when the mouse pointer is over the given genlist widget item
19271 * @param item genlist item with custom cursor set
19272 * @return the cursor type's name or @c NULL, if no custom cursors
19273 * were set to @p item (and on errors)
19275 * @see elm_object_cursor_get()
19276 * @see elm_genlist_item_cursor_set() for more details
19277 * @see elm_genlist_item_cursor_unset()
19281 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19283 * Unset any custom mouse pointer/cursor decoration set to be
19284 * shown, when the mouse pointer is over the given genlist widget
19285 * item, thus making it show the @b default cursor again.
19287 * @param item a genlist item
19289 * Use this call to undo any custom settings on this item's cursor
19290 * decoration, bringing it back to defaults (no custom style set).
19292 * @see elm_object_cursor_unset()
19293 * @see elm_genlist_item_cursor_set() for more details
19297 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19299 * Set a different @b style for a given custom cursor set for a
19302 * @param item genlist item with custom cursor set
19303 * @param style the <b>theme style</b> to use (e.g. @c "default",
19304 * @c "transparent", etc)
19306 * This function only makes sense when one is using custom mouse
19307 * cursor decorations <b>defined in a theme file</b> , which can
19308 * have, given a cursor name/type, <b>alternate styles</b> on
19309 * it. It works analogously as elm_object_cursor_style_set(), but
19310 * here applied only to genlist item objects.
19312 * @warning Before you set a cursor style you should have defined a
19313 * custom cursor previously on the item, with
19314 * elm_genlist_item_cursor_set()
19316 * @see elm_genlist_item_cursor_engine_only_set()
19317 * @see elm_genlist_item_cursor_style_get()
19321 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19323 * Get the current @b style set for a given genlist item's custom
19326 * @param item genlist item with custom cursor set.
19327 * @return style the cursor style in use. If the object does not
19328 * have a cursor set, then @c NULL is returned.
19330 * @see elm_genlist_item_cursor_style_set() for more details
19334 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19336 * Set if the (custom) cursor for a given genlist item should be
19337 * searched in its theme, also, or should only rely on the
19338 * rendering engine.
19340 * @param item item with custom (custom) cursor already set on
19341 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19342 * only on those provided by the rendering engine, @c EINA_FALSE to
19343 * have them searched on the widget's theme, as well.
19345 * @note This call is of use only if you've set a custom cursor
19346 * for genlist items, with elm_genlist_item_cursor_set().
19348 * @note By default, cursors will only be looked for between those
19349 * provided by the rendering engine.
19353 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19355 * Get if the (custom) cursor for a given genlist item is being
19356 * searched in its theme, also, or is only relying on the rendering
19359 * @param item a genlist item
19360 * @return @c EINA_TRUE, if cursors are being looked for only on
19361 * those provided by the rendering engine, @c EINA_FALSE if they
19362 * are being searched on the widget's theme, as well.
19364 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19368 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19370 * Update the contents of all realized items.
19372 * @param obj The genlist object.
19374 * This updates all realized items by calling all the item class functions again
19375 * to get the icons, labels and states. Use this when the original
19376 * item data has changed and the changes are desired to be reflected.
19378 * To update just one item, use elm_genlist_item_update().
19380 * @see elm_genlist_realized_items_get()
19381 * @see elm_genlist_item_update()
19385 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19387 * Activate a genlist mode on an item
19389 * @param item The genlist item
19390 * @param mode Mode name
19391 * @param mode_set Boolean to define set or unset mode.
19393 * A genlist mode is a different way of selecting an item. Once a mode is
19394 * activated on an item, any other selected item is immediately unselected.
19395 * This feature provides an easy way of implementing a new kind of animation
19396 * for selecting an item, without having to entirely rewrite the item style
19397 * theme. However, the elm_genlist_selected_* API can't be used to get what
19398 * item is activate for a mode.
19400 * The current item style will still be used, but applying a genlist mode to
19401 * an item will select it using a different kind of animation.
19403 * The current active item for a mode can be found by
19404 * elm_genlist_mode_item_get().
19406 * The characteristics of genlist mode are:
19407 * - Only one mode can be active at any time, and for only one item.
19408 * - Genlist handles deactivating other items when one item is activated.
19409 * - A mode is defined in the genlist theme (edc), and more modes can easily
19411 * - A mode style and the genlist item style are different things. They
19412 * can be combined to provide a default style to the item, with some kind
19413 * of animation for that item when the mode is activated.
19415 * When a mode is activated on an item, a new view for that item is created.
19416 * The theme of this mode defines the animation that will be used to transit
19417 * the item from the old view to the new view. This second (new) view will be
19418 * active for that item while the mode is active on the item, and will be
19419 * destroyed after the mode is totally deactivated from that item.
19421 * @see elm_genlist_mode_get()
19422 * @see elm_genlist_mode_item_get()
19426 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19428 * Get the last (or current) genlist mode used.
19430 * @param obj The genlist object
19432 * This function just returns the name of the last used genlist mode. It will
19433 * be the current mode if it's still active.
19435 * @see elm_genlist_item_mode_set()
19436 * @see elm_genlist_mode_item_get()
19440 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19442 * Get active genlist mode item
19444 * @param obj The genlist object
19445 * @return The active item for that current mode. Or @c NULL if no item is
19446 * activated with any mode.
19448 * This function returns the item that was activated with a mode, by the
19449 * function elm_genlist_item_mode_set().
19451 * @see elm_genlist_item_mode_set()
19452 * @see elm_genlist_mode_get()
19456 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19461 * @param obj The genlist object
19462 * @param reorder_mode The reorder mode
19463 * (EINA_TRUE = on, EINA_FALSE = off)
19467 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19470 * Get the reorder mode
19472 * @param obj The genlist object
19473 * @return The reorder mode
19474 * (EINA_TRUE = on, EINA_FALSE = off)
19478 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19485 * @defgroup Check Check
19487 * @image html img/widget/check/preview-00.png
19488 * @image latex img/widget/check/preview-00.eps
19489 * @image html img/widget/check/preview-01.png
19490 * @image latex img/widget/check/preview-01.eps
19491 * @image html img/widget/check/preview-02.png
19492 * @image latex img/widget/check/preview-02.eps
19494 * @brief The check widget allows for toggling a value between true and
19497 * Check objects are a lot like radio objects in layout and functionality
19498 * except they do not work as a group, but independently and only toggle the
19499 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19500 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19501 * returns the current state. For convenience, like the radio objects, you
19502 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19503 * for it to modify.
19505 * Signals that you can add callbacks for are:
19506 * "changed" - This is called whenever the user changes the state of one of
19507 * the check object(event_info is NULL).
19509 * @ref tutorial_check should give you a firm grasp of how to use this widget.
19513 * @brief Add a new Check object
19515 * @param parent The parent object
19516 * @return The new object or NULL if it cannot be created
19518 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19520 * @brief Set the text label of the check object
19522 * @param obj The check object
19523 * @param label The text label string in UTF-8
19525 * @deprecated use elm_object_text_set() instead.
19527 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19529 * @brief Get the text label of the check object
19531 * @param obj The check object
19532 * @return The text label string in UTF-8
19534 * @deprecated use elm_object_text_get() instead.
19536 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19538 * @brief Set the icon object of the check object
19540 * @param obj The check object
19541 * @param icon The icon object
19543 * Once the icon object is set, a previously set one will be deleted.
19544 * If you want to keep that old content object, use the
19545 * elm_check_icon_unset() function.
19547 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19549 * @brief Get the icon object of the check object
19551 * @param obj The check object
19552 * @return The icon object
19554 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19556 * @brief Unset the icon used for the check object
19558 * @param obj The check object
19559 * @return The icon object that was being used
19561 * Unparent and return the icon object which was set for this widget.
19563 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19565 * @brief Set the on/off state of the check object
19567 * @param obj The check object
19568 * @param state The state to use (1 == on, 0 == off)
19570 * This sets the state of the check. If set
19571 * with elm_check_state_pointer_set() the state of that variable is also
19572 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19574 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19576 * @brief Get the state of the check object
19578 * @param obj The check object
19579 * @return The boolean state
19581 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19583 * @brief Set a convenience pointer to a boolean to change
19585 * @param obj The check object
19586 * @param statep Pointer to the boolean to modify
19588 * This sets a pointer to a boolean, that, in addition to the check objects
19589 * state will also be modified directly. To stop setting the object pointed
19590 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19591 * then when this is called, the check objects state will also be modified to
19592 * reflect the value of the boolean @p statep points to, just like calling
19593 * elm_check_state_set().
19595 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19601 * @defgroup Radio Radio
19603 * @image html img/widget/radio/preview-00.png
19604 * @image latex img/widget/radio/preview-00.eps
19606 * @brief Radio is a widget that allows for 1 or more options to be displayed
19607 * and have the user choose only 1 of them.
19609 * A radio object contains an indicator, an optional Label and an optional
19610 * icon object. While it's possible to have a group of only one radio they,
19611 * are normally used in groups of 2 or more. To add a radio to a group use
19612 * elm_radio_group_add(). The radio object(s) will select from one of a set
19613 * of integer values, so any value they are configuring needs to be mapped to
19614 * a set of integers. To configure what value that radio object represents,
19615 * use elm_radio_state_value_set() to set the integer it represents. To set
19616 * the value the whole group(which one is currently selected) is to indicate
19617 * use elm_radio_value_set() on any group member, and to get the groups value
19618 * use elm_radio_value_get(). For convenience the radio objects are also able
19619 * to directly set an integer(int) to the value that is selected. To specify
19620 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19621 * The radio objects will modify this directly. That implies the pointer must
19622 * point to valid memory for as long as the radio objects exist.
19624 * Signals that you can add callbacks for are:
19625 * @li changed - This is called whenever the user changes the state of one of
19626 * the radio objects within the group of radio objects that work together.
19628 * @ref tutorial_radio show most of this API in action.
19632 * @brief Add a new radio to the parent
19634 * @param parent The parent object
19635 * @return The new object or NULL if it cannot be created
19637 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19639 * @brief Set the text label of the radio object
19641 * @param obj The radio object
19642 * @param label The text label string in UTF-8
19644 * @deprecated use elm_object_text_set() instead.
19646 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19648 * @brief Get the text label of the radio object
19650 * @param obj The radio object
19651 * @return The text label string in UTF-8
19653 * @deprecated use elm_object_text_set() instead.
19655 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19657 * @brief Set the icon object of the radio object
19659 * @param obj The radio object
19660 * @param icon The icon object
19662 * Once the icon object is set, a previously set one will be deleted. If you
19663 * want to keep that old content object, use the elm_radio_icon_unset()
19666 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19668 * @brief Get the icon object of the radio object
19670 * @param obj The radio object
19671 * @return The icon object
19673 * @see elm_radio_icon_set()
19675 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19677 * @brief Unset the icon used for the radio object
19679 * @param obj The radio object
19680 * @return The icon object that was being used
19682 * Unparent and return the icon object which was set for this widget.
19684 * @see elm_radio_icon_set()
19686 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19688 * @brief Add this radio to a group of other radio objects
19690 * @param obj The radio object
19691 * @param group Any object whose group the @p obj is to join.
19693 * Radio objects work in groups. Each member should have a different integer
19694 * value assigned. In order to have them work as a group, they need to know
19695 * about each other. This adds the given radio object to the group of which
19696 * the group object indicated is a member.
19698 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
19700 * @brief Set the integer value that this radio object represents
19702 * @param obj The radio object
19703 * @param value The value to use if this radio object is selected
19705 * This sets the value of the radio.
19707 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19709 * @brief Get the integer value that this radio object represents
19711 * @param obj The radio object
19712 * @return The value used if this radio object is selected
19714 * This gets the value of the radio.
19716 * @see elm_radio_value_set()
19718 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19720 * @brief Set the value of the radio.
19722 * @param obj The radio object
19723 * @param value The value to use for the group
19725 * This sets the value of the radio group and will also set the value if
19726 * pointed to, to the value supplied, but will not call any callbacks.
19728 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19730 * @brief Get the state of the radio object
19732 * @param obj The radio object
19733 * @return The integer state
19735 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19737 * @brief Set a convenience pointer to a integer to change
19739 * @param obj The radio object
19740 * @param valuep Pointer to the integer to modify
19742 * This sets a pointer to a integer, that, in addition to the radio objects
19743 * state will also be modified directly. To stop setting the object pointed
19744 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
19745 * when this is called, the radio objects state will also be modified to
19746 * reflect the value of the integer valuep points to, just like calling
19747 * elm_radio_value_set().
19749 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
19755 * @defgroup Pager Pager
19757 * @image html img/widget/pager/preview-00.png
19758 * @image latex img/widget/pager/preview-00.eps
19760 * @brief Widget that allows flipping between 1 or more “pages” of objects.
19762 * The flipping between “pages” of objects is animated. All content in pager
19763 * is kept in a stack, the last content to be added will be on the top of the
19764 * stack(be visible).
19766 * Objects can be pushed or popped from the stack or deleted as normal.
19767 * Pushes and pops will animate (and a pop will delete the object once the
19768 * animation is finished). Any object already in the pager can be promoted to
19769 * the top(from its current stacking position) through the use of
19770 * elm_pager_content_promote(). Objects are pushed to the top with
19771 * elm_pager_content_push() and when the top item is no longer wanted, simply
19772 * pop it with elm_pager_content_pop() and it will also be deleted. If an
19773 * object is no longer needed and is not the top item, just delete it as
19774 * normal. You can query which objects are the top and bottom with
19775 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
19777 * Signals that you can add callbacks for are:
19778 * "hide,finished" - when the previous page is hided
19780 * This widget has the following styles available:
19783 * @li fade_translucide
19784 * @li fade_invisible
19785 * @note This styles affect only the flipping animations, the appearance when
19786 * not animating is unaffected by styles.
19788 * @ref tutorial_pager gives a good overview of the usage of the API.
19792 * Add a new pager to the parent
19794 * @param parent The parent object
19795 * @return The new object or NULL if it cannot be created
19799 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19801 * @brief Push an object to the top of the pager stack (and show it).
19803 * @param obj The pager object
19804 * @param content The object to push
19806 * The object pushed becomes a child of the pager, it will be controlled and
19807 * deleted when the pager is deleted.
19809 * @note If the content is already in the stack use
19810 * elm_pager_content_promote().
19811 * @warning Using this function on @p content already in the stack results in
19812 * undefined behavior.
19814 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19816 * @brief Pop the object that is on top of the stack
19818 * @param obj The pager object
19820 * This pops the object that is on the top(visible) of the pager, makes it
19821 * disappear, then deletes the object. The object that was underneath it on
19822 * the stack will become visible.
19824 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
19826 * @brief Moves an object already in the pager stack to the top of the stack.
19828 * @param obj The pager object
19829 * @param content The object to promote
19831 * This will take the @p content and move it to the top of the stack as
19832 * if it had been pushed there.
19834 * @note If the content isn't already in the stack use
19835 * elm_pager_content_push().
19836 * @warning Using this function on @p content not already in the stack
19837 * results in undefined behavior.
19839 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19841 * @brief Return the object at the bottom of the pager stack
19843 * @param obj The pager object
19844 * @return The bottom object or NULL if none
19846 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19848 * @brief Return the object at the top of the pager stack
19850 * @param obj The pager object
19851 * @return The top object or NULL if none
19853 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19860 * @defgroup Slideshow Slideshow
19862 * @image html img/widget/slideshow/preview-00.png
19863 * @image latex img/widget/slideshow/preview-00.eps
19865 * This widget, as the name indicates, is a pre-made image
19866 * slideshow panel, with API functions acting on (child) image
19867 * items presentation. Between those actions, are:
19868 * - advance to next/previous image
19869 * - select the style of image transition animation
19870 * - set the exhibition time for each image
19871 * - start/stop the slideshow
19873 * The transition animations are defined in the widget's theme,
19874 * consequently new animations can be added without having to
19875 * update the widget's code.
19877 * @section Slideshow_Items Slideshow items
19879 * For slideshow items, just like for @ref Genlist "genlist" ones,
19880 * the user defines a @b classes, specifying functions that will be
19881 * called on the item's creation and deletion times.
19883 * The #Elm_Slideshow_Item_Class structure contains the following
19886 * - @c func.get - When an item is displayed, this function is
19887 * called, and it's where one should create the item object, de
19888 * facto. For example, the object can be a pure Evas image object
19889 * or an Elementary @ref Photocam "photocam" widget. See
19890 * #SlideshowItemGetFunc.
19891 * - @c func.del - When an item is no more displayed, this function
19892 * is called, where the user must delete any data associated to
19893 * the item. See #SlideshowItemDelFunc.
19895 * @section Slideshow_Caching Slideshow caching
19897 * The slideshow provides facilities to have items adjacent to the
19898 * one being displayed <b>already "realized"</b> (i.e. loaded) for
19899 * you, so that the system does not have to decode image data
19900 * anymore at the time it has to actually switch images on its
19901 * viewport. The user is able to set the numbers of items to be
19902 * cached @b before and @b after the current item, in the widget's
19905 * Smart events one can add callbacks for are:
19907 * - @c "changed" - when the slideshow switches its view to a new
19910 * List of examples for the slideshow widget:
19911 * @li @ref slideshow_example
19915 * @addtogroup Slideshow
19919 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
19920 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
19921 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
19922 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
19923 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
19926 * @struct _Elm_Slideshow_Item_Class
19928 * Slideshow item class definition. See @ref Slideshow_Items for
19931 struct _Elm_Slideshow_Item_Class
19933 struct _Elm_Slideshow_Item_Class_Func
19935 SlideshowItemGetFunc get;
19936 SlideshowItemDelFunc del;
19938 }; /**< #Elm_Slideshow_Item_Class member definitions */
19941 * Add a new slideshow widget to the given parent Elementary
19942 * (container) object
19944 * @param parent The parent object
19945 * @return A new slideshow widget handle or @c NULL, on errors
19947 * This function inserts a new slideshow widget on the canvas.
19949 * @ingroup Slideshow
19951 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19954 * Add (append) a new item in a given slideshow widget.
19956 * @param obj The slideshow object
19957 * @param itc The item class for the item
19958 * @param data The item's data
19959 * @return A handle to the item added or @c NULL, on errors
19961 * Add a new item to @p obj's internal list of items, appending it.
19962 * The item's class must contain the function really fetching the
19963 * image object to show for this item, which could be an Evas image
19964 * object or an Elementary photo, for example. The @p data
19965 * parameter is going to be passed to both class functions of the
19968 * @see #Elm_Slideshow_Item_Class
19969 * @see elm_slideshow_item_sorted_insert()
19971 * @ingroup Slideshow
19973 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
19976 * Insert a new item into the given slideshow widget, using the @p func
19977 * function to sort items (by item handles).
19979 * @param obj The slideshow object
19980 * @param itc The item class for the item
19981 * @param data The item's data
19982 * @param func The comparing function to be used to sort slideshow
19983 * items <b>by #Elm_Slideshow_Item item handles</b>
19984 * @return Returns The slideshow item handle, on success, or
19985 * @c NULL, on errors
19987 * Add a new item to @p obj's internal list of items, in a position
19988 * determined by the @p func comparing function. The item's class
19989 * must contain the function really fetching the image object to
19990 * show for this item, which could be an Evas image object or an
19991 * Elementary photo, for example. The @p data parameter is going to
19992 * be passed to both class functions of the item.
19994 * @see #Elm_Slideshow_Item_Class
19995 * @see elm_slideshow_item_add()
19997 * @ingroup Slideshow
19999 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);
20002 * Display a given slideshow widget's item, programmatically.
20004 * @param obj The slideshow object
20005 * @param item The item to display on @p obj's viewport
20007 * The change between the current item and @p item will use the
20008 * transition @p obj is set to use (@see
20009 * elm_slideshow_transition_set()).
20011 * @ingroup Slideshow
20013 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20016 * Slide to the @b next item, in a given slideshow widget
20018 * @param obj The slideshow object
20020 * The sliding animation @p obj is set to use will be the
20021 * transition effect used, after this call is issued.
20023 * @note If the end of the slideshow's internal list of items is
20024 * reached, it'll wrap around to the list's beginning, again.
20026 * @ingroup Slideshow
20028 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20031 * Slide to the @b previous item, in a given slideshow widget
20033 * @param obj The slideshow object
20035 * The sliding animation @p obj is set to use will be the
20036 * transition effect used, after this call is issued.
20038 * @note If the beginning of the slideshow's internal list of items
20039 * is reached, it'll wrap around to the list's end, again.
20041 * @ingroup Slideshow
20043 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20046 * Returns the list of sliding transition/effect names available, for a
20047 * given slideshow widget.
20049 * @param obj The slideshow object
20050 * @return The list of transitions (list of @b stringshared strings
20053 * The transitions, which come from @p obj's theme, must be an EDC
20054 * data item named @c "transitions" on the theme file, with (prefix)
20055 * names of EDC programs actually implementing them.
20057 * The available transitions for slideshows on the default theme are:
20058 * - @c "fade" - the current item fades out, while the new one
20059 * fades in to the slideshow's viewport.
20060 * - @c "black_fade" - the current item fades to black, and just
20061 * then, the new item will fade in.
20062 * - @c "horizontal" - the current item slides horizontally, until
20063 * it gets out of the slideshow's viewport, while the new item
20064 * comes from the left to take its place.
20065 * - @c "vertical" - the current item slides vertically, until it
20066 * gets out of the slideshow's viewport, while the new item comes
20067 * from the bottom to take its place.
20068 * - @c "square" - the new item starts to appear from the middle of
20069 * the current one, but with a tiny size, growing until its
20070 * target (full) size and covering the old one.
20072 * @warning The stringshared strings get no new references
20073 * exclusive to the user grabbing the list, here, so if you'd like
20074 * to use them out of this call's context, you'd better @c
20075 * eina_stringshare_ref() them.
20077 * @see elm_slideshow_transition_set()
20079 * @ingroup Slideshow
20081 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20084 * Set the current slide transition/effect in use for a given
20087 * @param obj The slideshow object
20088 * @param transition The new transition's name string
20090 * If @p transition is implemented in @p obj's theme (i.e., is
20091 * contained in the list returned by
20092 * elm_slideshow_transitions_get()), this new sliding effect will
20093 * be used on the widget.
20095 * @see elm_slideshow_transitions_get() for more details
20097 * @ingroup Slideshow
20099 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20102 * Get the current slide transition/effect in use for a given
20105 * @param obj The slideshow object
20106 * @return The current transition's name
20108 * @see elm_slideshow_transition_set() for more details
20110 * @ingroup Slideshow
20112 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20115 * Set the interval between each image transition on a given
20116 * slideshow widget, <b>and start the slideshow, itself</b>
20118 * @param obj The slideshow object
20119 * @param timeout The new displaying timeout for images
20121 * After this call, the slideshow widget will start cycling its
20122 * view, sequentially and automatically, with the images of the
20123 * items it has. The time between each new image displayed is going
20124 * to be @p timeout, in @b seconds. If a different timeout was set
20125 * previously and an slideshow was in progress, it will continue
20126 * with the new time between transitions, after this call.
20128 * @note A value less than or equal to 0 on @p timeout will disable
20129 * the widget's internal timer, thus halting any slideshow which
20130 * could be happening on @p obj.
20132 * @see elm_slideshow_timeout_get()
20134 * @ingroup Slideshow
20136 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20139 * Get the interval set for image transitions on a given slideshow
20142 * @param obj The slideshow object
20143 * @return Returns the timeout set on it
20145 * @see elm_slideshow_timeout_set() for more details
20147 * @ingroup Slideshow
20149 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20152 * Set if, after a slideshow is started, for a given slideshow
20153 * widget, its items should be displayed cyclically or not.
20155 * @param obj The slideshow object
20156 * @param loop Use @c EINA_TRUE to make it cycle through items or
20157 * @c EINA_FALSE for it to stop at the end of @p obj's internal
20160 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20161 * ignore what is set by this functions, i.e., they'll @b always
20162 * cycle through items. This affects only the "automatic"
20163 * slideshow, as set by elm_slideshow_timeout_set().
20165 * @see elm_slideshow_loop_get()
20167 * @ingroup Slideshow
20169 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20172 * Get if, after a slideshow is started, for a given slideshow
20173 * widget, its items are to be displayed cyclically or not.
20175 * @param obj The slideshow object
20176 * @return @c EINA_TRUE, if the items in @p obj will be cycled
20177 * through or @c EINA_FALSE, otherwise
20179 * @see elm_slideshow_loop_set() for more details
20181 * @ingroup Slideshow
20183 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20186 * Remove all items from a given slideshow widget
20188 * @param obj The slideshow object
20190 * This removes (and deletes) all items in @p obj, leaving it
20193 * @see elm_slideshow_item_del(), to remove just one item.
20195 * @ingroup Slideshow
20197 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20200 * Get the internal list of items in a given slideshow widget.
20202 * @param obj The slideshow object
20203 * @return The list of items (#Elm_Slideshow_Item as data) or
20204 * @c NULL on errors.
20206 * This list is @b not to be modified in any way and must not be
20207 * freed. Use the list members with functions like
20208 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20210 * @warning This list is only valid until @p obj object's internal
20211 * items list is changed. It should be fetched again with another
20212 * call to this function when changes happen.
20214 * @ingroup Slideshow
20216 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20219 * Delete a given item from a slideshow widget.
20221 * @param item The slideshow item
20223 * @ingroup Slideshow
20225 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20228 * Return the data associated with a given slideshow item
20230 * @param item The slideshow item
20231 * @return Returns the data associated to this item
20233 * @ingroup Slideshow
20235 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20238 * Returns the currently displayed item, in a given slideshow widget
20240 * @param obj The slideshow object
20241 * @return A handle to the item being displayed in @p obj or
20242 * @c NULL, if none is (and on errors)
20244 * @ingroup Slideshow
20246 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20249 * Get the real Evas object created to implement the view of a
20250 * given slideshow item
20252 * @param item The slideshow item.
20253 * @return the Evas object implementing this item's view.
20255 * This returns the actual Evas object used to implement the
20256 * specified slideshow item's view. This may be @c NULL, as it may
20257 * not have been created or may have been deleted, at any time, by
20258 * the slideshow. <b>Do not modify this object</b> (move, resize,
20259 * show, hide, etc.), as the slideshow is controlling it. This
20260 * function is for querying, emitting custom signals or hooking
20261 * lower level callbacks for events on that object. Do not delete
20262 * this object under any circumstances.
20264 * @see elm_slideshow_item_data_get()
20266 * @ingroup Slideshow
20268 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20271 * Get the the item, in a given slideshow widget, placed at
20272 * position @p nth, in its internal items list
20274 * @param obj The slideshow object
20275 * @param nth The number of the item to grab a handle to (0 being
20277 * @return The item stored in @p obj at position @p nth or @c NULL,
20278 * if there's no item with that index (and on errors)
20280 * @ingroup Slideshow
20282 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20285 * Set the current slide layout in use for a given slideshow widget
20287 * @param obj The slideshow object
20288 * @param layout The new layout's name string
20290 * If @p layout is implemented in @p obj's theme (i.e., is contained
20291 * in the list returned by elm_slideshow_layouts_get()), this new
20292 * images layout will be used on the widget.
20294 * @see elm_slideshow_layouts_get() for more details
20296 * @ingroup Slideshow
20298 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20301 * Get the current slide layout in use for a given slideshow widget
20303 * @param obj The slideshow object
20304 * @return The current layout's name
20306 * @see elm_slideshow_layout_set() for more details
20308 * @ingroup Slideshow
20310 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20313 * Returns the list of @b layout names available, for a given
20314 * slideshow widget.
20316 * @param obj The slideshow object
20317 * @return The list of layouts (list of @b stringshared strings
20320 * Slideshow layouts will change how the widget is to dispose each
20321 * image item in its viewport, with regard to cropping, scaling,
20324 * The layouts, which come from @p obj's theme, must be an EDC
20325 * data item name @c "layouts" on the theme file, with (prefix)
20326 * names of EDC programs actually implementing them.
20328 * The available layouts for slideshows on the default theme are:
20329 * - @c "fullscreen" - item images with original aspect, scaled to
20330 * touch top and down slideshow borders or, if the image's heigh
20331 * is not enough, left and right slideshow borders.
20332 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20333 * one, but always leaving 10% of the slideshow's dimensions of
20334 * distance between the item image's borders and the slideshow
20335 * borders, for each axis.
20337 * @warning The stringshared strings get no new references
20338 * exclusive to the user grabbing the list, here, so if you'd like
20339 * to use them out of this call's context, you'd better @c
20340 * eina_stringshare_ref() them.
20342 * @see elm_slideshow_layout_set()
20344 * @ingroup Slideshow
20346 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20349 * Set the number of items to cache, on a given slideshow widget,
20350 * <b>before the current item</b>
20352 * @param obj The slideshow object
20353 * @param count Number of items to cache before the current one
20355 * The default value for this property is @c 2. See
20356 * @ref Slideshow_Caching "slideshow caching" for more details.
20358 * @see elm_slideshow_cache_before_get()
20360 * @ingroup Slideshow
20362 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20365 * Retrieve the number of items to cache, on a given slideshow widget,
20366 * <b>before the current item</b>
20368 * @param obj The slideshow object
20369 * @return The number of items set to be cached before the current one
20371 * @see elm_slideshow_cache_before_set() for more details
20373 * @ingroup Slideshow
20375 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20378 * Set the number of items to cache, on a given slideshow widget,
20379 * <b>after the current item</b>
20381 * @param obj The slideshow object
20382 * @param count Number of items to cache after the current one
20384 * The default value for this property is @c 2. See
20385 * @ref Slideshow_Caching "slideshow caching" for more details.
20387 * @see elm_slideshow_cache_after_get()
20389 * @ingroup Slideshow
20391 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20394 * Retrieve the number of items to cache, on a given slideshow widget,
20395 * <b>after the current item</b>
20397 * @param obj The slideshow object
20398 * @return The number of items set to be cached after the current one
20400 * @see elm_slideshow_cache_after_set() for more details
20402 * @ingroup Slideshow
20404 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20407 * Get the number of items stored in a given slideshow widget
20409 * @param obj The slideshow object
20410 * @return The number of items on @p obj, at the moment of this call
20412 * @ingroup Slideshow
20414 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20421 * @defgroup Fileselector File Selector
20423 * @image html img/widget/fileselector/preview-00.png
20424 * @image latex img/widget/fileselector/preview-00.eps
20426 * A file selector is a widget that allows a user to navigate
20427 * through a file system, reporting file selections back via its
20430 * It contains shortcut buttons for home directory (@c ~) and to
20431 * jump one directory upwards (..), as well as cancel/ok buttons to
20432 * confirm/cancel a given selection. After either one of those two
20433 * former actions, the file selector will issue its @c "done" smart
20436 * There's a text entry on it, too, showing the name of the current
20437 * selection. There's the possibility of making it editable, so it
20438 * is useful on file saving dialogs on applications, where one
20439 * gives a file name to save contents to, in a given directory in
20440 * the system. This custom file name will be reported on the @c
20441 * "done" smart callback (explained in sequence).
20443 * Finally, it has a view to display file system items into in two
20448 * If Elementary is built with support of the Ethumb thumbnailing
20449 * library, the second form of view will display preview thumbnails
20450 * of files which it supports.
20452 * Smart callbacks one can register to:
20454 * - @c "selected" - the user has clicked on a file (when not in
20455 * folders-only mode) or directory (when in folders-only mode)
20456 * - @c "directory,open" - the list has been populated with new
20457 * content (@c event_info is a pointer to the directory's
20458 * path, a @b stringshared string)
20459 * - @c "done" - the user has clicked on the "ok" or "cancel"
20460 * buttons (@c event_info is a pointer to the selection's
20461 * path, a @b stringshared string)
20463 * Here is an example on its usage:
20464 * @li @ref fileselector_example
20468 * @addtogroup Fileselector
20473 * Defines how a file selector widget is to layout its contents
20474 * (file system entries).
20476 typedef enum _Elm_Fileselector_Mode
20478 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20479 ELM_FILESELECTOR_GRID, /**< layout as a grid */
20480 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20481 } Elm_Fileselector_Mode;
20484 * Add a new file selector widget to the given parent Elementary
20485 * (container) object
20487 * @param parent The parent object
20488 * @return a new file selector widget handle or @c NULL, on errors
20490 * This function inserts a new file selector widget on the canvas.
20492 * @ingroup Fileselector
20494 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20497 * Enable/disable the file name entry box where the user can type
20498 * in a name for a file, in a given file selector widget
20500 * @param obj The file selector object
20501 * @param is_save @c EINA_TRUE to make the file selector a "saving
20502 * dialog", @c EINA_FALSE otherwise
20504 * Having the entry editable is useful on file saving dialogs on
20505 * applications, where one gives a file name to save contents to,
20506 * in a given directory in the system. This custom file name will
20507 * be reported on the @c "done" smart callback.
20509 * @see elm_fileselector_is_save_get()
20511 * @ingroup Fileselector
20513 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20516 * Get whether the given file selector is in "saving dialog" mode
20518 * @param obj The file selector object
20519 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20520 * mode, @c EINA_FALSE otherwise (and on errors)
20522 * @see elm_fileselector_is_save_set() for more details
20524 * @ingroup Fileselector
20526 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20529 * Enable/disable folder-only view for a given file selector widget
20531 * @param obj The file selector object
20532 * @param only @c EINA_TRUE to make @p obj only display
20533 * directories, @c EINA_FALSE to make files to be displayed in it
20536 * If enabled, the widget's view will only display folder items,
20539 * @see elm_fileselector_folder_only_get()
20541 * @ingroup Fileselector
20543 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20546 * Get whether folder-only view is set for a given file selector
20549 * @param obj The file selector object
20550 * @return only @c EINA_TRUE if @p obj is only displaying
20551 * directories, @c EINA_FALSE if files are being displayed in it
20552 * too (and on errors)
20554 * @see elm_fileselector_folder_only_get()
20556 * @ingroup Fileselector
20558 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20561 * Enable/disable the "ok" and "cancel" buttons on a given file
20564 * @param obj The file selector object
20565 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20567 * @note A file selector without those buttons will never emit the
20568 * @c "done" smart event, and is only usable if one is just hooking
20569 * to the other two events.
20571 * @see elm_fileselector_buttons_ok_cancel_get()
20573 * @ingroup Fileselector
20575 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20578 * Get whether the "ok" and "cancel" buttons on a given file
20579 * selector widget are being shown.
20581 * @param obj The file selector object
20582 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20583 * otherwise (and on errors)
20585 * @see elm_fileselector_buttons_ok_cancel_set() for more details
20587 * @ingroup Fileselector
20589 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20592 * Enable/disable a tree view in the given file selector widget,
20593 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20595 * @param obj The file selector object
20596 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20599 * In a tree view, arrows are created on the sides of directories,
20600 * allowing them to expand in place.
20602 * @note If it's in other mode, the changes made by this function
20603 * will only be visible when one switches back to "list" mode.
20605 * @see elm_fileselector_expandable_get()
20607 * @ingroup Fileselector
20609 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20612 * Get whether tree view is enabled for the given file selector
20615 * @param obj The file selector object
20616 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20617 * otherwise (and or errors)
20619 * @see elm_fileselector_expandable_set() for more details
20621 * @ingroup Fileselector
20623 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20626 * Set, programmatically, the @b directory that a given file
20627 * selector widget will display contents from
20629 * @param obj The file selector object
20630 * @param path The path to display in @p obj
20632 * This will change the @b directory that @p obj is displaying. It
20633 * will also clear the text entry area on the @p obj object, which
20634 * displays select files' names.
20636 * @see elm_fileselector_path_get()
20638 * @ingroup Fileselector
20640 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20643 * Get the parent directory's path that a given file selector
20644 * widget is displaying
20646 * @param obj The file selector object
20647 * @return The (full) path of the directory the file selector is
20648 * displaying, a @b stringshared string
20650 * @see elm_fileselector_path_set()
20652 * @ingroup Fileselector
20654 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20657 * Set, programmatically, the currently selected file/directory in
20658 * the given file selector widget
20660 * @param obj The file selector object
20661 * @param path The (full) path to a file or directory
20662 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
20663 * latter case occurs if the directory or file pointed to do not
20666 * @see elm_fileselector_selected_get()
20668 * @ingroup Fileselector
20670 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20673 * Get the currently selected item's (full) path, in the given file
20676 * @param obj The file selector object
20677 * @return The absolute path of the selected item, a @b
20678 * stringshared string
20680 * @note Custom editions on @p obj object's text entry, if made,
20681 * will appear on the return string of this function, naturally.
20683 * @see elm_fileselector_selected_set() for more details
20685 * @ingroup Fileselector
20687 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20690 * Set the mode in which a given file selector widget will display
20691 * (layout) file system entries in its view
20693 * @param obj The file selector object
20694 * @param mode The mode of the fileselector, being it one of
20695 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
20696 * first one, naturally, will display the files in a list. The
20697 * latter will make the widget to display its entries in a grid
20700 * @note By using elm_fileselector_expandable_set(), the user may
20701 * trigger a tree view for that list.
20703 * @note If Elementary is built with support of the Ethumb
20704 * thumbnailing library, the second form of view will display
20705 * preview thumbnails of files which it supports. You must have
20706 * elm_need_ethumb() called in your Elementary for thumbnailing to
20709 * @see elm_fileselector_expandable_set().
20710 * @see elm_fileselector_mode_get().
20712 * @ingroup Fileselector
20714 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
20717 * Get the mode in which a given file selector widget is displaying
20718 * (layouting) file system entries in its view
20720 * @param obj The fileselector object
20721 * @return The mode in which the fileselector is at
20723 * @see elm_fileselector_mode_set() for more details
20725 * @ingroup Fileselector
20727 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20734 * @defgroup Progressbar Progress bar
20736 * The progress bar is a widget for visually representing the
20737 * progress status of a given job/task.
20739 * A progress bar may be horizontal or vertical. It may display an
20740 * icon besides it, as well as primary and @b units labels. The
20741 * former is meant to label the widget as a whole, while the
20742 * latter, which is formatted with floating point values (and thus
20743 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
20744 * units"</c>), is meant to label the widget's <b>progress
20745 * value</b>. Label, icon and unit strings/objects are @b optional
20746 * for progress bars.
20748 * A progress bar may be @b inverted, in which state it gets its
20749 * values inverted, with high values being on the left or top and
20750 * low values on the right or bottom, as opposed to normally have
20751 * the low values on the former and high values on the latter,
20752 * respectively, for horizontal and vertical modes.
20754 * The @b span of the progress, as set by
20755 * elm_progressbar_span_size_set(), is its length (horizontally or
20756 * vertically), unless one puts size hints on the widget to expand
20757 * on desired directions, by any container. That length will be
20758 * scaled by the object or applications scaling factor. At any
20759 * point code can query the progress bar for its value with
20760 * elm_progressbar_value_get().
20762 * Available widget styles for progress bars:
20764 * - @c "wheel" (simple style, no text, no progression, only
20765 * "pulse" effect is available)
20767 * Here is an example on its usage:
20768 * @li @ref progressbar_example
20772 * Add a new progress bar widget to the given parent Elementary
20773 * (container) object
20775 * @param parent The parent object
20776 * @return a new progress bar widget handle or @c NULL, on errors
20778 * This function inserts a new progress bar widget on the canvas.
20780 * @ingroup Progressbar
20782 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20785 * Set whether a given progress bar widget is at "pulsing mode" or
20788 * @param obj The progress bar object
20789 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
20790 * @c EINA_FALSE to put it back to its default one
20792 * By default, progress bars will display values from the low to
20793 * high value boundaries. There are, though, contexts in which the
20794 * state of progression of a given task is @b unknown. For those,
20795 * one can set a progress bar widget to a "pulsing state", to give
20796 * the user an idea that some computation is being held, but
20797 * without exact progress values. In the default theme it will
20798 * animate its bar with the contents filling in constantly and back
20799 * to non-filled, in a loop. To start and stop this pulsing
20800 * animation, one has to explicitly call elm_progressbar_pulse().
20802 * @see elm_progressbar_pulse_get()
20803 * @see elm_progressbar_pulse()
20805 * @ingroup Progressbar
20807 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
20810 * Get whether a given progress bar widget is at "pulsing mode" or
20813 * @param obj The progress bar object
20814 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
20815 * if it's in the default one (and on errors)
20817 * @ingroup Progressbar
20819 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20822 * Start/stop a given progress bar "pulsing" animation, if its
20825 * @param obj The progress bar object
20826 * @param state @c EINA_TRUE, to @b start the pulsing animation,
20827 * @c EINA_FALSE to @b stop it
20829 * @note This call won't do anything if @p obj is not under "pulsing mode".
20831 * @see elm_progressbar_pulse_set() for more details.
20833 * @ingroup Progressbar
20835 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20838 * Set the progress value (in percentage) on a given progress bar
20841 * @param obj The progress bar object
20842 * @param val The progress value (@b must be between @c 0.0 and @c
20845 * Use this call to set progress bar levels.
20847 * @note If you passes a value out of the specified range for @p
20848 * val, it will be interpreted as the @b closest of the @b boundary
20849 * values in the range.
20851 * @ingroup Progressbar
20853 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
20856 * Get the progress value (in percentage) on a given progress bar
20859 * @param obj The progress bar object
20860 * @return The value of the progressbar
20862 * @see elm_progressbar_value_set() for more details
20864 * @ingroup Progressbar
20866 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20869 * Set the label of a given progress bar widget
20871 * @param obj The progress bar object
20872 * @param label The text label string, in UTF-8
20874 * @ingroup Progressbar
20875 * @deprecated use elm_object_text_set() instead.
20877 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20880 * Get the label of a given progress bar widget
20882 * @param obj The progressbar object
20883 * @return The text label string, in UTF-8
20885 * @ingroup Progressbar
20886 * @deprecated use elm_object_text_set() instead.
20888 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20891 * Set the icon object of a given progress bar widget
20893 * @param obj The progress bar object
20894 * @param icon The icon object
20896 * Use this call to decorate @p obj with an icon next to it.
20898 * @note Once the icon object is set, a previously set one will be
20899 * deleted. If you want to keep that old content object, use the
20900 * elm_progressbar_icon_unset() function.
20902 * @see elm_progressbar_icon_get()
20904 * @ingroup Progressbar
20906 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20909 * Retrieve the icon object set for a given progress bar widget
20911 * @param obj The progress bar object
20912 * @return The icon object's handle, if @p obj had one set, or @c NULL,
20913 * otherwise (and on errors)
20915 * @see elm_progressbar_icon_set() for more details
20917 * @ingroup Progressbar
20919 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20922 * Unset an icon set on a given progress bar widget
20924 * @param obj The progress bar object
20925 * @return The icon object that was being used, if any was set, or
20926 * @c NULL, otherwise (and on errors)
20928 * This call will unparent and return the icon object which was set
20929 * for this widget, previously, on success.
20931 * @see elm_progressbar_icon_set() for more details
20933 * @ingroup Progressbar
20935 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20938 * Set the (exact) length of the bar region of a given progress bar
20941 * @param obj The progress bar object
20942 * @param size The length of the progress bar's bar region
20944 * This sets the minimum width (when in horizontal mode) or height
20945 * (when in vertical mode) of the actual bar area of the progress
20946 * bar @p obj. This in turn affects the object's minimum size. Use
20947 * this when you're not setting other size hints expanding on the
20948 * given direction (like weight and alignment hints) and you would
20949 * like it to have a specific size.
20951 * @note Icon, label and unit text around @p obj will require their
20952 * own space, which will make @p obj to require more the @p size,
20955 * @see elm_progressbar_span_size_get()
20957 * @ingroup Progressbar
20959 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
20962 * Get the length set for the bar region of a given progress bar
20965 * @param obj The progress bar object
20966 * @return The length of the progress bar's bar region
20968 * If that size was not set previously, with
20969 * elm_progressbar_span_size_set(), this call will return @c 0.
20971 * @ingroup Progressbar
20973 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20976 * Set the format string for a given progress bar widget's units
20979 * @param obj The progress bar object
20980 * @param format The format string for @p obj's units label
20982 * If @c NULL is passed on @p format, it will make @p obj's units
20983 * area to be hidden completely. If not, it'll set the <b>format
20984 * string</b> for the units label's @b text. The units label is
20985 * provided a floating point value, so the units text is up display
20986 * at most one floating point falue. Note that the units label is
20987 * optional. Use a format string such as "%1.2f meters" for
20990 * @note The default format string for a progress bar is an integer
20991 * percentage, as in @c "%.0f %%".
20993 * @see elm_progressbar_unit_format_get()
20995 * @ingroup Progressbar
20997 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21000 * Retrieve the format string set for a given progress bar widget's
21003 * @param obj The progress bar object
21004 * @return The format set string for @p obj's units label or
21005 * @c NULL, if none was set (and on errors)
21007 * @see elm_progressbar_unit_format_set() for more details
21009 * @ingroup Progressbar
21011 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21014 * Set the orientation of a given progress bar widget
21016 * @param obj The progress bar object
21017 * @param horizontal Use @c EINA_TRUE to make @p obj to be
21018 * @b horizontal, @c EINA_FALSE to make it @b vertical
21020 * Use this function to change how your progress bar is to be
21021 * disposed: vertically or horizontally.
21023 * @see elm_progressbar_horizontal_get()
21025 * @ingroup Progressbar
21027 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21030 * Retrieve the orientation of a given progress bar widget
21032 * @param obj The progress bar object
21033 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21034 * @c EINA_FALSE if it's @b vertical (and on errors)
21036 * @see elm_progressbar_horizontal_set() for more details
21038 * @ingroup Progressbar
21040 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21043 * Invert a given progress bar widget's displaying values order
21045 * @param obj The progress bar object
21046 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21047 * @c EINA_FALSE to bring it back to default, non-inverted values.
21049 * A progress bar may be @b inverted, in which state it gets its
21050 * values inverted, with high values being on the left or top and
21051 * low values on the right or bottom, as opposed to normally have
21052 * the low values on the former and high values on the latter,
21053 * respectively, for horizontal and vertical modes.
21055 * @see elm_progressbar_inverted_get()
21057 * @ingroup Progressbar
21059 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21062 * Get whether a given progress bar widget's displaying values are
21065 * @param obj The progress bar object
21066 * @return @c EINA_TRUE, if @p obj has inverted values,
21067 * @c EINA_FALSE otherwise (and on errors)
21069 * @see elm_progressbar_inverted_set() for more details
21071 * @ingroup Progressbar
21073 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21076 * @defgroup Separator Separator
21078 * @brief Separator is a very thin object used to separate other objects.
21080 * A separator can be vertical or horizontal.
21082 * @ref tutorial_separator is a good example of how to use a separator.
21086 * @brief Add a separator object to @p parent
21088 * @param parent The parent object
21090 * @return The separator object, or NULL upon failure
21092 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21094 * @brief Set the horizontal mode of a separator object
21096 * @param obj The separator object
21097 * @param horizontal If true, the separator is horizontal
21099 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21101 * @brief Get the horizontal mode of a separator object
21103 * @param obj The separator object
21104 * @return If true, the separator is horizontal
21106 * @see elm_separator_horizontal_set()
21108 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21114 * @defgroup Spinner Spinner
21115 * @ingroup Elementary
21117 * @image html img/widget/spinner/preview-00.png
21118 * @image latex img/widget/spinner/preview-00.eps
21120 * A spinner is a widget which allows the user to increase or decrease
21121 * numeric values using arrow buttons, or edit values directly, clicking
21122 * over it and typing the new value.
21124 * By default the spinner will not wrap and has a label
21125 * of "%.0f" (just showing the integer value of the double).
21127 * A spinner has a label that is formatted with floating
21128 * point values and thus accepts a printf-style format string, like
21131 * It also allows specific values to be replaced by pre-defined labels.
21133 * Smart callbacks one can register to:
21135 * - "changed" - Whenever the spinner value is changed.
21136 * - "delay,changed" - A short time after the value is changed by the user.
21137 * This will be called only when the user stops dragging for a very short
21138 * period or when they release their finger/mouse, so it avoids possibly
21139 * expensive reactions to the value change.
21141 * Available styles for it:
21143 * - @c "vertical": up/down buttons at the right side and text left aligned.
21145 * Here is an example on its usage:
21146 * @ref spinner_example
21150 * @addtogroup Spinner
21155 * Add a new spinner widget to the given parent Elementary
21156 * (container) object.
21158 * @param parent The parent object.
21159 * @return a new spinner widget handle or @c NULL, on errors.
21161 * This function inserts a new spinner widget on the canvas.
21166 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21169 * Set the format string of the displayed label.
21171 * @param obj The spinner object.
21172 * @param fmt The format string for the label display.
21174 * If @c NULL, this sets the format to "%.0f". If not it sets the format
21175 * string for the label text. The label text is provided a floating point
21176 * value, so the label text can display up to 1 floating point value.
21177 * Note that this is optional.
21179 * Use a format string such as "%1.2f meters" for example, and it will
21180 * display values like: "3.14 meters" for a value equal to 3.14159.
21182 * Default is "%0.f".
21184 * @see elm_spinner_label_format_get()
21188 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21191 * Get the label format of the spinner.
21193 * @param obj The spinner object.
21194 * @return The text label format string in UTF-8.
21196 * @see elm_spinner_label_format_set() for details.
21200 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21203 * Set the minimum and maximum values for the spinner.
21205 * @param obj The spinner object.
21206 * @param min The minimum value.
21207 * @param max The maximum value.
21209 * Define the allowed range of values to be selected by the user.
21211 * If actual value is less than @p min, it will be updated to @p min. If it
21212 * is bigger then @p max, will be updated to @p max. Actual value can be
21213 * get with elm_spinner_value_get().
21215 * By default, min is equal to 0, and max is equal to 100.
21217 * @warning Maximum must be greater than minimum.
21219 * @see elm_spinner_min_max_get()
21223 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21226 * Get the minimum and maximum values of the spinner.
21228 * @param obj The spinner object.
21229 * @param min Pointer where to store the minimum value.
21230 * @param max Pointer where to store the maximum value.
21232 * @note If only one value is needed, the other pointer can be passed
21235 * @see elm_spinner_min_max_set() for details.
21239 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21242 * Set the step used to increment or decrement the spinner value.
21244 * @param obj The spinner object.
21245 * @param step The step value.
21247 * This value will be incremented or decremented to the displayed value.
21248 * It will be incremented while the user keep right or top arrow pressed,
21249 * and will be decremented while the user keep left or bottom arrow pressed.
21251 * The interval to increment / decrement can be set with
21252 * elm_spinner_interval_set().
21254 * By default step value is equal to 1.
21256 * @see elm_spinner_step_get()
21260 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21263 * Get the step used to increment or decrement the spinner value.
21265 * @param obj The spinner object.
21266 * @return The step value.
21268 * @see elm_spinner_step_get() for more details.
21272 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21275 * Set the value the spinner displays.
21277 * @param obj The spinner object.
21278 * @param val The value to be displayed.
21280 * Value will be presented on the label following format specified with
21281 * elm_spinner_format_set().
21283 * @warning The value must to be between min and max values. This values
21284 * are set by elm_spinner_min_max_set().
21286 * @see elm_spinner_value_get().
21287 * @see elm_spinner_format_set().
21288 * @see elm_spinner_min_max_set().
21292 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21295 * Get the value displayed by the spinner.
21297 * @param obj The spinner object.
21298 * @return The value displayed.
21300 * @see elm_spinner_value_set() for details.
21304 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21307 * Set whether the spinner should wrap when it reaches its
21308 * minimum or maximum value.
21310 * @param obj The spinner object.
21311 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21314 * Disabled by default. If disabled, when the user tries to increment the
21316 * but displayed value plus step value is bigger than maximum value,
21318 * won't allow it. The same happens when the user tries to decrement it,
21319 * but the value less step is less than minimum value.
21321 * When wrap is enabled, in such situations it will allow these changes,
21322 * but will get the value that would be less than minimum and subtracts
21323 * from maximum. Or add the value that would be more than maximum to
21327 * @li min value = 10
21328 * @li max value = 50
21329 * @li step value = 20
21330 * @li displayed value = 20
21332 * When the user decrement value (using left or bottom arrow), it will
21333 * displays @c 40, because max - (min - (displayed - step)) is
21334 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21336 * @see elm_spinner_wrap_get().
21340 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21343 * Get whether the spinner should wrap when it reaches its
21344 * minimum or maximum value.
21346 * @param obj The spinner object
21347 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21348 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21350 * @see elm_spinner_wrap_set() for details.
21354 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21357 * Set whether the spinner can be directly edited by the user or not.
21359 * @param obj The spinner object.
21360 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21361 * don't allow users to edit it directly.
21363 * Spinner objects can have edition @b disabled, in which state they will
21364 * be changed only by arrows.
21365 * Useful for contexts
21366 * where you don't want your users to interact with it writting the value.
21368 * when using special values, the user can see real value instead
21369 * of special label on edition.
21371 * It's enabled by default.
21373 * @see elm_spinner_editable_get()
21377 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21380 * Get whether the spinner can be directly edited by the user or not.
21382 * @param obj The spinner object.
21383 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21384 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21386 * @see elm_spinner_editable_set() for details.
21390 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21393 * Set a special string to display in the place of the numerical value.
21395 * @param obj The spinner object.
21396 * @param value The value to be replaced.
21397 * @param label The label to be used.
21399 * It's useful for cases when a user should select an item that is
21400 * better indicated by a label than a value. For example, weekdays or months.
21404 * sp = elm_spinner_add(win);
21405 * elm_spinner_min_max_set(sp, 1, 3);
21406 * elm_spinner_special_value_add(sp, 1, "January");
21407 * elm_spinner_special_value_add(sp, 2, "February");
21408 * elm_spinner_special_value_add(sp, 3, "March");
21409 * evas_object_show(sp);
21414 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21417 * Set the interval on time updates for an user mouse button hold
21418 * on spinner widgets' arrows.
21420 * @param obj The spinner object.
21421 * @param interval The (first) interval value in seconds.
21423 * This interval value is @b decreased while the user holds the
21424 * mouse pointer either incrementing or decrementing spinner's value.
21426 * This helps the user to get to a given value distant from the
21427 * current one easier/faster, as it will start to change quicker and
21428 * quicker on mouse button holds.
21430 * The calculation for the next change interval value, starting from
21431 * the one set with this call, is the previous interval divided by
21432 * @c 1.05, so it decreases a little bit.
21434 * The default starting interval value for automatic changes is
21437 * @see elm_spinner_interval_get()
21441 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21444 * Get the interval on time updates for an user mouse button hold
21445 * on spinner widgets' arrows.
21447 * @param obj The spinner object.
21448 * @return The (first) interval value, in seconds, set on it.
21450 * @see elm_spinner_interval_set() for more details.
21454 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21461 * @defgroup Index Index
21463 * @image html img/widget/index/preview-00.png
21464 * @image latex img/widget/index/preview-00.eps
21466 * An index widget gives you an index for fast access to whichever
21467 * group of other UI items one might have. It's a list of text
21468 * items (usually letters, for alphabetically ordered access).
21470 * Index widgets are by default hidden and just appear when the
21471 * user clicks over it's reserved area in the canvas. In its
21472 * default theme, it's an area one @ref Fingers "finger" wide on
21473 * the right side of the index widget's container.
21475 * When items on the index are selected, smart callbacks get
21476 * called, so that its user can make other container objects to
21477 * show a given area or child object depending on the index item
21478 * selected. You'd probably be using an index together with @ref
21479 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21482 * Smart events one can add callbacks for are:
21483 * - @c "changed" - When the selected index item changes. @c
21484 * event_info is the selected item's data pointer.
21485 * - @c "delay,changed" - When the selected index item changes, but
21486 * after a small idling period. @c event_info is the selected
21487 * item's data pointer.
21488 * - @c "selected" - When the user releases a mouse button and
21489 * selects an item. @c event_info is the selected item's data
21491 * - @c "level,up" - when the user moves a finger from the first
21492 * level to the second level
21493 * - @c "level,down" - when the user moves a finger from the second
21494 * level to the first level
21496 * The @c "delay,changed" event is so that it'll wait a small time
21497 * before actually reporting those events and, moreover, just the
21498 * last event happening on those time frames will actually be
21501 * Here are some examples on its usage:
21502 * @li @ref index_example_01
21503 * @li @ref index_example_02
21507 * @addtogroup Index
21511 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21514 * Add a new index widget to the given parent Elementary
21515 * (container) object
21517 * @param parent The parent object
21518 * @return a new index widget handle or @c NULL, on errors
21520 * This function inserts a new index widget on the canvas.
21524 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21527 * Set whether a given index widget is or not visible,
21530 * @param obj The index object
21531 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21533 * Not to be confused with visible as in @c evas_object_show() --
21534 * visible with regard to the widget's auto hiding feature.
21536 * @see elm_index_active_get()
21540 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21543 * Get whether a given index widget is currently visible or not.
21545 * @param obj The index object
21546 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21548 * @see elm_index_active_set() for more details
21552 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21555 * Set the items level for a given index widget.
21557 * @param obj The index object.
21558 * @param level @c 0 or @c 1, the currently implemented levels.
21560 * @see elm_index_item_level_get()
21564 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21567 * Get the items level set for a given index widget.
21569 * @param obj The index object.
21570 * @return @c 0 or @c 1, which are the levels @p obj might be at.
21572 * @see elm_index_item_level_set() for more information
21576 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21579 * Returns the last selected item's data, for a given index widget.
21581 * @param obj The index object.
21582 * @return The item @b data associated to the last selected item on
21583 * @p obj (or @c NULL, on errors).
21585 * @warning The returned value is @b not an #Elm_Index_Item item
21586 * handle, but the data associated to it (see the @c item parameter
21587 * in elm_index_item_append(), as an example).
21591 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21594 * Append a new item on a given index widget.
21596 * @param obj The index object.
21597 * @param letter Letter under which the item should be indexed
21598 * @param item The item data to set for the index's item
21600 * Despite the most common usage of the @p letter argument is for
21601 * single char strings, one could use arbitrary strings as index
21604 * @c item will be the pointer returned back on @c "changed", @c
21605 * "delay,changed" and @c "selected" smart events.
21609 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21612 * Prepend a new item on a given index widget.
21614 * @param obj The index object.
21615 * @param letter Letter under which the item should be indexed
21616 * @param item The item data to set for the index's item
21618 * Despite the most common usage of the @p letter argument is for
21619 * single char strings, one could use arbitrary strings as index
21622 * @c item will be the pointer returned back on @c "changed", @c
21623 * "delay,changed" and @c "selected" smart events.
21627 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21630 * Append a new item, on a given index widget, <b>after the item
21631 * having @p relative as data</b>.
21633 * @param obj The index object.
21634 * @param letter Letter under which the item should be indexed
21635 * @param item The item data to set for the index's item
21636 * @param relative The item data of the index item to be the
21637 * predecessor of this new one
21639 * Despite the most common usage of the @p letter argument is for
21640 * single char strings, one could use arbitrary strings as index
21643 * @c item will be the pointer returned back on @c "changed", @c
21644 * "delay,changed" and @c "selected" smart events.
21646 * @note If @p relative is @c NULL or if it's not found to be data
21647 * set on any previous item on @p obj, this function will behave as
21648 * elm_index_item_append().
21652 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21655 * Prepend a new item, on a given index widget, <b>after the item
21656 * having @p relative as data</b>.
21658 * @param obj The index object.
21659 * @param letter Letter under which the item should be indexed
21660 * @param item The item data to set for the index's item
21661 * @param relative The item data of the index item to be the
21662 * successor of this new one
21664 * Despite the most common usage of the @p letter argument is for
21665 * single char strings, one could use arbitrary strings as index
21668 * @c item will be the pointer returned back on @c "changed", @c
21669 * "delay,changed" and @c "selected" smart events.
21671 * @note If @p relative is @c NULL or if it's not found to be data
21672 * set on any previous item on @p obj, this function will behave as
21673 * elm_index_item_prepend().
21677 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21680 * Insert a new item into the given index widget, using @p cmp_func
21681 * function to sort items (by item handles).
21683 * @param obj The index object.
21684 * @param letter Letter under which the item should be indexed
21685 * @param item The item data to set for the index's item
21686 * @param cmp_func The comparing function to be used to sort index
21687 * items <b>by #Elm_Index_Item item handles</b>
21688 * @param cmp_data_func A @b fallback function to be called for the
21689 * sorting of index items <b>by item data</b>). It will be used
21690 * when @p cmp_func returns @c 0 (equality), which means an index
21691 * item with provided item data already exists. To decide which
21692 * data item should be pointed to by the index item in question, @p
21693 * cmp_data_func will be used. If @p cmp_data_func returns a
21694 * non-negative value, the previous index item data will be
21695 * replaced by the given @p item pointer. If the previous data need
21696 * to be freed, it should be done by the @p cmp_data_func function,
21697 * because all references to it will be lost. If this function is
21698 * not provided (@c NULL is given), index items will be @b
21699 * duplicated, if @p cmp_func returns @c 0.
21701 * Despite the most common usage of the @p letter argument is for
21702 * single char strings, one could use arbitrary strings as index
21705 * @c item will be the pointer returned back on @c "changed", @c
21706 * "delay,changed" and @c "selected" smart events.
21710 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);
21713 * Remove an item from a given index widget, <b>to be referenced by
21714 * it's data value</b>.
21716 * @param obj The index object
21717 * @param item The item's data pointer for the item to be removed
21720 * If a deletion callback is set, via elm_index_item_del_cb_set(),
21721 * that callback function will be called by this one.
21723 * @warning The item to be removed from @p obj will be found via
21724 * its item data pointer, and not by an #Elm_Index_Item handle.
21728 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21731 * Find a given index widget's item, <b>using item data</b>.
21733 * @param obj The index object
21734 * @param item The item data pointed to by the desired index item
21735 * @return The index item handle, if found, or @c NULL otherwise
21739 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21742 * Removes @b all items from a given index widget.
21744 * @param obj The index object.
21746 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
21747 * that callback function will be called for each item in @p obj.
21751 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21754 * Go to a given items level on a index widget
21756 * @param obj The index object
21757 * @param level The index level (one of @c 0 or @c 1)
21761 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21764 * Return the data associated with a given index widget item
21766 * @param it The index widget item handle
21767 * @return The data associated with @p it
21769 * @see elm_index_item_data_set()
21773 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21776 * Set the data associated with a given index widget item
21778 * @param it The index widget item handle
21779 * @param data The new data pointer to set to @p it
21781 * This sets new item data on @p it.
21783 * @warning The old data pointer won't be touched by this function, so
21784 * the user had better to free that old data himself/herself.
21788 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
21791 * Set the function to be called when a given index widget item is freed.
21793 * @param it The item to set the callback on
21794 * @param func The function to call on the item's deletion
21796 * When called, @p func will have both @c data and @c event_info
21797 * arguments with the @p it item's data value and, naturally, the
21798 * @c obj argument with a handle to the parent index widget.
21802 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
21805 * Get the letter (string) set on a given index widget item.
21807 * @param it The index item handle
21808 * @return The letter string set on @p it
21812 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21819 * @defgroup Photocam Photocam
21821 * @image html img/widget/photocam/preview-00.png
21822 * @image latex img/widget/photocam/preview-00.eps
21824 * This is a widget specifically for displaying high-resolution digital
21825 * camera photos giving speedy feedback (fast load), low memory footprint
21826 * and zooming and panning as well as fitting logic. It is entirely focused
21827 * on jpeg images, and takes advantage of properties of the jpeg format (via
21828 * evas loader features in the jpeg loader).
21830 * Signals that you can add callbacks for are:
21831 * @li "clicked" - This is called when a user has clicked the photo without
21833 * @li "press" - This is called when a user has pressed down on the photo.
21834 * @li "longpressed" - This is called when a user has pressed down on the
21835 * photo for a long time without dragging around.
21836 * @li "clicked,double" - This is called when a user has double-clicked the
21838 * @li "load" - Photo load begins.
21839 * @li "loaded" - This is called when the image file load is complete for the
21840 * first view (low resolution blurry version).
21841 * @li "load,detail" - Photo detailed data load begins.
21842 * @li "loaded,detail" - This is called when the image file load is complete
21843 * for the detailed image data (full resolution needed).
21844 * @li "zoom,start" - Zoom animation started.
21845 * @li "zoom,stop" - Zoom animation stopped.
21846 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
21847 * @li "scroll" - the content has been scrolled (moved)
21848 * @li "scroll,anim,start" - scrolling animation has started
21849 * @li "scroll,anim,stop" - scrolling animation has stopped
21850 * @li "scroll,drag,start" - dragging the contents around has started
21851 * @li "scroll,drag,stop" - dragging the contents around has stopped
21853 * @ref tutorial_photocam shows the API in action.
21857 * @brief Types of zoom available.
21859 typedef enum _Elm_Photocam_Zoom_Mode
21861 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
21862 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
21863 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
21864 ELM_PHOTOCAM_ZOOM_MODE_LAST
21865 } Elm_Photocam_Zoom_Mode;
21867 * @brief Add a new Photocam object
21869 * @param parent The parent object
21870 * @return The new object or NULL if it cannot be created
21872 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21874 * @brief Set the photo file to be shown
21876 * @param obj The photocam object
21877 * @param file The photo file
21878 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
21880 * This sets (and shows) the specified file (with a relative or absolute
21881 * path) and will return a load error (same error that
21882 * evas_object_image_load_error_get() will return). The image will change and
21883 * adjust its size at this point and begin a background load process for this
21884 * photo that at some time in the future will be displayed at the full
21887 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
21889 * @brief Returns the path of the current image file
21891 * @param obj The photocam object
21892 * @return Returns the path
21894 * @see elm_photocam_file_set()
21896 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21898 * @brief Set the zoom level of the photo
21900 * @param obj The photocam object
21901 * @param zoom The zoom level to set
21903 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
21904 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
21905 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
21906 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
21909 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
21911 * @brief Get the zoom level of the photo
21913 * @param obj The photocam object
21914 * @return The current zoom level
21916 * This returns the current zoom level of the photocam object. Note that if
21917 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
21918 * (which is the default), the zoom level may be changed at any time by the
21919 * photocam object itself to account for photo size and photocam viewpoer
21922 * @see elm_photocam_zoom_set()
21923 * @see elm_photocam_zoom_mode_set()
21925 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21927 * @brief Set the zoom mode
21929 * @param obj The photocam object
21930 * @param mode The desired mode
21932 * This sets the zoom mode to manual or one of several automatic levels.
21933 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
21934 * elm_photocam_zoom_set() and will stay at that level until changed by code
21935 * or until zoom mode is changed. This is the default mode. The Automatic
21936 * modes will allow the photocam object to automatically adjust zoom mode
21937 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
21938 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
21939 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
21940 * pixels within the frame are left unfilled.
21942 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
21944 * @brief Get the zoom mode
21946 * @param obj The photocam object
21947 * @return The current zoom mode
21949 * This gets the current zoom mode of the photocam object.
21951 * @see elm_photocam_zoom_mode_set()
21953 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21955 * @brief Get the current image pixel width and height
21957 * @param obj The photocam object
21958 * @param w A pointer to the width return
21959 * @param h A pointer to the height return
21961 * This gets the current photo pixel width and height (for the original).
21962 * The size will be returned in the integers @p w and @p h that are pointed
21965 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
21967 * @brief Get the area of the image that is currently shown
21970 * @param x A pointer to the X-coordinate of region
21971 * @param y A pointer to the Y-coordinate of region
21972 * @param w A pointer to the width
21973 * @param h A pointer to the height
21975 * @see elm_photocam_image_region_show()
21976 * @see elm_photocam_image_region_bring_in()
21978 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
21980 * @brief Set the viewed portion of the image
21982 * @param obj The photocam object
21983 * @param x X-coordinate of region in image original pixels
21984 * @param y Y-coordinate of region in image original pixels
21985 * @param w Width of region in image original pixels
21986 * @param h Height of region in image original pixels
21988 * This shows the region of the image without using animation.
21990 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
21992 * @brief Bring in the viewed portion of the image
21994 * @param obj The photocam object
21995 * @param x X-coordinate of region in image original pixels
21996 * @param y Y-coordinate of region in image original pixels
21997 * @param w Width of region in image original pixels
21998 * @param h Height of region in image original pixels
22000 * This shows the region of the image using animation.
22002 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22004 * @brief Set the paused state for photocam
22006 * @param obj The photocam object
22007 * @param paused The pause state to set
22009 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22010 * photocam. The default is off. This will stop zooming using animation on
22011 * zoom levels changes and change instantly. This will stop any existing
22012 * animations that are running.
22014 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22016 * @brief Get the paused state for photocam
22018 * @param obj The photocam object
22019 * @return The current paused state
22021 * This gets the current paused state for the photocam object.
22023 * @see elm_photocam_paused_set()
22025 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22027 * @brief Get the internal low-res image used for photocam
22029 * @param obj The photocam object
22030 * @return The internal image object handle, or NULL if none exists
22032 * This gets the internal image object inside photocam. Do not modify it. It
22033 * is for inspection only, and hooking callbacks to. Nothing else. It may be
22034 * deleted at any time as well.
22036 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22038 * @brief Set the photocam scrolling bouncing.
22040 * @param obj The photocam object
22041 * @param h_bounce bouncing for horizontal
22042 * @param v_bounce bouncing for vertical
22044 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22046 * @brief Get the photocam scrolling bouncing.
22048 * @param obj The photocam object
22049 * @param h_bounce bouncing for horizontal
22050 * @param v_bounce bouncing for vertical
22052 * @see elm_photocam_bounce_set()
22054 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22060 * @defgroup Map Map
22061 * @ingroup Elementary
22063 * @image html img/widget/map/preview-00.png
22064 * @image latex img/widget/map/preview-00.eps
22066 * This is a widget specifically for displaying a map. It uses basically
22067 * OpenStreetMap provider http://www.openstreetmap.org/,
22068 * but custom providers can be added.
22070 * It supports some basic but yet nice features:
22071 * @li zoom and scroll
22072 * @li markers with content to be displayed when user clicks over it
22073 * @li group of markers
22076 * Smart callbacks one can listen to:
22078 * - "clicked" - This is called when a user has clicked the map without
22080 * - "press" - This is called when a user has pressed down on the map.
22081 * - "longpressed" - This is called when a user has pressed down on the map
22082 * for a long time without dragging around.
22083 * - "clicked,double" - This is called when a user has double-clicked
22085 * - "load,detail" - Map detailed data load begins.
22086 * - "loaded,detail" - This is called when all currently visible parts of
22087 * the map are loaded.
22088 * - "zoom,start" - Zoom animation started.
22089 * - "zoom,stop" - Zoom animation stopped.
22090 * - "zoom,change" - Zoom changed when using an auto zoom mode.
22091 * - "scroll" - the content has been scrolled (moved).
22092 * - "scroll,anim,start" - scrolling animation has started.
22093 * - "scroll,anim,stop" - scrolling animation has stopped.
22094 * - "scroll,drag,start" - dragging the contents around has started.
22095 * - "scroll,drag,stop" - dragging the contents around has stopped.
22096 * - "downloaded" - This is called when all currently required map images
22098 * - "route,load" - This is called when route request begins.
22099 * - "route,loaded" - This is called when route request ends.
22100 * - "name,load" - This is called when name request begins.
22101 * - "name,loaded- This is called when name request ends.
22103 * Available style for map widget:
22106 * Available style for markers:
22111 * Available style for marker bubble:
22114 * List of examples:
22115 * @li @ref map_example_01
22116 * @li @ref map_example_02
22117 * @li @ref map_example_03
22126 * @enum _Elm_Map_Zoom_Mode
22127 * @typedef Elm_Map_Zoom_Mode
22129 * Set map's zoom behavior. It can be set to manual or automatic.
22131 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22133 * Values <b> don't </b> work as bitmask, only one can be choosen.
22135 * @note Valid sizes are 2^zoom, consequently the map may be smaller
22136 * than the scroller view.
22138 * @see elm_map_zoom_mode_set()
22139 * @see elm_map_zoom_mode_get()
22143 typedef enum _Elm_Map_Zoom_Mode
22145 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22146 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22147 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22148 ELM_MAP_ZOOM_MODE_LAST
22149 } Elm_Map_Zoom_Mode;
22152 * @enum _Elm_Map_Route_Sources
22153 * @typedef Elm_Map_Route_Sources
22155 * Set route service to be used. By default used source is
22156 * #ELM_MAP_ROUTE_SOURCE_YOURS.
22158 * @see elm_map_route_source_set()
22159 * @see elm_map_route_source_get()
22163 typedef enum _Elm_Map_Route_Sources
22165 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22166 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. */
22167 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22168 ELM_MAP_ROUTE_SOURCE_LAST
22169 } Elm_Map_Route_Sources;
22171 typedef enum _Elm_Map_Name_Sources
22173 ELM_MAP_NAME_SOURCE_NOMINATIM,
22174 ELM_MAP_NAME_SOURCE_LAST
22175 } Elm_Map_Name_Sources;
22178 * @enum _Elm_Map_Route_Type
22179 * @typedef Elm_Map_Route_Type
22181 * Set type of transport used on route.
22183 * @see elm_map_route_add()
22187 typedef enum _Elm_Map_Route_Type
22189 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22190 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22191 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22192 ELM_MAP_ROUTE_TYPE_LAST
22193 } Elm_Map_Route_Type;
22196 * @enum _Elm_Map_Route_Method
22197 * @typedef Elm_Map_Route_Method
22199 * Set the routing method, what should be priorized, time or distance.
22201 * @see elm_map_route_add()
22205 typedef enum _Elm_Map_Route_Method
22207 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22208 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22209 ELM_MAP_ROUTE_METHOD_LAST
22210 } Elm_Map_Route_Method;
22212 typedef enum _Elm_Map_Name_Method
22214 ELM_MAP_NAME_METHOD_SEARCH,
22215 ELM_MAP_NAME_METHOD_REVERSE,
22216 ELM_MAP_NAME_METHOD_LAST
22217 } Elm_Map_Name_Method;
22219 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(). */
22220 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(). */
22221 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(). */
22222 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(). */
22223 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
22224 typedef struct _Elm_Map_Track Elm_Map_Track;
22226 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. */
22227 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22228 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22229 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22231 typedef char *(*ElmMapModuleSourceFunc) (void);
22232 typedef int (*ElmMapModuleZoomMinFunc) (void);
22233 typedef int (*ElmMapModuleZoomMaxFunc) (void);
22234 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22235 typedef int (*ElmMapModuleRouteSourceFunc) (void);
22236 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22237 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22238 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22239 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22242 * Add a new map widget to the given parent Elementary (container) object.
22244 * @param parent The parent object.
22245 * @return a new map widget handle or @c NULL, on errors.
22247 * This function inserts a new map widget on the canvas.
22251 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22254 * Set the zoom level of the map.
22256 * @param obj The map object.
22257 * @param zoom The zoom level to set.
22259 * This sets the zoom level.
22261 * It will respect limits defined by elm_map_source_zoom_min_set() and
22262 * elm_map_source_zoom_max_set().
22264 * By default these values are 0 (world map) and 18 (maximum zoom).
22266 * This function should be used when zoom mode is set to
22267 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22268 * with elm_map_zoom_mode_set().
22270 * @see elm_map_zoom_mode_set().
22271 * @see elm_map_zoom_get().
22275 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22278 * Get the zoom level of the map.
22280 * @param obj The map object.
22281 * @return The current zoom level.
22283 * This returns the current zoom level of the map object.
22285 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22286 * (which is the default), the zoom level may be changed at any time by the
22287 * map object itself to account for map size and map viewport size.
22289 * @see elm_map_zoom_set() for details.
22293 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22296 * Set the zoom mode used by the map object.
22298 * @param obj The map object.
22299 * @param mode The zoom mode of the map, being it one of
22300 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22301 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22303 * This sets the zoom mode to manual or one of the automatic levels.
22304 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22305 * elm_map_zoom_set() and will stay at that level until changed by code
22306 * or until zoom mode is changed. This is the default mode.
22308 * The Automatic modes will allow the map object to automatically
22309 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22310 * adjust zoom so the map fits inside the scroll frame with no pixels
22311 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22312 * ensure no pixels within the frame are left unfilled. Do not forget that
22313 * the valid sizes are 2^zoom, consequently the map may be smaller than
22314 * the scroller view.
22316 * @see elm_map_zoom_set()
22320 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22323 * Get the zoom mode used by the map object.
22325 * @param obj The map object.
22326 * @return The zoom mode of the map, being it one of
22327 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22328 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22330 * This function returns the current zoom mode used by the map object.
22332 * @see elm_map_zoom_mode_set() for more details.
22336 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22339 * Get the current coordinates of the map.
22341 * @param obj The map object.
22342 * @param lon Pointer where to store longitude.
22343 * @param lat Pointer where to store latitude.
22345 * This gets the current center coordinates of the map object. It can be
22346 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22348 * @see elm_map_geo_region_bring_in()
22349 * @see elm_map_geo_region_show()
22353 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22356 * Animatedly bring in given coordinates to the center of the map.
22358 * @param obj The map object.
22359 * @param lon Longitude to center at.
22360 * @param lat Latitude to center at.
22362 * This causes map to jump to the given @p lat and @p lon coordinates
22363 * and show it (by scrolling) in the center of the viewport, if it is not
22364 * already centered. This will use animation to do so and take a period
22365 * of time to complete.
22367 * @see elm_map_geo_region_show() for a function to avoid animation.
22368 * @see elm_map_geo_region_get()
22372 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22375 * Show the given coordinates at the center of the map, @b immediately.
22377 * @param obj The map object.
22378 * @param lon Longitude to center at.
22379 * @param lat Latitude to center at.
22381 * This causes map to @b redraw its viewport's contents to the
22382 * region contining the given @p lat and @p lon, that will be moved to the
22383 * center of the map.
22385 * @see elm_map_geo_region_bring_in() for a function to move with animation.
22386 * @see elm_map_geo_region_get()
22390 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22393 * Pause or unpause the map.
22395 * @param obj The map object.
22396 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22399 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22402 * The default is off.
22404 * This will stop zooming using animation, changing zoom levels will
22405 * change instantly. This will stop any existing animations that are running.
22407 * @see elm_map_paused_get()
22411 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22414 * Get a value whether map is paused or not.
22416 * @param obj The map object.
22417 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22418 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22420 * This gets the current paused state for the map object.
22422 * @see elm_map_paused_set() for details.
22426 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22429 * Set to show markers during zoom level changes or not.
22431 * @param obj The map object.
22432 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22435 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22438 * The default is off.
22440 * This will stop zooming using animation, changing zoom levels will
22441 * change instantly. This will stop any existing animations that are running.
22443 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22446 * The default is off.
22448 * Enabling it will force the map to stop displaying the markers during
22449 * zoom level changes. Set to on if you have a large number of markers.
22451 * @see elm_map_paused_markers_get()
22455 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22458 * Get a value whether markers will be displayed on zoom level changes or not
22460 * @param obj The map object.
22461 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22462 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22464 * This gets the current markers paused state for the map object.
22466 * @see elm_map_paused_markers_set() for details.
22470 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22473 * Get the information of downloading status.
22475 * @param obj The map object.
22476 * @param try_num Pointer where to store number of tiles being downloaded.
22477 * @param finish_num Pointer where to store number of tiles successfully
22480 * This gets the current downloading status for the map object, the number
22481 * of tiles being downloaded and the number of tiles already downloaded.
22485 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22488 * Convert a pixel coordinate (x,y) into a geographic coordinate
22489 * (longitude, latitude).
22491 * @param obj The map object.
22492 * @param x the coordinate.
22493 * @param y the coordinate.
22494 * @param size the size in pixels of the map.
22495 * The map is a square and generally his size is : pow(2.0, zoom)*256.
22496 * @param lon Pointer where to store the longitude that correspond to x.
22497 * @param lat Pointer where to store the latitude that correspond to y.
22499 * @note Origin pixel point is the top left corner of the viewport.
22500 * Map zoom and size are taken on account.
22502 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22506 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);
22509 * Convert a geographic coordinate (longitude, latitude) into a pixel
22510 * coordinate (x, y).
22512 * @param obj The map object.
22513 * @param lon the longitude.
22514 * @param lat the latitude.
22515 * @param size the size in pixels of the map. The map is a square
22516 * and generally his size is : pow(2.0, zoom)*256.
22517 * @param x Pointer where to store the horizontal pixel coordinate that
22518 * correspond to the longitude.
22519 * @param y Pointer where to store the vertical pixel coordinate that
22520 * correspond to the latitude.
22522 * @note Origin pixel point is the top left corner of the viewport.
22523 * Map zoom and size are taken on account.
22525 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22529 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);
22532 * Convert a geographic coordinate (longitude, latitude) into a name
22535 * @param obj The map object.
22536 * @param lon the longitude.
22537 * @param lat the latitude.
22538 * @return name A #Elm_Map_Name handle for this coordinate.
22540 * To get the string for this address, elm_map_name_address_get()
22543 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22547 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22550 * Convert a name (address) into a geographic coordinate
22551 * (longitude, latitude).
22553 * @param obj The map object.
22554 * @param name The address.
22555 * @return name A #Elm_Map_Name handle for this address.
22557 * To get the longitude and latitude, elm_map_name_region_get()
22560 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22564 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22567 * Convert a pixel coordinate into a rotated pixel coordinate.
22569 * @param obj The map object.
22570 * @param x horizontal coordinate of the point to rotate.
22571 * @param y vertical coordinate of the point to rotate.
22572 * @param cx rotation's center horizontal position.
22573 * @param cy rotation's center vertical position.
22574 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22575 * @param xx Pointer where to store rotated x.
22576 * @param yy Pointer where to store rotated y.
22580 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);
22583 * Add a new marker to the map object.
22585 * @param obj The map object.
22586 * @param lon The longitude of the marker.
22587 * @param lat The latitude of the marker.
22588 * @param clas The class, to use when marker @b isn't grouped to others.
22589 * @param clas_group The class group, to use when marker is grouped to others
22590 * @param data The data passed to the callbacks.
22592 * @return The created marker or @c NULL upon failure.
22594 * A marker will be created and shown in a specific point of the map, defined
22595 * by @p lon and @p lat.
22597 * It will be displayed using style defined by @p class when this marker
22598 * is displayed alone (not grouped). A new class can be created with
22599 * elm_map_marker_class_new().
22601 * If the marker is grouped to other markers, it will be displayed with
22602 * style defined by @p class_group. Markers with the same group are grouped
22603 * if they are close. A new group class can be created with
22604 * elm_map_marker_group_class_new().
22606 * Markers created with this method can be deleted with
22607 * elm_map_marker_remove().
22609 * A marker can have associated content to be displayed by a bubble,
22610 * when a user click over it, as well as an icon. These objects will
22611 * be fetch using class' callback functions.
22613 * @see elm_map_marker_class_new()
22614 * @see elm_map_marker_group_class_new()
22615 * @see elm_map_marker_remove()
22619 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);
22622 * Set the maximum numbers of markers' content to be displayed in a group.
22624 * @param obj The map object.
22625 * @param max The maximum numbers of items displayed in a bubble.
22627 * A bubble will be displayed when the user clicks over the group,
22628 * and will place the content of markers that belong to this group
22631 * A group can have a long list of markers, consequently the creation
22632 * of the content of the bubble can be very slow.
22634 * In order to avoid this, a maximum number of items is displayed
22637 * By default this number is 30.
22639 * Marker with the same group class are grouped if they are close.
22641 * @see elm_map_marker_add()
22645 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
22648 * Remove a marker from the map.
22650 * @param marker The marker to remove.
22652 * @see elm_map_marker_add()
22656 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22659 * Get the current coordinates of the marker.
22661 * @param marker marker.
22662 * @param lat Pointer where to store the marker's latitude.
22663 * @param lon Pointer where to store the marker's longitude.
22665 * These values are set when adding markers, with function
22666 * elm_map_marker_add().
22668 * @see elm_map_marker_add()
22672 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
22675 * Animatedly bring in given marker to the center of the map.
22677 * @param marker The marker to center at.
22679 * This causes map to jump to the given @p marker's coordinates
22680 * and show it (by scrolling) in the center of the viewport, if it is not
22681 * already centered. This will use animation to do so and take a period
22682 * of time to complete.
22684 * @see elm_map_marker_show() for a function to avoid animation.
22685 * @see elm_map_marker_region_get()
22689 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22692 * Show the given marker at the center of the map, @b immediately.
22694 * @param marker The marker to center at.
22696 * This causes map to @b redraw its viewport's contents to the
22697 * region contining the given @p marker's coordinates, that will be
22698 * moved to the center of the map.
22700 * @see elm_map_marker_bring_in() for a function to move with animation.
22701 * @see elm_map_markers_list_show() if more than one marker need to be
22703 * @see elm_map_marker_region_get()
22707 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22710 * Move and zoom the map to display a list of markers.
22712 * @param markers A list of #Elm_Map_Marker handles.
22714 * The map will be centered on the center point of the markers in the list.
22715 * Then the map will be zoomed in order to fit the markers using the maximum
22716 * zoom which allows display of all the markers.
22718 * @warning All the markers should belong to the same map object.
22720 * @see elm_map_marker_show() to show a single marker.
22721 * @see elm_map_marker_bring_in()
22725 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
22728 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
22730 * @param marker The marker wich content should be returned.
22731 * @return Return the evas object if it exists, else @c NULL.
22733 * To set callback function #ElmMapMarkerGetFunc for the marker class,
22734 * elm_map_marker_class_get_cb_set() should be used.
22736 * This content is what will be inside the bubble that will be displayed
22737 * when an user clicks over the marker.
22739 * This returns the actual Evas object used to be placed inside
22740 * the bubble. This may be @c NULL, as it may
22741 * not have been created or may have been deleted, at any time, by
22742 * the map. <b>Do not modify this object</b> (move, resize,
22743 * show, hide, etc.), as the map is controlling it. This
22744 * function is for querying, emitting custom signals or hooking
22745 * lower level callbacks for events on that object. Do not delete
22746 * this object under any circumstances.
22750 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22753 * Update the marker
22755 * @param marker The marker to be updated.
22757 * If a content is set to this marker, it will call function to delete it,
22758 * #ElmMapMarkerDelFunc, and then will fetch the content again with
22759 * #ElmMapMarkerGetFunc.
22761 * These functions are set for the marker class with
22762 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
22766 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22769 * Close all the bubbles opened by the user.
22771 * @param obj The map object.
22773 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
22774 * when the user clicks on a marker.
22776 * This functions is set for the marker class with
22777 * elm_map_marker_class_get_cb_set().
22781 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
22784 * Create a new group class.
22786 * @param obj The map object.
22787 * @return Returns the new group class.
22789 * Each marker must be associated to a group class. Markers in the same
22790 * group are grouped if they are close.
22792 * The group class defines the style of the marker when a marker is grouped
22793 * to others markers. When it is alone, another class will be used.
22795 * A group class will need to be provided when creating a marker with
22796 * elm_map_marker_add().
22798 * Some properties and functions can be set by class, as:
22799 * - style, with elm_map_group_class_style_set()
22800 * - data - to be associated to the group class. It can be set using
22801 * elm_map_group_class_data_set().
22802 * - min zoom to display markers, set with
22803 * elm_map_group_class_zoom_displayed_set().
22804 * - max zoom to group markers, set using
22805 * elm_map_group_class_zoom_grouped_set().
22806 * - visibility - set if markers will be visible or not, set with
22807 * elm_map_group_class_hide_set().
22808 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
22809 * It can be set using elm_map_group_class_icon_cb_set().
22811 * @see elm_map_marker_add()
22812 * @see elm_map_group_class_style_set()
22813 * @see elm_map_group_class_data_set()
22814 * @see elm_map_group_class_zoom_displayed_set()
22815 * @see elm_map_group_class_zoom_grouped_set()
22816 * @see elm_map_group_class_hide_set()
22817 * @see elm_map_group_class_icon_cb_set()
22821 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
22824 * Set the marker's style of a group class.
22826 * @param clas The group class.
22827 * @param style The style to be used by markers.
22829 * Each marker must be associated to a group class, and will use the style
22830 * defined by such class when grouped to other markers.
22832 * The following styles are provided by default theme:
22833 * @li @c radio - blue circle
22834 * @li @c radio2 - green circle
22837 * @see elm_map_group_class_new() for more details.
22838 * @see elm_map_marker_add()
22842 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
22845 * Set the icon callback function of a group class.
22847 * @param clas The group class.
22848 * @param icon_get The callback function that will return the icon.
22850 * Each marker must be associated to a group class, and it can display a
22851 * custom icon. The function @p icon_get must return this icon.
22853 * @see elm_map_group_class_new() for more details.
22854 * @see elm_map_marker_add()
22858 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
22861 * Set the data associated to the group class.
22863 * @param clas The group class.
22864 * @param data The new user data.
22866 * This data will be passed for callback functions, like icon get callback,
22867 * that can be set with elm_map_group_class_icon_cb_set().
22869 * If a data was previously set, the object will lose the pointer for it,
22870 * so if needs to be freed, you must do it yourself.
22872 * @see elm_map_group_class_new() for more details.
22873 * @see elm_map_group_class_icon_cb_set()
22874 * @see elm_map_marker_add()
22878 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
22881 * Set the minimum zoom from where the markers are displayed.
22883 * @param clas The group class.
22884 * @param zoom The minimum zoom.
22886 * Markers only will be displayed when the map is displayed at @p zoom
22889 * @see elm_map_group_class_new() for more details.
22890 * @see elm_map_marker_add()
22894 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
22897 * Set the zoom from where the markers are no more grouped.
22899 * @param clas The group class.
22900 * @param zoom The maximum zoom.
22902 * Markers only will be grouped when the map is displayed at
22903 * less than @p zoom.
22905 * @see elm_map_group_class_new() for more details.
22906 * @see elm_map_marker_add()
22910 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
22913 * Set if the markers associated to the group class @clas are hidden or not.
22915 * @param clas The group class.
22916 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
22919 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
22924 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
22927 * Create a new marker class.
22929 * @param obj The map object.
22930 * @return Returns the new group class.
22932 * Each marker must be associated to a class.
22934 * The marker class defines the style of the marker when a marker is
22935 * displayed alone, i.e., not grouped to to others markers. When grouped
22936 * it will use group class style.
22938 * A marker class will need to be provided when creating a marker with
22939 * elm_map_marker_add().
22941 * Some properties and functions can be set by class, as:
22942 * - style, with elm_map_marker_class_style_set()
22943 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
22944 * It can be set using elm_map_marker_class_icon_cb_set().
22945 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
22946 * Set using elm_map_marker_class_get_cb_set().
22947 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
22948 * Set using elm_map_marker_class_del_cb_set().
22950 * @see elm_map_marker_add()
22951 * @see elm_map_marker_class_style_set()
22952 * @see elm_map_marker_class_icon_cb_set()
22953 * @see elm_map_marker_class_get_cb_set()
22954 * @see elm_map_marker_class_del_cb_set()
22958 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
22961 * Set the marker's style of a marker class.
22963 * @param clas The marker class.
22964 * @param style The style to be used by markers.
22966 * Each marker must be associated to a marker class, and will use the style
22967 * defined by such class when alone, i.e., @b not grouped to other markers.
22969 * The following styles are provided by default theme:
22974 * @see elm_map_marker_class_new() for more details.
22975 * @see elm_map_marker_add()
22979 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
22982 * Set the icon callback function of a marker class.
22984 * @param clas The marker class.
22985 * @param icon_get The callback function that will return the icon.
22987 * Each marker must be associated to a marker class, and it can display a
22988 * custom icon. The function @p icon_get must return this icon.
22990 * @see elm_map_marker_class_new() for more details.
22991 * @see elm_map_marker_add()
22995 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
22998 * Set the bubble content callback function of a marker class.
23000 * @param clas The marker class.
23001 * @param get The callback function that will return the content.
23003 * Each marker must be associated to a marker class, and it can display a
23004 * a content on a bubble that opens when the user click over the marker.
23005 * The function @p get must return this content object.
23007 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23010 * @see elm_map_marker_class_new() for more details.
23011 * @see elm_map_marker_class_del_cb_set()
23012 * @see elm_map_marker_add()
23016 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23019 * Set the callback function used to delete bubble content of a marker class.
23021 * @param clas The marker class.
23022 * @param del The callback function that will delete the content.
23024 * Each marker must be associated to a marker class, and it can display a
23025 * a content on a bubble that opens when the user click over the marker.
23026 * The function to return such content can be set with
23027 * elm_map_marker_class_get_cb_set().
23029 * If this content must be freed, a callback function need to be
23030 * set for that task with this function.
23032 * If this callback is defined it will have to delete (or not) the
23033 * object inside, but if the callback is not defined the object will be
23034 * destroyed with evas_object_del().
23036 * @see elm_map_marker_class_new() for more details.
23037 * @see elm_map_marker_class_get_cb_set()
23038 * @see elm_map_marker_add()
23042 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23045 * Get the list of available sources.
23047 * @param obj The map object.
23048 * @return The source names list.
23050 * It will provide a list with all available sources, that can be set as
23051 * current source with elm_map_source_name_set(), or get with
23052 * elm_map_source_name_get().
23054 * Available sources:
23060 * @see elm_map_source_name_set() for more details.
23061 * @see elm_map_source_name_get()
23065 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23068 * Set the source of the map.
23070 * @param obj The map object.
23071 * @param source The source to be used.
23073 * Map widget retrieves images that composes the map from a web service.
23074 * This web service can be set with this method.
23076 * A different service can return a different maps with different
23077 * information and it can use different zoom values.
23079 * The @p source_name need to match one of the names provided by
23080 * elm_map_source_names_get().
23082 * The current source can be get using elm_map_source_name_get().
23084 * @see elm_map_source_names_get()
23085 * @see elm_map_source_name_get()
23090 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23093 * Get the name of currently used source.
23095 * @param obj The map object.
23096 * @return Returns the name of the source in use.
23098 * @see elm_map_source_name_set() for more details.
23102 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23105 * Set the source of the route service to be used by the map.
23107 * @param obj The map object.
23108 * @param source The route service to be used, being it one of
23109 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23110 * and #ELM_MAP_ROUTE_SOURCE_ORS.
23112 * Each one has its own algorithm, so the route retrieved may
23113 * differ depending on the source route. Now, only the default is working.
23115 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23116 * http://www.yournavigation.org/.
23118 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23119 * assumptions. Its routing core is based on Contraction Hierarchies.
23121 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23123 * @see elm_map_route_source_get().
23127 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23130 * Get the current route source.
23132 * @param obj The map object.
23133 * @return The source of the route service used by the map.
23135 * @see elm_map_route_source_set() for details.
23139 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23142 * Set the minimum zoom of the source.
23144 * @param obj The map object.
23145 * @param zoom New minimum zoom value to be used.
23147 * By default, it's 0.
23151 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23154 * Get the minimum zoom of the source.
23156 * @param obj The map object.
23157 * @return Returns the minimum zoom of the source.
23159 * @see elm_map_source_zoom_min_set() for details.
23163 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23166 * Set the maximum zoom of the source.
23168 * @param obj The map object.
23169 * @param zoom New maximum zoom value to be used.
23171 * By default, it's 18.
23175 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23178 * Get the maximum zoom of the source.
23180 * @param obj The map object.
23181 * @return Returns the maximum zoom of the source.
23183 * @see elm_map_source_zoom_min_set() for details.
23187 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23190 * Set the user agent used by the map object to access routing services.
23192 * @param obj The map object.
23193 * @param user_agent The user agent to be used by the map.
23195 * User agent is a client application implementing a network protocol used
23196 * in communications within a client–server distributed computing system
23198 * The @p user_agent identification string will transmitted in a header
23199 * field @c User-Agent.
23201 * @see elm_map_user_agent_get()
23205 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23208 * Get the user agent used by the map object.
23210 * @param obj The map object.
23211 * @return The user agent identification string used by the map.
23213 * @see elm_map_user_agent_set() for details.
23217 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23220 * Add a new route to the map object.
23222 * @param obj The map object.
23223 * @param type The type of transport to be considered when tracing a route.
23224 * @param method The routing method, what should be priorized.
23225 * @param flon The start longitude.
23226 * @param flat The start latitude.
23227 * @param tlon The destination longitude.
23228 * @param tlat The destination latitude.
23230 * @return The created route or @c NULL upon failure.
23232 * A route will be traced by point on coordinates (@p flat, @p flon)
23233 * to point on coordinates (@p tlat, @p tlon), using the route service
23234 * set with elm_map_route_source_set().
23236 * It will take @p type on consideration to define the route,
23237 * depending if the user will be walking or driving, the route may vary.
23238 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23239 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23241 * Another parameter is what the route should priorize, the minor distance
23242 * or the less time to be spend on the route. So @p method should be one
23243 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23245 * Routes created with this method can be deleted with
23246 * elm_map_route_remove(), colored with elm_map_route_color_set(),
23247 * and distance can be get with elm_map_route_distance_get().
23249 * @see elm_map_route_remove()
23250 * @see elm_map_route_color_set()
23251 * @see elm_map_route_distance_get()
23252 * @see elm_map_route_source_set()
23256 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);
23259 * Remove a route from the map.
23261 * @param route The route to remove.
23263 * @see elm_map_route_add()
23267 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23270 * Set the route color.
23272 * @param route The route object.
23273 * @param r Red channel value, from 0 to 255.
23274 * @param g Green channel value, from 0 to 255.
23275 * @param b Blue channel value, from 0 to 255.
23276 * @param a Alpha channel value, from 0 to 255.
23278 * It uses an additive color model, so each color channel represents
23279 * how much of each primary colors must to be used. 0 represents
23280 * ausence of this color, so if all of the three are set to 0,
23281 * the color will be black.
23283 * These component values should be integers in the range 0 to 255,
23284 * (single 8-bit byte).
23286 * This sets the color used for the route. By default, it is set to
23287 * solid red (r = 255, g = 0, b = 0, a = 255).
23289 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23291 * @see elm_map_route_color_get()
23295 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23298 * Get the route color.
23300 * @param route The route object.
23301 * @param r Pointer where to store the red channel value.
23302 * @param g Pointer where to store the green channel value.
23303 * @param b Pointer where to store the blue channel value.
23304 * @param a Pointer where to store the alpha channel value.
23306 * @see elm_map_route_color_set() for details.
23310 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23313 * Get the route distance in kilometers.
23315 * @param route The route object.
23316 * @return The distance of route (unit : km).
23320 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23323 * Get the information of route nodes.
23325 * @param route The route object.
23326 * @return Returns a string with the nodes of route.
23330 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23333 * Get the information of route waypoint.
23335 * @param route the route object.
23336 * @return Returns a string with information about waypoint of route.
23340 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23343 * Get the address of the name.
23345 * @param name The name handle.
23346 * @return Returns the address string of @p name.
23348 * This gets the coordinates of the @p name, created with one of the
23349 * conversion functions.
23351 * @see elm_map_utils_convert_name_into_coord()
23352 * @see elm_map_utils_convert_coord_into_name()
23356 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23359 * Get the current coordinates of the name.
23361 * @param name The name handle.
23362 * @param lat Pointer where to store the latitude.
23363 * @param lon Pointer where to store The longitude.
23365 * This gets the coordinates of the @p name, created with one of the
23366 * conversion functions.
23368 * @see elm_map_utils_convert_name_into_coord()
23369 * @see elm_map_utils_convert_coord_into_name()
23373 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23376 * Remove a name from the map.
23378 * @param name The name to remove.
23380 * Basically the struct handled by @p name will be freed, so convertions
23381 * between address and coordinates will be lost.
23383 * @see elm_map_utils_convert_name_into_coord()
23384 * @see elm_map_utils_convert_coord_into_name()
23388 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23393 * @param obj The map object.
23394 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23395 * @param cx Rotation's center horizontal position.
23396 * @param cy Rotation's center vertical position.
23398 * @see elm_map_rotate_get()
23402 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23405 * Get the rotate degree of the map
23407 * @param obj The map object
23408 * @param degree Pointer where to store degrees from 0.0 to 360.0
23409 * to rotate arount Z axis.
23410 * @param cx Pointer where to store rotation's center horizontal position.
23411 * @param cy Pointer where to store rotation's center vertical position.
23413 * @see elm_map_rotate_set() to set map rotation.
23417 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);
23420 * Enable or disable mouse wheel to be used to zoom in / out the map.
23422 * @param obj The map object.
23423 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23426 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23428 * It's disabled by default.
23430 * @see elm_map_wheel_disabled_get()
23434 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23437 * Get a value whether mouse wheel is enabled or not.
23439 * @param obj The map object.
23440 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23441 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23443 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23445 * @see elm_map_wheel_disabled_set() for details.
23449 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23453 * Add a track on the map
23455 * @param obj The map object.
23456 * @param emap The emap route object.
23457 * @return The route object. This is an elm object of type Route.
23459 * @see elm_route_add() for details.
23463 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23467 * Remove a track from the map
23469 * @param obj The map object.
23470 * @param route The track to remove.
23474 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23481 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23483 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23485 EAPI double elm_route_lon_min_get(Evas_Object *obj);
23486 EAPI double elm_route_lat_min_get(Evas_Object *obj);
23487 EAPI double elm_route_lon_max_get(Evas_Object *obj);
23488 EAPI double elm_route_lat_max_get(Evas_Object *obj);
23492 * @defgroup Panel Panel
23494 * @image html img/widget/panel/preview-00.png
23495 * @image latex img/widget/panel/preview-00.eps
23497 * @brief A panel is a type of animated container that contains subobjects.
23498 * It can be expanded or contracted by clicking the button on it's edge.
23500 * Orientations are as follows:
23501 * @li ELM_PANEL_ORIENT_TOP
23502 * @li ELM_PANEL_ORIENT_LEFT
23503 * @li ELM_PANEL_ORIENT_RIGHT
23505 * @ref tutorial_panel shows one way to use this widget.
23508 typedef enum _Elm_Panel_Orient
23510 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23511 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23512 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23513 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23514 } Elm_Panel_Orient;
23516 * @brief Adds a panel object
23518 * @param parent The parent object
23520 * @return The panel object, or NULL on failure
23522 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23524 * @brief Sets the orientation of the panel
23526 * @param parent The parent object
23527 * @param orient The panel orientation. Can be one of the following:
23528 * @li ELM_PANEL_ORIENT_TOP
23529 * @li ELM_PANEL_ORIENT_LEFT
23530 * @li ELM_PANEL_ORIENT_RIGHT
23532 * Sets from where the panel will (dis)appear.
23534 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23536 * @brief Get the orientation of the panel.
23538 * @param obj The panel object
23539 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23541 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23543 * @brief Set the content of the panel.
23545 * @param obj The panel object
23546 * @param content The panel content
23548 * Once the content object is set, a previously set one will be deleted.
23549 * If you want to keep that old content object, use the
23550 * elm_panel_content_unset() function.
23552 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23554 * @brief Get the content of the panel.
23556 * @param obj The panel object
23557 * @return The content that is being used
23559 * Return the content object which is set for this widget.
23561 * @see elm_panel_content_set()
23563 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23565 * @brief Unset the content of the panel.
23567 * @param obj The panel object
23568 * @return The content that was being used
23570 * Unparent and return the content object which was set for this widget.
23572 * @see elm_panel_content_set()
23574 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23576 * @brief Set the state of the panel.
23578 * @param obj The panel object
23579 * @param hidden If true, the panel will run the animation to contract
23581 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23583 * @brief Get the state of the panel.
23585 * @param obj The panel object
23586 * @param hidden If true, the panel is in the "hide" state
23588 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23590 * @brief Toggle the hidden state of the panel from code
23592 * @param obj The panel object
23594 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23600 * @defgroup Panes Panes
23601 * @ingroup Elementary
23603 * @image html img/widget/panes/preview-00.png
23604 * @image latex img/widget/panes/preview-00.eps width=\textwidth
23606 * @image html img/panes.png
23607 * @image latex img/panes.eps width=\textwidth
23609 * The panes adds a dragable bar between two contents. When dragged
23610 * this bar will resize contents size.
23612 * Panes can be displayed vertically or horizontally, and contents
23613 * size proportion can be customized (homogeneous by default).
23615 * Smart callbacks one can listen to:
23616 * - "press" - The panes has been pressed (button wasn't released yet).
23617 * - "unpressed" - The panes was released after being pressed.
23618 * - "clicked" - The panes has been clicked>
23619 * - "clicked,double" - The panes has been double clicked
23621 * Available styles for it:
23624 * Here is an example on its usage:
23625 * @li @ref panes_example
23629 * @addtogroup Panes
23634 * Add a new panes widget to the given parent Elementary
23635 * (container) object.
23637 * @param parent The parent object.
23638 * @return a new panes widget handle or @c NULL, on errors.
23640 * This function inserts a new panes widget on the canvas.
23644 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23647 * Set the left content of the panes widget.
23649 * @param obj The panes object.
23650 * @param content The new left content object.
23652 * Once the content object is set, a previously set one will be deleted.
23653 * If you want to keep that old content object, use the
23654 * elm_panes_content_left_unset() function.
23656 * If panes is displayed vertically, left content will be displayed at
23659 * @see elm_panes_content_left_get()
23660 * @see elm_panes_content_right_set() to set content on the other side.
23664 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23667 * Set the right content of the panes widget.
23669 * @param obj The panes object.
23670 * @param content The new right content object.
23672 * Once the content object is set, a previously set one will be deleted.
23673 * If you want to keep that old content object, use the
23674 * elm_panes_content_right_unset() function.
23676 * If panes is displayed vertically, left content will be displayed at
23679 * @see elm_panes_content_right_get()
23680 * @see elm_panes_content_left_set() to set content on the other side.
23684 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23687 * Get the left content of the panes.
23689 * @param obj The panes object.
23690 * @return The left content object that is being used.
23692 * Return the left content object which is set for this widget.
23694 * @see elm_panes_content_left_set() for details.
23698 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23701 * Get the right content of the panes.
23703 * @param obj The panes object
23704 * @return The right content object that is being used
23706 * Return the right content object which is set for this widget.
23708 * @see elm_panes_content_right_set() for details.
23712 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23715 * Unset the left content used for the panes.
23717 * @param obj The panes object.
23718 * @return The left content object that was being used.
23720 * Unparent and return the left content object which was set for this widget.
23722 * @see elm_panes_content_left_set() for details.
23723 * @see elm_panes_content_left_get().
23727 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23730 * Unset the right content used for the panes.
23732 * @param obj The panes object.
23733 * @return The right content object that was being used.
23735 * Unparent and return the right content object which was set for this
23738 * @see elm_panes_content_right_set() for details.
23739 * @see elm_panes_content_right_get().
23743 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23746 * Get the size proportion of panes widget's left side.
23748 * @param obj The panes object.
23749 * @return float value between 0.0 and 1.0 representing size proportion
23752 * @see elm_panes_content_left_size_set() for more details.
23756 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23759 * Set the size proportion of panes widget's left side.
23761 * @param obj The panes object.
23762 * @param size Value between 0.0 and 1.0 representing size proportion
23765 * By default it's homogeneous, i.e., both sides have the same size.
23767 * If something different is required, it can be set with this function.
23768 * For example, if the left content should be displayed over
23769 * 75% of the panes size, @p size should be passed as @c 0.75.
23770 * This way, right content will be resized to 25% of panes size.
23772 * If displayed vertically, left content is displayed at top, and
23773 * right content at bottom.
23775 * @note This proportion will change when user drags the panes bar.
23777 * @see elm_panes_content_left_size_get()
23781 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
23784 * Set the orientation of a given panes widget.
23786 * @param obj The panes object.
23787 * @param horizontal Use @c EINA_TRUE to make @p obj to be
23788 * @b horizontal, @c EINA_FALSE to make it @b vertical.
23790 * Use this function to change how your panes is to be
23791 * disposed: vertically or horizontally.
23793 * By default it's displayed horizontally.
23795 * @see elm_panes_horizontal_get()
23799 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
23802 * Retrieve the orientation of a given panes widget.
23804 * @param obj The panes object.
23805 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
23806 * @c EINA_FALSE if it's @b vertical (and on errors).
23808 * @see elm_panes_horizontal_set() for more details.
23812 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23813 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
23814 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23821 * @defgroup Flip Flip
23823 * @image html img/widget/flip/preview-00.png
23824 * @image latex img/widget/flip/preview-00.eps
23826 * This widget holds 2 content objects(Evas_Object): one on the front and one
23827 * on the back. It allows you to flip from front to back and vice-versa using
23828 * various animations.
23830 * If either the front or back contents are not set the flip will treat that
23831 * as transparent. So if you wore to set the front content but not the back,
23832 * and then call elm_flip_go() you would see whatever is below the flip.
23834 * For a list of supported animations see elm_flip_go().
23836 * Signals that you can add callbacks for are:
23837 * "animate,begin" - when a flip animation was started
23838 * "animate,done" - when a flip animation is finished
23840 * @ref tutorial_flip show how to use most of the API.
23844 typedef enum _Elm_Flip_Mode
23846 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
23847 ELM_FLIP_ROTATE_X_CENTER_AXIS,
23848 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
23849 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
23850 ELM_FLIP_CUBE_LEFT,
23851 ELM_FLIP_CUBE_RIGHT,
23853 ELM_FLIP_CUBE_DOWN,
23854 ELM_FLIP_PAGE_LEFT,
23855 ELM_FLIP_PAGE_RIGHT,
23859 typedef enum _Elm_Flip_Interaction
23861 ELM_FLIP_INTERACTION_NONE,
23862 ELM_FLIP_INTERACTION_ROTATE,
23863 ELM_FLIP_INTERACTION_CUBE,
23864 ELM_FLIP_INTERACTION_PAGE
23865 } Elm_Flip_Interaction;
23866 typedef enum _Elm_Flip_Direction
23868 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
23869 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
23870 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
23871 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
23872 } Elm_Flip_Direction;
23874 * @brief Add a new flip to the parent
23876 * @param parent The parent object
23877 * @return The new object or NULL if it cannot be created
23879 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23881 * @brief Set the front content of the flip widget.
23883 * @param obj The flip object
23884 * @param content The new front content object
23886 * Once the content object is set, a previously set one will be deleted.
23887 * If you want to keep that old content object, use the
23888 * elm_flip_content_front_unset() function.
23890 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23892 * @brief Set the back content of the flip widget.
23894 * @param obj The flip object
23895 * @param content The new back content object
23897 * Once the content object is set, a previously set one will be deleted.
23898 * If you want to keep that old content object, use the
23899 * elm_flip_content_back_unset() function.
23901 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23903 * @brief Get the front content used for the flip
23905 * @param obj The flip object
23906 * @return The front content object that is being used
23908 * Return the front content object which is set for this widget.
23910 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23912 * @brief Get the back content used for the flip
23914 * @param obj The flip object
23915 * @return The back content object that is being used
23917 * Return the back content object which is set for this widget.
23919 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23921 * @brief Unset the front content used for the flip
23923 * @param obj The flip object
23924 * @return The front content object that was being used
23926 * Unparent and return the front content object which was set for this widget.
23928 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23930 * @brief Unset the back content used for the flip
23932 * @param obj The flip object
23933 * @return The back content object that was being used
23935 * Unparent and return the back content object which was set for this widget.
23937 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23939 * @brief Get flip front visibility state
23941 * @param obj The flip objct
23942 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
23945 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23947 * @brief Set flip perspective
23949 * @param obj The flip object
23950 * @param foc The coordinate to set the focus on
23951 * @param x The X coordinate
23952 * @param y The Y coordinate
23954 * @warning This function currently does nothing.
23956 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
23958 * @brief Runs the flip animation
23960 * @param obj The flip object
23961 * @param mode The mode type
23963 * Flips the front and back contents using the @p mode animation. This
23964 * efectively hides the currently visible content and shows the hidden one.
23966 * There a number of possible animations to use for the flipping:
23967 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
23968 * around a horizontal axis in the middle of its height, the other content
23969 * is shown as the other side of the flip.
23970 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
23971 * around a vertical axis in the middle of its width, the other content is
23972 * shown as the other side of the flip.
23973 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
23974 * around a diagonal axis in the middle of its width, the other content is
23975 * shown as the other side of the flip.
23976 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
23977 * around a diagonal axis in the middle of its height, the other content is
23978 * shown as the other side of the flip.
23979 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
23980 * as if the flip was a cube, the other content is show as the right face of
23982 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
23983 * right as if the flip was a cube, the other content is show as the left
23984 * face of the cube.
23985 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
23986 * flip was a cube, the other content is show as the bottom face of the cube.
23987 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
23988 * the flip was a cube, the other content is show as the upper face of the
23990 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
23991 * if the flip was a book, the other content is shown as the page below that.
23992 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
23993 * as if the flip was a book, the other content is shown as the page below
23995 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
23996 * flip was a book, the other content is shown as the page below that.
23997 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
23998 * flip was a book, the other content is shown as the page below that.
24000 * @image html elm_flip.png
24001 * @image latex elm_flip.eps width=\textwidth
24003 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24005 * @brief Set the interactive flip mode
24007 * @param obj The flip object
24008 * @param mode The interactive flip mode to use
24010 * This sets if the flip should be interactive (allow user to click and
24011 * drag a side of the flip to reveal the back page and cause it to flip).
24012 * By default a flip is not interactive. You may also need to set which
24013 * sides of the flip are "active" for flipping and how much space they use
24014 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24015 * and elm_flip_interacton_direction_hitsize_set()
24017 * The four avilable mode of interaction are:
24018 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24019 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24020 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24021 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24023 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24024 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24025 * happen, those can only be acheived with elm_flip_go();
24027 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24029 * @brief Get the interactive flip mode
24031 * @param obj The flip object
24032 * @return The interactive flip mode
24034 * Returns the interactive flip mode set by elm_flip_interaction_set()
24036 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24038 * @brief Set which directions of the flip respond to interactive flip
24040 * @param obj The flip object
24041 * @param dir The direction to change
24042 * @param enabled If that direction is enabled or not
24044 * By default all directions are disabled, so you may want to enable the
24045 * desired directions for flipping if you need interactive flipping. You must
24046 * call this function once for each direction that should be enabled.
24048 * @see elm_flip_interaction_set()
24050 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24052 * @brief Get the enabled state of that flip direction
24054 * @param obj The flip object
24055 * @param dir The direction to check
24056 * @return If that direction is enabled or not
24058 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24060 * @see elm_flip_interaction_set()
24062 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24064 * @brief Set the amount of the flip that is sensitive to interactive flip
24066 * @param obj The flip object
24067 * @param dir The direction to modify
24068 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24070 * Set the amount of the flip that is sensitive to interactive flip, with 0
24071 * representing no area in the flip and 1 representing the entire flip. There
24072 * is however a consideration to be made in that the area will never be
24073 * smaller than the finger size set(as set in your Elementary configuration).
24075 * @see elm_flip_interaction_set()
24077 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24079 * @brief Get the amount of the flip that is sensitive to interactive flip
24081 * @param obj The flip object
24082 * @param dir The direction to check
24083 * @return The size set for that direction
24085 * Returns the amount os sensitive area set by
24086 * elm_flip_interacton_direction_hitsize_set().
24088 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24093 /* scrolledentry */
24094 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24095 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24096 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24097 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24098 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24099 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24100 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24101 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24102 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24103 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24104 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24105 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24106 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24107 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24108 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24109 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24110 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24111 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24112 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24113 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24114 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24115 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24116 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24117 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24118 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24119 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24120 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24121 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24122 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24123 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24124 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24125 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24126 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24127 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24128 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24129 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);
24130 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24131 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24132 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);
24133 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24134 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);
24135 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24136 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24137 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24138 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24139 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24140 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24141 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24142 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24143 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);
24144 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);
24145 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);
24146 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);
24147 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);
24148 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);
24149 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24150 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24151 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24152 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24153 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24154 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24155 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24158 * @defgroup Conformant Conformant
24159 * @ingroup Elementary
24161 * @image html img/widget/conformant/preview-00.png
24162 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24164 * @image html img/conformant.png
24165 * @image latex img/conformant.eps width=\textwidth
24167 * The aim is to provide a widget that can be used in elementary apps to
24168 * account for space taken up by the indicator, virtual keypad & softkey
24169 * windows when running the illume2 module of E17.
24171 * So conformant content will be sized and positioned considering the
24172 * space required for such stuff, and when they popup, as a keyboard
24173 * shows when an entry is selected, conformant content won't change.
24175 * Available styles for it:
24178 * See how to use this widget in this example:
24179 * @ref conformant_example
24183 * @addtogroup Conformant
24188 * Add a new conformant widget to the given parent Elementary
24189 * (container) object.
24191 * @param parent The parent object.
24192 * @return A new conformant widget handle or @c NULL, on errors.
24194 * This function inserts a new conformant widget on the canvas.
24196 * @ingroup Conformant
24198 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24201 * Set the content of the conformant widget.
24203 * @param obj The conformant object.
24204 * @param content The content to be displayed by the conformant.
24206 * Content will be sized and positioned considering the space required
24207 * to display a virtual keyboard. So it won't fill all the conformant
24208 * size. This way is possible to be sure that content won't resize
24209 * or be re-positioned after the keyboard is displayed.
24211 * Once the content object is set, a previously set one will be deleted.
24212 * If you want to keep that old content object, use the
24213 * elm_conformat_content_unset() function.
24215 * @see elm_conformant_content_unset()
24216 * @see elm_conformant_content_get()
24218 * @ingroup Conformant
24220 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24223 * Get the content of the conformant widget.
24225 * @param obj The conformant object.
24226 * @return The content that is being used.
24228 * Return the content object which is set for this widget.
24229 * It won't be unparent from conformant. For that, use
24230 * elm_conformant_content_unset().
24232 * @see elm_conformant_content_set() for more details.
24233 * @see elm_conformant_content_unset()
24235 * @ingroup Conformant
24237 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24240 * Unset the content of the conformant widget.
24242 * @param obj The conformant object.
24243 * @return The content that was being used.
24245 * Unparent and return the content object which was set for this widget.
24247 * @see elm_conformant_content_set() for more details.
24249 * @ingroup Conformant
24251 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24254 * Returns the Evas_Object that represents the content area.
24256 * @param obj The conformant object.
24257 * @return The content area of the widget.
24259 * @ingroup Conformant
24261 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24268 * @defgroup Mapbuf Mapbuf
24269 * @ingroup Elementary
24271 * @image html img/widget/mapbuf/preview-00.png
24272 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24274 * This holds one content object and uses an Evas Map of transformation
24275 * points to be later used with this content. So the content will be
24276 * moved, resized, etc as a single image. So it will improve performance
24277 * when you have a complex interafce, with a lot of elements, and will
24278 * need to resize or move it frequently (the content object and its
24281 * See how to use this widget in this example:
24282 * @ref mapbuf_example
24286 * @addtogroup Mapbuf
24291 * Add a new mapbuf widget to the given parent Elementary
24292 * (container) object.
24294 * @param parent The parent object.
24295 * @return A new mapbuf widget handle or @c NULL, on errors.
24297 * This function inserts a new mapbuf widget on the canvas.
24301 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24304 * Set the content of the mapbuf.
24306 * @param obj The mapbuf object.
24307 * @param content The content that will be filled in this mapbuf object.
24309 * Once the content object is set, a previously set one will be deleted.
24310 * If you want to keep that old content object, use the
24311 * elm_mapbuf_content_unset() function.
24313 * To enable map, elm_mapbuf_enabled_set() should be used.
24317 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24320 * Get the content of the mapbuf.
24322 * @param obj The mapbuf object.
24323 * @return The content that is being used.
24325 * Return the content object which is set for this widget.
24327 * @see elm_mapbuf_content_set() for details.
24331 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24334 * Unset the content of the mapbuf.
24336 * @param obj The mapbuf object.
24337 * @return The content that was being used.
24339 * Unparent and return the content object which was set for this widget.
24341 * @see elm_mapbuf_content_set() for details.
24345 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24348 * Enable or disable the map.
24350 * @param obj The mapbuf object.
24351 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24353 * This enables the map that is set or disables it. On enable, the object
24354 * geometry will be saved, and the new geometry will change (position and
24355 * size) to reflect the map geometry set.
24357 * Also, when enabled, alpha and smooth states will be used, so if the
24358 * content isn't solid, alpha should be enabled, for example, otherwise
24359 * a black retangle will fill the content.
24361 * When disabled, the stored map will be freed and geometry prior to
24362 * enabling the map will be restored.
24364 * It's disabled by default.
24366 * @see elm_mapbuf_alpha_set()
24367 * @see elm_mapbuf_smooth_set()
24371 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24374 * Get a value whether map is enabled or not.
24376 * @param obj The mapbuf object.
24377 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24378 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24380 * @see elm_mapbuf_enabled_set() for details.
24384 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24387 * Enable or disable smooth map rendering.
24389 * @param obj The mapbuf object.
24390 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24393 * This sets smoothing for map rendering. If the object is a type that has
24394 * its own smoothing settings, then both the smooth settings for this object
24395 * and the map must be turned off.
24397 * By default smooth maps are enabled.
24401 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24404 * Get a value whether smooth map rendering is enabled or not.
24406 * @param obj The mapbuf object.
24407 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24408 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24410 * @see elm_mapbuf_smooth_set() for details.
24414 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24417 * Set or unset alpha flag for map rendering.
24419 * @param obj The mapbuf object.
24420 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24423 * This sets alpha flag for map rendering. If the object is a type that has
24424 * its own alpha settings, then this will take precedence. Only image objects
24425 * have this currently. It stops alpha blending of the map area, and is
24426 * useful if you know the object and/or all sub-objects is 100% solid.
24428 * Alpha is enabled by default.
24432 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24435 * Get a value whether alpha blending is enabled or not.
24437 * @param obj The mapbuf object.
24438 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24439 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24441 * @see elm_mapbuf_alpha_set() for details.
24445 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24452 * @defgroup Flipselector Flip Selector
24454 * @image html img/widget/flipselector/preview-00.png
24455 * @image latex img/widget/flipselector/preview-00.eps
24457 * A flip selector is a widget to show a set of @b text items, one
24458 * at a time, with the same sheet switching style as the @ref Clock
24459 * "clock" widget, when one changes the current displaying sheet
24460 * (thus, the "flip" in the name).
24462 * User clicks to flip sheets which are @b held for some time will
24463 * make the flip selector to flip continuosly and automatically for
24464 * the user. The interval between flips will keep growing in time,
24465 * so that it helps the user to reach an item which is distant from
24466 * the current selection.
24468 * Smart callbacks one can register to:
24469 * - @c "selected" - when the widget's selected text item is changed
24470 * - @c "overflowed" - when the widget's current selection is changed
24471 * from the first item in its list to the last
24472 * - @c "underflowed" - when the widget's current selection is changed
24473 * from the last item in its list to the first
24475 * Available styles for it:
24478 * Here is an example on its usage:
24479 * @li @ref flipselector_example
24483 * @addtogroup Flipselector
24487 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24490 * Add a new flip selector widget to the given parent Elementary
24491 * (container) widget
24493 * @param parent The parent object
24494 * @return a new flip selector widget handle or @c NULL, on errors
24496 * This function inserts a new flip selector widget on the canvas.
24498 * @ingroup Flipselector
24500 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24503 * Programmatically select the next item of a flip selector widget
24505 * @param obj The flipselector object
24507 * @note The selection will be animated. Also, if it reaches the
24508 * end of its list of member items, it will continue with the first
24511 * @ingroup Flipselector
24513 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24516 * Programmatically select the previous item of a flip selector
24519 * @param obj The flipselector object
24521 * @note The selection will be animated. Also, if it reaches the
24522 * beginning of its list of member items, it will continue with the
24523 * last one backwards.
24525 * @ingroup Flipselector
24527 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24530 * Append a (text) item to a flip selector widget
24532 * @param obj The flipselector object
24533 * @param label The (text) label of the new item
24534 * @param func Convenience callback function to take place when
24536 * @param data Data passed to @p func, above
24537 * @return A handle to the item added or @c NULL, on errors
24539 * The widget's list of labels to show will be appended with the
24540 * given value. If the user wishes so, a callback function pointer
24541 * can be passed, which will get called when this same item is
24544 * @note The current selection @b won't be modified by appending an
24545 * element to the list.
24547 * @note The maximum length of the text label is going to be
24548 * determined <b>by the widget's theme</b>. Strings larger than
24549 * that value are going to be @b truncated.
24551 * @ingroup Flipselector
24553 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24556 * Prepend a (text) item to a flip selector widget
24558 * @param obj The flipselector object
24559 * @param label The (text) label of the new item
24560 * @param func Convenience callback function to take place when
24562 * @param data Data passed to @p func, above
24563 * @return A handle to the item added or @c NULL, on errors
24565 * The widget's list of labels to show will be prepended with the
24566 * given value. If the user wishes so, a callback function pointer
24567 * can be passed, which will get called when this same item is
24570 * @note The current selection @b won't be modified by prepending
24571 * an element to the list.
24573 * @note The maximum length of the text label is going to be
24574 * determined <b>by the widget's theme</b>. Strings larger than
24575 * that value are going to be @b truncated.
24577 * @ingroup Flipselector
24579 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24582 * Get the internal list of items in a given flip selector widget.
24584 * @param obj The flipselector object
24585 * @return The list of items (#Elm_Flipselector_Item as data) or
24586 * @c NULL on errors.
24588 * This list is @b not to be modified in any way and must not be
24589 * freed. Use the list members with functions like
24590 * elm_flipselector_item_label_set(),
24591 * elm_flipselector_item_label_get(),
24592 * elm_flipselector_item_del(),
24593 * elm_flipselector_item_selected_get(),
24594 * elm_flipselector_item_selected_set().
24596 * @warning This list is only valid until @p obj object's internal
24597 * items list is changed. It should be fetched again with another
24598 * call to this function when changes happen.
24600 * @ingroup Flipselector
24602 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24605 * Get the first item in the given flip selector widget's list of
24608 * @param obj The flipselector object
24609 * @return The first item or @c NULL, if it has no items (and on
24612 * @see elm_flipselector_item_append()
24613 * @see elm_flipselector_last_item_get()
24615 * @ingroup Flipselector
24617 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24620 * Get the last item in the given flip selector widget's list of
24623 * @param obj The flipselector object
24624 * @return The last item or @c NULL, if it has no items (and on
24627 * @see elm_flipselector_item_prepend()
24628 * @see elm_flipselector_first_item_get()
24630 * @ingroup Flipselector
24632 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24635 * Get the currently selected item in a flip selector widget.
24637 * @param obj The flipselector object
24638 * @return The selected item or @c NULL, if the widget has no items
24641 * @ingroup Flipselector
24643 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24646 * Set whether a given flip selector widget's item should be the
24647 * currently selected one.
24649 * @param item The flip selector item
24650 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
24652 * This sets whether @p item is or not the selected (thus, under
24653 * display) one. If @p item is different than one under display,
24654 * the latter will be unselected. If the @p item is set to be
24655 * unselected, on the other hand, the @b first item in the widget's
24656 * internal members list will be the new selected one.
24658 * @see elm_flipselector_item_selected_get()
24660 * @ingroup Flipselector
24662 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24665 * Get whether a given flip selector widget's item is the currently
24668 * @param item The flip selector item
24669 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
24672 * @see elm_flipselector_item_selected_set()
24674 * @ingroup Flipselector
24676 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24679 * Delete a given item from a flip selector widget.
24681 * @param item The item to delete
24683 * @ingroup Flipselector
24685 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24688 * Get the label of a given flip selector widget's item.
24690 * @param item The item to get label from
24691 * @return The text label of @p item or @c NULL, on errors
24693 * @see elm_flipselector_item_label_set()
24695 * @ingroup Flipselector
24697 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24700 * Set the label of a given flip selector widget's item.
24702 * @param item The item to set label on
24703 * @param label The text label string, in UTF-8 encoding
24705 * @see elm_flipselector_item_label_get()
24707 * @ingroup Flipselector
24709 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24712 * Gets the item before @p item in a flip selector widget's
24713 * internal list of items.
24715 * @param item The item to fetch previous from
24716 * @return The item before the @p item, in its parent's list. If
24717 * there is no previous item for @p item or there's an
24718 * error, @c NULL is returned.
24720 * @see elm_flipselector_item_next_get()
24722 * @ingroup Flipselector
24724 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24727 * Gets the item after @p item in a flip selector widget's
24728 * internal list of items.
24730 * @param item The item to fetch next from
24731 * @return The item after the @p item, in its parent's list. If
24732 * there is no next item for @p item or there's an
24733 * error, @c NULL is returned.
24735 * @see elm_flipselector_item_next_get()
24737 * @ingroup Flipselector
24739 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24742 * Set the interval on time updates for an user mouse button hold
24743 * on a flip selector widget.
24745 * @param obj The flip selector object
24746 * @param interval The (first) interval value in seconds
24748 * This interval value is @b decreased while the user holds the
24749 * mouse pointer either flipping up or flipping doww a given flip
24752 * This helps the user to get to a given item distant from the
24753 * current one easier/faster, as it will start to flip quicker and
24754 * quicker on mouse button holds.
24756 * The calculation for the next flip interval value, starting from
24757 * the one set with this call, is the previous interval divided by
24758 * 1.05, so it decreases a little bit.
24760 * The default starting interval value for automatic flips is
24763 * @see elm_flipselector_interval_get()
24765 * @ingroup Flipselector
24767 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
24770 * Get the interval on time updates for an user mouse button hold
24771 * on a flip selector widget.
24773 * @param obj The flip selector object
24774 * @return The (first) interval value, in seconds, set on it
24776 * @see elm_flipselector_interval_set() for more details
24778 * @ingroup Flipselector
24780 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24786 * @addtogroup Calendar
24791 * @enum _Elm_Calendar_Mark_Repeat
24792 * @typedef Elm_Calendar_Mark_Repeat
24794 * Event periodicity, used to define if a mark should be repeated
24795 * @b beyond event's day. It's set when a mark is added.
24797 * So, for a mark added to 13th May with periodicity set to WEEKLY,
24798 * there will be marks every week after this date. Marks will be displayed
24799 * at 13th, 20th, 27th, 3rd June ...
24801 * Values don't work as bitmask, only one can be choosen.
24803 * @see elm_calendar_mark_add()
24805 * @ingroup Calendar
24807 typedef enum _Elm_Calendar_Mark_Repeat
24809 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
24810 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
24811 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
24812 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*/
24813 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. */
24814 } Elm_Calendar_Mark_Repeat;
24816 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(). */
24819 * Add a new calendar widget to the given parent Elementary
24820 * (container) object.
24822 * @param parent The parent object.
24823 * @return a new calendar widget handle or @c NULL, on errors.
24825 * This function inserts a new calendar widget on the canvas.
24827 * @ref calendar_example_01
24829 * @ingroup Calendar
24831 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24834 * Get weekdays names displayed by the calendar.
24836 * @param obj The calendar object.
24837 * @return Array of seven strings to be used as weekday names.
24839 * By default, weekdays abbreviations get from system are displayed:
24840 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
24841 * The first string is related to Sunday, the second to Monday...
24843 * @see elm_calendar_weekdays_name_set()
24845 * @ref calendar_example_05
24847 * @ingroup Calendar
24849 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24852 * Set weekdays names to be displayed by the calendar.
24854 * @param obj The calendar object.
24855 * @param weekdays Array of seven strings to be used as weekday names.
24856 * @warning It must have 7 elements, or it will access invalid memory.
24857 * @warning The strings must be NULL terminated ('@\0').
24859 * By default, weekdays abbreviations get from system are displayed:
24860 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
24862 * The first string should be related to Sunday, the second to Monday...
24864 * The usage should be like this:
24866 * const char *weekdays[] =
24868 * "Sunday", "Monday", "Tuesday", "Wednesday",
24869 * "Thursday", "Friday", "Saturday"
24871 * elm_calendar_weekdays_names_set(calendar, weekdays);
24874 * @see elm_calendar_weekdays_name_get()
24876 * @ref calendar_example_02
24878 * @ingroup Calendar
24880 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
24883 * Set the minimum and maximum values for the year
24885 * @param obj The calendar object
24886 * @param min The minimum year, greater than 1901;
24887 * @param max The maximum year;
24889 * Maximum must be greater than minimum, except if you don't wan't to set
24891 * Default values are 1902 and -1.
24893 * If the maximum year is a negative value, it will be limited depending
24894 * on the platform architecture (year 2037 for 32 bits);
24896 * @see elm_calendar_min_max_year_get()
24898 * @ref calendar_example_03
24900 * @ingroup Calendar
24902 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
24905 * Get the minimum and maximum values for the year
24907 * @param obj The calendar object.
24908 * @param min The minimum year.
24909 * @param max The maximum year.
24911 * Default values are 1902 and -1.
24913 * @see elm_calendar_min_max_year_get() for more details.
24915 * @ref calendar_example_05
24917 * @ingroup Calendar
24919 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
24922 * Enable or disable day selection
24924 * @param obj The calendar object.
24925 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
24928 * Enabled by default. If disabled, the user still can select months,
24929 * but not days. Selected days are highlighted on calendar.
24930 * It should be used if you won't need such selection for the widget usage.
24932 * When a day is selected, or month is changed, smart callbacks for
24933 * signal "changed" will be called.
24935 * @see elm_calendar_day_selection_enable_get()
24937 * @ref calendar_example_04
24939 * @ingroup Calendar
24941 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24944 * Get a value whether day selection is enabled or not.
24946 * @see elm_calendar_day_selection_enable_set() for details.
24948 * @param obj The calendar object.
24949 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
24950 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
24952 * @ref calendar_example_05
24954 * @ingroup Calendar
24956 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24960 * Set selected date to be highlighted on calendar.
24962 * @param obj The calendar object.
24963 * @param selected_time A @b tm struct to represent the selected date.
24965 * Set the selected date, changing the displayed month if needed.
24966 * Selected date changes when the user goes to next/previous month or
24967 * select a day pressing over it on calendar.
24969 * @see elm_calendar_selected_time_get()
24971 * @ref calendar_example_04
24973 * @ingroup Calendar
24975 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
24978 * Get selected date.
24980 * @param obj The calendar object
24981 * @param selected_time A @b tm struct to point to selected date
24982 * @return EINA_FALSE means an error ocurred and returned time shouldn't
24985 * Get date selected by the user or set by function
24986 * elm_calendar_selected_time_set().
24987 * Selected date changes when the user goes to next/previous month or
24988 * select a day pressing over it on calendar.
24990 * @see elm_calendar_selected_time_get()
24992 * @ref calendar_example_05
24994 * @ingroup Calendar
24996 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
24999 * Set a function to format the string that will be used to display
25002 * @param obj The calendar object
25003 * @param format_function Function to set the month-year string given
25004 * the selected date
25006 * By default it uses strftime with "%B %Y" format string.
25007 * It should allocate the memory that will be used by the string,
25008 * that will be freed by the widget after usage.
25009 * A pointer to the string and a pointer to the time struct will be provided.
25014 * _format_month_year(struct tm *selected_time)
25017 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25018 * return strdup(buf);
25021 * elm_calendar_format_function_set(calendar, _format_month_year);
25024 * @ref calendar_example_02
25026 * @ingroup Calendar
25028 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25031 * Add a new mark to the calendar
25033 * @param obj The calendar object
25034 * @param mark_type A string used to define the type of mark. It will be
25035 * emitted to the theme, that should display a related modification on these
25036 * days representation.
25037 * @param mark_time A time struct to represent the date of inclusion of the
25038 * mark. For marks that repeats it will just be displayed after the inclusion
25039 * date in the calendar.
25040 * @param repeat Repeat the event following this periodicity. Can be a unique
25041 * mark (that don't repeat), daily, weekly, monthly or annually.
25042 * @return The created mark or @p NULL upon failure.
25044 * Add a mark that will be drawn in the calendar respecting the insertion
25045 * time and periodicity. It will emit the type as signal to the widget theme.
25046 * Default theme supports "holiday" and "checked", but it can be extended.
25048 * It won't immediately update the calendar, drawing the marks.
25049 * For this, call elm_calendar_marks_draw(). However, when user selects
25050 * next or previous month calendar forces marks drawn.
25052 * Marks created with this method can be deleted with
25053 * elm_calendar_mark_del().
25057 * struct tm selected_time;
25058 * time_t current_time;
25060 * current_time = time(NULL) + 5 * 84600;
25061 * localtime_r(¤t_time, &selected_time);
25062 * elm_calendar_mark_add(cal, "holiday", selected_time,
25063 * ELM_CALENDAR_ANNUALLY);
25065 * current_time = time(NULL) + 1 * 84600;
25066 * localtime_r(¤t_time, &selected_time);
25067 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25069 * elm_calendar_marks_draw(cal);
25072 * @see elm_calendar_marks_draw()
25073 * @see elm_calendar_mark_del()
25075 * @ref calendar_example_06
25077 * @ingroup Calendar
25079 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);
25082 * Delete mark from the calendar.
25084 * @param mark The mark to be deleted.
25086 * If deleting all calendar marks is required, elm_calendar_marks_clear()
25087 * should be used instead of getting marks list and deleting each one.
25089 * @see elm_calendar_mark_add()
25091 * @ref calendar_example_06
25093 * @ingroup Calendar
25095 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25098 * Remove all calendar's marks
25100 * @param obj The calendar object.
25102 * @see elm_calendar_mark_add()
25103 * @see elm_calendar_mark_del()
25105 * @ingroup Calendar
25107 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25111 * Get a list of all the calendar marks.
25113 * @param obj The calendar object.
25114 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25116 * @see elm_calendar_mark_add()
25117 * @see elm_calendar_mark_del()
25118 * @see elm_calendar_marks_clear()
25120 * @ingroup Calendar
25122 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25125 * Draw calendar marks.
25127 * @param obj The calendar object.
25129 * Should be used after adding, removing or clearing marks.
25130 * It will go through the entire marks list updating the calendar.
25131 * If lots of marks will be added, add all the marks and then call
25134 * When the month is changed, i.e. user selects next or previous month,
25135 * marks will be drawed.
25137 * @see elm_calendar_mark_add()
25138 * @see elm_calendar_mark_del()
25139 * @see elm_calendar_marks_clear()
25141 * @ref calendar_example_06
25143 * @ingroup Calendar
25145 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25148 * Set a day text color to the same that represents Saturdays.
25150 * @param obj The calendar object.
25151 * @param pos The text position. Position is the cell counter, from left
25152 * to right, up to down. It starts on 0 and ends on 41.
25154 * @deprecated use elm_calendar_mark_add() instead like:
25157 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25158 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25161 * @see elm_calendar_mark_add()
25163 * @ingroup Calendar
25165 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25168 * Set a day text color to the same that represents Sundays.
25170 * @param obj The calendar object.
25171 * @param pos The text position. Position is the cell counter, from left
25172 * to right, up to down. It starts on 0 and ends on 41.
25174 * @deprecated use elm_calendar_mark_add() instead like:
25177 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25178 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25181 * @see elm_calendar_mark_add()
25183 * @ingroup Calendar
25185 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25188 * Set a day text color to the same that represents Weekdays.
25190 * @param obj The calendar object
25191 * @param pos The text position. Position is the cell counter, from left
25192 * to right, up to down. It starts on 0 and ends on 41.
25194 * @deprecated use elm_calendar_mark_add() instead like:
25197 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25199 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25200 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25201 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25202 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25203 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25204 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25205 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25206 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25207 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25210 * @see elm_calendar_mark_add()
25212 * @ingroup Calendar
25214 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25217 * Set the interval on time updates for an user mouse button hold
25218 * on calendar widgets' month selection.
25220 * @param obj The calendar object
25221 * @param interval The (first) interval value in seconds
25223 * This interval value is @b decreased while the user holds the
25224 * mouse pointer either selecting next or previous month.
25226 * This helps the user to get to a given month distant from the
25227 * current one easier/faster, as it will start to change quicker and
25228 * quicker on mouse button holds.
25230 * The calculation for the next change interval value, starting from
25231 * the one set with this call, is the previous interval divided by
25232 * 1.05, so it decreases a little bit.
25234 * The default starting interval value for automatic changes is
25237 * @see elm_calendar_interval_get()
25239 * @ingroup Calendar
25241 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25244 * Get the interval on time updates for an user mouse button hold
25245 * on calendar widgets' month selection.
25247 * @param obj The calendar object
25248 * @return The (first) interval value, in seconds, set on it
25250 * @see elm_calendar_interval_set() for more details
25252 * @ingroup Calendar
25254 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25261 * @defgroup Diskselector Diskselector
25262 * @ingroup Elementary
25264 * @image html img/widget/diskselector/preview-00.png
25265 * @image latex img/widget/diskselector/preview-00.eps
25267 * A diskselector is a kind of list widget. It scrolls horizontally,
25268 * and can contain label and icon objects. Three items are displayed
25269 * with the selected one in the middle.
25271 * It can act like a circular list with round mode and labels can be
25272 * reduced for a defined length for side items.
25274 * Smart callbacks one can listen to:
25275 * - "selected" - when item is selected, i.e. scroller stops.
25277 * Available styles for it:
25280 * List of examples:
25281 * @li @ref diskselector_example_01
25282 * @li @ref diskselector_example_02
25286 * @addtogroup Diskselector
25290 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(). */
25293 * Add a new diskselector widget to the given parent Elementary
25294 * (container) object.
25296 * @param parent The parent object.
25297 * @return a new diskselector widget handle or @c NULL, on errors.
25299 * This function inserts a new diskselector widget on the canvas.
25301 * @ingroup Diskselector
25303 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25306 * Enable or disable round mode.
25308 * @param obj The diskselector object.
25309 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25312 * Disabled by default. If round mode is enabled the items list will
25313 * work like a circle list, so when the user reaches the last item,
25314 * the first one will popup.
25316 * @see elm_diskselector_round_get()
25318 * @ingroup Diskselector
25320 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25323 * Get a value whether round mode is enabled or not.
25325 * @see elm_diskselector_round_set() for details.
25327 * @param obj The diskselector object.
25328 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25329 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25331 * @ingroup Diskselector
25333 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25336 * Get the side labels max length.
25338 * @deprecated use elm_diskselector_side_label_length_get() instead:
25340 * @param obj The diskselector object.
25341 * @return The max length defined for side labels, or 0 if not a valid
25344 * @ingroup Diskselector
25346 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25349 * Set the side labels max length.
25351 * @deprecated use elm_diskselector_side_label_length_set() instead:
25353 * @param obj The diskselector object.
25354 * @param len The max length defined for side labels.
25356 * @ingroup Diskselector
25358 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25361 * Get the side labels max length.
25363 * @see elm_diskselector_side_label_length_set() for details.
25365 * @param obj The diskselector object.
25366 * @return The max length defined for side labels, or 0 if not a valid
25369 * @ingroup Diskselector
25371 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25374 * Set the side labels max length.
25376 * @param obj The diskselector object.
25377 * @param len The max length defined for side labels.
25379 * Length is the number of characters of items' label that will be
25380 * visible when it's set on side positions. It will just crop
25381 * the string after defined size. E.g.:
25383 * An item with label "January" would be displayed on side position as
25384 * "Jan" if max length is set to 3, or "Janu", if this property
25387 * When it's selected, the entire label will be displayed, except for
25388 * width restrictions. In this case label will be cropped and "..."
25389 * will be concatenated.
25391 * Default side label max length is 3.
25393 * This property will be applyed over all items, included before or
25394 * later this function call.
25396 * @ingroup Diskselector
25398 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25401 * Set the number of items to be displayed.
25403 * @param obj The diskselector object.
25404 * @param num The number of items the diskselector will display.
25406 * Default value is 3, and also it's the minimun. If @p num is less
25407 * than 3, it will be set to 3.
25409 * Also, it can be set on theme, using data item @c display_item_num
25410 * on group "elm/diskselector/item/X", where X is style set.
25413 * group { name: "elm/diskselector/item/X";
25415 * item: "display_item_num" "5";
25418 * @ingroup Diskselector
25420 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25423 * Get the number of items in the diskselector object.
25425 * @param obj The diskselector object.
25427 * @ingroup Diskselector
25429 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25432 * Set bouncing behaviour when the scrolled content reaches an edge.
25434 * Tell the internal scroller object whether it should bounce or not
25435 * when it reaches the respective edges for each axis.
25437 * @param obj The diskselector object.
25438 * @param h_bounce Whether to bounce or not in the horizontal axis.
25439 * @param v_bounce Whether to bounce or not in the vertical axis.
25441 * @see elm_scroller_bounce_set()
25443 * @ingroup Diskselector
25445 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25448 * Get the bouncing behaviour of the internal scroller.
25450 * Get whether the internal scroller should bounce when the edge of each
25451 * axis is reached scrolling.
25453 * @param obj The diskselector object.
25454 * @param h_bounce Pointer where to store the bounce state of the horizontal
25456 * @param v_bounce Pointer where to store the bounce state of the vertical
25459 * @see elm_scroller_bounce_get()
25460 * @see elm_diskselector_bounce_set()
25462 * @ingroup Diskselector
25464 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25467 * Get the scrollbar policy.
25469 * @see elm_diskselector_scroller_policy_get() for details.
25471 * @param obj The diskselector object.
25472 * @param policy_h Pointer where to store horizontal scrollbar policy.
25473 * @param policy_v Pointer where to store vertical scrollbar policy.
25475 * @ingroup Diskselector
25477 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);
25480 * Set the scrollbar policy.
25482 * @param obj The diskselector object.
25483 * @param policy_h Horizontal scrollbar policy.
25484 * @param policy_v Vertical scrollbar policy.
25486 * This sets the scrollbar visibility policy for the given scroller.
25487 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25488 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25489 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25490 * This applies respectively for the horizontal and vertical scrollbars.
25492 * The both are disabled by default, i.e., are set to
25493 * #ELM_SCROLLER_POLICY_OFF.
25495 * @ingroup Diskselector
25497 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
25500 * Remove all diskselector's items.
25502 * @param obj The diskselector object.
25504 * @see elm_diskselector_item_del()
25505 * @see elm_diskselector_item_append()
25507 * @ingroup Diskselector
25509 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25512 * Get a list of all the diskselector items.
25514 * @param obj The diskselector object.
25515 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
25516 * or @c NULL on failure.
25518 * @see elm_diskselector_item_append()
25519 * @see elm_diskselector_item_del()
25520 * @see elm_diskselector_clear()
25522 * @ingroup Diskselector
25524 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25527 * Appends a new item to the diskselector object.
25529 * @param obj The diskselector object.
25530 * @param label The label of the diskselector item.
25531 * @param icon The icon object to use at left side of the item. An
25532 * icon can be any Evas object, but usually it is an icon created
25533 * with elm_icon_add().
25534 * @param func The function to call when the item is selected.
25535 * @param data The data to associate with the item for related callbacks.
25537 * @return The created item or @c NULL upon failure.
25539 * A new item will be created and appended to the diskselector, i.e., will
25540 * be set as last item. Also, if there is no selected item, it will
25541 * be selected. This will always happens for the first appended item.
25543 * If no icon is set, label will be centered on item position, otherwise
25544 * the icon will be placed at left of the label, that will be shifted
25547 * Items created with this method can be deleted with
25548 * elm_diskselector_item_del().
25550 * Associated @p data can be properly freed when item is deleted if a
25551 * callback function is set with elm_diskselector_item_del_cb_set().
25553 * If a function is passed as argument, it will be called everytime this item
25554 * is selected, i.e., the user stops the diskselector with this
25555 * item on center position. If such function isn't needed, just passing
25556 * @c NULL as @p func is enough. The same should be done for @p data.
25558 * Simple example (with no function callback or data associated):
25560 * disk = elm_diskselector_add(win);
25561 * ic = elm_icon_add(win);
25562 * elm_icon_file_set(ic, "path/to/image", NULL);
25563 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25564 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
25567 * @see elm_diskselector_item_del()
25568 * @see elm_diskselector_item_del_cb_set()
25569 * @see elm_diskselector_clear()
25570 * @see elm_icon_add()
25572 * @ingroup Diskselector
25574 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);
25578 * Delete them item from the diskselector.
25580 * @param it The item of diskselector to be deleted.
25582 * If deleting all diskselector items is required, elm_diskselector_clear()
25583 * should be used instead of getting items list and deleting each one.
25585 * @see elm_diskselector_clear()
25586 * @see elm_diskselector_item_append()
25587 * @see elm_diskselector_item_del_cb_set()
25589 * @ingroup Diskselector
25591 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25594 * Set the function called when a diskselector item is freed.
25596 * @param it The item to set the callback on
25597 * @param func The function called
25599 * If there is a @p func, then it will be called prior item's memory release.
25600 * That will be called with the following arguments:
25602 * @li item's Evas object;
25605 * This way, a data associated to a diskselector item could be properly
25608 * @ingroup Diskselector
25610 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
25613 * Get the data associated to the item.
25615 * @param it The diskselector item
25616 * @return The data associated to @p it
25618 * The return value is a pointer to data associated to @p item when it was
25619 * created, with function elm_diskselector_item_append(). If no data
25620 * was passed as argument, it will return @c NULL.
25622 * @see elm_diskselector_item_append()
25624 * @ingroup Diskselector
25626 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25629 * Set the icon associated to the item.
25631 * @param it The diskselector item
25632 * @param icon The icon object to associate with @p it
25634 * The icon object to use at left side of the item. An
25635 * icon can be any Evas object, but usually it is an icon created
25636 * with elm_icon_add().
25638 * Once the icon object is set, a previously set one will be deleted.
25639 * @warning Setting the same icon for two items will cause the icon to
25640 * dissapear from the first item.
25642 * If an icon was passed as argument on item creation, with function
25643 * elm_diskselector_item_append(), it will be already
25644 * associated to the item.
25646 * @see elm_diskselector_item_append()
25647 * @see elm_diskselector_item_icon_get()
25649 * @ingroup Diskselector
25651 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
25654 * Get the icon associated to the item.
25656 * @param it The diskselector item
25657 * @return The icon associated to @p it
25659 * The return value is a pointer to the icon associated to @p item when it was
25660 * created, with function elm_diskselector_item_append(), or later
25661 * with function elm_diskselector_item_icon_set. If no icon
25662 * was passed as argument, it will return @c NULL.
25664 * @see elm_diskselector_item_append()
25665 * @see elm_diskselector_item_icon_set()
25667 * @ingroup Diskselector
25669 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25672 * Set the label of item.
25674 * @param it The item of diskselector.
25675 * @param label The label of item.
25677 * The label to be displayed by the item.
25679 * If no icon is set, label will be centered on item position, otherwise
25680 * the icon will be placed at left of the label, that will be shifted
25683 * An item with label "January" would be displayed on side position as
25684 * "Jan" if max length is set to 3 with function
25685 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
25688 * When this @p item is selected, the entire label will be displayed,
25689 * except for width restrictions.
25690 * In this case label will be cropped and "..." will be concatenated,
25691 * but only for display purposes. It will keep the entire string, so
25692 * if diskselector is resized the remaining characters will be displayed.
25694 * If a label was passed as argument on item creation, with function
25695 * elm_diskselector_item_append(), it will be already
25696 * displayed by the item.
25698 * @see elm_diskselector_side_label_lenght_set()
25699 * @see elm_diskselector_item_label_get()
25700 * @see elm_diskselector_item_append()
25702 * @ingroup Diskselector
25704 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
25707 * Get the label of item.
25709 * @param it The item of diskselector.
25710 * @return The label of item.
25712 * The return value is a pointer to the label associated to @p item when it was
25713 * created, with function elm_diskselector_item_append(), or later
25714 * with function elm_diskselector_item_label_set. If no label
25715 * was passed as argument, it will return @c NULL.
25717 * @see elm_diskselector_item_label_set() for more details.
25718 * @see elm_diskselector_item_append()
25720 * @ingroup Diskselector
25722 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25725 * Get the selected item.
25727 * @param obj The diskselector object.
25728 * @return The selected diskselector item.
25730 * The selected item can be unselected with function
25731 * elm_diskselector_item_selected_set(), and the first item of
25732 * diskselector will be selected.
25734 * The selected item always will be centered on diskselector, with
25735 * full label displayed, i.e., max lenght set to side labels won't
25736 * apply on the selected item. More details on
25737 * elm_diskselector_side_label_length_set().
25739 * @ingroup Diskselector
25741 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25744 * Set the selected state of an item.
25746 * @param it The diskselector item
25747 * @param selected The selected state
25749 * This sets the selected state of the given item @p it.
25750 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
25752 * If a new item is selected the previosly selected will be unselected.
25753 * Previoulsy selected item can be get with function
25754 * elm_diskselector_selected_item_get().
25756 * If the item @p it is unselected, the first item of diskselector will
25759 * Selected items will be visible on center position of diskselector.
25760 * So if it was on another position before selected, or was invisible,
25761 * diskselector will animate items until the selected item reaches center
25764 * @see elm_diskselector_item_selected_get()
25765 * @see elm_diskselector_selected_item_get()
25767 * @ingroup Diskselector
25769 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
25772 * Get whether the @p item is selected or not.
25774 * @param it The diskselector item.
25775 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
25776 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
25778 * @see elm_diskselector_selected_item_set() for details.
25779 * @see elm_diskselector_item_selected_get()
25781 * @ingroup Diskselector
25783 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25786 * Get the first item of the diskselector.
25788 * @param obj The diskselector object.
25789 * @return The first item, or @c NULL if none.
25791 * The list of items follows append order. So it will return the first
25792 * item appended to the widget that wasn't deleted.
25794 * @see elm_diskselector_item_append()
25795 * @see elm_diskselector_items_get()
25797 * @ingroup Diskselector
25799 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25802 * Get the last item of the diskselector.
25804 * @param obj The diskselector object.
25805 * @return The last item, or @c NULL if none.
25807 * The list of items follows append order. So it will return last first
25808 * item appended to the widget that wasn't deleted.
25810 * @see elm_diskselector_item_append()
25811 * @see elm_diskselector_items_get()
25813 * @ingroup Diskselector
25815 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25818 * Get the item before @p item in diskselector.
25820 * @param it The diskselector item.
25821 * @return The item before @p item, or @c NULL if none or on failure.
25823 * The list of items follows append order. So it will return item appended
25824 * just before @p item and that wasn't deleted.
25826 * If it is the first item, @c NULL will be returned.
25827 * First item can be get by elm_diskselector_first_item_get().
25829 * @see elm_diskselector_item_append()
25830 * @see elm_diskselector_items_get()
25832 * @ingroup Diskselector
25834 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25837 * Get the item after @p item in diskselector.
25839 * @param it The diskselector item.
25840 * @return The item after @p item, or @c NULL if none or on failure.
25842 * The list of items follows append order. So it will return item appended
25843 * just after @p item and that wasn't deleted.
25845 * If it is the last item, @c NULL will be returned.
25846 * Last item can be get by elm_diskselector_last_item_get().
25848 * @see elm_diskselector_item_append()
25849 * @see elm_diskselector_items_get()
25851 * @ingroup Diskselector
25853 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25856 * Set the text to be shown in the diskselector item.
25858 * @param item Target item
25859 * @param text The text to set in the content
25861 * Setup the text as tooltip to object. The item can have only one tooltip,
25862 * so any previous tooltip data is removed.
25864 * @see elm_object_tooltip_text_set() for more details.
25866 * @ingroup Diskselector
25868 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
25871 * Set the content to be shown in the tooltip item.
25873 * Setup the tooltip to item. The item can have only one tooltip,
25874 * so any previous tooltip data is removed. @p func(with @p data) will
25875 * be called every time that need show the tooltip and it should
25876 * return a valid Evas_Object. This object is then managed fully by
25877 * tooltip system and is deleted when the tooltip is gone.
25879 * @param item the diskselector item being attached a tooltip.
25880 * @param func the function used to create the tooltip contents.
25881 * @param data what to provide to @a func as callback data/context.
25882 * @param del_cb called when data is not needed anymore, either when
25883 * another callback replaces @p func, the tooltip is unset with
25884 * elm_diskselector_item_tooltip_unset() or the owner @a item
25885 * dies. This callback receives as the first parameter the
25886 * given @a data, and @c event_info is the item.
25888 * @see elm_object_tooltip_content_cb_set() for more details.
25890 * @ingroup Diskselector
25892 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);
25895 * Unset tooltip from item.
25897 * @param item diskselector item to remove previously set tooltip.
25899 * Remove tooltip from item. The callback provided as del_cb to
25900 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
25901 * it is not used anymore.
25903 * @see elm_object_tooltip_unset() for more details.
25904 * @see elm_diskselector_item_tooltip_content_cb_set()
25906 * @ingroup Diskselector
25908 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25912 * Sets a different style for this item tooltip.
25914 * @note before you set a style you should define a tooltip with
25915 * elm_diskselector_item_tooltip_content_cb_set() or
25916 * elm_diskselector_item_tooltip_text_set()
25918 * @param item diskselector item with tooltip already set.
25919 * @param style the theme style to use (default, transparent, ...)
25921 * @see elm_object_tooltip_style_set() for more details.
25923 * @ingroup Diskselector
25925 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
25928 * Get the style for this item tooltip.
25930 * @param item diskselector item with tooltip already set.
25931 * @return style the theme style in use, defaults to "default". If the
25932 * object does not have a tooltip set, then NULL is returned.
25934 * @see elm_object_tooltip_style_get() for more details.
25935 * @see elm_diskselector_item_tooltip_style_set()
25937 * @ingroup Diskselector
25939 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25942 * Set the cursor to be shown when mouse is over the diskselector item
25944 * @param item Target item
25945 * @param cursor the cursor name to be used.
25947 * @see elm_object_cursor_set() for more details.
25949 * @ingroup Diskselector
25951 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
25954 * Get the cursor to be shown when mouse is over the diskselector item
25956 * @param item diskselector item with cursor already set.
25957 * @return the cursor name.
25959 * @see elm_object_cursor_get() for more details.
25960 * @see elm_diskselector_cursor_set()
25962 * @ingroup Diskselector
25964 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25968 * Unset the cursor to be shown when mouse is over the diskselector item
25970 * @param item Target item
25972 * @see elm_object_cursor_unset() for more details.
25973 * @see elm_diskselector_cursor_set()
25975 * @ingroup Diskselector
25977 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25980 * Sets a different style for this item cursor.
25982 * @note before you set a style you should define a cursor with
25983 * elm_diskselector_item_cursor_set()
25985 * @param item diskselector item with cursor already set.
25986 * @param style the theme style to use (default, transparent, ...)
25988 * @see elm_object_cursor_style_set() for more details.
25990 * @ingroup Diskselector
25992 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
25996 * Get the style for this item cursor.
25998 * @param item diskselector item with cursor already set.
25999 * @return style the theme style in use, defaults to "default". If the
26000 * object does not have a cursor set, then @c NULL is returned.
26002 * @see elm_object_cursor_style_get() for more details.
26003 * @see elm_diskselector_item_cursor_style_set()
26005 * @ingroup Diskselector
26007 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26011 * Set if the cursor set should be searched on the theme or should use
26012 * the provided by the engine, only.
26014 * @note before you set if should look on theme you should define a cursor
26015 * with elm_diskselector_item_cursor_set().
26016 * By default it will only look for cursors provided by the engine.
26018 * @param item widget item with cursor already set.
26019 * @param engine_only boolean to define if cursors set with
26020 * elm_diskselector_item_cursor_set() should be searched only
26021 * between cursors provided by the engine or searched on widget's
26024 * @see elm_object_cursor_engine_only_set() for more details.
26026 * @ingroup Diskselector
26028 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26031 * Get the cursor engine only usage for this item cursor.
26033 * @param item widget item with cursor already set.
26034 * @return engine_only boolean to define it cursors should be looked only
26035 * between the provided by the engine or searched on widget's theme as well.
26036 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26038 * @see elm_object_cursor_engine_only_get() for more details.
26039 * @see elm_diskselector_item_cursor_engine_only_set()
26041 * @ingroup Diskselector
26043 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26050 * @defgroup Colorselector Colorselector
26054 * @image html img/widget/colorselector/preview-00.png
26055 * @image latex img/widget/colorselector/preview-00.eps
26057 * @brief Widget for user to select a color.
26059 * Signals that you can add callbacks for are:
26060 * "changed" - When the color value changes(event_info is NULL).
26062 * See @ref tutorial_colorselector.
26065 * @brief Add a new colorselector to the parent
26067 * @param parent The parent object
26068 * @return The new object or NULL if it cannot be created
26070 * @ingroup Colorselector
26072 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26074 * Set a color for the colorselector
26076 * @param obj Colorselector object
26077 * @param r r-value of color
26078 * @param g g-value of color
26079 * @param b b-value of color
26080 * @param a a-value of color
26082 * @ingroup Colorselector
26084 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26086 * Get a color from the colorselector
26088 * @param obj Colorselector object
26089 * @param r integer pointer for r-value of color
26090 * @param g integer pointer for g-value of color
26091 * @param b integer pointer for b-value of color
26092 * @param a integer pointer for a-value of color
26094 * @ingroup Colorselector
26096 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26102 * @defgroup Ctxpopup Ctxpopup
26104 * @image html img/widget/ctxpopup/preview-00.png
26105 * @image latex img/widget/ctxpopup/preview-00.eps
26107 * @brief Context popup widet.
26109 * A ctxpopup is a widget that, when shown, pops up a list of items.
26110 * It automatically chooses an area inside its parent object's view
26111 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26112 * optimally fit into it. In the default theme, it will also point an
26113 * arrow to it's top left position at the time one shows it. Ctxpopup
26114 * items have a label and/or an icon. It is intended for a small
26115 * number of items (hence the use of list, not genlist).
26117 * @note Ctxpopup is a especialization of @ref Hover.
26119 * Signals that you can add callbacks for are:
26120 * "dismissed" - the ctxpopup was dismissed
26122 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26125 typedef enum _Elm_Ctxpopup_Direction
26127 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26129 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26130 the clicked area */
26131 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26132 the clicked area */
26133 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26135 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26136 } Elm_Ctxpopup_Direction;
26139 * @brief Add a new Ctxpopup object to the parent.
26141 * @param parent Parent object
26142 * @return New object or @c NULL, if it cannot be created
26144 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26146 * @brief Set the Ctxpopup's parent
26148 * @param obj The ctxpopup object
26149 * @param area The parent to use
26151 * Set the parent object.
26153 * @note elm_ctxpopup_add() will automatically call this function
26154 * with its @c parent argument.
26156 * @see elm_ctxpopup_add()
26157 * @see elm_hover_parent_set()
26159 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26161 * @brief Get the Ctxpopup's parent
26163 * @param obj The ctxpopup object
26165 * @see elm_ctxpopup_hover_parent_set() for more information
26167 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26169 * @brief Clear all items in the given ctxpopup object.
26171 * @param obj Ctxpopup object
26173 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26175 * @brief Change the ctxpopup's orientation to horizontal or vertical.
26177 * @param obj Ctxpopup object
26178 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26180 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26182 * @brief Get the value of current ctxpopup object's orientation.
26184 * @param obj Ctxpopup object
26185 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26187 * @see elm_ctxpopup_horizontal_set()
26189 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26191 * @brief Add a new item to a ctxpopup object.
26193 * @param obj Ctxpopup object
26194 * @param icon Icon to be set on new item
26195 * @param label The Label of the new item
26196 * @param func Convenience function called when item selected
26197 * @param data Data passed to @p func
26198 * @return A handle to the item added or @c NULL, on errors
26200 * @warning Ctxpopup can't hold both an item list and a content at the same
26201 * time. When an item is added, any previous content will be removed.
26203 * @see elm_ctxpopup_content_set()
26205 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);
26207 * @brief Delete the given item in a ctxpopup object.
26209 * @param it Ctxpopup item to be deleted
26211 * @see elm_ctxpopup_item_append()
26213 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26215 * @brief Set the ctxpopup item's state as disabled or enabled.
26217 * @param it Ctxpopup item to be enabled/disabled
26218 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26220 * When disabled the item is greyed out to indicate it's state.
26222 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26224 * @brief Get the ctxpopup item's disabled/enabled state.
26226 * @param it Ctxpopup item to be enabled/disabled
26227 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26229 * @see elm_ctxpopup_item_disabled_set()
26231 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26233 * @brief Get the icon object for the given ctxpopup item.
26235 * @param it Ctxpopup item
26236 * @return icon object or @c NULL, if the item does not have icon or an error
26239 * @see elm_ctxpopup_item_append()
26240 * @see elm_ctxpopup_item_icon_set()
26242 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26244 * @brief Sets the side icon associated with the ctxpopup item
26246 * @param it Ctxpopup item
26247 * @param icon Icon object to be set
26249 * Once the icon object is set, a previously set one will be deleted.
26250 * @warning Setting the same icon for two items will cause the icon to
26251 * dissapear from the first item.
26253 * @see elm_ctxpopup_item_append()
26255 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26257 * @brief Get the label for the given ctxpopup item.
26259 * @param it Ctxpopup item
26260 * @return label string or @c NULL, if the item does not have label or an
26263 * @see elm_ctxpopup_item_append()
26264 * @see elm_ctxpopup_item_label_set()
26266 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26268 * @brief (Re)set the label on the given ctxpopup item.
26270 * @param it Ctxpopup item
26271 * @param label String to set as label
26273 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26275 * @brief Set an elm widget as the content of the ctxpopup.
26277 * @param obj Ctxpopup object
26278 * @param content Content to be swallowed
26280 * If the content object is already set, a previous one will bedeleted. If
26281 * you want to keep that old content object, use the
26282 * elm_ctxpopup_content_unset() function.
26284 * @deprecated use elm_object_content_set()
26286 * @warning Ctxpopup can't hold both a item list and a content at the same
26287 * time. When a content is set, any previous items will be removed.
26289 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26291 * @brief Unset the ctxpopup content
26293 * @param obj Ctxpopup object
26294 * @return The content that was being used
26296 * Unparent and return the content object which was set for this widget.
26298 * @deprecated use elm_object_content_unset()
26300 * @see elm_ctxpopup_content_set()
26302 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26304 * @brief Set the direction priority of a ctxpopup.
26306 * @param obj Ctxpopup object
26307 * @param first 1st priority of direction
26308 * @param second 2nd priority of direction
26309 * @param third 3th priority of direction
26310 * @param fourth 4th priority of direction
26312 * This functions gives a chance to user to set the priority of ctxpopup
26313 * showing direction. This doesn't guarantee the ctxpopup will appear in the
26314 * requested direction.
26316 * @see Elm_Ctxpopup_Direction
26318 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);
26320 * @brief Get the direction priority of a ctxpopup.
26322 * @param obj Ctxpopup object
26323 * @param first 1st priority of direction to be returned
26324 * @param second 2nd priority of direction to be returned
26325 * @param third 3th priority of direction to be returned
26326 * @param fourth 4th priority of direction to be returned
26328 * @see elm_ctxpopup_direction_priority_set() for more information.
26330 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);
26333 * @brief Get the current direction of a ctxpopup.
26335 * @param obj Ctxpopup object
26336 * @return current direction of a ctxpopup
26338 * @warning Once the ctxpopup showed up, the direction would be determined
26340 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26349 * @defgroup Transit Transit
26350 * @ingroup Elementary
26352 * Transit is designed to apply various animated transition effects to @c
26353 * Evas_Object, such like translation, rotation, etc. For using these
26354 * effects, create an @ref Elm_Transit and add the desired transition effects.
26356 * Once the effects are added into transit, they will be automatically
26357 * managed (their callback will be called until the duration is ended, and
26358 * they will be deleted on completion).
26362 * Elm_Transit *trans = elm_transit_add();
26363 * elm_transit_object_add(trans, obj);
26364 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26365 * elm_transit_duration_set(transit, 1);
26366 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26367 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26368 * elm_transit_repeat_times_set(transit, 3);
26371 * Some transition effects are used to change the properties of objects. They
26373 * @li @ref elm_transit_effect_translation_add
26374 * @li @ref elm_transit_effect_color_add
26375 * @li @ref elm_transit_effect_rotation_add
26376 * @li @ref elm_transit_effect_wipe_add
26377 * @li @ref elm_transit_effect_zoom_add
26378 * @li @ref elm_transit_effect_resizing_add
26380 * Other transition effects are used to make one object disappear and another
26381 * object appear on its old place. These effects are:
26383 * @li @ref elm_transit_effect_flip_add
26384 * @li @ref elm_transit_effect_resizable_flip_add
26385 * @li @ref elm_transit_effect_fade_add
26386 * @li @ref elm_transit_effect_blend_add
26388 * It's also possible to make a transition chain with @ref
26389 * elm_transit_chain_transit_add.
26391 * @warning We strongly recommend to use elm_transit just when edje can not do
26392 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26393 * animations can be manipulated inside the theme.
26395 * List of examples:
26396 * @li @ref transit_example_01_explained
26397 * @li @ref transit_example_02_explained
26398 * @li @ref transit_example_03_c
26399 * @li @ref transit_example_04_c
26405 * @enum Elm_Transit_Tween_Mode
26407 * The type of acceleration used in the transition.
26411 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26412 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26413 over time, then decrease again
26415 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26417 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26419 } Elm_Transit_Tween_Mode;
26422 * @enum Elm_Transit_Effect_Flip_Axis
26424 * The axis where flip effect should be applied.
26428 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26429 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26430 } Elm_Transit_Effect_Flip_Axis;
26432 * @enum Elm_Transit_Effect_Wipe_Dir
26434 * The direction where the wipe effect should occur.
26438 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26439 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26440 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26441 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26442 } Elm_Transit_Effect_Wipe_Dir;
26443 /** @enum Elm_Transit_Effect_Wipe_Type
26445 * Whether the wipe effect should show or hide the object.
26449 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26451 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26453 } Elm_Transit_Effect_Wipe_Type;
26456 * @typedef Elm_Transit
26458 * The Transit created with elm_transit_add(). This type has the information
26459 * about the objects which the transition will be applied, and the
26460 * transition effects that will be used. It also contains info about
26461 * duration, number of repetitions, auto-reverse, etc.
26463 typedef struct _Elm_Transit Elm_Transit;
26464 typedef void Elm_Transit_Effect;
26466 * @typedef Elm_Transit_Effect_Transition_Cb
26468 * Transition callback called for this effect on each transition iteration.
26470 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26472 * Elm_Transit_Effect_End_Cb
26474 * Transition callback called for this effect when the transition is over.
26476 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26479 * Elm_Transit_Del_Cb
26481 * A callback called when the transit is deleted.
26483 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26488 * @note Is not necessary to delete the transit object, it will be deleted at
26489 * the end of its operation.
26490 * @note The transit will start playing when the program enter in the main loop, is not
26491 * necessary to give a start to the transit.
26493 * @return The transit object.
26497 EAPI Elm_Transit *elm_transit_add(void);
26500 * Stops the animation and delete the @p transit object.
26502 * Call this function if you wants to stop the animation before the duration
26503 * time. Make sure the @p transit object is still alive with
26504 * elm_transit_del_cb_set() function.
26505 * All added effects will be deleted, calling its repective data_free_cb
26506 * functions. The function setted by elm_transit_del_cb_set() will be called.
26508 * @see elm_transit_del_cb_set()
26510 * @param transit The transit object to be deleted.
26513 * @warning Just call this function if you are sure the transit is alive.
26515 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26518 * Add a new effect to the transit.
26520 * @note The cb function and the data are the key to the effect. If you try to
26521 * add an already added effect, nothing is done.
26522 * @note After the first addition of an effect in @p transit, if its
26523 * effect list become empty again, the @p transit will be killed by
26524 * elm_transit_del(transit) function.
26528 * Elm_Transit *transit = elm_transit_add();
26529 * elm_transit_effect_add(transit,
26530 * elm_transit_effect_blend_op,
26531 * elm_transit_effect_blend_context_new(),
26532 * elm_transit_effect_blend_context_free);
26535 * @param transit The transit object.
26536 * @param transition_cb The operation function. It is called when the
26537 * animation begins, it is the function that actually performs the animation.
26538 * It is called with the @p data, @p transit and the time progression of the
26539 * animation (a double value between 0.0 and 1.0).
26540 * @param effect The context data of the effect.
26541 * @param end_cb The function to free the context data, it will be called
26542 * at the end of the effect, it must finalize the animation and free the
26546 * @warning The transit free the context data at the and of the transition with
26547 * the data_free_cb function, do not use the context data in another transit.
26549 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);
26552 * Delete an added effect.
26554 * This function will remove the effect from the @p transit, calling the
26555 * data_free_cb to free the @p data.
26557 * @see elm_transit_effect_add()
26559 * @note If the effect is not found, nothing is done.
26560 * @note If the effect list become empty, this function will call
26561 * elm_transit_del(transit), that is, it will kill the @p transit.
26563 * @param transit The transit object.
26564 * @param transition_cb The operation function.
26565 * @param effect The context data of the effect.
26569 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);
26572 * Add new object to apply the effects.
26574 * @note After the first addition of an object in @p transit, if its
26575 * object list become empty again, the @p transit will be killed by
26576 * elm_transit_del(transit) function.
26577 * @note If the @p obj belongs to another transit, the @p obj will be
26578 * removed from it and it will only belong to the @p transit. If the old
26579 * transit stays without objects, it will die.
26580 * @note When you add an object into the @p transit, its state from
26581 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26582 * transit ends, if you change this state whith evas_object_pass_events_set()
26583 * after add the object, this state will change again when @p transit stops to
26586 * @param transit The transit object.
26587 * @param obj Object to be animated.
26590 * @warning It is not allowed to add a new object after transit begins to go.
26592 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26595 * Removes an added object from the transit.
26597 * @note If the @p obj is not in the @p transit, nothing is done.
26598 * @note If the list become empty, this function will call
26599 * elm_transit_del(transit), that is, it will kill the @p transit.
26601 * @param transit The transit object.
26602 * @param obj Object to be removed from @p transit.
26605 * @warning It is not allowed to remove objects after transit begins to go.
26607 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26610 * Get the objects of the transit.
26612 * @param transit The transit object.
26613 * @return a Eina_List with the objects from the transit.
26617 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26620 * Enable/disable keeping up the objects states.
26621 * If it is not kept, the objects states will be reset when transition ends.
26623 * @note @p transit can not be NULL.
26624 * @note One state includes geometry, color, map data.
26626 * @param transit The transit object.
26627 * @param state_keep Keeping or Non Keeping.
26631 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
26634 * Get a value whether the objects states will be reset or not.
26636 * @note @p transit can not be NULL
26638 * @see elm_transit_objects_final_state_keep_set()
26640 * @param transit The transit object.
26641 * @return EINA_TRUE means the states of the objects will be reset.
26642 * If @p transit is NULL, EINA_FALSE is returned
26646 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26649 * Set the event enabled when transit is operating.
26651 * If @p enabled is EINA_TRUE, the objects of the transit will receives
26652 * events from mouse and keyboard during the animation.
26653 * @note When you add an object with elm_transit_object_add(), its state from
26654 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26655 * transit ends, if you change this state with evas_object_pass_events_set()
26656 * after adding the object, this state will change again when @p transit stops
26659 * @param transit The transit object.
26660 * @param enabled Events are received when enabled is @c EINA_TRUE, and
26661 * ignored otherwise.
26665 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26668 * Get the value of event enabled status.
26670 * @see elm_transit_event_enabled_set()
26672 * @param transit The Transit object
26673 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
26674 * EINA_FALSE is returned
26678 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26681 * Set the user-callback function when the transit is deleted.
26683 * @note Using this function twice will overwrite the first function setted.
26684 * @note the @p transit object will be deleted after call @p cb function.
26686 * @param transit The transit object.
26687 * @param cb Callback function pointer. This function will be called before
26688 * the deletion of the transit.
26689 * @param data Callback funtion user data. It is the @p op parameter.
26693 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
26696 * Set reverse effect automatically.
26698 * If auto reverse is setted, after running the effects with the progress
26699 * parameter from 0 to 1, it will call the effecs again with the progress
26700 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
26701 * where the duration was setted with the function elm_transit_add and
26702 * the repeat with the function elm_transit_repeat_times_set().
26704 * @param transit The transit object.
26705 * @param reverse EINA_TRUE means the auto_reverse is on.
26709 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
26712 * Get if the auto reverse is on.
26714 * @see elm_transit_auto_reverse_set()
26716 * @param transit The transit object.
26717 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
26718 * EINA_FALSE is returned
26722 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26725 * Set the transit repeat count. Effect will be repeated by repeat count.
26727 * This function sets the number of repetition the transit will run after
26728 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
26729 * If the @p repeat is a negative number, it will repeat infinite times.
26731 * @note If this function is called during the transit execution, the transit
26732 * will run @p repeat times, ignoring the times it already performed.
26734 * @param transit The transit object
26735 * @param repeat Repeat count
26739 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
26742 * Get the transit repeat count.
26744 * @see elm_transit_repeat_times_set()
26746 * @param transit The Transit object.
26747 * @return The repeat count. If @p transit is NULL
26752 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26755 * Set the transit animation acceleration type.
26757 * This function sets the tween mode of the transit that can be:
26758 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
26759 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
26760 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
26761 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
26763 * @param transit The transit object.
26764 * @param tween_mode The tween type.
26768 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
26771 * Get the transit animation acceleration type.
26773 * @note @p transit can not be NULL
26775 * @param transit The transit object.
26776 * @return The tween type. If @p transit is NULL
26777 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
26781 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26784 * Set the transit animation time
26786 * @note @p transit can not be NULL
26788 * @param transit The transit object.
26789 * @param duration The animation time.
26793 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
26796 * Get the transit animation time
26798 * @note @p transit can not be NULL
26800 * @param transit The transit object.
26802 * @return The transit animation time.
26806 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26809 * Starts the transition.
26810 * Once this API is called, the transit begins to measure the time.
26812 * @note @p transit can not be NULL
26814 * @param transit The transit object.
26818 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26821 * Pause/Resume the transition.
26823 * If you call elm_transit_go again, the transit will be started from the
26824 * beginning, and will be unpaused.
26826 * @note @p transit can not be NULL
26828 * @param transit The transit object.
26829 * @param paused Whether the transition should be paused or not.
26833 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
26836 * Get the value of paused status.
26838 * @see elm_transit_paused_set()
26840 * @note @p transit can not be NULL
26842 * @param transit The transit object.
26843 * @return EINA_TRUE means transition is paused. If @p transit is NULL
26844 * EINA_FALSE is returned
26848 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26851 * Get the time progression of the animation (a double value between 0.0 and 1.0).
26853 * The value returned is a fraction (current time / total time). It
26854 * represents the progression position relative to the total.
26856 * @note @p transit can not be NULL
26858 * @param transit The transit object.
26860 * @return The time progression value. If @p transit is NULL
26865 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26868 * Makes the chain relationship between two transits.
26870 * @note @p transit can not be NULL. Transit would have multiple chain transits.
26871 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
26873 * @param transit The transit object.
26874 * @param chain_transit The chain transit object. This transit will be operated
26875 * after transit is done.
26877 * This function adds @p chain_transit transition to a chain after the @p
26878 * transit, and will be started as soon as @p transit ends. See @ref
26879 * transit_example_02_explained for a full example.
26883 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
26886 * Cut off the chain relationship between two transits.
26888 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
26889 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
26891 * @param transit The transit object.
26892 * @param chain_transit The chain transit object.
26894 * This function remove the @p chain_transit transition from the @p transit.
26898 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
26901 * Get the current chain transit list.
26903 * @note @p transit can not be NULL.
26905 * @param transit The transit object.
26906 * @return chain transit list.
26910 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
26913 * Add the Resizing Effect to Elm_Transit.
26915 * @note This API is one of the facades. It creates resizing effect context
26916 * and add it's required APIs to elm_transit_effect_add.
26918 * @see elm_transit_effect_add()
26920 * @param transit Transit object.
26921 * @param from_w Object width size when effect begins.
26922 * @param from_h Object height size when effect begins.
26923 * @param to_w Object width size when effect ends.
26924 * @param to_h Object height size when effect ends.
26925 * @return Resizing effect context data.
26929 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);
26932 * Add the Translation Effect to Elm_Transit.
26934 * @note This API is one of the facades. It creates translation effect context
26935 * and add it's required APIs to elm_transit_effect_add.
26937 * @see elm_transit_effect_add()
26939 * @param transit Transit object.
26940 * @param from_dx X Position variation when effect begins.
26941 * @param from_dy Y Position variation when effect begins.
26942 * @param to_dx X Position variation when effect ends.
26943 * @param to_dy Y Position variation when effect ends.
26944 * @return Translation effect context data.
26947 * @warning It is highly recommended just create a transit with this effect when
26948 * the window that the objects of the transit belongs has already been created.
26949 * This is because this effect needs the geometry information about the objects,
26950 * and if the window was not created yet, it can get a wrong information.
26952 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);
26955 * Add the Zoom Effect to Elm_Transit.
26957 * @note This API is one of the facades. It creates zoom effect context
26958 * and add it's required APIs to elm_transit_effect_add.
26960 * @see elm_transit_effect_add()
26962 * @param transit Transit object.
26963 * @param from_rate Scale rate when effect begins (1 is current rate).
26964 * @param to_rate Scale rate when effect ends.
26965 * @return Zoom effect context data.
26968 * @warning It is highly recommended just create a transit with this effect when
26969 * the window that the objects of the transit belongs has already been created.
26970 * This is because this effect needs the geometry information about the objects,
26971 * and if the window was not created yet, it can get a wrong information.
26973 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
26976 * Add the Flip Effect to Elm_Transit.
26978 * @note This API is one of the facades. It creates flip effect context
26979 * and add it's required APIs to elm_transit_effect_add.
26980 * @note This effect is applied to each pair of objects in the order they are listed
26981 * in the transit list of objects. The first object in the pair will be the
26982 * "front" object and the second will be the "back" object.
26984 * @see elm_transit_effect_add()
26986 * @param transit Transit object.
26987 * @param axis Flipping Axis(X or Y).
26988 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
26989 * @return Flip effect context data.
26992 * @warning It is highly recommended just create a transit with this effect when
26993 * the window that the objects of the transit belongs has already been created.
26994 * This is because this effect needs the geometry information about the objects,
26995 * and if the window was not created yet, it can get a wrong information.
26997 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27000 * Add the Resizable Flip Effect to Elm_Transit.
27002 * @note This API is one of the facades. It creates resizable flip effect context
27003 * and add it's required APIs to elm_transit_effect_add.
27004 * @note This effect is applied to each pair of objects in the order they are listed
27005 * in the transit list of objects. The first object in the pair will be the
27006 * "front" object and the second will be the "back" object.
27008 * @see elm_transit_effect_add()
27010 * @param transit Transit object.
27011 * @param axis Flipping Axis(X or Y).
27012 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27013 * @return Resizable flip effect context data.
27016 * @warning It is highly recommended just create a transit with this effect when
27017 * the window that the objects of the transit belongs has already been created.
27018 * This is because this effect needs the geometry information about the objects,
27019 * and if the window was not created yet, it can get a wrong information.
27021 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27024 * Add the Wipe Effect to Elm_Transit.
27026 * @note This API is one of the facades. It creates wipe effect context
27027 * and add it's required APIs to elm_transit_effect_add.
27029 * @see elm_transit_effect_add()
27031 * @param transit Transit object.
27032 * @param type Wipe type. Hide or show.
27033 * @param dir Wipe Direction.
27034 * @return Wipe effect context data.
27037 * @warning It is highly recommended just create a transit with this effect when
27038 * the window that the objects of the transit belongs has already been created.
27039 * This is because this effect needs the geometry information about the objects,
27040 * and if the window was not created yet, it can get a wrong information.
27042 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27045 * Add the Color Effect to Elm_Transit.
27047 * @note This API is one of the facades. It creates color effect context
27048 * and add it's required APIs to elm_transit_effect_add.
27050 * @see elm_transit_effect_add()
27052 * @param transit Transit object.
27053 * @param from_r RGB R when effect begins.
27054 * @param from_g RGB G when effect begins.
27055 * @param from_b RGB B when effect begins.
27056 * @param from_a RGB A when effect begins.
27057 * @param to_r RGB R when effect ends.
27058 * @param to_g RGB G when effect ends.
27059 * @param to_b RGB B when effect ends.
27060 * @param to_a RGB A when effect ends.
27061 * @return Color effect context data.
27065 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);
27068 * Add the Fade Effect to Elm_Transit.
27070 * @note This API is one of the facades. It creates fade effect context
27071 * and add it's required APIs to elm_transit_effect_add.
27072 * @note This effect is applied to each pair of objects in the order they are listed
27073 * in the transit list of objects. The first object in the pair will be the
27074 * "before" object and the second will be the "after" object.
27076 * @see elm_transit_effect_add()
27078 * @param transit Transit object.
27079 * @return Fade effect context data.
27082 * @warning It is highly recommended just create a transit with this effect when
27083 * the window that the objects of the transit belongs has already been created.
27084 * This is because this effect needs the color information about the objects,
27085 * and if the window was not created yet, it can get a wrong information.
27087 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27090 * Add the Blend Effect to Elm_Transit.
27092 * @note This API is one of the facades. It creates blend effect context
27093 * and add it's required APIs to elm_transit_effect_add.
27094 * @note This effect is applied to each pair of objects in the order they are listed
27095 * in the transit list of objects. The first object in the pair will be the
27096 * "before" object and the second will be the "after" object.
27098 * @see elm_transit_effect_add()
27100 * @param transit Transit object.
27101 * @return Blend effect context data.
27104 * @warning It is highly recommended just create a transit with this effect when
27105 * the window that the objects of the transit belongs has already been created.
27106 * This is because this effect needs the color information about the objects,
27107 * and if the window was not created yet, it can get a wrong information.
27109 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27112 * Add the Rotation Effect to Elm_Transit.
27114 * @note This API is one of the facades. It creates rotation effect context
27115 * and add it's required APIs to elm_transit_effect_add.
27117 * @see elm_transit_effect_add()
27119 * @param transit Transit object.
27120 * @param from_degree Degree when effect begins.
27121 * @param to_degree Degree when effect is ends.
27122 * @return Rotation effect context data.
27125 * @warning It is highly recommended just create a transit with this effect when
27126 * the window that the objects of the transit belongs has already been created.
27127 * This is because this effect needs the geometry information about the objects,
27128 * and if the window was not created yet, it can get a wrong information.
27130 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27133 * Add the ImageAnimation Effect to Elm_Transit.
27135 * @note This API is one of the facades. It creates image animation effect context
27136 * and add it's required APIs to elm_transit_effect_add.
27137 * The @p images parameter is a list images paths. This list and
27138 * its contents will be deleted at the end of the effect by
27139 * elm_transit_effect_image_animation_context_free() function.
27143 * char buf[PATH_MAX];
27144 * Eina_List *images = NULL;
27145 * Elm_Transit *transi = elm_transit_add();
27147 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27148 * images = eina_list_append(images, eina_stringshare_add(buf));
27150 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27151 * images = eina_list_append(images, eina_stringshare_add(buf));
27152 * elm_transit_effect_image_animation_add(transi, images);
27156 * @see elm_transit_effect_add()
27158 * @param transit Transit object.
27159 * @param images Eina_List of images file paths. This list and
27160 * its contents will be deleted at the end of the effect by
27161 * elm_transit_effect_image_animation_context_free() function.
27162 * @return Image Animation effect context data.
27166 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27171 typedef struct _Elm_Store Elm_Store;
27172 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
27173 typedef struct _Elm_Store_Item Elm_Store_Item;
27174 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
27175 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
27176 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27177 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
27178 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
27179 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
27180 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
27181 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
27183 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27184 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
27185 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
27186 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27190 ELM_STORE_ITEM_MAPPING_NONE = 0,
27191 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27192 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27193 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27194 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27195 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27196 // can add more here as needed by common apps
27197 ELM_STORE_ITEM_MAPPING_LAST
27198 } Elm_Store_Item_Mapping_Type;
27200 struct _Elm_Store_Item_Mapping_Icon
27202 // FIXME: allow edje file icons
27204 Elm_Icon_Lookup_Order lookup_order;
27205 Eina_Bool standard_name : 1;
27206 Eina_Bool no_scale : 1;
27207 Eina_Bool smooth : 1;
27208 Eina_Bool scale_up : 1;
27209 Eina_Bool scale_down : 1;
27212 struct _Elm_Store_Item_Mapping_Empty
27217 struct _Elm_Store_Item_Mapping_Photo
27222 struct _Elm_Store_Item_Mapping_Custom
27224 Elm_Store_Item_Mapping_Cb func;
27227 struct _Elm_Store_Item_Mapping
27229 Elm_Store_Item_Mapping_Type type;
27234 Elm_Store_Item_Mapping_Empty empty;
27235 Elm_Store_Item_Mapping_Icon icon;
27236 Elm_Store_Item_Mapping_Photo photo;
27237 Elm_Store_Item_Mapping_Custom custom;
27238 // add more types here
27242 struct _Elm_Store_Item_Info
27244 Elm_Genlist_Item_Class *item_class;
27245 const Elm_Store_Item_Mapping *mapping;
27250 struct _Elm_Store_Item_Info_Filesystem
27252 Elm_Store_Item_Info base;
27256 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27257 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27259 EAPI void elm_store_free(Elm_Store *st);
27261 EAPI Elm_Store *elm_store_filesystem_new(void);
27262 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27263 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27264 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27266 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27268 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27269 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27270 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27271 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27272 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27273 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27275 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27276 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27277 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27278 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27279 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27280 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27281 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27284 * @defgroup SegmentControl SegmentControl
27285 * @ingroup Elementary
27287 * @image html img/widget/segment_control/preview-00.png
27288 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27290 * @image html img/segment_control.png
27291 * @image latex img/segment_control.eps width=\textwidth
27293 * Segment control widget is a horizontal control made of multiple segment
27294 * items, each segment item functioning similar to discrete two state button.
27295 * A segment control groups the items together and provides compact
27296 * single button with multiple equal size segments.
27298 * Segment item size is determined by base widget
27299 * size and the number of items added.
27300 * Only one segment item can be at selected state. A segment item can display
27301 * combination of Text and any Evas_Object like Images or other widget.
27303 * Smart callbacks one can listen to:
27304 * - "changed" - When the user clicks on a segment item which is not
27305 * previously selected and get selected. The event_info parameter is the
27306 * segment item index.
27308 * Available styles for it:
27311 * Here is an example on its usage:
27312 * @li @ref segment_control_example
27316 * @addtogroup SegmentControl
27320 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27323 * Add a new segment control widget to the given parent Elementary
27324 * (container) object.
27326 * @param parent The parent object.
27327 * @return a new segment control widget handle or @c NULL, on errors.
27329 * This function inserts a new segment control widget on the canvas.
27331 * @ingroup SegmentControl
27333 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27336 * Append a new item to the segment control object.
27338 * @param obj The segment control object.
27339 * @param icon The icon object to use for the left side of the item. An
27340 * icon can be any Evas object, but usually it is an icon created
27341 * with elm_icon_add().
27342 * @param label The label of the item.
27343 * Note that, NULL is different from empty string "".
27344 * @return The created item or @c NULL upon failure.
27346 * A new item will be created and appended to the segment control, i.e., will
27347 * be set as @b last item.
27349 * If it should be inserted at another position,
27350 * elm_segment_control_item_insert_at() should be used instead.
27352 * Items created with this function can be deleted with function
27353 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27355 * @note @p label set to @c NULL is different from empty string "".
27357 * only has icon, it will be displayed bigger and centered. If it has
27358 * icon and label, even that an empty string, icon will be smaller and
27359 * positioned at left.
27363 * sc = elm_segment_control_add(win);
27364 * ic = elm_icon_add(win);
27365 * elm_icon_file_set(ic, "path/to/image", NULL);
27366 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27367 * elm_segment_control_item_add(sc, ic, "label");
27368 * evas_object_show(sc);
27371 * @see elm_segment_control_item_insert_at()
27372 * @see elm_segment_control_item_del()
27374 * @ingroup SegmentControl
27376 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27379 * Insert a new item to the segment control object at specified position.
27381 * @param obj The segment control object.
27382 * @param icon The icon object to use for the left side of the item. An
27383 * icon can be any Evas object, but usually it is an icon created
27384 * with elm_icon_add().
27385 * @param label The label of the item.
27386 * @param index Item position. Value should be between 0 and items count.
27387 * @return The created item or @c NULL upon failure.
27389 * Index values must be between @c 0, when item will be prepended to
27390 * segment control, and items count, that can be get with
27391 * elm_segment_control_item_count_get(), case when item will be appended
27392 * to segment control, just like elm_segment_control_item_add().
27394 * Items created with this function can be deleted with function
27395 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27397 * @note @p label set to @c NULL is different from empty string "".
27399 * only has icon, it will be displayed bigger and centered. If it has
27400 * icon and label, even that an empty string, icon will be smaller and
27401 * positioned at left.
27403 * @see elm_segment_control_item_add()
27404 * @see elm_segment_control_item_count_get()
27405 * @see elm_segment_control_item_del()
27407 * @ingroup SegmentControl
27409 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);
27412 * Remove a segment control item from its parent, deleting it.
27414 * @param it The item to be removed.
27416 * Items can be added with elm_segment_control_item_add() or
27417 * elm_segment_control_item_insert_at().
27419 * @ingroup SegmentControl
27421 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27424 * Remove a segment control item at given index from its parent,
27427 * @param obj The segment control object.
27428 * @param index The position of the segment control item to be deleted.
27430 * Items can be added with elm_segment_control_item_add() or
27431 * elm_segment_control_item_insert_at().
27433 * @ingroup SegmentControl
27435 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27438 * Get the Segment items count from segment control.
27440 * @param obj The segment control object.
27441 * @return Segment items count.
27443 * It will just return the number of items added to segment control @p obj.
27445 * @ingroup SegmentControl
27447 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27450 * Get the item placed at specified index.
27452 * @param obj The segment control object.
27453 * @param index The index of the segment item.
27454 * @return The segment control item or @c NULL on failure.
27456 * Index is the position of an item in segment control widget. Its
27457 * range is from @c 0 to <tt> count - 1 </tt>.
27458 * Count is the number of items, that can be get with
27459 * elm_segment_control_item_count_get().
27461 * @ingroup SegmentControl
27463 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27466 * Get the label of item.
27468 * @param obj The segment control object.
27469 * @param index The index of the segment item.
27470 * @return The label of the item at @p index.
27472 * The return value is a pointer to the label associated to the item when
27473 * it was created, with function elm_segment_control_item_add(), or later
27474 * with function elm_segment_control_item_label_set. If no label
27475 * was passed as argument, it will return @c NULL.
27477 * @see elm_segment_control_item_label_set() for more details.
27478 * @see elm_segment_control_item_add()
27480 * @ingroup SegmentControl
27482 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27485 * Set the label of item.
27487 * @param it The item of segment control.
27488 * @param text The label of item.
27490 * The label to be displayed by the item.
27491 * Label will be at right of the icon (if set).
27493 * If a label was passed as argument on item creation, with function
27494 * elm_control_segment_item_add(), it will be already
27495 * displayed by the item.
27497 * @see elm_segment_control_item_label_get()
27498 * @see elm_segment_control_item_add()
27500 * @ingroup SegmentControl
27502 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
27505 * Get the icon associated to the item.
27507 * @param obj The segment control object.
27508 * @param index The index of the segment item.
27509 * @return The left side icon associated to the item at @p index.
27511 * The return value is a pointer to the icon associated to the item when
27512 * it was created, with function elm_segment_control_item_add(), or later
27513 * with function elm_segment_control_item_icon_set(). If no icon
27514 * was passed as argument, it will return @c NULL.
27516 * @see elm_segment_control_item_add()
27517 * @see elm_segment_control_item_icon_set()
27519 * @ingroup SegmentControl
27521 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27524 * Set the icon associated to the item.
27526 * @param it The segment control item.
27527 * @param icon The icon object to associate with @p it.
27529 * The icon object to use at left side of the item. An
27530 * icon can be any Evas object, but usually it is an icon created
27531 * with elm_icon_add().
27533 * Once the icon object is set, a previously set one will be deleted.
27534 * @warning Setting the same icon for two items will cause the icon to
27535 * dissapear from the first item.
27537 * If an icon was passed as argument on item creation, with function
27538 * elm_segment_control_item_add(), it will be already
27539 * associated to the item.
27541 * @see elm_segment_control_item_add()
27542 * @see elm_segment_control_item_icon_get()
27544 * @ingroup SegmentControl
27546 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27549 * Get the index of an item.
27551 * @param it The segment control item.
27552 * @return The position of item in segment control widget.
27554 * Index is the position of an item in segment control widget. Its
27555 * range is from @c 0 to <tt> count - 1 </tt>.
27556 * Count is the number of items, that can be get with
27557 * elm_segment_control_item_count_get().
27559 * @ingroup SegmentControl
27561 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27564 * Get the base object of the item.
27566 * @param it The segment control item.
27567 * @return The base object associated with @p it.
27569 * Base object is the @c Evas_Object that represents that item.
27571 * @ingroup SegmentControl
27573 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27576 * Get the selected item.
27578 * @param obj The segment control object.
27579 * @return The selected item or @c NULL if none of segment items is
27582 * The selected item can be unselected with function
27583 * elm_segment_control_item_selected_set().
27585 * The selected item always will be highlighted on segment control.
27587 * @ingroup SegmentControl
27589 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27592 * Set the selected state of an item.
27594 * @param it The segment control item
27595 * @param select The selected state
27597 * This sets the selected state of the given item @p it.
27598 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27600 * If a new item is selected the previosly selected will be unselected.
27601 * Previoulsy selected item can be get with function
27602 * elm_segment_control_item_selected_get().
27604 * The selected item always will be highlighted on segment control.
27606 * @see elm_segment_control_item_selected_get()
27608 * @ingroup SegmentControl
27610 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
27617 * @defgroup Grid Grid
27619 * The grid is a grid layout widget that lays out a series of children as a
27620 * fixed "grid" of widgets using a given percentage of the grid width and
27621 * height each using the child object.
27623 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
27624 * widgets size itself. The default is 100 x 100, so that means the
27625 * position and sizes of children will effectively be percentages (0 to 100)
27626 * of the width or height of the grid widget
27632 * Add a new grid to the parent
27634 * @param parent The parent object
27635 * @return The new object or NULL if it cannot be created
27639 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
27642 * Set the virtual size of the grid
27644 * @param obj The grid object
27645 * @param w The virtual width of the grid
27646 * @param h The virtual height of the grid
27650 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
27653 * Get the virtual size of the grid
27655 * @param obj The grid object
27656 * @param w Pointer to integer to store the virtual width of the grid
27657 * @param h Pointer to integer to store the virtual height of the grid
27661 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
27664 * Pack child at given position and size
27666 * @param obj The grid object
27667 * @param subobj The child to pack
27668 * @param x The virtual x coord at which to pack it
27669 * @param y The virtual y coord at which to pack it
27670 * @param w The virtual width at which to pack it
27671 * @param h The virtual height at which to pack it
27675 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
27678 * Unpack a child from a grid object
27680 * @param obj The grid object
27681 * @param subobj The child to unpack
27685 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
27688 * Faster way to remove all child objects from a grid object.
27690 * @param obj The grid object
27691 * @param clear If true, it will delete just removed children
27695 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
27698 * Set packing of an existing child at to position and size
27700 * @param subobj The child to set packing of
27701 * @param x The virtual x coord at which to pack it
27702 * @param y The virtual y coord at which to pack it
27703 * @param w The virtual width at which to pack it
27704 * @param h The virtual height at which to pack it
27708 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
27711 * get packing of a child
27713 * @param subobj The child to query
27714 * @param x Pointer to integer to store the virtual x coord
27715 * @param y Pointer to integer to store the virtual y coord
27716 * @param w Pointer to integer to store the virtual width
27717 * @param h Pointer to integer to store the virtual height
27721 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
27727 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
27728 EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
27729 EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
27730 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
27731 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
27732 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
27735 * @defgroup Video Video
27737 * @addtogroup Video
27740 * Elementary comes with two object that help design application that need
27741 * to display video. The main one, Elm_Video, display a video by using Emotion.
27742 * It does embedded the video inside an Edje object, so you can do some
27743 * animation depending on the video state change. It does also implement a
27744 * ressource management policy to remove this burden from the application writer.
27746 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
27747 * It take care of updating its content according to Emotion event and provide a
27748 * way to theme itself. It also does automatically raise the priority of the
27749 * linked Elm_Video so it will use the video decoder if available. It also does
27750 * activate the remember function on the linked Elm_Video object.
27752 * Signals that you can add callback for are :
27754 * "forward,clicked" - the user clicked the forward button.
27755 * "info,clicked" - the user clicked the info button.
27756 * "next,clicked" - the user clicked the next button.
27757 * "pause,clicked" - the user clicked the pause button.
27758 * "play,clicked" - the user clicked the play button.
27759 * "prev,clicked" - the user clicked the prev button.
27760 * "rewind,clicked" - the user clicked the rewind button.
27761 * "stop,clicked" - the user clicked the stop button.
27765 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
27767 * @param parent The parent object
27768 * @return a new player widget handle or @c NULL, on errors.
27770 * This function inserts a new player widget on the canvas.
27772 * @see elm_player_video_set()
27776 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
27779 * @brief Link a Elm_Payer with an Elm_Video object.
27781 * @param player the Elm_Player object.
27782 * @param video The Elm_Video object.
27784 * This mean that action on the player widget will affect the
27785 * video object and the state of the video will be reflected in
27786 * the player itself.
27788 * @see elm_player_add()
27789 * @see elm_video_add()
27793 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
27796 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
27798 * @param parent The parent object
27799 * @return a new video widget handle or @c NULL, on errors.
27801 * This function inserts a new video widget on the canvas.
27803 * @seeelm_video_file_set()
27804 * @see elm_video_uri_set()
27808 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
27811 * @brief Define the file that will be the video source.
27813 * @param video The video object to define the file for.
27814 * @param filename The file to target.
27816 * This function will explicitly define a filename as a source
27817 * for the video of the Elm_Video object.
27819 * @see elm_video_uri_set()
27820 * @see elm_video_add()
27821 * @see elm_player_add()
27825 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
27828 * @brief Define the uri that will be the video source.
27830 * @param video The video object to define the file for.
27831 * @param uri The uri to target.
27833 * This function will define an uri as a source for the video of the
27834 * Elm_Video object. URI could be remote source of video, like http:// or local source
27835 * like for example WebCam who are most of the time v4l2:// (but that depend and
27836 * you should use Emotion API to request and list the available Webcam on your system).
27838 * @see elm_video_file_set()
27839 * @see elm_video_add()
27840 * @see elm_player_add()
27844 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
27847 * @brief Get the underlying Emotion object.
27849 * @param video The video object to proceed the request on.
27850 * @return the underlying Emotion object.
27854 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
27857 * @brief Start to play the video
27859 * @param video The video object to proceed the request on.
27861 * Start to play the video and cancel all suspend state.
27865 EAPI void elm_video_play(Evas_Object *video);
27868 * @brief Pause the video
27870 * @param video The video object to proceed the request on.
27872 * Pause the video and start a timer to trigger suspend mode.
27876 EAPI void elm_video_pause(Evas_Object *video);
27879 * @brief Stop the video
27881 * @param video The video object to proceed the request on.
27883 * Stop the video and put the emotion in deep sleep mode.
27887 EAPI void elm_video_stop(Evas_Object *video);
27890 * @brief Is the video actually playing.
27892 * @param video The video object to proceed the request on.
27893 * @return EINA_TRUE if the video is actually playing.
27895 * You should consider watching event on the object instead of polling
27896 * the object state.
27900 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
27903 * @brief Is it possible to seek inside the video.
27905 * @param video The video object to proceed the request on.
27906 * @return EINA_TRUE if is possible to seek inside the video.
27910 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
27913 * @brief Is the audio muted.
27915 * @param video The video object to proceed the request on.
27916 * @return EINA_TRUE if the audio is muted.
27920 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
27923 * @brief Change the mute state of the Elm_Video object.
27925 * @param video The video object to proceed the request on.
27926 * @param mute The new mute state.
27930 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
27933 * @brief Get the audio level of the current video.
27935 * @param video The video object to proceed the request on.
27936 * @return the current audio level.
27940 EAPI double elm_video_audio_level_get(Evas_Object *video);
27943 * @brief Set the audio level of anElm_Video object.
27945 * @param video The video object to proceed the request on.
27946 * @param volume The new audio volume.
27950 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
27952 EAPI double elm_video_play_position_get(Evas_Object *video);
27953 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
27954 EAPI double elm_video_play_length_get(Evas_Object *video);
27955 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
27956 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
27957 EAPI const char *elm_video_title_get(Evas_Object *video);
27963 * @defgroup Naviframe Naviframe
27964 * @ingroup Elementary
27966 * @brief Naviframe is a kind of view manager for the applications.
27968 * Naviframe provides functions to switch different pages with stack
27969 * mechanism. It means if one page(item) needs to be changed to the new one,
27970 * then naviframe would push the new page to it's internal stack. Of course,
27971 * it can be back to the previous page by popping the top page. Naviframe
27972 * provides some transition effect while the pages are switching (same as
27975 * Since each item could keep the different styles, users could keep the
27976 * same look & feel for the pages or different styles for the items in it's
27979 * Signals that you can add callback for are:
27981 * @li "transition,finished" - When the transition is finished in changing
27983 * @li "title,clicked" - User clicked title area
27985 * Default contents parts for the naviframe items that you can use for are:
27987 * @li "elm.swallow.content" - The main content of the page
27988 * @li "elm.swallow.prev_btn" - The button to go to the previous page
27989 * @li "elm.swallow.next_btn" - The button to go to the next page
27991 * Default text parts of naviframe items that you can be used are:
27993 * @li "elm.text.title" - The title label in the title area
27995 * @ref tutorial_naviframe gives a good overview of the usage of the API.
27999 * @addtogroup Naviframe
28004 * @brief Add a new Naviframe object to the parent.
28006 * @param parent Parent object
28007 * @return New object or @c NULL, if it cannot be created
28009 * @ingroup Naviframe
28011 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28013 * @brief Push a new item to the top of the naviframe stack (and show it).
28015 * @param obj The naviframe object
28016 * @param title_label The label in the title area. The name of the title
28017 * label part is "elm.text.title"
28018 * @param prev_btn The button to go to the previous item. If it is NULL,
28019 * then naviframe will create a back button automatically. The name of
28020 * the prev_btn part is "elm.swallow.prev_btn"
28021 * @param next_btn The button to go to the next item. Or It could be just an
28022 * extra function button. The name of the next_btn part is
28023 * "elm.swallow.next_btn"
28024 * @param content The main content object. The name of content part is
28025 * "elm.swallow.content"
28026 * @param item_style The current item style name. @c NULL would be default.
28027 * @return The created item or @c NULL upon failure.
28029 * The item pushed becomes one page of the naviframe, this item will be
28030 * deleted when it is popped.
28032 * @see also elm_naviframe_item_style_set()
28034 * The following styles are available for this item:
28037 * @ingroup Naviframe
28039 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);
28041 * @brief Pop an item that is on top of the stack
28043 * @param obj The naviframe object
28044 * @return @c NULL or the content object(if the
28045 * elm_naviframe_content_preserve_on_pop_get is true).
28047 * This pops an item that is on the top(visible) of the naviframe, makes it
28048 * disappear, then deletes the item. The item that was underneath it on the
28049 * stack will become visible.
28051 * @see also elm_naviframe_content_preserve_on_pop_get()
28053 * @ingroup Naviframe
28055 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28057 * @brief Pop the items between the top and the above one on the given item.
28059 * @param it The naviframe item
28061 * @ingroup Naviframe
28063 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28065 * @brief Delete the given item instantly.
28067 * @param it The naviframe item
28069 * This just deletes the given item from the naviframe item list instantly.
28070 * So this would not emit any signals for view transitions but just change
28071 * the current view if the given item is a top one.
28073 * @ingroup Naviframe
28075 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28077 * @brief preserve the content objects when items are popped.
28079 * @param obj The naviframe object
28080 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28082 * @see also elm_naviframe_content_preserve_on_pop_get()
28084 * @ingroup Naviframe
28086 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28088 * @brief Get a value whether preserve mode is enabled or not.
28090 * @param obj The naviframe object
28091 * @return If @c EINA_TRUE, preserve mode is enabled
28093 * @see also elm_naviframe_content_preserve_on_pop_set()
28095 * @ingroup Naviframe
28097 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28099 * @brief Get a top item on the naviframe stack
28101 * @param obj The naviframe object
28102 * @return The top item on the naviframe stack or @c NULL, if the stack is
28105 * @ingroup Naviframe
28107 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28109 * @brief Get a bottom item on the naviframe stack
28111 * @param obj The naviframe object
28112 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28115 * @ingroup Naviframe
28117 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28119 * @brief Set an item style
28121 * @param obj The naviframe item
28122 * @param item_style The current item style name. @c NULL would be default
28124 * The following styles are available for this item:
28127 * @see also elm_naviframe_item_style_get()
28129 * @ingroup Naviframe
28131 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28133 * @brief Get an item style
28135 * @param obj The naviframe item
28136 * @return The current item style name
28138 * @see also elm_naviframe_item_style_set()
28140 * @ingroup Naviframe
28142 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28144 * @brief Show/Hide the title area
28146 * @param it The naviframe item
28147 * @param visible If @c EINA_TRUE, title area will be visible, hidden
28150 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
28152 * @see also elm_naviframe_item_title_visible_get()
28154 * @ingroup Naviframe
28156 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28158 * @brief Get a value whether title area is visible or not.
28160 * @param it The naviframe item
28161 * @return If @c EINA_TRUE, title area is visible
28163 * @see also elm_naviframe_item_title_visible_set()
28165 * @ingroup Naviframe
28167 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28170 * @brief Set creating prev button automatically or not
28172 * @param obj The naviframe object
28173 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28174 * be created internally when you pass the @c NULL to the prev_btn
28175 * parameter in elm_naviframe_item_push
28177 * @see also elm_naviframe_item_push()
28179 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28181 * @brief Get a value whether prev button(back button) will be auto pushed or
28184 * @param obj The naviframe object
28185 * @return If @c EINA_TRUE, prev button will be auto pushed.
28187 * @see also elm_naviframe_item_push()
28188 * elm_naviframe_prev_btn_auto_pushed_set()
28190 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);