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 * The following signals may be emitted by the label widget:
7378 * @li "language,changed": The program's language changed.
7380 * See @ref tutorial_label for a demonstration of how to use a label widget.
7384 * @brief Add a new label to the parent
7386 * @param parent The parent object
7387 * @return The new object or NULL if it cannot be created
7389 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7391 * @brief Set the label on the label object
7393 * @param obj The label object
7394 * @param label The label will be used on the label object
7395 * @deprecated See elm_object_text_set()
7397 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 */
7399 * @brief Get the label used on the label object
7401 * @param obj The label object
7402 * @return The string inside the label
7403 * @deprecated See elm_object_text_get()
7405 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7407 * @brief Set the wrapping behavior of the label
7409 * @param obj The label object
7410 * @param wrap To wrap text or not
7412 * By default no wrapping is done. Possible values for @p wrap are:
7413 * @li ELM_WRAP_NONE - No wrapping
7414 * @li ELM_WRAP_CHAR - wrap between characters
7415 * @li ELM_WRAP_WORD - wrap between words
7416 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7418 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7420 * @brief Get the wrapping behavior of the label
7422 * @param obj The label object
7425 * @see elm_label_line_wrap_set()
7427 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7429 * @brief Set wrap width of the label
7431 * @param obj The label object
7432 * @param w The wrap width in pixels at a minimum where words need to wrap
7434 * This function sets the maximum width size hint of the label.
7436 * @warning This is only relevant if the label is inside a container.
7438 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7440 * @brief Get wrap width of the label
7442 * @param obj The label object
7443 * @return The wrap width in pixels at a minimum where words need to wrap
7445 * @see elm_label_wrap_width_set()
7447 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7449 * @brief Set wrap height of the label
7451 * @param obj The label object
7452 * @param h The wrap height in pixels at a minimum where words need to wrap
7454 * This function sets the maximum height size hint of the label.
7456 * @warning This is only relevant if the label is inside a container.
7458 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7460 * @brief get wrap width of the label
7462 * @param obj The label object
7463 * @return The wrap height in pixels at a minimum where words need to wrap
7465 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7467 * @brief Set the font size on the label object.
7469 * @param obj The label object
7470 * @param size font size
7472 * @warning NEVER use this. It is for hyper-special cases only. use styles
7473 * instead. e.g. "big", "medium", "small" - or better name them by use:
7474 * "title", "footnote", "quote" etc.
7476 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7478 * @brief Set the text color on the label object
7480 * @param obj The label object
7481 * @param r Red property background color of The label object
7482 * @param g Green property background color of The label object
7483 * @param b Blue property background color of The label object
7484 * @param a Alpha property background color of The label object
7486 * @warning NEVER use this. It is for hyper-special cases only. use styles
7487 * instead. e.g. "big", "medium", "small" - or better name them by use:
7488 * "title", "footnote", "quote" etc.
7490 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);
7492 * @brief Set the text align on the label object
7494 * @param obj The label object
7495 * @param align align mode ("left", "center", "right")
7497 * @warning NEVER use this. It is for hyper-special cases only. use styles
7498 * instead. e.g. "big", "medium", "small" - or better name them by use:
7499 * "title", "footnote", "quote" etc.
7501 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7503 * @brief Set background color of the label
7505 * @param obj The label object
7506 * @param r Red property background color of The label object
7507 * @param g Green property background color of The label object
7508 * @param b Blue property background color of The label object
7509 * @param a Alpha property background alpha of The label object
7511 * @warning NEVER use this. It is for hyper-special cases only. use styles
7512 * instead. e.g. "big", "medium", "small" - or better name them by use:
7513 * "title", "footnote", "quote" etc.
7515 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);
7517 * @brief Set the ellipsis behavior of the label
7519 * @param obj The label object
7520 * @param ellipsis To ellipsis text or not
7522 * If set to true and the text doesn't fit in the label an ellipsis("...")
7523 * will be shown at the end of the widget.
7525 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7526 * choosen wrap method was ELM_WRAP_WORD.
7528 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7530 * @brief Set the text slide of the label
7532 * @param obj The label object
7533 * @param slide To start slide or stop
7535 * If set to true the text of the label will slide throught the length of
7538 * @warning This only work with the themes "slide_short", "slide_long" and
7541 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7543 * @brief Get the text slide mode of the label
7545 * @param obj The label object
7546 * @return slide slide mode value
7548 * @see elm_label_slide_set()
7550 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7552 * @brief Set the slide duration(speed) of the label
7554 * @param obj The label object
7555 * @return The duration in seconds in moving text from slide begin position
7556 * to slide end position
7558 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7560 * @brief Get the slide duration(speed) of the label
7562 * @param obj The label object
7563 * @return The duration time in moving text from slide begin position to slide end position
7565 * @see elm_label_slide_duration_set()
7567 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7573 * @defgroup Toggle Toggle
7575 * @image html img/widget/toggle/preview-00.png
7576 * @image latex img/widget/toggle/preview-00.eps
7578 * @brief A toggle is a slider which can be used to toggle between
7579 * two values. It has two states: on and off.
7581 * This widget is deprecated. Please use elm_check_add() instead using the
7582 * toggle style like:
7585 * obj = elm_check_add(parent);
7586 * elm_object_style_set(obj, "toggle");
7587 * elm_check_states_labels_set(obj, "ON", "OFF");
7590 * Signals that you can add callbacks for are:
7591 * @li "changed" - Whenever the toggle value has been changed. Is not called
7592 * until the toggle is released by the cursor (assuming it
7593 * has been triggered by the cursor in the first place).
7595 * @ref tutorial_toggle show how to use a toggle.
7599 * @brief Add a toggle to @p parent.
7601 * @param parent The parent object
7603 * @return The toggle object
7605 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7607 * @brief Sets the label to be displayed with the toggle.
7609 * @param obj The toggle object
7610 * @param label The label to be displayed
7612 * @deprecated use elm_object_text_set() instead.
7614 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7616 * @brief Gets the label of the toggle
7618 * @param obj toggle object
7619 * @return The label of the toggle
7621 * @deprecated use elm_object_text_get() instead.
7623 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7625 * @brief Set the icon used for the toggle
7627 * @param obj The toggle object
7628 * @param icon The icon object for the button
7630 * Once the icon object is set, a previously set one will be deleted
7631 * If you want to keep that old content object, use the
7632 * elm_toggle_icon_unset() function.
7634 EINA_DEPRECATED EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7636 * @brief Get the icon used for the toggle
7638 * @param obj The toggle object
7639 * @return The icon object that is being used
7641 * Return the icon object which is set for this widget.
7643 * @see elm_toggle_icon_set()
7645 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7647 * @brief Unset the icon used for the toggle
7649 * @param obj The toggle object
7650 * @return The icon object that was being used
7652 * Unparent and return the icon object which was set for this widget.
7654 * @see elm_toggle_icon_set()
7656 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7658 * @brief Sets the labels to be associated with the on and off states of the toggle.
7660 * @param obj The toggle object
7661 * @param onlabel The label displayed when the toggle is in the "on" state
7662 * @param offlabel The label displayed when the toggle is in the "off" state
7664 EINA_DEPRECATED EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7666 * @brief Gets the labels associated with the on and off states of the toggle.
7668 * @param obj The toggle object
7669 * @param onlabel A char** to place the onlabel of @p obj into
7670 * @param offlabel A char** to place the offlabel of @p obj into
7672 EINA_DEPRECATED EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7674 * @brief Sets the state of the toggle to @p state.
7676 * @param obj The toggle object
7677 * @param state The state of @p obj
7679 EINA_DEPRECATED EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7681 * @brief Gets the state of the toggle to @p state.
7683 * @param obj The toggle object
7684 * @return The state of @p obj
7686 EINA_DEPRECATED EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7688 * @brief Sets the state pointer of the toggle to @p statep.
7690 * @param obj The toggle object
7691 * @param statep The state pointer of @p obj
7693 EINA_DEPRECATED EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7699 * @defgroup Frame Frame
7701 * @image html img/widget/frame/preview-00.png
7702 * @image latex img/widget/frame/preview-00.eps
7704 * @brief Frame is a widget that holds some content and has a title.
7706 * The default look is a frame with a title, but Frame supports multple
7714 * @li outdent_bottom
7716 * Of all this styles only default shows the title. Frame emits no signals.
7718 * For a detailed example see the @ref tutorial_frame.
7723 * @brief Add a new frame to the parent
7725 * @param parent The parent object
7726 * @return The new object or NULL if it cannot be created
7728 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7730 * @brief Set the frame label
7732 * @param obj The frame object
7733 * @param label The label of this frame object
7735 * @deprecated use elm_object_text_set() instead.
7737 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7739 * @brief Get the frame label
7741 * @param obj The frame object
7743 * @return The label of this frame objet or NULL if unable to get frame
7745 * @deprecated use elm_object_text_get() instead.
7747 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7749 * @brief Set the content of the frame widget
7751 * Once the content object is set, a previously set one will be deleted.
7752 * If you want to keep that old content object, use the
7753 * elm_frame_content_unset() function.
7755 * @param obj The frame object
7756 * @param content The content will be filled in this frame object
7758 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7760 * @brief Get the content of the frame widget
7762 * Return the content object which is set for this widget
7764 * @param obj The frame object
7765 * @return The content that is being used
7767 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7769 * @brief Unset the content of the frame widget
7771 * Unparent and return the content object which was set for this widget
7773 * @param obj The frame object
7774 * @return The content that was being used
7776 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7782 * @defgroup Table Table
7784 * A container widget to arrange other widgets in a table where items can
7785 * also span multiple columns or rows - even overlap (and then be raised or
7786 * lowered accordingly to adjust stacking if they do overlap).
7788 * The followin are examples of how to use a table:
7789 * @li @ref tutorial_table_01
7790 * @li @ref tutorial_table_02
7795 * @brief Add a new table to the parent
7797 * @param parent The parent object
7798 * @return The new object or NULL if it cannot be created
7800 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7802 * @brief Set the homogeneous layout in the table
7804 * @param obj The layout object
7805 * @param homogeneous A boolean to set if the layout is homogeneous in the
7806 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7808 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7810 * @brief Get the current table homogeneous mode.
7812 * @param obj The table object
7813 * @return A boolean to indicating if the layout is homogeneous in the table
7814 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7816 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7818 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7820 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7822 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7824 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7826 * @brief Set padding between cells.
7828 * @param obj The layout object.
7829 * @param horizontal set the horizontal padding.
7830 * @param vertical set the vertical padding.
7832 * Default value is 0.
7834 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7836 * @brief Get padding between cells.
7838 * @param obj The layout object.
7839 * @param horizontal set the horizontal padding.
7840 * @param vertical set the vertical padding.
7842 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7844 * @brief Add a subobject on the table with the coordinates passed
7846 * @param obj The table object
7847 * @param subobj The subobject to be added to the table
7848 * @param x Row number
7849 * @param y Column number
7853 * @note All positioning inside the table is relative to rows and columns, so
7854 * a value of 0 for x and y, means the top left cell of the table, and a
7855 * value of 1 for w and h means @p subobj only takes that 1 cell.
7857 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7859 * @brief Remove child from table.
7861 * @param obj The table object
7862 * @param subobj The subobject
7864 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7866 * @brief Faster way to remove all child objects from a table object.
7868 * @param obj The table object
7869 * @param clear If true, will delete children, else just remove from table.
7871 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7873 * @brief Set the packing location of an existing child of the table
7875 * @param subobj The subobject to be modified in the table
7876 * @param x Row number
7877 * @param y Column number
7881 * Modifies the position of an object already in the table.
7883 * @note All positioning inside the table is relative to rows and columns, so
7884 * a value of 0 for x and y, means the top left cell of the table, and a
7885 * value of 1 for w and h means @p subobj only takes that 1 cell.
7887 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7889 * @brief Get the packing location of an existing child of the table
7891 * @param subobj The subobject to be modified in the table
7892 * @param x Row number
7893 * @param y Column number
7897 * @see elm_table_pack_set()
7899 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7905 * @defgroup Gengrid Gengrid (Generic grid)
7907 * This widget aims to position objects in a grid layout while
7908 * actually creating and rendering only the visible ones, using the
7909 * same idea as the @ref Genlist "genlist": the user defines a @b
7910 * class for each item, specifying functions that will be called at
7911 * object creation, deletion, etc. When those items are selected by
7912 * the user, a callback function is issued. Users may interact with
7913 * a gengrid via the mouse (by clicking on items to select them and
7914 * clicking on the grid's viewport and swiping to pan the whole
7915 * view) or via the keyboard, navigating through item with the
7918 * @section Gengrid_Layouts Gengrid layouts
7920 * Gengrids may layout its items in one of two possible layouts:
7924 * When in "horizontal mode", items will be placed in @b columns,
7925 * from top to bottom and, when the space for a column is filled,
7926 * another one is started on the right, thus expanding the grid
7927 * horizontally, making for horizontal scrolling. When in "vertical
7928 * mode" , though, items will be placed in @b rows, from left to
7929 * right and, when the space for a row is filled, another one is
7930 * started below, thus expanding the grid vertically (and making
7931 * for vertical scrolling).
7933 * @section Gengrid_Items Gengrid items
7935 * An item in a gengrid can have 0 or more text labels (they can be
7936 * regular text or textblock Evas objects - that's up to the style
7937 * to determine), 0 or more icons (which are simply objects
7938 * swallowed into the gengrid item's theming Edje object) and 0 or
7939 * more <b>boolean states</b>, which have the behavior left to the
7940 * user to define. The Edje part names for each of these properties
7941 * will be looked up, in the theme file for the gengrid, under the
7942 * Edje (string) data items named @c "labels", @c "icons" and @c
7943 * "states", respectively. For each of those properties, if more
7944 * than one part is provided, they must have names listed separated
7945 * by spaces in the data fields. For the default gengrid item
7946 * theme, we have @b one label part (@c "elm.text"), @b two icon
7947 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7950 * A gengrid item may be at one of several styles. Elementary
7951 * provides one by default - "default", but this can be extended by
7952 * system or application custom themes/overlays/extensions (see
7953 * @ref Theme "themes" for more details).
7955 * @section Gengrid_Item_Class Gengrid item classes
7957 * In order to have the ability to add and delete items on the fly,
7958 * gengrid implements a class (callback) system where the
7959 * application provides a structure with information about that
7960 * type of item (gengrid may contain multiple different items with
7961 * different classes, states and styles). Gengrid will call the
7962 * functions in this struct (methods) when an item is "realized"
7963 * (i.e., created dynamically, while the user is scrolling the
7964 * grid). All objects will simply be deleted when no longer needed
7965 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7966 * contains the following members:
7967 * - @c item_style - This is a constant string and simply defines
7968 * the name of the item style. It @b must be specified and the
7969 * default should be @c "default".
7970 * - @c func.label_get - This function is called when an item
7971 * object is actually created. The @c data parameter will point to
7972 * the same data passed to elm_gengrid_item_append() and related
7973 * item creation functions. The @c obj parameter is the gengrid
7974 * object itself, while the @c part one is the name string of one
7975 * of the existing text parts in the Edje group implementing the
7976 * item's theme. This function @b must return a strdup'()ed string,
7977 * as the caller will free() it when done. See
7978 * #Elm_Gengrid_Item_Label_Get_Cb.
7979 * - @c func.icon_get - This function is called when an item object
7980 * is actually created. The @c data parameter will point to the
7981 * same data passed to elm_gengrid_item_append() and related item
7982 * creation functions. The @c obj parameter is the gengrid object
7983 * itself, while the @c part one is the name string of one of the
7984 * existing (icon) swallow parts in the Edje group implementing the
7985 * item's theme. It must return @c NULL, when no icon is desired,
7986 * or a valid object handle, otherwise. The object will be deleted
7987 * by the gengrid on its deletion or when the item is "unrealized".
7988 * See #Elm_Gengrid_Item_Icon_Get_Cb.
7989 * - @c func.state_get - This function is called when an item
7990 * object is actually created. The @c data parameter will point to
7991 * the same data passed to elm_gengrid_item_append() and related
7992 * item creation functions. The @c obj parameter is the gengrid
7993 * object itself, while the @c part one is the name string of one
7994 * of the state parts in the Edje group implementing the item's
7995 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7996 * true/on. Gengrids will emit a signal to its theming Edje object
7997 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7998 * "source" arguments, respectively, when the state is true (the
7999 * default is false), where @c XXX is the name of the (state) part.
8000 * See #Elm_Gengrid_Item_State_Get_Cb.
8001 * - @c func.del - This is called when elm_gengrid_item_del() is
8002 * called on an item or elm_gengrid_clear() is called on the
8003 * gengrid. This is intended for use when gengrid items are
8004 * deleted, so any data attached to the item (e.g. its data
8005 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8007 * @section Gengrid_Usage_Hints Usage hints
8009 * If the user wants to have multiple items selected at the same
8010 * time, elm_gengrid_multi_select_set() will permit it. If the
8011 * gengrid is single-selection only (the default), then
8012 * elm_gengrid_select_item_get() will return the selected item or
8013 * @c NULL, if none is selected. If the gengrid is under
8014 * multi-selection, then elm_gengrid_selected_items_get() will
8015 * return a list (that is only valid as long as no items are
8016 * modified (added, deleted, selected or unselected) of child items
8019 * If an item changes (internal (boolean) state, label or icon
8020 * changes), then use elm_gengrid_item_update() to have gengrid
8021 * update the item with the new state. A gengrid will re-"realize"
8022 * the item, thus calling the functions in the
8023 * #Elm_Gengrid_Item_Class set for that item.
8025 * To programmatically (un)select an item, use
8026 * elm_gengrid_item_selected_set(). To get its selected state use
8027 * elm_gengrid_item_selected_get(). To make an item disabled
8028 * (unable to be selected and appear differently) use
8029 * elm_gengrid_item_disabled_set() to set this and
8030 * elm_gengrid_item_disabled_get() to get the disabled state.
8032 * Grid cells will only have their selection smart callbacks called
8033 * when firstly getting selected. Any further clicks will do
8034 * nothing, unless you enable the "always select mode", with
8035 * elm_gengrid_always_select_mode_set(), thus making every click to
8036 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8037 * turn off the ability to select items entirely in the widget and
8038 * they will neither appear selected nor call the selection smart
8041 * Remember that you can create new styles and add your own theme
8042 * augmentation per application with elm_theme_extension_add(). If
8043 * you absolutely must have a specific style that overrides any
8044 * theme the user or system sets up you can use
8045 * elm_theme_overlay_add() to add such a file.
8047 * @section Gengrid_Smart_Events Gengrid smart events
8049 * Smart events that you can add callbacks for are:
8050 * - @c "activated" - The user has double-clicked or pressed
8051 * (enter|return|spacebar) on an item. The @c event_info parameter
8052 * is the gengrid item that was activated.
8053 * - @c "clicked,double" - The user has double-clicked an item.
8054 * The @c event_info parameter is the gengrid item that was double-clicked.
8055 * - @c "longpressed" - This is called when the item is pressed for a certain
8056 * amount of time. By default it's 1 second.
8057 * - @c "selected" - The user has made an item selected. The
8058 * @c event_info parameter is the gengrid item that was selected.
8059 * - @c "unselected" - The user has made an item unselected. The
8060 * @c event_info parameter is the gengrid item that was unselected.
8061 * - @c "realized" - This is called when the item in the gengrid
8062 * has its implementing Evas object instantiated, de facto. @c
8063 * event_info is the gengrid item that was created. The object
8064 * may be deleted at any time, so it is highly advised to the
8065 * caller @b not to use the object pointer returned from
8066 * elm_gengrid_item_object_get(), because it may point to freed
8068 * - @c "unrealized" - This is called when the implementing Evas
8069 * object for this item is deleted. @c event_info is the gengrid
8070 * item that was deleted.
8071 * - @c "changed" - Called when an item is added, removed, resized
8072 * or moved and when the gengrid is resized or gets "horizontal"
8074 * - @c "scroll,anim,start" - This is called when scrolling animation has
8076 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8078 * - @c "drag,start,up" - Called when the item in the gengrid has
8079 * been dragged (not scrolled) up.
8080 * - @c "drag,start,down" - Called when the item in the gengrid has
8081 * been dragged (not scrolled) down.
8082 * - @c "drag,start,left" - Called when the item in the gengrid has
8083 * been dragged (not scrolled) left.
8084 * - @c "drag,start,right" - Called when the item in the gengrid has
8085 * been dragged (not scrolled) right.
8086 * - @c "drag,stop" - Called when the item in the gengrid has
8087 * stopped being dragged.
8088 * - @c "drag" - Called when the item in the gengrid is being
8090 * - @c "scroll" - called when the content has been scrolled
8092 * - @c "scroll,drag,start" - called when dragging the content has
8094 * - @c "scroll,drag,stop" - called when dragging the content has
8096 * - @c "edge,top" - This is called when the gengrid is scrolled until
8098 * - @c "edge,bottom" - This is called when the gengrid is scrolled
8099 * until the bottom edge.
8100 * - @c "edge,left" - This is called when the gengrid is scrolled
8101 * until the left edge.
8102 * - @c "edge,right" - This is called when the gengrid is scrolled
8103 * until the right edge.
8105 * List of gengrid examples:
8106 * @li @ref gengrid_example
8110 * @addtogroup Gengrid
8114 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8115 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8116 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8117 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
8118 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. */
8119 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. */
8120 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
8123 * @struct _Elm_Gengrid_Item_Class
8125 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8128 struct _Elm_Gengrid_Item_Class
8130 const char *item_style;
8131 struct _Elm_Gengrid_Item_Class_Func
8133 Elm_Gengrid_Item_Label_Get_Cb label_get;
8134 Elm_Gengrid_Item_Icon_Get_Cb icon_get;
8135 Elm_Gengrid_Item_State_Get_Cb state_get;
8136 Elm_Gengrid_Item_Del_Cb del;
8138 }; /**< #Elm_Gengrid_Item_Class member definitions */
8141 * Add a new gengrid widget to the given parent Elementary
8142 * (container) object
8144 * @param parent The parent object
8145 * @return a new gengrid widget handle or @c NULL, on errors
8147 * This function inserts a new gengrid widget on the canvas.
8149 * @see elm_gengrid_item_size_set()
8150 * @see elm_gengrid_group_item_size_set()
8151 * @see elm_gengrid_horizontal_set()
8152 * @see elm_gengrid_item_append()
8153 * @see elm_gengrid_item_del()
8154 * @see elm_gengrid_clear()
8158 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8161 * Set the size for the items of a given gengrid widget
8163 * @param obj The gengrid object.
8164 * @param w The items' width.
8165 * @param h The items' height;
8167 * A gengrid, after creation, has still no information on the size
8168 * to give to each of its cells. So, you most probably will end up
8169 * with squares one @ref Fingers "finger" wide, the default
8170 * size. Use this function to force a custom size for you items,
8171 * making them as big as you wish.
8173 * @see elm_gengrid_item_size_get()
8177 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8180 * Get the size set for the items of a given gengrid widget
8182 * @param obj The gengrid object.
8183 * @param w Pointer to a variable where to store the items' width.
8184 * @param h Pointer to a variable where to store the items' height.
8186 * @note Use @c NULL pointers on the size values you're not
8187 * interested in: they'll be ignored by the function.
8189 * @see elm_gengrid_item_size_get() for more details
8193 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8196 * Set the size for the group items of a given gengrid widget
8198 * @param obj The gengrid object.
8199 * @param w The group items' width.
8200 * @param h The group items' height;
8202 * A gengrid, after creation, has still no information on the size
8203 * to give to each of its cells. So, you most probably will end up
8204 * with squares one @ref Fingers "finger" wide, the default
8205 * size. Use this function to force a custom size for you group items,
8206 * making them as big as you wish.
8208 * @see elm_gengrid_group_item_size_get()
8212 EAPI void elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8215 * Get the size set for the group items of a given gengrid widget
8217 * @param obj The gengrid object.
8218 * @param w Pointer to a variable where to store the group items' width.
8219 * @param h Pointer to a variable where to store the group items' height.
8221 * @note Use @c NULL pointers on the size values you're not
8222 * interested in: they'll be ignored by the function.
8224 * @see elm_gengrid_group_item_size_get() for more details
8228 EAPI void elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8231 * Set the items grid's alignment within a given gengrid widget
8233 * @param obj The gengrid object.
8234 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8235 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8237 * This sets the alignment of the whole grid of items of a gengrid
8238 * within its given viewport. By default, those values are both
8239 * 0.5, meaning that the gengrid will have its items grid placed
8240 * exactly in the middle of its viewport.
8242 * @note If given alignment values are out of the cited ranges,
8243 * they'll be changed to the nearest boundary values on the valid
8246 * @see elm_gengrid_align_get()
8250 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8253 * Get the items grid's alignment values within a given gengrid
8256 * @param obj The gengrid object.
8257 * @param align_x Pointer to a variable where to store the
8258 * horizontal alignment.
8259 * @param align_y Pointer to a variable where to store the vertical
8262 * @note Use @c NULL pointers on the alignment values you're not
8263 * interested in: they'll be ignored by the function.
8265 * @see elm_gengrid_align_set() for more details
8269 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8272 * Set whether a given gengrid widget is or not able have items
8275 * @param obj The gengrid object
8276 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8277 * @c EINA_FALSE to turn it off
8279 * If a gengrid is set to allow reordering, a click held for more
8280 * than 0.5 over a given item will highlight it specially,
8281 * signalling the gengrid has entered the reordering state. From
8282 * that time on, the user will be able to, while still holding the
8283 * mouse button down, move the item freely in the gengrid's
8284 * viewport, replacing to said item to the locations it goes to.
8285 * The replacements will be animated and, whenever the user
8286 * releases the mouse button, the item being replaced gets a new
8287 * definitive place in the grid.
8289 * @see elm_gengrid_reorder_mode_get()
8293 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8296 * Get whether a given gengrid widget is or not able have items
8299 * @param obj The gengrid object
8300 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8303 * @see elm_gengrid_reorder_mode_set() for more details
8307 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8310 * Append a new item in a given gengrid widget.
8312 * @param obj The gengrid object.
8313 * @param gic The item class for the item.
8314 * @param data The item data.
8315 * @param func Convenience function called when the item is
8317 * @param func_data Data to be passed to @p func.
8318 * @return A handle to the item added or @c NULL, on errors.
8320 * This adds an item to the beginning of the gengrid.
8322 * @see elm_gengrid_item_prepend()
8323 * @see elm_gengrid_item_insert_before()
8324 * @see elm_gengrid_item_insert_after()
8325 * @see elm_gengrid_item_del()
8329 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);
8332 * Prepend a new item in a given gengrid widget.
8334 * @param obj The gengrid object.
8335 * @param gic The item class for the item.
8336 * @param data The item data.
8337 * @param func Convenience function called when the item is
8339 * @param func_data Data to be passed to @p func.
8340 * @return A handle to the item added or @c NULL, on errors.
8342 * This adds an item to the end of the gengrid.
8344 * @see elm_gengrid_item_append()
8345 * @see elm_gengrid_item_insert_before()
8346 * @see elm_gengrid_item_insert_after()
8347 * @see elm_gengrid_item_del()
8351 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);
8354 * Insert an item before another in a gengrid widget
8356 * @param obj The gengrid object.
8357 * @param gic The item class for the item.
8358 * @param data The item data.
8359 * @param relative The item to place this new one before.
8360 * @param func Convenience function called when the item is
8362 * @param func_data Data to be passed to @p func.
8363 * @return A handle to the item added or @c NULL, on errors.
8365 * This inserts an item before another in the gengrid.
8367 * @see elm_gengrid_item_append()
8368 * @see elm_gengrid_item_prepend()
8369 * @see elm_gengrid_item_insert_after()
8370 * @see elm_gengrid_item_del()
8374 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);
8377 * Insert an item after another in a gengrid widget
8379 * @param obj The gengrid object.
8380 * @param gic The item class for the item.
8381 * @param data The item data.
8382 * @param relative The item to place this new one after.
8383 * @param func Convenience function called when the item is
8385 * @param func_data Data to be passed to @p func.
8386 * @return A handle to the item added or @c NULL, on errors.
8388 * This inserts an item after another in the gengrid.
8390 * @see elm_gengrid_item_append()
8391 * @see elm_gengrid_item_prepend()
8392 * @see elm_gengrid_item_insert_after()
8393 * @see elm_gengrid_item_del()
8397 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);
8399 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);
8401 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);
8404 * Set whether items on a given gengrid widget are to get their
8405 * selection callbacks issued for @b every subsequent selection
8406 * click on them or just for the first click.
8408 * @param obj The gengrid object
8409 * @param always_select @c EINA_TRUE to make items "always
8410 * selected", @c EINA_FALSE, otherwise
8412 * By default, grid items will only call their selection callback
8413 * function when firstly getting selected, any subsequent further
8414 * clicks will do nothing. With this call, you make those
8415 * subsequent clicks also to issue the selection callbacks.
8417 * @note <b>Double clicks</b> will @b always be reported on items.
8419 * @see elm_gengrid_always_select_mode_get()
8423 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8426 * Get whether items on a given gengrid widget have their selection
8427 * callbacks issued for @b every subsequent selection click on them
8428 * or just for the first click.
8430 * @param obj The gengrid object.
8431 * @return @c EINA_TRUE if the gengrid items are "always selected",
8432 * @c EINA_FALSE, otherwise
8434 * @see elm_gengrid_always_select_mode_set() for more details
8438 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8441 * Set whether items on a given gengrid widget can be selected or not.
8443 * @param obj The gengrid object
8444 * @param no_select @c EINA_TRUE to make items selectable,
8445 * @c EINA_FALSE otherwise
8447 * This will make items in @p obj selectable or not. In the latter
8448 * case, any user interaction on the gengrid items will neither make
8449 * them appear selected nor them call their selection callback
8452 * @see elm_gengrid_no_select_mode_get()
8456 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8459 * Get whether items on a given gengrid widget can be selected or
8462 * @param obj The gengrid object
8463 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8466 * @see elm_gengrid_no_select_mode_set() for more details
8470 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8473 * Enable or disable multi-selection in a given gengrid widget
8475 * @param obj The gengrid object.
8476 * @param multi @c EINA_TRUE, to enable multi-selection,
8477 * @c EINA_FALSE to disable it.
8479 * Multi-selection is the ability for one to have @b more than one
8480 * item selected, on a given gengrid, simultaneously. When it is
8481 * enabled, a sequence of clicks on different items will make them
8482 * all selected, progressively. A click on an already selected item
8483 * will unselect it. If interecting via the keyboard,
8484 * multi-selection is enabled while holding the "Shift" key.
8486 * @note By default, multi-selection is @b disabled on gengrids
8488 * @see elm_gengrid_multi_select_get()
8492 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8495 * Get whether multi-selection is enabled or disabled for a given
8498 * @param obj The gengrid object.
8499 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8500 * EINA_FALSE otherwise
8502 * @see elm_gengrid_multi_select_set() for more details
8506 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8509 * Enable or disable bouncing effect for a given gengrid widget
8511 * @param obj The gengrid object
8512 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8513 * @c EINA_FALSE to disable it
8514 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8515 * @c EINA_FALSE to disable it
8517 * The bouncing effect occurs whenever one reaches the gengrid's
8518 * edge's while panning it -- it will scroll past its limits a
8519 * little bit and return to the edge again, in a animated for,
8522 * @note By default, gengrids have bouncing enabled on both axis
8524 * @see elm_gengrid_bounce_get()
8528 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8531 * Get whether bouncing effects are enabled or disabled, for a
8532 * given gengrid widget, on each axis
8534 * @param obj The gengrid object
8535 * @param h_bounce Pointer to a variable where to store the
8536 * horizontal bouncing flag.
8537 * @param v_bounce Pointer to a variable where to store the
8538 * vertical bouncing flag.
8540 * @see elm_gengrid_bounce_set() for more details
8544 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8547 * Set a given gengrid widget's scrolling page size, relative to
8548 * its viewport size.
8550 * @param obj The gengrid object
8551 * @param h_pagerel The horizontal page (relative) size
8552 * @param v_pagerel The vertical page (relative) size
8554 * The gengrid's scroller is capable of binding scrolling by the
8555 * user to "pages". It means that, while scrolling and, specially
8556 * after releasing the mouse button, the grid will @b snap to the
8557 * nearest displaying page's area. When page sizes are set, the
8558 * grid's continuous content area is split into (equal) page sized
8561 * This function sets the size of a page <b>relatively to the
8562 * viewport dimensions</b> of the gengrid, for each axis. A value
8563 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8564 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8565 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8566 * 1.0. Values beyond those will make it behave behave
8567 * inconsistently. If you only want one axis to snap to pages, use
8568 * the value @c 0.0 for the other one.
8570 * There is a function setting page size values in @b absolute
8571 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8572 * is mutually exclusive to this one.
8574 * @see elm_gengrid_page_relative_get()
8578 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8581 * Get a given gengrid widget's scrolling page size, relative to
8582 * its viewport size.
8584 * @param obj The gengrid object
8585 * @param h_pagerel Pointer to a variable where to store the
8586 * horizontal page (relative) size
8587 * @param v_pagerel Pointer to a variable where to store the
8588 * vertical page (relative) size
8590 * @see elm_gengrid_page_relative_set() for more details
8594 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8597 * Set a given gengrid widget's scrolling page size
8599 * @param obj The gengrid object
8600 * @param h_pagerel The horizontal page size, in pixels
8601 * @param v_pagerel The vertical page size, in pixels
8603 * The gengrid's scroller is capable of binding scrolling by the
8604 * user to "pages". It means that, while scrolling and, specially
8605 * after releasing the mouse button, the grid will @b snap to the
8606 * nearest displaying page's area. When page sizes are set, the
8607 * grid's continuous content area is split into (equal) page sized
8610 * This function sets the size of a page of the gengrid, in pixels,
8611 * for each axis. Sane usable values are, between @c 0 and the
8612 * dimensions of @p obj, for each axis. Values beyond those will
8613 * make it behave behave inconsistently. If you only want one axis
8614 * to snap to pages, use the value @c 0 for the other one.
8616 * There is a function setting page size values in @b relative
8617 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8618 * use is mutually exclusive to this one.
8622 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8625 * @brief Get gengrid current page number.
8627 * @param obj The gengrid object
8628 * @param h_pagenumber The horizontal page number
8629 * @param v_pagenumber The vertical page number
8631 * The page number starts from 0. 0 is the first page.
8632 * Current page means the page which meet the top-left of the viewport.
8633 * If there are two or more pages in the viewport, it returns the number of page
8634 * which meet the top-left of the viewport.
8636 * @see elm_gengrid_last_page_get()
8637 * @see elm_gengrid_page_show()
8638 * @see elm_gengrid_page_brint_in()
8640 EAPI void elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8643 * @brief Get scroll last page number.
8645 * @param obj The gengrid object
8646 * @param h_pagenumber The horizontal page number
8647 * @param v_pagenumber The vertical page number
8649 * The page number starts from 0. 0 is the first page.
8650 * This returns the last page number among the pages.
8652 * @see elm_gengrid_current_page_get()
8653 * @see elm_gengrid_page_show()
8654 * @see elm_gengrid_page_brint_in()
8656 EAPI void elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8659 * Show a specific virtual region within the gengrid content object by page number.
8661 * @param obj The gengrid object
8662 * @param h_pagenumber The horizontal page number
8663 * @param v_pagenumber The vertical page number
8665 * 0, 0 of the indicated page is located at the top-left of the viewport.
8666 * This will jump to the page directly without animation.
8671 * sc = elm_gengrid_add(win);
8672 * elm_gengrid_content_set(sc, content);
8673 * elm_gengrid_page_relative_set(sc, 1, 0);
8674 * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8675 * elm_gengrid_page_show(sc, h_page + 1, v_page);
8678 * @see elm_gengrid_page_bring_in()
8680 EAPI void elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8683 * Show a specific virtual region within the gengrid content object by page number.
8685 * @param obj The gengrid object
8686 * @param h_pagenumber The horizontal page number
8687 * @param v_pagenumber The vertical page number
8689 * 0, 0 of the indicated page is located at the top-left of the viewport.
8690 * This will slide to the page with animation.
8695 * sc = elm_gengrid_add(win);
8696 * elm_gengrid_content_set(sc, content);
8697 * elm_gengrid_page_relative_set(sc, 1, 0);
8698 * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8699 * elm_gengrid_page_bring_in(sc, h_page, v_page);
8702 * @see elm_gengrid_page_show()
8704 EAPI void elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8707 * Set for what direction a given gengrid widget will expand while
8708 * placing its items.
8710 * @param obj The gengrid object.
8711 * @param setting @c EINA_TRUE to make the gengrid expand
8712 * horizontally, @c EINA_FALSE to expand vertically.
8714 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8715 * in @b columns, from top to bottom and, when the space for a
8716 * column is filled, another one is started on the right, thus
8717 * expanding the grid horizontally. When in "vertical mode"
8718 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8719 * to right and, when the space for a row is filled, another one is
8720 * started below, thus expanding the grid vertically.
8722 * @see elm_gengrid_horizontal_get()
8726 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8729 * Get for what direction a given gengrid widget will expand while
8730 * placing its items.
8732 * @param obj The gengrid object.
8733 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8734 * @c EINA_FALSE if it's set to expand vertically.
8736 * @see elm_gengrid_horizontal_set() for more detais
8740 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8743 * Get the first item in a given gengrid widget
8745 * @param obj The gengrid object
8746 * @return The first item's handle or @c NULL, if there are no
8747 * items in @p obj (and on errors)
8749 * This returns the first item in the @p obj's internal list of
8752 * @see elm_gengrid_last_item_get()
8756 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8759 * Get the last item in a given gengrid widget
8761 * @param obj The gengrid object
8762 * @return The last item's handle or @c NULL, if there are no
8763 * items in @p obj (and on errors)
8765 * This returns the last item in the @p obj's internal list of
8768 * @see elm_gengrid_first_item_get()
8772 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8775 * Get the @b next item in a gengrid widget's internal list of items,
8776 * given a handle to one of those items.
8778 * @param item The gengrid item to fetch next from
8779 * @return The item after @p item, or @c NULL if there's none (and
8782 * This returns the item placed after the @p item, on the container
8785 * @see elm_gengrid_item_prev_get()
8789 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8792 * Get the @b previous item in a gengrid widget's internal list of items,
8793 * given a handle to one of those items.
8795 * @param item The gengrid item to fetch previous from
8796 * @return The item before @p item, or @c NULL if there's none (and
8799 * This returns the item placed before the @p item, on the container
8802 * @see elm_gengrid_item_next_get()
8806 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8809 * Get the gengrid object's handle which contains a given gengrid
8812 * @param item The item to fetch the container from
8813 * @return The gengrid (parent) object
8815 * This returns the gengrid object itself that an item belongs to.
8819 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8822 * Remove a gengrid item from the its parent, deleting it.
8824 * @param item The item to be removed.
8825 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8827 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8832 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8835 * Update the contents of a given gengrid item
8837 * @param item The gengrid item
8839 * This updates an item by calling all the item class functions
8840 * again to get the icons, labels and states. Use this when the
8841 * original item data has changed and you want thta changes to be
8846 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8847 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8848 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8851 * Return the data associated to a given gengrid item
8853 * @param item The gengrid item.
8854 * @return the data associated to this item.
8856 * This returns the @c data value passed on the
8857 * elm_gengrid_item_append() and related item addition calls.
8859 * @see elm_gengrid_item_append()
8860 * @see elm_gengrid_item_data_set()
8864 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8867 * Set the data associated to a given gengrid item
8869 * @param item The gengrid item
8870 * @param data The new data pointer to set on it
8872 * This @b overrides the @c data value passed on the
8873 * elm_gengrid_item_append() and related item addition calls. This
8874 * function @b won't call elm_gengrid_item_update() automatically,
8875 * so you'd issue it afterwards if you want to hove the item
8876 * updated to reflect the that new data.
8878 * @see elm_gengrid_item_data_get()
8882 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8885 * Get a given gengrid item's position, relative to the whole
8886 * gengrid's grid area.
8888 * @param item The Gengrid item.
8889 * @param x Pointer to variable where to store the item's <b>row
8891 * @param y Pointer to variable where to store the item's <b>column
8894 * This returns the "logical" position of the item whithin the
8895 * gengrid. For example, @c (0, 1) would stand for first row,
8900 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8903 * Set whether a given gengrid item is selected or not
8905 * @param item The gengrid item
8906 * @param selected Use @c EINA_TRUE, to make it selected, @c
8907 * EINA_FALSE to make it unselected
8909 * This sets the selected state of an item. If multi selection is
8910 * not enabled on the containing gengrid and @p selected is @c
8911 * EINA_TRUE, any other previously selected items will get
8912 * unselected in favor of this new one.
8914 * @see elm_gengrid_item_selected_get()
8918 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8921 * Get whether a given gengrid item is selected or not
8923 * @param item The gengrid item
8924 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8926 * @see elm_gengrid_item_selected_set() for more details
8930 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8933 * Get the real Evas object created to implement the view of a
8934 * given gengrid item
8936 * @param item The gengrid item.
8937 * @return the Evas object implementing this item's view.
8939 * This returns the actual Evas object used to implement the
8940 * specified gengrid item's view. This may be @c NULL, as it may
8941 * not have been created or may have been deleted, at any time, by
8942 * the gengrid. <b>Do not modify this object</b> (move, resize,
8943 * show, hide, etc.), as the gengrid is controlling it. This
8944 * function is for querying, emitting custom signals or hooking
8945 * lower level callbacks for events on that object. Do not delete
8946 * this object under any circumstances.
8948 * @see elm_gengrid_item_data_get()
8952 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8955 * Show the portion of a gengrid's internal grid containing a given
8956 * item, @b immediately.
8958 * @param item The item to display
8960 * This causes gengrid to @b redraw its viewport's contents to the
8961 * region contining the given @p item item, if it is not fully
8964 * @see elm_gengrid_item_bring_in()
8968 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8971 * Animatedly bring in, to the visible are of a gengrid, a given
8974 * @param item The gengrid item to display
8976 * This causes gengrig to jump to the given @p item item and show
8977 * it (by scrolling), if it is not fully visible. This will use
8978 * animation to do so and take a period of time to complete.
8980 * @see elm_gengrid_item_show()
8984 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8987 * Set whether a given gengrid item is disabled or not.
8989 * @param item The gengrid item
8990 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8991 * to enable it back.
8993 * A disabled item cannot be selected or unselected. It will also
8994 * change its appearance, to signal the user it's disabled.
8996 * @see elm_gengrid_item_disabled_get()
9000 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9003 * Get whether a given gengrid item is disabled or not.
9005 * @param item The gengrid item
9006 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9009 * @see elm_gengrid_item_disabled_set() for more details
9013 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9016 * Set the text to be shown in a given gengrid item's tooltips.
9018 * @param item The gengrid item
9019 * @param text The text to set in the content
9021 * This call will setup the text to be used as tooltip to that item
9022 * (analogous to elm_object_tooltip_text_set(), but being item
9023 * tooltips with higher precedence than object tooltips). It can
9024 * have only one tooltip at a time, so any previous tooltip data
9029 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9032 * Set the content to be shown in a given gengrid item's tooltips
9034 * @param item The gengrid item.
9035 * @param func The function returning the tooltip contents.
9036 * @param data What to provide to @a func as callback data/context.
9037 * @param del_cb Called when data is not needed anymore, either when
9038 * another callback replaces @p func, the tooltip is unset with
9039 * elm_gengrid_item_tooltip_unset() or the owner @p item
9040 * dies. This callback receives as its first parameter the
9041 * given @p data, being @c event_info the item handle.
9043 * This call will setup the tooltip's contents to @p item
9044 * (analogous to elm_object_tooltip_content_cb_set(), but being
9045 * item tooltips with higher precedence than object tooltips). It
9046 * can have only one tooltip at a time, so any previous tooltip
9047 * content will get removed. @p func (with @p data) will be called
9048 * every time Elementary needs to show the tooltip and it should
9049 * return a valid Evas object, which will be fully managed by the
9050 * tooltip system, getting deleted when the tooltip is gone.
9054 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);
9057 * Unset a tooltip from a given gengrid item
9059 * @param item gengrid item to remove a previously set tooltip from.
9061 * This call removes any tooltip set on @p item. The callback
9062 * provided as @c del_cb to
9063 * elm_gengrid_item_tooltip_content_cb_set() will be called to
9064 * notify it is not used anymore (and have resources cleaned, if
9067 * @see elm_gengrid_item_tooltip_content_cb_set()
9071 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9074 * Set a different @b style for a given gengrid item's tooltip.
9076 * @param item gengrid item with tooltip set
9077 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9078 * "default", @c "transparent", etc)
9080 * Tooltips can have <b>alternate styles</b> to be displayed on,
9081 * which are defined by the theme set on Elementary. This function
9082 * works analogously as elm_object_tooltip_style_set(), but here
9083 * applied only to gengrid item objects. The default style for
9084 * tooltips is @c "default".
9086 * @note before you set a style you should define a tooltip with
9087 * elm_gengrid_item_tooltip_content_cb_set() or
9088 * elm_gengrid_item_tooltip_text_set()
9090 * @see elm_gengrid_item_tooltip_style_get()
9094 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9097 * Get the style set a given gengrid item's tooltip.
9099 * @param item gengrid item with tooltip already set on.
9100 * @return style the theme style in use, which defaults to
9101 * "default". If the object does not have a tooltip set,
9102 * then @c NULL is returned.
9104 * @see elm_gengrid_item_tooltip_style_set() for more details
9108 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9110 * @brief Disable size restrictions on an object's tooltip
9111 * @param item The tooltip's anchor object
9112 * @param disable If EINA_TRUE, size restrictions are disabled
9113 * @return EINA_FALSE on failure, EINA_TRUE on success
9115 * This function allows a tooltip to expand beyond its parant window's canvas.
9116 * It will instead be limited only by the size of the display.
9118 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9120 * @brief Retrieve size restriction state of an object's tooltip
9121 * @param item The tooltip's anchor object
9122 * @return If EINA_TRUE, size restrictions are disabled
9124 * This function returns whether a tooltip is allowed to expand beyond
9125 * its parant window's canvas.
9126 * It will instead be limited only by the size of the display.
9128 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9130 * Set the type of mouse pointer/cursor decoration to be shown,
9131 * when the mouse pointer is over the given gengrid widget item
9133 * @param item gengrid item to customize cursor on
9134 * @param cursor the cursor type's name
9136 * This function works analogously as elm_object_cursor_set(), but
9137 * here the cursor's changing area is restricted to the item's
9138 * area, and not the whole widget's. Note that that item cursors
9139 * have precedence over widget cursors, so that a mouse over @p
9140 * item will always show cursor @p type.
9142 * If this function is called twice for an object, a previously set
9143 * cursor will be unset on the second call.
9145 * @see elm_object_cursor_set()
9146 * @see elm_gengrid_item_cursor_get()
9147 * @see elm_gengrid_item_cursor_unset()
9151 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9154 * Get the type of mouse pointer/cursor decoration set to be shown,
9155 * when the mouse pointer is over the given gengrid widget item
9157 * @param item gengrid item with custom cursor set
9158 * @return the cursor type's name or @c NULL, if no custom cursors
9159 * were set to @p item (and on errors)
9161 * @see elm_object_cursor_get()
9162 * @see elm_gengrid_item_cursor_set() for more details
9163 * @see elm_gengrid_item_cursor_unset()
9167 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9170 * Unset any custom mouse pointer/cursor decoration set to be
9171 * shown, when the mouse pointer is over the given gengrid widget
9172 * item, thus making it show the @b default cursor again.
9174 * @param item a gengrid item
9176 * Use this call to undo any custom settings on this item's cursor
9177 * decoration, bringing it back to defaults (no custom style set).
9179 * @see elm_object_cursor_unset()
9180 * @see elm_gengrid_item_cursor_set() for more details
9184 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9187 * Set a different @b style for a given custom cursor set for a
9190 * @param item gengrid item with custom cursor set
9191 * @param style the <b>theme style</b> to use (e.g. @c "default",
9192 * @c "transparent", etc)
9194 * This function only makes sense when one is using custom mouse
9195 * cursor decorations <b>defined in a theme file</b> , which can
9196 * have, given a cursor name/type, <b>alternate styles</b> on
9197 * it. It works analogously as elm_object_cursor_style_set(), but
9198 * here applied only to gengrid item objects.
9200 * @warning Before you set a cursor style you should have defined a
9201 * custom cursor previously on the item, with
9202 * elm_gengrid_item_cursor_set()
9204 * @see elm_gengrid_item_cursor_engine_only_set()
9205 * @see elm_gengrid_item_cursor_style_get()
9209 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9212 * Get the current @b style set for a given gengrid item's custom
9215 * @param item gengrid item with custom cursor set.
9216 * @return style the cursor style in use. If the object does not
9217 * have a cursor set, then @c NULL is returned.
9219 * @see elm_gengrid_item_cursor_style_set() for more details
9223 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9226 * Set if the (custom) cursor for a given gengrid item should be
9227 * searched in its theme, also, or should only rely on the
9230 * @param item item with custom (custom) cursor already set on
9231 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9232 * only on those provided by the rendering engine, @c EINA_FALSE to
9233 * have them searched on the widget's theme, as well.
9235 * @note This call is of use only if you've set a custom cursor
9236 * for gengrid items, with elm_gengrid_item_cursor_set().
9238 * @note By default, cursors will only be looked for between those
9239 * provided by the rendering engine.
9243 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9246 * Get if the (custom) cursor for a given gengrid item is being
9247 * searched in its theme, also, or is only relying on the rendering
9250 * @param item a gengrid item
9251 * @return @c EINA_TRUE, if cursors are being looked for only on
9252 * those provided by the rendering engine, @c EINA_FALSE if they
9253 * are being searched on the widget's theme, as well.
9255 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9259 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9262 * Remove all items from a given gengrid widget
9264 * @param obj The gengrid object.
9266 * This removes (and deletes) all items in @p obj, leaving it
9269 * @see elm_gengrid_item_del(), to remove just one item.
9273 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9276 * Get the selected item in a given gengrid widget
9278 * @param obj The gengrid object.
9279 * @return The selected item's handleor @c NULL, if none is
9280 * selected at the moment (and on errors)
9282 * This returns the selected item in @p obj. If multi selection is
9283 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9284 * the first item in the list is selected, which might not be very
9285 * useful. For that case, see elm_gengrid_selected_items_get().
9289 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9292 * Get <b>a list</b> of selected items in a given gengrid
9294 * @param obj The gengrid object.
9295 * @return The list of selected items or @c NULL, if none is
9296 * selected at the moment (and on errors)
9298 * This returns a list of the selected items, in the order that
9299 * they appear in the grid. This list is only valid as long as no
9300 * more items are selected or unselected (or unselected implictly
9301 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9304 * @see elm_gengrid_selected_item_get()
9308 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9315 * @defgroup Clock Clock
9317 * @image html img/widget/clock/preview-00.png
9318 * @image latex img/widget/clock/preview-00.eps
9320 * This is a @b digital clock widget. In its default theme, it has a
9321 * vintage "flipping numbers clock" appearance, which will animate
9322 * sheets of individual algarisms individually as time goes by.
9324 * A newly created clock will fetch system's time (already
9325 * considering local time adjustments) to start with, and will tick
9326 * accondingly. It may or may not show seconds.
9328 * Clocks have an @b edition mode. When in it, the sheets will
9329 * display extra arrow indications on the top and bottom and the
9330 * user may click on them to raise or lower the time values. After
9331 * it's told to exit edition mode, it will keep ticking with that
9332 * new time set (it keeps the difference from local time).
9334 * Also, when under edition mode, user clicks on the cited arrows
9335 * which are @b held for some time will make the clock to flip the
9336 * sheet, thus editing the time, continuosly and automatically for
9337 * the user. The interval between sheet flips will keep growing in
9338 * time, so that it helps the user to reach a time which is distant
9341 * The time display is, by default, in military mode (24h), but an
9342 * am/pm indicator may be optionally shown, too, when it will
9345 * Smart callbacks one can register to:
9346 * - "changed" - the clock's user changed the time
9348 * Here is an example on its usage:
9349 * @li @ref clock_example
9358 * Identifiers for which clock digits should be editable, when a
9359 * clock widget is in edition mode. Values may be ORed together to
9360 * make a mask, naturally.
9362 * @see elm_clock_edit_set()
9363 * @see elm_clock_digit_edit_set()
9365 typedef enum _Elm_Clock_Digedit
9367 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9368 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9369 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9370 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9371 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9372 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9373 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9374 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9375 } Elm_Clock_Digedit;
9378 * Add a new clock widget to the given parent Elementary
9379 * (container) object
9381 * @param parent The parent object
9382 * @return a new clock widget handle or @c NULL, on errors
9384 * This function inserts a new clock widget on the canvas.
9388 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9391 * Set a clock widget's time, programmatically
9393 * @param obj The clock widget object
9394 * @param hrs The hours to set
9395 * @param min The minutes to set
9396 * @param sec The secondes to set
9398 * This function updates the time that is showed by the clock
9401 * Values @b must be set within the following ranges:
9402 * - 0 - 23, for hours
9403 * - 0 - 59, for minutes
9404 * - 0 - 59, for seconds,
9406 * even if the clock is not in "military" mode.
9408 * @warning The behavior for values set out of those ranges is @b
9413 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9416 * Get a clock widget's time values
9418 * @param obj The clock object
9419 * @param[out] hrs Pointer to the variable to get the hours value
9420 * @param[out] min Pointer to the variable to get the minutes value
9421 * @param[out] sec Pointer to the variable to get the seconds value
9423 * This function gets the time set for @p obj, returning
9424 * it on the variables passed as the arguments to function
9426 * @note Use @c NULL pointers on the time values you're not
9427 * interested in: they'll be ignored by the function.
9431 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9434 * Set whether a given clock widget is under <b>edition mode</b> or
9435 * under (default) displaying-only mode.
9437 * @param obj The clock object
9438 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9439 * put it back to "displaying only" mode
9441 * This function makes a clock's time to be editable or not <b>by
9442 * user interaction</b>. When in edition mode, clocks @b stop
9443 * ticking, until one brings them back to canonical mode. The
9444 * elm_clock_digit_edit_set() function will influence which digits
9445 * of the clock will be editable. By default, all of them will be
9446 * (#ELM_CLOCK_NONE).
9448 * @note am/pm sheets, if being shown, will @b always be editable
9449 * under edition mode.
9451 * @see elm_clock_edit_get()
9455 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9458 * Retrieve whether a given clock widget is under <b>edition
9459 * mode</b> or under (default) displaying-only mode.
9461 * @param obj The clock object
9462 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9465 * This function retrieves whether the clock's time can be edited
9466 * or not by user interaction.
9468 * @see elm_clock_edit_set() for more details
9472 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9475 * Set what digits of the given clock widget should be editable
9476 * when in edition mode.
9478 * @param obj The clock object
9479 * @param digedit Bit mask indicating the digits to be editable
9480 * (values in #Elm_Clock_Digedit).
9482 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9483 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9486 * @see elm_clock_digit_edit_get()
9490 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9493 * Retrieve what digits of the given clock widget should be
9494 * editable when in edition mode.
9496 * @param obj The clock object
9497 * @return Bit mask indicating the digits to be editable
9498 * (values in #Elm_Clock_Digedit).
9500 * @see elm_clock_digit_edit_set() for more details
9504 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9507 * Set if the given clock widget must show hours in military or
9510 * @param obj The clock object
9511 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9514 * This function sets if the clock must show hours in military or
9515 * am/pm mode. In some countries like Brazil the military mode
9516 * (00-24h-format) is used, in opposition to the USA, where the
9517 * am/pm mode is more commonly used.
9519 * @see elm_clock_show_am_pm_get()
9523 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9526 * Get if the given clock widget shows hours in military or am/pm
9529 * @param obj The clock object
9530 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9533 * This function gets if the clock shows hours in military or am/pm
9536 * @see elm_clock_show_am_pm_set() for more details
9540 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9543 * Set if the given clock widget must show time with seconds or not
9545 * @param obj The clock object
9546 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9548 * This function sets if the given clock must show or not elapsed
9549 * seconds. By default, they are @b not shown.
9551 * @see elm_clock_show_seconds_get()
9555 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9558 * Get whether the given clock widget is showing time with seconds
9561 * @param obj The clock object
9562 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9564 * This function gets whether @p obj is showing or not the elapsed
9567 * @see elm_clock_show_seconds_set()
9571 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9574 * Set the interval on time updates for an user mouse button hold
9575 * on clock widgets' time edition.
9577 * @param obj The clock object
9578 * @param interval The (first) interval value in seconds
9580 * This interval value is @b decreased while the user holds the
9581 * mouse pointer either incrementing or decrementing a given the
9582 * clock digit's value.
9584 * This helps the user to get to a given time distant from the
9585 * current one easier/faster, as it will start to flip quicker and
9586 * quicker on mouse button holds.
9588 * The calculation for the next flip interval value, starting from
9589 * the one set with this call, is the previous interval divided by
9590 * 1.05, so it decreases a little bit.
9592 * The default starting interval value for automatic flips is
9595 * @see elm_clock_interval_get()
9599 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9602 * Get the interval on time updates for an user mouse button hold
9603 * on clock widgets' time edition.
9605 * @param obj The clock object
9606 * @return The (first) interval value, in seconds, set on it
9608 * @see elm_clock_interval_set() for more details
9612 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9619 * @defgroup Layout Layout
9621 * @image html img/widget/layout/preview-00.png
9622 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9624 * @image html img/layout-predefined.png
9625 * @image latex img/layout-predefined.eps width=\textwidth
9627 * This is a container widget that takes a standard Edje design file and
9628 * wraps it very thinly in a widget.
9630 * An Edje design (theme) file has a very wide range of possibilities to
9631 * describe the behavior of elements added to the Layout. Check out the Edje
9632 * documentation and the EDC reference to get more information about what can
9633 * be done with Edje.
9635 * Just like @ref List, @ref Box, and other container widgets, any
9636 * object added to the Layout will become its child, meaning that it will be
9637 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9639 * The Layout widget can contain as many Contents, Boxes or Tables as
9640 * described in its theme file. For instance, objects can be added to
9641 * different Tables by specifying the respective Table part names. The same
9642 * is valid for Content and Box.
9644 * The objects added as child of the Layout will behave as described in the
9645 * part description where they were added. There are 3 possible types of
9646 * parts where a child can be added:
9648 * @section secContent Content (SWALLOW part)
9650 * Only one object can be added to the @c SWALLOW part (but you still can
9651 * have many @c SWALLOW parts and one object on each of them). Use the @c
9652 * elm_layout_content_* set of functions to set, retrieve and unset objects
9653 * as content of the @c SWALLOW. After being set to this part, the object
9654 * size, position, visibility, clipping and other description properties
9655 * will be totally controled by the description of the given part (inside
9656 * the Edje theme file).
9658 * One can use @c evas_object_size_hint_* functions on the child to have some
9659 * kind of control over its behavior, but the resulting behavior will still
9660 * depend heavily on the @c SWALLOW part description.
9662 * The Edje theme also can change the part description, based on signals or
9663 * scripts running inside the theme. This change can also be animated. All of
9664 * this will affect the child object set as content accordingly. The object
9665 * size will be changed if the part size is changed, it will animate move if
9666 * the part is moving, and so on.
9668 * The following picture demonstrates a Layout widget with a child object
9669 * added to its @c SWALLOW:
9671 * @image html layout_swallow.png
9672 * @image latex layout_swallow.eps width=\textwidth
9674 * @section secBox Box (BOX part)
9676 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9677 * allows one to add objects to the box and have them distributed along its
9678 * area, accordingly to the specified @a layout property (now by @a layout we
9679 * mean the chosen layouting design of the Box, not the Layout widget
9682 * A similar effect for having a box with its position, size and other things
9683 * controled by the Layout theme would be to create an Elementary @ref Box
9684 * widget and add it as a Content in the @c SWALLOW part.
9686 * The main difference of using the Layout Box is that its behavior, the box
9687 * properties like layouting format, padding, align, etc. will be all
9688 * controled by the theme. This means, for example, that a signal could be
9689 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9690 * handled the signal by changing the box padding, or align, or both. Using
9691 * the Elementary @ref Box widget is not necessarily harder or easier, it
9692 * just depends on the circunstances and requirements.
9694 * The Layout Box can be used through the @c elm_layout_box_* set of
9697 * The following picture demonstrates a Layout widget with many child objects
9698 * added to its @c BOX part:
9700 * @image html layout_box.png
9701 * @image latex layout_box.eps width=\textwidth
9703 * @section secTable Table (TABLE part)
9705 * Just like the @ref secBox, the Layout Table is very similar to the
9706 * Elementary @ref Table widget. It allows one to add objects to the Table
9707 * specifying the row and column where the object should be added, and any
9708 * column or row span if necessary.
9710 * Again, we could have this design by adding a @ref Table widget to the @c
9711 * SWALLOW part using elm_layout_content_set(). The same difference happens
9712 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9713 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9715 * The Layout Table can be used through the @c elm_layout_table_* set of
9718 * The following picture demonstrates a Layout widget with many child objects
9719 * added to its @c TABLE part:
9721 * @image html layout_table.png
9722 * @image latex layout_table.eps width=\textwidth
9724 * @section secPredef Predefined Layouts
9726 * Another interesting thing about the Layout widget is that it offers some
9727 * predefined themes that come with the default Elementary theme. These
9728 * themes can be set by the call elm_layout_theme_set(), and provide some
9729 * basic functionality depending on the theme used.
9731 * Most of them already send some signals, some already provide a toolbar or
9732 * back and next buttons.
9734 * These are available predefined theme layouts. All of them have class = @c
9735 * layout, group = @c application, and style = one of the following options:
9737 * @li @c toolbar-content - application with toolbar and main content area
9738 * @li @c toolbar-content-back - application with toolbar and main content
9739 * area with a back button and title area
9740 * @li @c toolbar-content-back-next - application with toolbar and main
9741 * content area with a back and next buttons and title area
9742 * @li @c content-back - application with a main content area with a back
9743 * button and title area
9744 * @li @c content-back-next - application with a main content area with a
9745 * back and next buttons and title area
9746 * @li @c toolbar-vbox - application with toolbar and main content area as a
9748 * @li @c toolbar-table - application with toolbar and main content area as a
9751 * @section secExamples Examples
9753 * Some examples of the Layout widget can be found here:
9754 * @li @ref layout_example_01
9755 * @li @ref layout_example_02
9756 * @li @ref layout_example_03
9757 * @li @ref layout_example_edc
9762 * Add a new layout to the parent
9764 * @param parent The parent object
9765 * @return The new object or NULL if it cannot be created
9767 * @see elm_layout_file_set()
9768 * @see elm_layout_theme_set()
9772 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9774 * Set the file that will be used as layout
9776 * @param obj The layout object
9777 * @param file The path to file (edj) that will be used as layout
9778 * @param group The group that the layout belongs in edje file
9780 * @return (1 = success, 0 = error)
9784 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9786 * Set the edje group from the elementary theme that will be used as layout
9788 * @param obj The layout object
9789 * @param clas the clas of the group
9790 * @param group the group
9791 * @param style the style to used
9793 * @return (1 = success, 0 = error)
9797 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9799 * Set the layout content.
9801 * @param obj The layout object
9802 * @param swallow The swallow part name in the edje file
9803 * @param content The child that will be added in this layout object
9805 * Once the content object is set, a previously set one will be deleted.
9806 * If you want to keep that old content object, use the
9807 * elm_layout_content_unset() function.
9809 * @note In an Edje theme, the part used as a content container is called @c
9810 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9811 * expected to be a part name just like the second parameter of
9812 * elm_layout_box_append().
9814 * @see elm_layout_box_append()
9815 * @see elm_layout_content_get()
9816 * @see elm_layout_content_unset()
9821 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9823 * Get the child object in the given content part.
9825 * @param obj The layout object
9826 * @param swallow The SWALLOW part to get its content
9828 * @return The swallowed object or NULL if none or an error occurred
9830 * @see elm_layout_content_set()
9834 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9836 * Unset the layout content.
9838 * @param obj The layout object
9839 * @param swallow The swallow part name in the edje file
9840 * @return The content that was being used
9842 * Unparent and return the content object which was set for this part.
9844 * @see elm_layout_content_set()
9848 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9850 * Set the text of the given part
9852 * @param obj The layout object
9853 * @param part The TEXT part where to set the text
9854 * @param text The text to set
9857 * @deprecated use elm_object_text_* instead.
9859 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9861 * Get the text set in the given part
9863 * @param obj The layout object
9864 * @param part The TEXT part to retrieve the text off
9866 * @return The text set in @p part
9869 * @deprecated use elm_object_text_* instead.
9871 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9873 * Append child to layout box part.
9875 * @param obj the layout object
9876 * @param part the box part to which the object will be appended.
9877 * @param child the child object to append to box.
9879 * Once the object is appended, it will become child of the layout. Its
9880 * lifetime will be bound to the layout, whenever the layout dies the child
9881 * will be deleted automatically. One should use elm_layout_box_remove() to
9882 * make this layout forget about the object.
9884 * @see elm_layout_box_prepend()
9885 * @see elm_layout_box_insert_before()
9886 * @see elm_layout_box_insert_at()
9887 * @see elm_layout_box_remove()
9891 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9893 * Prepend child to layout box part.
9895 * @param obj the layout object
9896 * @param part the box part to prepend.
9897 * @param child the child object to prepend to box.
9899 * Once the object is prepended, it will become child of the layout. Its
9900 * lifetime will be bound to the layout, whenever the layout dies the child
9901 * will be deleted automatically. One should use elm_layout_box_remove() to
9902 * make this layout forget about the object.
9904 * @see elm_layout_box_append()
9905 * @see elm_layout_box_insert_before()
9906 * @see elm_layout_box_insert_at()
9907 * @see elm_layout_box_remove()
9911 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9913 * Insert child to layout box part before a reference object.
9915 * @param obj the layout object
9916 * @param part the box part to insert.
9917 * @param child the child object to insert into box.
9918 * @param reference another reference object to insert before in box.
9920 * Once the object is inserted, it will become child of the layout. Its
9921 * lifetime will be bound to the layout, whenever the layout dies the child
9922 * will be deleted automatically. One should use elm_layout_box_remove() to
9923 * make this layout forget about the object.
9925 * @see elm_layout_box_append()
9926 * @see elm_layout_box_prepend()
9927 * @see elm_layout_box_insert_before()
9928 * @see elm_layout_box_remove()
9932 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9934 * Insert child to layout box part at a given position.
9936 * @param obj the layout object
9937 * @param part the box part to insert.
9938 * @param child the child object to insert into box.
9939 * @param pos the numeric position >=0 to insert the child.
9941 * Once the object is inserted, it will become child of the layout. Its
9942 * lifetime will be bound to the layout, whenever the layout dies the child
9943 * will be deleted automatically. One should use elm_layout_box_remove() to
9944 * make this layout forget about the object.
9946 * @see elm_layout_box_append()
9947 * @see elm_layout_box_prepend()
9948 * @see elm_layout_box_insert_before()
9949 * @see elm_layout_box_remove()
9953 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9955 * Remove a child of the given part box.
9957 * @param obj The layout object
9958 * @param part The box part name to remove child.
9959 * @param child The object to remove from box.
9960 * @return The object that was being used, or NULL if not found.
9962 * The object will be removed from the box part and its lifetime will
9963 * not be handled by the layout anymore. This is equivalent to
9964 * elm_layout_content_unset() for box.
9966 * @see elm_layout_box_append()
9967 * @see elm_layout_box_remove_all()
9971 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9973 * Remove all child of the given part box.
9975 * @param obj The layout object
9976 * @param part The box part name to remove child.
9977 * @param clear If EINA_TRUE, then all objects will be deleted as
9978 * well, otherwise they will just be removed and will be
9979 * dangling on the canvas.
9981 * The objects will be removed from the box part and their lifetime will
9982 * not be handled by the layout anymore. This is equivalent to
9983 * elm_layout_box_remove() for all box children.
9985 * @see elm_layout_box_append()
9986 * @see elm_layout_box_remove()
9990 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9992 * Insert child to layout table part.
9994 * @param obj the layout object
9995 * @param part the box part to pack child.
9996 * @param child_obj the child object to pack into table.
9997 * @param col the column to which the child should be added. (>= 0)
9998 * @param row the row to which the child should be added. (>= 0)
9999 * @param colspan how many columns should be used to store this object. (>=
10001 * @param rowspan how many rows should be used to store this object. (>= 1)
10003 * Once the object is inserted, it will become child of the table. Its
10004 * lifetime will be bound to the layout, and whenever the layout dies the
10005 * child will be deleted automatically. One should use
10006 * elm_layout_table_remove() to make this layout forget about the object.
10008 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10009 * more space than a single cell. For instance, the following code:
10011 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10014 * Would result in an object being added like the following picture:
10016 * @image html layout_colspan.png
10017 * @image latex layout_colspan.eps width=\textwidth
10019 * @see elm_layout_table_unpack()
10020 * @see elm_layout_table_clear()
10024 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);
10026 * Unpack (remove) a child of the given part table.
10028 * @param obj The layout object
10029 * @param part The table part name to remove child.
10030 * @param child_obj The object to remove from table.
10031 * @return The object that was being used, or NULL if not found.
10033 * The object will be unpacked from the table part and its lifetime
10034 * will not be handled by the layout anymore. This is equivalent to
10035 * elm_layout_content_unset() for table.
10037 * @see elm_layout_table_pack()
10038 * @see elm_layout_table_clear()
10042 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10044 * Remove all child of the given part table.
10046 * @param obj The layout object
10047 * @param part The table part name to remove child.
10048 * @param clear If EINA_TRUE, then all objects will be deleted as
10049 * well, otherwise they will just be removed and will be
10050 * dangling on the canvas.
10052 * The objects will be removed from the table part and their lifetime will
10053 * not be handled by the layout anymore. This is equivalent to
10054 * elm_layout_table_unpack() for all table children.
10056 * @see elm_layout_table_pack()
10057 * @see elm_layout_table_unpack()
10061 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10063 * Get the edje layout
10065 * @param obj The layout object
10067 * @return A Evas_Object with the edje layout settings loaded
10068 * with function elm_layout_file_set
10070 * This returns the edje object. It is not expected to be used to then
10071 * swallow objects via edje_object_part_swallow() for example. Use
10072 * elm_layout_content_set() instead so child object handling and sizing is
10075 * @note This function should only be used if you really need to call some
10076 * low level Edje function on this edje object. All the common stuff (setting
10077 * text, emitting signals, hooking callbacks to signals, etc.) can be done
10078 * with proper elementary functions.
10080 * @see elm_object_signal_callback_add()
10081 * @see elm_object_signal_emit()
10082 * @see elm_object_text_part_set()
10083 * @see elm_layout_content_set()
10084 * @see elm_layout_box_append()
10085 * @see elm_layout_table_pack()
10086 * @see elm_layout_data_get()
10090 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10092 * Get the edje data from the given layout
10094 * @param obj The layout object
10095 * @param key The data key
10097 * @return The edje data string
10099 * This function fetches data specified inside the edje theme of this layout.
10100 * This function return NULL if data is not found.
10102 * In EDC this comes from a data block within the group block that @p
10103 * obj was loaded from. E.g.
10110 * item: "key1" "value1";
10111 * item: "key2" "value2";
10119 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10123 * @param obj The layout object
10125 * Manually forces a sizing re-evaluation. This is useful when the minimum
10126 * size required by the edje theme of this layout has changed. The change on
10127 * the minimum size required by the edje theme is not immediately reported to
10128 * the elementary layout, so one needs to call this function in order to tell
10129 * the widget (layout) that it needs to reevaluate its own size.
10131 * The minimum size of the theme is calculated based on minimum size of
10132 * parts, the size of elements inside containers like box and table, etc. All
10133 * of this can change due to state changes, and that's when this function
10134 * should be called.
10136 * Also note that a standard signal of "size,eval" "elm" emitted from the
10137 * edje object will cause this to happen too.
10141 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10144 * Sets a specific cursor for an edje part.
10146 * @param obj The layout object.
10147 * @param part_name a part from loaded edje group.
10148 * @param cursor cursor name to use, see Elementary_Cursor.h
10150 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10151 * part not exists or it has "mouse_events: 0".
10155 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10158 * Get the cursor to be shown when mouse is over an edje part
10160 * @param obj The layout object.
10161 * @param part_name a part from loaded edje group.
10162 * @return the cursor name.
10166 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10169 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10171 * @param obj The layout object.
10172 * @param part_name a part from loaded edje group, that had a cursor set
10173 * with elm_layout_part_cursor_set().
10177 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10180 * Sets a specific cursor style for an edje part.
10182 * @param obj The layout object.
10183 * @param part_name a part from loaded edje group.
10184 * @param style the theme style to use (default, transparent, ...)
10186 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10187 * part not exists or it did not had a cursor set.
10191 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10194 * Gets a specific cursor style for an edje part.
10196 * @param obj The layout object.
10197 * @param part_name a part from loaded edje group.
10199 * @return the theme style in use, defaults to "default". If the
10200 * object does not have a cursor set, then NULL is returned.
10204 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10207 * Sets if the cursor set should be searched on the theme or should use
10208 * the provided by the engine, only.
10210 * @note before you set if should look on theme you should define a
10211 * cursor with elm_layout_part_cursor_set(). By default it will only
10212 * look for cursors provided by the engine.
10214 * @param obj The layout object.
10215 * @param part_name a part from loaded edje group.
10216 * @param engine_only if cursors should be just provided by the engine
10217 * or should also search on widget's theme as well
10219 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10220 * part not exists or it did not had a cursor set.
10224 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);
10227 * Gets a specific cursor engine_only for an edje part.
10229 * @param obj The layout object.
10230 * @param part_name a part from loaded edje group.
10232 * @return whenever the cursor is just provided by engine or also from theme.
10236 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10239 * @def elm_layout_icon_set
10240 * Convienience macro to set the icon object in a layout that follows the
10241 * Elementary naming convention for its parts.
10245 #define elm_layout_icon_set(_ly, _obj) \
10248 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
10249 if ((_obj)) sig = "elm,state,icon,visible"; \
10250 else sig = "elm,state,icon,hidden"; \
10251 elm_object_signal_emit((_ly), sig, "elm"); \
10255 * @def elm_layout_icon_get
10256 * Convienience macro to get the icon object from a layout that follows the
10257 * Elementary naming convention for its parts.
10261 #define elm_layout_icon_get(_ly) \
10262 elm_layout_content_get((_ly), "elm.swallow.icon")
10265 * @def elm_layout_end_set
10266 * Convienience macro to set the end object in a layout that follows the
10267 * Elementary naming convention for its parts.
10271 #define elm_layout_end_set(_ly, _obj) \
10274 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
10275 if ((_obj)) sig = "elm,state,end,visible"; \
10276 else sig = "elm,state,end,hidden"; \
10277 elm_object_signal_emit((_ly), sig, "elm"); \
10281 * @def elm_layout_end_get
10282 * Convienience macro to get the end object in a layout that follows the
10283 * Elementary naming convention for its parts.
10287 #define elm_layout_end_get(_ly) \
10288 elm_layout_content_get((_ly), "elm.swallow.end")
10291 * @def elm_layout_label_set
10292 * Convienience macro to set the label in a layout that follows the
10293 * Elementary naming convention for its parts.
10296 * @deprecated use elm_object_text_* instead.
10298 #define elm_layout_label_set(_ly, _txt) \
10299 elm_layout_text_set((_ly), "elm.text", (_txt))
10302 * @def elm_layout_label_get
10303 * Convienience macro to get the label in a layout that follows the
10304 * Elementary naming convention for its parts.
10307 * @deprecated use elm_object_text_* instead.
10309 #define elm_layout_label_get(_ly) \
10310 elm_layout_text_get((_ly), "elm.text")
10312 /* smart callbacks called:
10313 * "theme,changed" - when elm theme is changed.
10317 * @defgroup Notify Notify
10319 * @image html img/widget/notify/preview-00.png
10320 * @image latex img/widget/notify/preview-00.eps
10322 * Display a container in a particular region of the parent(top, bottom,
10323 * etc. A timeout can be set to automatically hide the notify. This is so
10324 * that, after an evas_object_show() on a notify object, if a timeout was set
10325 * on it, it will @b automatically get hidden after that time.
10327 * Signals that you can add callbacks for are:
10328 * @li "timeout" - when timeout happens on notify and it's hidden
10329 * @li "block,clicked" - when a click outside of the notify happens
10331 * @ref tutorial_notify show usage of the API.
10336 * @brief Possible orient values for notify.
10338 * This values should be used in conjunction to elm_notify_orient_set() to
10339 * set the position in which the notify should appear(relative to its parent)
10340 * and in conjunction with elm_notify_orient_get() to know where the notify
10343 typedef enum _Elm_Notify_Orient
10345 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10346 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10347 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10348 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10349 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10350 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10351 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10352 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10353 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10354 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10355 } Elm_Notify_Orient;
10357 * @brief Add a new notify to the parent
10359 * @param parent The parent object
10360 * @return The new object or NULL if it cannot be created
10362 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10364 * @brief Set the content of the notify widget
10366 * @param obj The notify object
10367 * @param content The content will be filled in this notify object
10369 * Once the content object is set, a previously set one will be deleted. If
10370 * you want to keep that old content object, use the
10371 * elm_notify_content_unset() function.
10373 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10375 * @brief Unset the content of the notify widget
10377 * @param obj The notify object
10378 * @return The content that was being used
10380 * Unparent and return the content object which was set for this widget
10382 * @see elm_notify_content_set()
10384 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10386 * @brief Return the content of the notify widget
10388 * @param obj The notify object
10389 * @return The content that is being used
10391 * @see elm_notify_content_set()
10393 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10395 * @brief Set the notify parent
10397 * @param obj The notify object
10398 * @param content The new parent
10400 * Once the parent object is set, a previously set one will be disconnected
10403 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10405 * @brief Get the notify parent
10407 * @param obj The notify object
10408 * @return The parent
10410 * @see elm_notify_parent_set()
10412 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10414 * @brief Set the orientation
10416 * @param obj The notify object
10417 * @param orient The new orientation
10419 * Sets the position in which the notify will appear in its parent.
10421 * @see @ref Elm_Notify_Orient for possible values.
10423 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10425 * @brief Return the orientation
10426 * @param obj The notify object
10427 * @return The orientation of the notification
10429 * @see elm_notify_orient_set()
10430 * @see Elm_Notify_Orient
10432 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10434 * @brief Set the time interval after which the notify window is going to be
10437 * @param obj The notify object
10438 * @param time The timeout in seconds
10440 * This function sets a timeout and starts the timer controlling when the
10441 * notify is hidden. Since calling evas_object_show() on a notify restarts
10442 * the timer controlling when the notify is hidden, setting this before the
10443 * notify is shown will in effect mean starting the timer when the notify is
10446 * @note Set a value <= 0.0 to disable a running timer.
10448 * @note If the value > 0.0 and the notify is previously visible, the
10449 * timer will be started with this value, canceling any running timer.
10451 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10453 * @brief Return the timeout value (in seconds)
10454 * @param obj the notify object
10456 * @see elm_notify_timeout_set()
10458 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10460 * @brief Sets whether events should be passed to by a click outside
10463 * @param obj The notify object
10464 * @param repeats EINA_TRUE Events are repeats, else no
10466 * When true if the user clicks outside the window the events will be caught
10467 * by the others widgets, else the events are blocked.
10469 * @note The default value is EINA_TRUE.
10471 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10473 * @brief Return true if events are repeat below the notify object
10474 * @param obj the notify object
10476 * @see elm_notify_repeat_events_set()
10478 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10484 * @defgroup Hover Hover
10486 * @image html img/widget/hover/preview-00.png
10487 * @image latex img/widget/hover/preview-00.eps
10489 * A Hover object will hover over its @p parent object at the @p target
10490 * location. Anything in the background will be given a darker coloring to
10491 * indicate that the hover object is on top (at the default theme). When the
10492 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10493 * clicked that @b doesn't cause the hover to be dismissed.
10495 * @note The hover object will take up the entire space of @p target
10498 * Elementary has the following styles for the hover widget:
10502 * @li hoversel_vertical
10504 * The following are the available position for content:
10516 * Signals that you can add callbacks for are:
10517 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10518 * @li "smart,changed" - a content object placed under the "smart"
10519 * policy was replaced to a new slot direction.
10521 * See @ref tutorial_hover for more information.
10525 typedef enum _Elm_Hover_Axis
10527 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10528 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10529 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10530 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10533 * @brief Adds a hover object to @p parent
10535 * @param parent The parent object
10536 * @return The hover object or NULL if one could not be created
10538 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10540 * @brief Sets the target object for the hover.
10542 * @param obj The hover object
10543 * @param target The object to center the hover onto. The hover
10545 * This function will cause the hover to be centered on the target object.
10547 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10549 * @brief Gets the target object for the hover.
10551 * @param obj The hover object
10552 * @param parent The object to locate the hover over.
10554 * @see elm_hover_target_set()
10556 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10558 * @brief Sets the parent object for the hover.
10560 * @param obj The hover object
10561 * @param parent The object to locate the hover over.
10563 * This function will cause the hover to take up the entire space that the
10564 * parent object fills.
10566 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10568 * @brief Gets the parent object for the hover.
10570 * @param obj The hover object
10571 * @return The parent object to locate the hover over.
10573 * @see elm_hover_parent_set()
10575 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10577 * @brief Sets the content of the hover object and the direction in which it
10580 * @param obj The hover object
10581 * @param swallow The direction that the object will be displayed
10582 * at. Accepted values are "left", "top-left", "top", "top-right",
10583 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10585 * @param content The content to place at @p swallow
10587 * Once the content object is set for a given direction, a previously
10588 * set one (on the same direction) will be deleted. If you want to
10589 * keep that old content object, use the elm_hover_content_unset()
10592 * All directions may have contents at the same time, except for
10593 * "smart". This is a special placement hint and its use case
10594 * independs of the calculations coming from
10595 * elm_hover_best_content_location_get(). Its use is for cases when
10596 * one desires only one hover content, but with a dinamic special
10597 * placement within the hover area. The content's geometry, whenever
10598 * it changes, will be used to decide on a best location not
10599 * extrapolating the hover's parent object view to show it in (still
10600 * being the hover's target determinant of its medium part -- move and
10601 * resize it to simulate finger sizes, for example). If one of the
10602 * directions other than "smart" are used, a previously content set
10603 * using it will be deleted, and vice-versa.
10605 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10607 * @brief Get the content of the hover object, in a given direction.
10609 * Return the content object which was set for this widget in the
10610 * @p swallow direction.
10612 * @param obj The hover object
10613 * @param swallow The direction that the object was display at.
10614 * @return The content that was being used
10616 * @see elm_hover_content_set()
10618 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10620 * @brief Unset the content of the hover object, in a given direction.
10622 * Unparent and return the content object set at @p swallow direction.
10624 * @param obj The hover object
10625 * @param swallow The direction that the object was display at.
10626 * @return The content that was being used.
10628 * @see elm_hover_content_set()
10630 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10632 * @brief Returns the best swallow location for content in the hover.
10634 * @param obj The hover object
10635 * @param pref_axis The preferred orientation axis for the hover object to use
10636 * @return The edje location to place content into the hover or @c
10639 * Best is defined here as the location at which there is the most available
10642 * @p pref_axis may be one of
10643 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10644 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10645 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10646 * - @c ELM_HOVER_AXIS_BOTH -- both
10648 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10649 * nescessarily be along the horizontal axis("left" or "right"). If
10650 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10651 * be along the vertical axis("top" or "bottom"). Chossing
10652 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10653 * returned position may be in either axis.
10655 * @see elm_hover_content_set()
10657 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10664 * @defgroup Entry Entry
10666 * @image html img/widget/entry/preview-00.png
10667 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10668 * @image html img/widget/entry/preview-01.png
10669 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10670 * @image html img/widget/entry/preview-02.png
10671 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10672 * @image html img/widget/entry/preview-03.png
10673 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10675 * An entry is a convenience widget which shows a box that the user can
10676 * enter text into. Entries by default don't scroll, so they grow to
10677 * accomodate the entire text, resizing the parent window as needed. This
10678 * can be changed with the elm_entry_scrollable_set() function.
10680 * They can also be single line or multi line (the default) and when set
10681 * to multi line mode they support text wrapping in any of the modes
10682 * indicated by #Elm_Wrap_Type.
10684 * Other features include password mode, filtering of inserted text with
10685 * elm_entry_text_filter_append() and related functions, inline "items" and
10686 * formatted markup text.
10688 * @section entry-markup Formatted text
10690 * The markup tags supported by the Entry are defined by the theme, but
10691 * even when writing new themes or extensions it's a good idea to stick to
10692 * a sane default, to maintain coherency and avoid application breakages.
10693 * Currently defined by the default theme are the following tags:
10694 * @li \<br\>: Inserts a line break.
10695 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10697 * @li \<tab\>: Inserts a tab.
10698 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10700 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10701 * @li \<link\>...\</link\>: Underlines the enclosed text.
10702 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10704 * @section entry-special Special markups
10706 * Besides those used to format text, entries support two special markup
10707 * tags used to insert clickable portions of text or items inlined within
10710 * @subsection entry-anchors Anchors
10712 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10713 * \</a\> tags and an event will be generated when this text is clicked,
10717 * This text is outside <a href=anc-01>but this one is an anchor</a>
10720 * The @c href attribute in the opening tag gives the name that will be
10721 * used to identify the anchor and it can be any valid utf8 string.
10723 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10724 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10725 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10726 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10729 * @subsection entry-items Items
10731 * Inlined in the text, any other @c Evas_Object can be inserted by using
10732 * \<item\> tags this way:
10735 * <item size=16x16 vsize=full href=emoticon/haha></item>
10738 * Just like with anchors, the @c href identifies each item, but these need,
10739 * in addition, to indicate their size, which is done using any one of
10740 * @c size, @c absize or @c relsize attributes. These attributes take their
10741 * value in the WxH format, where W is the width and H the height of the
10744 * @li absize: Absolute pixel size for the item. Whatever value is set will
10745 * be the item's size regardless of any scale value the object may have
10746 * been set to. The final line height will be adjusted to fit larger items.
10747 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10749 * @li relsize: Size is adjusted for the item to fit within the current
10752 * Besides their size, items are specificed a @c vsize value that affects
10753 * how their final size and position are calculated. The possible values
10755 * @li ascent: Item will be placed within the line's baseline and its
10756 * ascent. That is, the height between the line where all characters are
10757 * positioned and the highest point in the line. For @c size and @c absize
10758 * items, the descent value will be added to the total line height to make
10759 * them fit. @c relsize items will be adjusted to fit within this space.
10760 * @li full: Items will be placed between the descent and ascent, or the
10761 * lowest point in the line and its highest.
10763 * The next image shows different configurations of items and how they
10764 * are the previously mentioned options affect their sizes. In all cases,
10765 * the green line indicates the ascent, blue for the baseline and red for
10768 * @image html entry_item.png
10769 * @image latex entry_item.eps width=\textwidth
10771 * And another one to show how size differs from absize. In the first one,
10772 * the scale value is set to 1.0, while the second one is using one of 2.0.
10774 * @image html entry_item_scale.png
10775 * @image latex entry_item_scale.eps width=\textwidth
10777 * After the size for an item is calculated, the entry will request an
10778 * object to place in its space. For this, the functions set with
10779 * elm_entry_item_provider_append() and related functions will be called
10780 * in order until one of them returns a @c non-NULL value. If no providers
10781 * are available, or all of them return @c NULL, then the entry falls back
10782 * to one of the internal defaults, provided the name matches with one of
10785 * All of the following are currently supported:
10788 * - emoticon/angry-shout
10789 * - emoticon/crazy-laugh
10790 * - emoticon/evil-laugh
10792 * - emoticon/goggle-smile
10793 * - emoticon/grumpy
10794 * - emoticon/grumpy-smile
10795 * - emoticon/guilty
10796 * - emoticon/guilty-smile
10798 * - emoticon/half-smile
10799 * - emoticon/happy-panting
10801 * - emoticon/indifferent
10803 * - emoticon/knowing-grin
10805 * - emoticon/little-bit-sorry
10806 * - emoticon/love-lots
10808 * - emoticon/minimal-smile
10809 * - emoticon/not-happy
10810 * - emoticon/not-impressed
10812 * - emoticon/opensmile
10815 * - emoticon/squint-laugh
10816 * - emoticon/surprised
10817 * - emoticon/suspicious
10818 * - emoticon/tongue-dangling
10819 * - emoticon/tongue-poke
10821 * - emoticon/unhappy
10822 * - emoticon/very-sorry
10825 * - emoticon/worried
10828 * Alternatively, an item may reference an image by its path, using
10829 * the URI form @c file:///path/to/an/image.png and the entry will then
10830 * use that image for the item.
10832 * @section entry-files Loading and saving files
10834 * Entries have convinience functions to load text from a file and save
10835 * changes back to it after a short delay. The automatic saving is enabled
10836 * by default, but can be disabled with elm_entry_autosave_set() and files
10837 * can be loaded directly as plain text or have any markup in them
10838 * recognized. See elm_entry_file_set() for more details.
10840 * @section entry-signals Emitted signals
10842 * This widget emits the following signals:
10844 * @li "changed": The text within the entry was changed.
10845 * @li "changed,user": The text within the entry was changed because of user interaction.
10846 * @li "activated": The enter key was pressed on a single line entry.
10847 * @li "press": A mouse button has been pressed on the entry.
10848 * @li "longpressed": A mouse button has been pressed and held for a couple
10850 * @li "clicked": The entry has been clicked (mouse press and release).
10851 * @li "clicked,double": The entry has been double clicked.
10852 * @li "clicked,triple": The entry has been triple clicked.
10853 * @li "focused": The entry has received focus.
10854 * @li "unfocused": The entry has lost focus.
10855 * @li "selection,paste": A paste of the clipboard contents was requested.
10856 * @li "selection,copy": A copy of the selected text into the clipboard was
10858 * @li "selection,cut": A cut of the selected text into the clipboard was
10860 * @li "selection,start": A selection has begun and no previous selection
10862 * @li "selection,changed": The current selection has changed.
10863 * @li "selection,cleared": The current selection has been cleared.
10864 * @li "cursor,changed": The cursor has changed position.
10865 * @li "anchor,clicked": An anchor has been clicked. The event_info
10866 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10867 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10868 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10869 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10870 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10871 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10872 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10873 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10874 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10875 * @li "preedit,changed": The preedit string has changed.
10876 * @li "language,changed": Program language changed.
10878 * @section entry-examples
10880 * An overview of the Entry API can be seen in @ref entry_example_01
10885 * @typedef Elm_Entry_Anchor_Info
10887 * The info sent in the callback for the "anchor,clicked" signals emitted
10890 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10892 * @struct _Elm_Entry_Anchor_Info
10894 * The info sent in the callback for the "anchor,clicked" signals emitted
10897 struct _Elm_Entry_Anchor_Info
10899 const char *name; /**< The name of the anchor, as stated in its href */
10900 int button; /**< The mouse button used to click on it */
10901 Evas_Coord x, /**< Anchor geometry, relative to canvas */
10902 y, /**< Anchor geometry, relative to canvas */
10903 w, /**< Anchor geometry, relative to canvas */
10904 h; /**< Anchor geometry, relative to canvas */
10907 * @typedef Elm_Entry_Filter_Cb
10908 * This callback type is used by entry filters to modify text.
10909 * @param data The data specified as the last param when adding the filter
10910 * @param entry The entry object
10911 * @param text A pointer to the location of the text being filtered. This data can be modified,
10912 * but any additional allocations must be managed by the user.
10913 * @see elm_entry_text_filter_append
10914 * @see elm_entry_text_filter_prepend
10916 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10919 * This adds an entry to @p parent object.
10921 * By default, entries are:
10925 * @li autosave is enabled
10927 * @param parent The parent object
10928 * @return The new object or NULL if it cannot be created
10930 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10932 * Sets the entry to single line mode.
10934 * In single line mode, entries don't ever wrap when the text reaches the
10935 * edge, and instead they keep growing horizontally. Pressing the @c Enter
10936 * key will generate an @c "activate" event instead of adding a new line.
10938 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10939 * and pressing enter will break the text into a different line
10940 * without generating any events.
10942 * @param obj The entry object
10943 * @param single_line If true, the text in the entry
10944 * will be on a single line.
10946 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10948 * Gets whether the entry is set to be single line.
10950 * @param obj The entry object
10951 * @return single_line If true, the text in the entry is set to display
10952 * on a single line.
10954 * @see elm_entry_single_line_set()
10956 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10958 * Sets the entry to password mode.
10960 * In password mode, entries are implicitly single line and the display of
10961 * any text in them is replaced with asterisks (*).
10963 * @param obj The entry object
10964 * @param password If true, password mode is enabled.
10966 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10968 * Gets whether the entry is set to password mode.
10970 * @param obj The entry object
10971 * @return If true, the entry is set to display all characters
10972 * as asterisks (*).
10974 * @see elm_entry_password_set()
10976 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10978 * This sets the text displayed within the entry to @p entry.
10980 * @param obj The entry object
10981 * @param entry The text to be displayed
10983 * @deprecated Use elm_object_text_set() instead.
10985 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10987 * This returns the text currently shown in object @p entry.
10988 * See also elm_entry_entry_set().
10990 * @param obj The entry object
10991 * @return The currently displayed text or NULL on failure
10993 * @deprecated Use elm_object_text_get() instead.
10995 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10997 * Appends @p entry to the text of the entry.
10999 * Adds the text in @p entry to the end of any text already present in the
11002 * The appended text is subject to any filters set for the widget.
11004 * @param obj The entry object
11005 * @param entry The text to be displayed
11007 * @see elm_entry_text_filter_append()
11009 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11011 * Gets whether the entry is empty.
11013 * Empty means no text at all. If there are any markup tags, like an item
11014 * tag for which no provider finds anything, and no text is displayed, this
11015 * function still returns EINA_FALSE.
11017 * @param obj The entry object
11018 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11020 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11022 * Gets any selected text within the entry.
11024 * If there's any selected text in the entry, this function returns it as
11025 * a string in markup format. NULL is returned if no selection exists or
11026 * if an error occurred.
11028 * The returned value points to an internal string and should not be freed
11029 * or modified in any way. If the @p entry object is deleted or its
11030 * contents are changed, the returned pointer should be considered invalid.
11032 * @param obj The entry object
11033 * @return The selected text within the entry or NULL on failure
11035 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11037 * Inserts the given text into the entry at the current cursor position.
11039 * This inserts text at the cursor position as if it was typed
11040 * by the user (note that this also allows markup which a user
11041 * can't just "type" as it would be converted to escaped text, so this
11042 * call can be used to insert things like emoticon items or bold push/pop
11043 * tags, other font and color change tags etc.)
11045 * If any selection exists, it will be replaced by the inserted text.
11047 * The inserted text is subject to any filters set for the widget.
11049 * @param obj The entry object
11050 * @param entry The text to insert
11052 * @see elm_entry_text_filter_append()
11054 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11056 * Set the line wrap type to use on multi-line entries.
11058 * Sets the wrap type used by the entry to any of the specified in
11059 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11060 * line (without inserting a line break or paragraph separator) when it
11061 * reaches the far edge of the widget.
11063 * Note that this only makes sense for multi-line entries. A widget set
11064 * to be single line will never wrap.
11066 * @param obj The entry object
11067 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11069 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11071 * Gets the wrap mode the entry was set to use.
11073 * @param obj The entry object
11074 * @return Wrap type
11076 * @see also elm_entry_line_wrap_set()
11078 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11080 * Sets if the entry is to be editable or not.
11082 * By default, entries are editable and when focused, any text input by the
11083 * user will be inserted at the current cursor position. But calling this
11084 * function with @p editable as EINA_FALSE will prevent the user from
11085 * inputting text into the entry.
11087 * The only way to change the text of a non-editable entry is to use
11088 * elm_object_text_set(), elm_entry_entry_insert() and other related
11091 * @param obj The entry object
11092 * @param editable If EINA_TRUE, user input will be inserted in the entry,
11093 * if not, the entry is read-only and no user input is allowed.
11095 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11097 * Gets whether the entry is editable or not.
11099 * @param obj The entry object
11100 * @return If true, the entry is editable by the user.
11101 * If false, it is not editable by the user
11103 * @see elm_entry_editable_set()
11105 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11107 * This drops any existing text selection within the entry.
11109 * @param obj The entry object
11111 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11113 * This selects all text within the entry.
11115 * @param obj The entry object
11117 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11119 * This moves the cursor one place to the right within the entry.
11121 * @param obj The entry object
11122 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11124 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11126 * This moves the cursor one place to the left within the entry.
11128 * @param obj The entry object
11129 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11131 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11133 * This moves the cursor one line up within the entry.
11135 * @param obj The entry object
11136 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11138 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11140 * This moves the cursor one line down within the entry.
11142 * @param obj The entry object
11143 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11145 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11147 * This moves the cursor to the beginning of the entry.
11149 * @param obj The entry object
11151 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11153 * This moves the cursor to the end of the entry.
11155 * @param obj The entry object
11157 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11159 * This moves the cursor to the beginning of the current line.
11161 * @param obj The entry object
11163 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11165 * This moves the cursor to the end of the current line.
11167 * @param obj The entry object
11169 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11171 * This begins a selection within the entry as though
11172 * the user were holding down the mouse button to make a selection.
11174 * @param obj The entry object
11176 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11178 * This ends a selection within the entry as though
11179 * the user had just released the mouse button while making a selection.
11181 * @param obj The entry object
11183 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11185 * Gets whether a format node exists at the current cursor position.
11187 * A format node is anything that defines how the text is rendered. It can
11188 * be a visible format node, such as a line break or a paragraph separator,
11189 * or an invisible one, such as bold begin or end tag.
11190 * This function returns whether any format node exists at the current
11193 * @param obj The entry object
11194 * @return EINA_TRUE if the current cursor position contains a format node,
11195 * EINA_FALSE otherwise.
11197 * @see elm_entry_cursor_is_visible_format_get()
11199 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11201 * Gets if the current cursor position holds a visible format node.
11203 * @param obj The entry object
11204 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11205 * if it's an invisible one or no format exists.
11207 * @see elm_entry_cursor_is_format_get()
11209 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11211 * Gets the character pointed by the cursor at its current position.
11213 * This function returns a string with the utf8 character stored at the
11214 * current cursor position.
11215 * Only the text is returned, any format that may exist will not be part
11216 * of the return value.
11218 * @param obj The entry object
11219 * @return The text pointed by the cursors.
11221 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11223 * This function returns the geometry of the cursor.
11225 * It's useful if you want to draw something on the cursor (or where it is),
11226 * or for example in the case of scrolled entry where you want to show the
11229 * @param obj The entry object
11230 * @param x returned geometry
11231 * @param y returned geometry
11232 * @param w returned geometry
11233 * @param h returned geometry
11234 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11236 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);
11238 * Sets the cursor position in the entry to the given value
11240 * The value in @p pos is the index of the character position within the
11241 * contents of the string as returned by elm_entry_cursor_pos_get().
11243 * @param obj The entry object
11244 * @param pos The position of the cursor
11246 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11248 * Retrieves the current position of the cursor in the entry
11250 * @param obj The entry object
11251 * @return The cursor position
11253 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11255 * This executes a "cut" action on the selected text in the entry.
11257 * @param obj The entry object
11259 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11261 * This executes a "copy" action on the selected text in the entry.
11263 * @param obj The entry object
11265 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11267 * This executes a "paste" action in the entry.
11269 * @param obj The entry object
11271 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11273 * This clears and frees the items in a entry's contextual (longpress)
11276 * @param obj The entry object
11278 * @see elm_entry_context_menu_item_add()
11280 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11282 * This adds an item to the entry's contextual menu.
11284 * A longpress on an entry will make the contextual menu show up, if this
11285 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11286 * By default, this menu provides a few options like enabling selection mode,
11287 * which is useful on embedded devices that need to be explicit about it,
11288 * and when a selection exists it also shows the copy and cut actions.
11290 * With this function, developers can add other options to this menu to
11291 * perform any action they deem necessary.
11293 * @param obj The entry object
11294 * @param label The item's text label
11295 * @param icon_file The item's icon file
11296 * @param icon_type The item's icon type
11297 * @param func The callback to execute when the item is clicked
11298 * @param data The data to associate with the item for related functions
11300 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);
11302 * This disables the entry's contextual (longpress) menu.
11304 * @param obj The entry object
11305 * @param disabled If true, the menu is disabled
11307 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11309 * This returns whether the entry's contextual (longpress) menu is
11312 * @param obj The entry object
11313 * @return If true, the menu is disabled
11315 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11317 * This appends a custom item provider to the list for that entry
11319 * This appends the given callback. The list is walked from beginning to end
11320 * with each function called given the item href string in the text. If the
11321 * function returns an object handle other than NULL (it should create an
11322 * object to do this), then this object is used to replace that item. If
11323 * not the next provider is called until one provides an item object, or the
11324 * default provider in entry does.
11326 * @param obj The entry object
11327 * @param func The function called to provide the item object
11328 * @param data The data passed to @p func
11330 * @see @ref entry-items
11332 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);
11334 * This prepends a custom item provider to the list for that entry
11336 * This prepends the given callback. See elm_entry_item_provider_append() for
11339 * @param obj The entry object
11340 * @param func The function called to provide the item object
11341 * @param data The data passed to @p func
11343 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);
11345 * This removes a custom item provider to the list for that entry
11347 * This removes the given callback. See elm_entry_item_provider_append() for
11350 * @param obj The entry object
11351 * @param func The function called to provide the item object
11352 * @param data The data passed to @p func
11354 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);
11356 * Append a filter function for text inserted in the entry
11358 * Append the given callback to the list. This functions will be called
11359 * whenever any text is inserted into the entry, with the text to be inserted
11360 * as a parameter. The callback function is free to alter the text in any way
11361 * it wants, but it must remember to free the given pointer and update it.
11362 * If the new text is to be discarded, the function can free it and set its
11363 * text parameter to NULL. This will also prevent any following filters from
11366 * @param obj The entry object
11367 * @param func The function to use as text filter
11368 * @param data User data to pass to @p func
11370 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11372 * Prepend a filter function for text insdrted in the entry
11374 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11375 * for more information
11377 * @param obj The entry object
11378 * @param func The function to use as text filter
11379 * @param data User data to pass to @p func
11381 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11383 * Remove a filter from the list
11385 * Removes the given callback from the filter list. See
11386 * elm_entry_text_filter_append() for more information.
11388 * @param obj The entry object
11389 * @param func The filter function to remove
11390 * @param data The user data passed when adding the function
11392 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11394 * This converts a markup (HTML-like) string into UTF-8.
11396 * The returned string is a malloc'ed buffer and it should be freed when
11397 * not needed anymore.
11399 * @param s The string (in markup) to be converted
11400 * @return The converted string (in UTF-8). It should be freed.
11402 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11404 * This converts a UTF-8 string into markup (HTML-like).
11406 * The returned string is a malloc'ed buffer and it should be freed when
11407 * not needed anymore.
11409 * @param s The string (in UTF-8) to be converted
11410 * @return The converted string (in markup). It should be freed.
11412 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11414 * This sets the file (and implicitly loads it) for the text to display and
11415 * then edit. All changes are written back to the file after a short delay if
11416 * the entry object is set to autosave (which is the default).
11418 * If the entry had any other file set previously, any changes made to it
11419 * will be saved if the autosave feature is enabled, otherwise, the file
11420 * will be silently discarded and any non-saved changes will be lost.
11422 * @param obj The entry object
11423 * @param file The path to the file to load and save
11424 * @param format The file format
11426 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11428 * Gets the file being edited by the entry.
11430 * This function can be used to retrieve any file set on the entry for
11431 * edition, along with the format used to load and save it.
11433 * @param obj The entry object
11434 * @param file The path to the file to load and save
11435 * @param format The file format
11437 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11439 * This function writes any changes made to the file set with
11440 * elm_entry_file_set()
11442 * @param obj The entry object
11444 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11446 * This sets the entry object to 'autosave' the loaded text file or not.
11448 * @param obj The entry object
11449 * @param autosave Autosave the loaded file or not
11451 * @see elm_entry_file_set()
11453 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11455 * This gets the entry object's 'autosave' status.
11457 * @param obj The entry object
11458 * @return Autosave the loaded file or not
11460 * @see elm_entry_file_set()
11462 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11464 * Control pasting of text and images for the widget.
11466 * Normally the entry allows both text and images to be pasted. By setting
11467 * textonly to be true, this prevents images from being pasted.
11469 * Note this only changes the behaviour of text.
11471 * @param obj The entry object
11472 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11473 * text+image+other.
11475 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11477 * Getting elm_entry text paste/drop mode.
11479 * In textonly mode, only text may be pasted or dropped into the widget.
11481 * @param obj The entry object
11482 * @return If the widget only accepts text from pastes.
11484 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11486 * Enable or disable scrolling in entry
11488 * Normally the entry is not scrollable unless you enable it with this call.
11490 * @param obj The entry object
11491 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11493 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11495 * Get the scrollable state of the entry
11497 * Normally the entry is not scrollable. This gets the scrollable state
11498 * of the entry. See elm_entry_scrollable_set() for more information.
11500 * @param obj The entry object
11501 * @return The scrollable state
11503 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11505 * This sets a widget to be displayed to the left of a scrolled entry.
11507 * @param obj The scrolled entry object
11508 * @param icon The widget to display on the left side of the scrolled
11511 * @note A previously set widget will be destroyed.
11512 * @note If the object being set does not have minimum size hints set,
11513 * it won't get properly displayed.
11515 * @see elm_entry_end_set()
11517 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11519 * Gets the leftmost widget of the scrolled entry. This object is
11520 * owned by the scrolled entry and should not be modified.
11522 * @param obj The scrolled entry object
11523 * @return the left widget inside the scroller
11525 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11527 * Unset the leftmost widget of the scrolled entry, unparenting and
11530 * @param obj The scrolled entry object
11531 * @return the previously set icon sub-object of this entry, on
11534 * @see elm_entry_icon_set()
11536 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11538 * Sets the visibility of the left-side widget of the scrolled entry,
11539 * set by elm_entry_icon_set().
11541 * @param obj The scrolled entry object
11542 * @param setting EINA_TRUE if the object should be displayed,
11543 * EINA_FALSE if not.
11545 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11547 * This sets a widget to be displayed to the end of a scrolled entry.
11549 * @param obj The scrolled entry object
11550 * @param end The widget to display on the right side of the scrolled
11553 * @note A previously set widget will be destroyed.
11554 * @note If the object being set does not have minimum size hints set,
11555 * it won't get properly displayed.
11557 * @see elm_entry_icon_set
11559 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11561 * Gets the endmost widget of the scrolled entry. This object is owned
11562 * by the scrolled entry and should not be modified.
11564 * @param obj The scrolled entry object
11565 * @return the right widget inside the scroller
11567 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11569 * Unset the endmost widget of the scrolled entry, unparenting and
11572 * @param obj The scrolled entry object
11573 * @return the previously set icon sub-object of this entry, on
11576 * @see elm_entry_icon_set()
11578 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11580 * Sets the visibility of the end widget of the scrolled entry, set by
11581 * elm_entry_end_set().
11583 * @param obj The scrolled entry object
11584 * @param setting EINA_TRUE if the object should be displayed,
11585 * EINA_FALSE if not.
11587 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11589 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11592 * Setting an entry to single-line mode with elm_entry_single_line_set()
11593 * will automatically disable the display of scrollbars when the entry
11594 * moves inside its scroller.
11596 * @param obj The scrolled entry object
11597 * @param h The horizontal scrollbar policy to apply
11598 * @param v The vertical scrollbar policy to apply
11600 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11602 * This enables/disables bouncing within the entry.
11604 * This function sets whether the entry will bounce when scrolling reaches
11605 * the end of the contained entry.
11607 * @param obj The scrolled entry object
11608 * @param h The horizontal bounce state
11609 * @param v The vertical bounce state
11611 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11613 * Get the bounce mode
11615 * @param obj The Entry object
11616 * @param h_bounce Allow bounce horizontally
11617 * @param v_bounce Allow bounce vertically
11619 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11621 /* pre-made filters for entries */
11623 * @typedef Elm_Entry_Filter_Limit_Size
11625 * Data for the elm_entry_filter_limit_size() entry filter.
11627 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11629 * @struct _Elm_Entry_Filter_Limit_Size
11631 * Data for the elm_entry_filter_limit_size() entry filter.
11633 struct _Elm_Entry_Filter_Limit_Size
11635 int max_char_count; /**< The maximum number of characters allowed. */
11636 int max_byte_count; /**< The maximum number of bytes allowed*/
11639 * Filter inserted text based on user defined character and byte limits
11641 * Add this filter to an entry to limit the characters that it will accept
11642 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11643 * The funtion works on the UTF-8 representation of the string, converting
11644 * it from the set markup, thus not accounting for any format in it.
11646 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11647 * it as data when setting the filter. In it, it's possible to set limits
11648 * by character count or bytes (any of them is disabled if 0), and both can
11649 * be set at the same time. In that case, it first checks for characters,
11652 * The function will cut the inserted text in order to allow only the first
11653 * number of characters that are still allowed. The cut is made in
11654 * characters, even when limiting by bytes, in order to always contain
11655 * valid ones and avoid half unicode characters making it in.
11657 * This filter, like any others, does not apply when setting the entry text
11658 * directly with elm_object_text_set() (or the deprecated
11659 * elm_entry_entry_set()).
11661 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11663 * @typedef Elm_Entry_Filter_Accept_Set
11665 * Data for the elm_entry_filter_accept_set() entry filter.
11667 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11669 * @struct _Elm_Entry_Filter_Accept_Set
11671 * Data for the elm_entry_filter_accept_set() entry filter.
11673 struct _Elm_Entry_Filter_Accept_Set
11675 const char *accepted; /**< Set of characters accepted in the entry. */
11676 const char *rejected; /**< Set of characters rejected from the entry. */
11679 * Filter inserted text based on accepted or rejected sets of characters
11681 * Add this filter to an entry to restrict the set of accepted characters
11682 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11683 * This structure contains both accepted and rejected sets, but they are
11684 * mutually exclusive.
11686 * The @c accepted set takes preference, so if it is set, the filter will
11687 * only work based on the accepted characters, ignoring anything in the
11688 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11690 * In both cases, the function filters by matching utf8 characters to the
11691 * raw markup text, so it can be used to remove formatting tags.
11693 * This filter, like any others, does not apply when setting the entry text
11694 * directly with elm_object_text_set() (or the deprecated
11695 * elm_entry_entry_set()).
11697 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11699 * Set the input panel layout of the entry
11701 * @param obj The entry object
11702 * @param layout layout type
11704 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11706 * Get the input panel layout of the entry
11708 * @param obj The entry object
11709 * @return layout type
11711 * @see elm_entry_input_panel_layout_set
11713 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11718 /* composite widgets - these basically put together basic widgets above
11719 * in convenient packages that do more than basic stuff */
11723 * @defgroup Anchorview Anchorview
11725 * @image html img/widget/anchorview/preview-00.png
11726 * @image latex img/widget/anchorview/preview-00.eps
11728 * Anchorview is for displaying text that contains markup with anchors
11729 * like <c>\<a href=1234\>something\</\></c> in it.
11731 * Besides being styled differently, the anchorview widget provides the
11732 * necessary functionality so that clicking on these anchors brings up a
11733 * popup with user defined content such as "call", "add to contacts" or
11734 * "open web page". This popup is provided using the @ref Hover widget.
11736 * This widget is very similar to @ref Anchorblock, so refer to that
11737 * widget for an example. The only difference Anchorview has is that the
11738 * widget is already provided with scrolling functionality, so if the
11739 * text set to it is too large to fit in the given space, it will scroll,
11740 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11741 * text can be displayed.
11743 * This widget emits the following signals:
11744 * @li "anchor,clicked": will be called when an anchor is clicked. The
11745 * @p event_info parameter on the callback will be a pointer of type
11746 * ::Elm_Entry_Anchorview_Info.
11748 * See @ref Anchorblock for an example on how to use both of them.
11757 * @typedef Elm_Entry_Anchorview_Info
11759 * The info sent in the callback for "anchor,clicked" signals emitted by
11760 * the Anchorview widget.
11762 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11764 * @struct _Elm_Entry_Anchorview_Info
11766 * The info sent in the callback for "anchor,clicked" signals emitted by
11767 * the Anchorview widget.
11769 struct _Elm_Entry_Anchorview_Info
11771 const char *name; /**< Name of the anchor, as indicated in its href
11773 int button; /**< The mouse button used to click on it */
11774 Evas_Object *hover; /**< The hover object to use for the popup */
11776 Evas_Coord x, y, w, h;
11777 } anchor, /**< Geometry selection of text used as anchor */
11778 hover_parent; /**< Geometry of the object used as parent by the
11780 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11781 for content on the left side of
11782 the hover. Before calling the
11783 callback, the widget will make the
11784 necessary calculations to check
11785 which sides are fit to be set with
11786 content, based on the position the
11787 hover is activated and its distance
11788 to the edges of its parent object
11790 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11791 the right side of the hover.
11792 See @ref hover_left */
11793 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11794 of the hover. See @ref hover_left */
11795 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11796 below the hover. See @ref
11800 * Add a new Anchorview object
11802 * @param parent The parent object
11803 * @return The new object or NULL if it cannot be created
11805 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11807 * Set the text to show in the anchorview
11809 * Sets the text of the anchorview to @p text. This text can include markup
11810 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11811 * text that will be specially styled and react to click events, ended with
11812 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11813 * "anchor,clicked" signal that you can attach a callback to with
11814 * evas_object_smart_callback_add(). The name of the anchor given in the
11815 * event info struct will be the one set in the href attribute, in this
11816 * case, anchorname.
11818 * Other markup can be used to style the text in different ways, but it's
11819 * up to the style defined in the theme which tags do what.
11820 * @deprecated use elm_object_text_set() instead.
11822 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11824 * Get the markup text set for the anchorview
11826 * Retrieves the text set on the anchorview, with markup tags included.
11828 * @param obj The anchorview object
11829 * @return The markup text set or @c NULL if nothing was set or an error
11831 * @deprecated use elm_object_text_set() instead.
11833 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11835 * Set the parent of the hover popup
11837 * Sets the parent object to use by the hover created by the anchorview
11838 * when an anchor is clicked. See @ref Hover for more details on this.
11839 * If no parent is set, the same anchorview object will be used.
11841 * @param obj The anchorview object
11842 * @param parent The object to use as parent for the hover
11844 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11846 * Get the parent of the hover popup
11848 * Get the object used as parent for the hover created by the anchorview
11849 * widget. See @ref Hover for more details on this.
11851 * @param obj The anchorview object
11852 * @return The object used as parent for the hover, NULL if none is set.
11854 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11856 * Set the style that the hover should use
11858 * When creating the popup hover, anchorview will request that it's
11859 * themed according to @p style.
11861 * @param obj The anchorview object
11862 * @param style The style to use for the underlying hover
11864 * @see elm_object_style_set()
11866 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11868 * Get the style that the hover should use
11870 * Get the style the hover created by anchorview will use.
11872 * @param obj The anchorview object
11873 * @return The style to use by the hover. NULL means the default is used.
11875 * @see elm_object_style_set()
11877 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11879 * Ends the hover popup in the anchorview
11881 * When an anchor is clicked, the anchorview widget will create a hover
11882 * object to use as a popup with user provided content. This function
11883 * terminates this popup, returning the anchorview to its normal state.
11885 * @param obj The anchorview object
11887 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11889 * Set bouncing behaviour when the scrolled content reaches an edge
11891 * Tell the internal scroller object whether it should bounce or not
11892 * when it reaches the respective edges for each axis.
11894 * @param obj The anchorview object
11895 * @param h_bounce Whether to bounce or not in the horizontal axis
11896 * @param v_bounce Whether to bounce or not in the vertical axis
11898 * @see elm_scroller_bounce_set()
11900 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11902 * Get the set bouncing behaviour of the internal scroller
11904 * Get whether the internal scroller should bounce when the edge of each
11905 * axis is reached scrolling.
11907 * @param obj The anchorview object
11908 * @param h_bounce Pointer where to store the bounce state of the horizontal
11910 * @param v_bounce Pointer where to store the bounce state of the vertical
11913 * @see elm_scroller_bounce_get()
11915 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11917 * Appends a custom item provider to the given anchorview
11919 * Appends the given function to the list of items providers. This list is
11920 * called, one function at a time, with the given @p data pointer, the
11921 * anchorview object and, in the @p item parameter, the item name as
11922 * referenced in its href string. Following functions in the list will be
11923 * called in order until one of them returns something different to NULL,
11924 * which should be an Evas_Object which will be used in place of the item
11927 * Items in the markup text take the form \<item relsize=16x16 vsize=full
11928 * href=item/name\>\</item\>
11930 * @param obj The anchorview object
11931 * @param func The function to add to the list of providers
11932 * @param data User data that will be passed to the callback function
11934 * @see elm_entry_item_provider_append()
11936 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);
11938 * Prepend a custom item provider to the given anchorview
11940 * Like elm_anchorview_item_provider_append(), but it adds the function
11941 * @p func to the beginning of the list, instead of the end.
11943 * @param obj The anchorview object
11944 * @param func The function to add to the list of providers
11945 * @param data User data that will be passed to the callback function
11947 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);
11949 * Remove a custom item provider from the list of the given anchorview
11951 * Removes the function and data pairing that matches @p func and @p data.
11952 * That is, unless the same function and same user data are given, the
11953 * function will not be removed from the list. This allows us to add the
11954 * same callback several times, with different @p data pointers and be
11955 * able to remove them later without conflicts.
11957 * @param obj The anchorview object
11958 * @param func The function to remove from the list
11959 * @param data The data matching the function to remove from the list
11961 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);
11968 * @defgroup Anchorblock Anchorblock
11970 * @image html img/widget/anchorblock/preview-00.png
11971 * @image latex img/widget/anchorblock/preview-00.eps
11973 * Anchorblock is for displaying text that contains markup with anchors
11974 * like <c>\<a href=1234\>something\</\></c> in it.
11976 * Besides being styled differently, the anchorblock widget provides the
11977 * necessary functionality so that clicking on these anchors brings up a
11978 * popup with user defined content such as "call", "add to contacts" or
11979 * "open web page". This popup is provided using the @ref Hover widget.
11981 * This widget emits the following signals:
11982 * @li "anchor,clicked": will be called when an anchor is clicked. The
11983 * @p event_info parameter on the callback will be a pointer of type
11984 * ::Elm_Entry_Anchorblock_Info.
11990 * Since examples are usually better than plain words, we might as well
11991 * try @ref tutorial_anchorblock_example "one".
11994 * @addtogroup Anchorblock
11998 * @typedef Elm_Entry_Anchorblock_Info
12000 * The info sent in the callback for "anchor,clicked" signals emitted by
12001 * the Anchorblock widget.
12003 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12005 * @struct _Elm_Entry_Anchorblock_Info
12007 * The info sent in the callback for "anchor,clicked" signals emitted by
12008 * the Anchorblock widget.
12010 struct _Elm_Entry_Anchorblock_Info
12012 const char *name; /**< Name of the anchor, as indicated in its href
12014 int button; /**< The mouse button used to click on it */
12015 Evas_Object *hover; /**< The hover object to use for the popup */
12017 Evas_Coord x, y, w, h;
12018 } anchor, /**< Geometry selection of text used as anchor */
12019 hover_parent; /**< Geometry of the object used as parent by the
12021 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12022 for content on the left side of
12023 the hover. Before calling the
12024 callback, the widget will make the
12025 necessary calculations to check
12026 which sides are fit to be set with
12027 content, based on the position the
12028 hover is activated and its distance
12029 to the edges of its parent object
12031 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12032 the right side of the hover.
12033 See @ref hover_left */
12034 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12035 of the hover. See @ref hover_left */
12036 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12037 below the hover. See @ref
12041 * Add a new Anchorblock object
12043 * @param parent The parent object
12044 * @return The new object or NULL if it cannot be created
12046 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12048 * Set the text to show in the anchorblock
12050 * Sets the text of the anchorblock to @p text. This text can include markup
12051 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12052 * of text that will be specially styled and react to click events, ended
12053 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12054 * "anchor,clicked" signal that you can attach a callback to with
12055 * evas_object_smart_callback_add(). The name of the anchor given in the
12056 * event info struct will be the one set in the href attribute, in this
12057 * case, anchorname.
12059 * Other markup can be used to style the text in different ways, but it's
12060 * up to the style defined in the theme which tags do what.
12061 * @deprecated use elm_object_text_set() instead.
12063 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12065 * Get the markup text set for the anchorblock
12067 * Retrieves the text set on the anchorblock, with markup tags included.
12069 * @param obj The anchorblock object
12070 * @return The markup text set or @c NULL if nothing was set or an error
12072 * @deprecated use elm_object_text_set() instead.
12074 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12076 * Set the parent of the hover popup
12078 * Sets the parent object to use by the hover created by the anchorblock
12079 * when an anchor is clicked. See @ref Hover for more details on this.
12081 * @param obj The anchorblock object
12082 * @param parent The object to use as parent for the hover
12084 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12086 * Get the parent of the hover popup
12088 * Get the object used as parent for the hover created by the anchorblock
12089 * widget. See @ref Hover for more details on this.
12090 * If no parent is set, the same anchorblock object will be used.
12092 * @param obj The anchorblock object
12093 * @return The object used as parent for the hover, NULL if none is set.
12095 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12097 * Set the style that the hover should use
12099 * When creating the popup hover, anchorblock will request that it's
12100 * themed according to @p style.
12102 * @param obj The anchorblock object
12103 * @param style The style to use for the underlying hover
12105 * @see elm_object_style_set()
12107 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12109 * Get the style that the hover should use
12111 * Get the style the hover created by anchorblock will use.
12113 * @param obj The anchorblock object
12114 * @return The style to use by the hover. NULL means the default is used.
12116 * @see elm_object_style_set()
12118 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12120 * Ends the hover popup in the anchorblock
12122 * When an anchor is clicked, the anchorblock widget will create a hover
12123 * object to use as a popup with user provided content. This function
12124 * terminates this popup, returning the anchorblock to its normal state.
12126 * @param obj The anchorblock object
12128 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12130 * Appends a custom item provider to the given anchorblock
12132 * Appends the given function to the list of items providers. This list is
12133 * called, one function at a time, with the given @p data pointer, the
12134 * anchorblock object and, in the @p item parameter, the item name as
12135 * referenced in its href string. Following functions in the list will be
12136 * called in order until one of them returns something different to NULL,
12137 * which should be an Evas_Object which will be used in place of the item
12140 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12141 * href=item/name\>\</item\>
12143 * @param obj The anchorblock object
12144 * @param func The function to add to the list of providers
12145 * @param data User data that will be passed to the callback function
12147 * @see elm_entry_item_provider_append()
12149 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);
12151 * Prepend a custom item provider to the given anchorblock
12153 * Like elm_anchorblock_item_provider_append(), but it adds the function
12154 * @p func to the beginning of the list, instead of the end.
12156 * @param obj The anchorblock object
12157 * @param func The function to add to the list of providers
12158 * @param data User data that will be passed to the callback function
12160 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);
12162 * Remove a custom item provider from the list of the given anchorblock
12164 * Removes the function and data pairing that matches @p func and @p data.
12165 * That is, unless the same function and same user data are given, the
12166 * function will not be removed from the list. This allows us to add the
12167 * same callback several times, with different @p data pointers and be
12168 * able to remove them later without conflicts.
12170 * @param obj The anchorblock object
12171 * @param func The function to remove from the list
12172 * @param data The data matching the function to remove from the list
12174 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);
12180 * @defgroup Bubble Bubble
12182 * @image html img/widget/bubble/preview-00.png
12183 * @image latex img/widget/bubble/preview-00.eps
12184 * @image html img/widget/bubble/preview-01.png
12185 * @image latex img/widget/bubble/preview-01.eps
12186 * @image html img/widget/bubble/preview-02.png
12187 * @image latex img/widget/bubble/preview-02.eps
12189 * @brief The Bubble is a widget to show text similarly to how speech is
12190 * represented in comics.
12192 * The bubble widget contains 5 important visual elements:
12193 * @li The frame is a rectangle with rounded rectangles and an "arrow".
12194 * @li The @p icon is an image to which the frame's arrow points to.
12195 * @li The @p label is a text which appears to the right of the icon if the
12196 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12198 * @li The @p info is a text which appears to the right of the label. Info's
12199 * font is of a ligther color than label.
12200 * @li The @p content is an evas object that is shown inside the frame.
12202 * The position of the arrow, icon, label and info depends on which corner is
12203 * selected. The four available corners are:
12204 * @li "top_left" - Default
12206 * @li "bottom_left"
12207 * @li "bottom_right"
12209 * Signals that you can add callbacks for are:
12210 * @li "clicked" - This is called when a user has clicked the bubble.
12212 * For an example of using a buble see @ref bubble_01_example_page "this".
12217 * Add a new bubble to the parent
12219 * @param parent The parent object
12220 * @return The new object or NULL if it cannot be created
12222 * This function adds a text bubble to the given parent evas object.
12224 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12226 * Set the label of the bubble
12228 * @param obj The bubble object
12229 * @param label The string to set in the label
12231 * This function sets the title of the bubble. Where this appears depends on
12232 * the selected corner.
12233 * @deprecated use elm_object_text_set() instead.
12235 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12237 * Get the label of the bubble
12239 * @param obj The bubble object
12240 * @return The string of set in the label
12242 * This function gets the title of the bubble.
12243 * @deprecated use elm_object_text_get() instead.
12245 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12247 * Set the info of the bubble
12249 * @param obj The bubble object
12250 * @param info The given info about the bubble
12252 * This function sets the info of the bubble. Where this appears depends on
12253 * the selected corner.
12254 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12256 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12258 * Get the info of the bubble
12260 * @param obj The bubble object
12262 * @return The "info" string of the bubble
12264 * This function gets the info text.
12265 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12267 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12269 * Set the content to be shown in the bubble
12271 * Once the content object is set, a previously set one will be deleted.
12272 * If you want to keep the old content object, use the
12273 * elm_bubble_content_unset() function.
12275 * @param obj The bubble object
12276 * @param content The given content of the bubble
12278 * This function sets the content shown on the middle of the bubble.
12280 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12282 * Get the content shown in the bubble
12284 * Return the content object which is set for this widget.
12286 * @param obj The bubble object
12287 * @return The content that is being used
12289 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12291 * Unset the content shown in the bubble
12293 * Unparent and return the content object which was set for this widget.
12295 * @param obj The bubble object
12296 * @return The content that was being used
12298 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12300 * Set the icon of the bubble
12302 * Once the icon object is set, a previously set one will be deleted.
12303 * If you want to keep the old content object, use the
12304 * elm_icon_content_unset() function.
12306 * @param obj The bubble object
12307 * @param icon The given icon for the bubble
12309 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12311 * Get the icon of the bubble
12313 * @param obj The bubble object
12314 * @return The icon for the bubble
12316 * This function gets the icon shown on the top left of bubble.
12318 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12320 * Unset the icon of the bubble
12322 * Unparent and return the icon object which was set for this widget.
12324 * @param obj The bubble object
12325 * @return The icon that was being used
12327 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12329 * Set the corner of the bubble
12331 * @param obj The bubble object.
12332 * @param corner The given corner for the bubble.
12334 * This function sets the corner of the bubble. The corner will be used to
12335 * determine where the arrow in the frame points to and where label, icon and
12338 * Possible values for corner are:
12339 * @li "top_left" - Default
12341 * @li "bottom_left"
12342 * @li "bottom_right"
12344 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12346 * Get the corner of the bubble
12348 * @param obj The bubble object.
12349 * @return The given corner for the bubble.
12351 * This function gets the selected corner of the bubble.
12353 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12359 * @defgroup Photo Photo
12361 * For displaying the photo of a person (contact). Simple yet
12362 * with a very specific purpose.
12364 * Signals that you can add callbacks for are:
12366 * "clicked" - This is called when a user has clicked the photo
12367 * "drag,start" - Someone started dragging the image out of the object
12368 * "drag,end" - Dragged item was dropped (somewhere)
12374 * Add a new photo to the parent
12376 * @param parent The parent object
12377 * @return The new object or NULL if it cannot be created
12381 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12384 * Set the file that will be used as photo
12386 * @param obj The photo object
12387 * @param file The path to file that will be used as photo
12389 * @return (1 = success, 0 = error)
12393 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12396 * Set the file that will be used as thumbnail in the photo.
12398 * @param obj The photo object.
12399 * @param file The path to file that will be used as thumb.
12400 * @param group The key used in case of an EET file.
12404 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12407 * Set the size that will be used on the photo
12409 * @param obj The photo object
12410 * @param size The size that the photo will be
12414 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12417 * Set if the photo should be completely visible or not.
12419 * @param obj The photo object
12420 * @param fill if true the photo will be completely visible
12424 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12427 * Set editability of the photo.
12429 * An editable photo can be dragged to or from, and can be cut or
12430 * pasted too. Note that pasting an image or dropping an item on
12431 * the image will delete the existing content.
12433 * @param obj The photo object.
12434 * @param set To set of clear editablity.
12436 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12442 /* gesture layer */
12444 * @defgroup Elm_Gesture_Layer Gesture Layer
12445 * Gesture Layer Usage:
12447 * Use Gesture Layer to detect gestures.
12448 * The advantage is that you don't have to implement
12449 * gesture detection, just set callbacks of gesture state.
12450 * By using gesture layer we make standard interface.
12452 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12453 * with a parent object parameter.
12454 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12455 * call. Usually with same object as target (2nd parameter).
12457 * Now you need to tell gesture layer what gestures you follow.
12458 * This is done with @ref elm_gesture_layer_cb_set call.
12459 * By setting the callback you actually saying to gesture layer:
12460 * I would like to know when the gesture @ref Elm_Gesture_Types
12461 * switches to state @ref Elm_Gesture_State.
12463 * Next, you need to implement the actual action that follows the input
12464 * in your callback.
12466 * Note that if you like to stop being reported about a gesture, just set
12467 * all callbacks referring this gesture to NULL.
12468 * (again with @ref elm_gesture_layer_cb_set)
12470 * The information reported by gesture layer to your callback is depending
12471 * on @ref Elm_Gesture_Types:
12472 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12473 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12474 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12476 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12477 * @ref ELM_GESTURE_MOMENTUM.
12479 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12480 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12481 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12482 * Note that we consider a flick as a line-gesture that should be completed
12483 * in flick-time-limit as defined in @ref Config.
12485 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12487 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12490 * Gesture Layer Tweaks:
12492 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12493 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12495 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12496 * so gesture starts when user touches (a *DOWN event) touch-surface
12497 * and ends when no fingers touches surface (a *UP event).
12501 * @enum _Elm_Gesture_Types
12502 * Enum of supported gesture types.
12503 * @ingroup Elm_Gesture_Layer
12505 enum _Elm_Gesture_Types
12507 ELM_GESTURE_FIRST = 0,
12509 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12510 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12511 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12512 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12514 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12516 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12517 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12519 ELM_GESTURE_ZOOM, /**< Zoom */
12520 ELM_GESTURE_ROTATE, /**< Rotate */
12526 * @typedef Elm_Gesture_Types
12527 * gesture types enum
12528 * @ingroup Elm_Gesture_Layer
12530 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12533 * @enum _Elm_Gesture_State
12534 * Enum of gesture states.
12535 * @ingroup Elm_Gesture_Layer
12537 enum _Elm_Gesture_State
12539 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12540 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12541 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12542 ELM_GESTURE_STATE_END, /**< Gesture completed */
12543 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12547 * @typedef Elm_Gesture_State
12548 * gesture states enum
12549 * @ingroup Elm_Gesture_Layer
12551 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12554 * @struct _Elm_Gesture_Taps_Info
12555 * Struct holds taps info for user
12556 * @ingroup Elm_Gesture_Layer
12558 struct _Elm_Gesture_Taps_Info
12560 Evas_Coord x, y; /**< Holds center point between fingers */
12561 unsigned int n; /**< Number of fingers tapped */
12562 unsigned int timestamp; /**< event timestamp */
12566 * @typedef Elm_Gesture_Taps_Info
12567 * holds taps info for user
12568 * @ingroup Elm_Gesture_Layer
12570 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12573 * @struct _Elm_Gesture_Momentum_Info
12574 * Struct holds momentum info for user
12575 * x1 and y1 are not necessarily in sync
12576 * x1 holds x value of x direction starting point
12577 * and same holds for y1.
12578 * This is noticeable when doing V-shape movement
12579 * @ingroup Elm_Gesture_Layer
12581 struct _Elm_Gesture_Momentum_Info
12582 { /* Report line ends, timestamps, and momentum computed */
12583 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12584 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12585 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12586 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12588 unsigned int tx; /**< Timestamp of start of final x-swipe */
12589 unsigned int ty; /**< Timestamp of start of final y-swipe */
12591 Evas_Coord mx; /**< Momentum on X */
12592 Evas_Coord my; /**< Momentum on Y */
12596 * @typedef Elm_Gesture_Momentum_Info
12597 * holds momentum info for user
12598 * @ingroup Elm_Gesture_Layer
12600 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12603 * @struct _Elm_Gesture_Line_Info
12604 * Struct holds line info for user
12605 * @ingroup Elm_Gesture_Layer
12607 struct _Elm_Gesture_Line_Info
12608 { /* Report line ends, timestamps, and momentum computed */
12609 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12610 unsigned int n; /**< Number of fingers (lines) */
12611 /* FIXME should be radians, bot degrees */
12612 double angle; /**< Angle (direction) of lines */
12616 * @typedef Elm_Gesture_Line_Info
12617 * Holds line info for user
12618 * @ingroup Elm_Gesture_Layer
12620 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12623 * @struct _Elm_Gesture_Zoom_Info
12624 * Struct holds zoom info for user
12625 * @ingroup Elm_Gesture_Layer
12627 struct _Elm_Gesture_Zoom_Info
12629 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12630 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12631 double zoom; /**< Zoom value: 1.0 means no zoom */
12632 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12636 * @typedef Elm_Gesture_Zoom_Info
12637 * Holds zoom info for user
12638 * @ingroup Elm_Gesture_Layer
12640 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12643 * @struct _Elm_Gesture_Rotate_Info
12644 * Struct holds rotation info for user
12645 * @ingroup Elm_Gesture_Layer
12647 struct _Elm_Gesture_Rotate_Info
12649 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12650 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12651 double base_angle; /**< Holds start-angle */
12652 double angle; /**< Rotation value: 0.0 means no rotation */
12653 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12657 * @typedef Elm_Gesture_Rotate_Info
12658 * Holds rotation info for user
12659 * @ingroup Elm_Gesture_Layer
12661 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12664 * @typedef Elm_Gesture_Event_Cb
12665 * User callback used to stream gesture info from gesture layer
12666 * @param data user data
12667 * @param event_info gesture report info
12668 * Returns a flag field to be applied on the causing event.
12669 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12670 * upon the event, in an irreversible way.
12672 * @ingroup Elm_Gesture_Layer
12674 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12677 * Use function to set callbacks to be notified about
12678 * change of state of gesture.
12679 * When a user registers a callback with this function
12680 * this means this gesture has to be tested.
12682 * When ALL callbacks for a gesture are set to NULL
12683 * it means user isn't interested in gesture-state
12684 * and it will not be tested.
12686 * @param obj Pointer to gesture-layer.
12687 * @param idx The gesture you would like to track its state.
12688 * @param cb callback function pointer.
12689 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12690 * @param data user info to be sent to callback (usually, Smart Data)
12692 * @ingroup Elm_Gesture_Layer
12694 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);
12697 * Call this function to get repeat-events settings.
12699 * @param obj Pointer to gesture-layer.
12701 * @return repeat events settings.
12702 * @see elm_gesture_layer_hold_events_set()
12703 * @ingroup Elm_Gesture_Layer
12705 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12708 * This function called in order to make gesture-layer repeat events.
12709 * Set this of you like to get the raw events only if gestures were not detected.
12710 * Clear this if you like gesture layer to fwd events as testing gestures.
12712 * @param obj Pointer to gesture-layer.
12713 * @param r Repeat: TRUE/FALSE
12715 * @ingroup Elm_Gesture_Layer
12717 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12720 * This function sets step-value for zoom action.
12721 * Set step to any positive value.
12722 * Cancel step setting by setting to 0.0
12724 * @param obj Pointer to gesture-layer.
12725 * @param s new zoom step value.
12727 * @ingroup Elm_Gesture_Layer
12729 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12732 * This function sets step-value for rotate action.
12733 * Set step to any positive value.
12734 * Cancel step setting by setting to 0.0
12736 * @param obj Pointer to gesture-layer.
12737 * @param s new roatate step value.
12739 * @ingroup Elm_Gesture_Layer
12741 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12744 * This function called to attach gesture-layer to an Evas_Object.
12745 * @param obj Pointer to gesture-layer.
12746 * @param t Pointer to underlying object (AKA Target)
12748 * @return TRUE, FALSE on success, failure.
12750 * @ingroup Elm_Gesture_Layer
12752 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12755 * Call this function to construct a new gesture-layer object.
12756 * This does not activate the gesture layer. You have to
12757 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12759 * @param parent the parent object.
12761 * @return Pointer to new gesture-layer object.
12763 * @ingroup Elm_Gesture_Layer
12765 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12768 * @defgroup Thumb Thumb
12770 * @image html img/widget/thumb/preview-00.png
12771 * @image latex img/widget/thumb/preview-00.eps
12773 * A thumb object is used for displaying the thumbnail of an image or video.
12774 * You must have compiled Elementary with Ethumb_Client support and the DBus
12775 * service must be present and auto-activated in order to have thumbnails to
12778 * Once the thumbnail object becomes visible, it will check if there is a
12779 * previously generated thumbnail image for the file set on it. If not, it
12780 * will start generating this thumbnail.
12782 * Different config settings will cause different thumbnails to be generated
12783 * even on the same file.
12785 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12786 * Ethumb documentation to change this path, and to see other configuration
12789 * Signals that you can add callbacks for are:
12791 * - "clicked" - This is called when a user has clicked the thumb without dragging
12793 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12794 * - "press" - This is called when a user has pressed down the thumb.
12795 * - "generate,start" - The thumbnail generation started.
12796 * - "generate,stop" - The generation process stopped.
12797 * - "generate,error" - The generation failed.
12798 * - "load,error" - The thumbnail image loading failed.
12800 * available styles:
12804 * An example of use of thumbnail:
12806 * - @ref thumb_example_01
12810 * @addtogroup Thumb
12815 * @enum _Elm_Thumb_Animation_Setting
12816 * @typedef Elm_Thumb_Animation_Setting
12818 * Used to set if a video thumbnail is animating or not.
12822 typedef enum _Elm_Thumb_Animation_Setting
12824 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12825 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
12826 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
12827 ELM_THUMB_ANIMATION_LAST
12828 } Elm_Thumb_Animation_Setting;
12831 * Add a new thumb object to the parent.
12833 * @param parent The parent object.
12834 * @return The new object or NULL if it cannot be created.
12836 * @see elm_thumb_file_set()
12837 * @see elm_thumb_ethumb_client_get()
12841 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12843 * Reload thumbnail if it was generated before.
12845 * @param obj The thumb object to reload
12847 * This is useful if the ethumb client configuration changed, like its
12848 * size, aspect or any other property one set in the handle returned
12849 * by elm_thumb_ethumb_client_get().
12851 * If the options didn't change, the thumbnail won't be generated again, but
12852 * the old one will still be used.
12854 * @see elm_thumb_file_set()
12858 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12860 * Set the file that will be used as thumbnail.
12862 * @param obj The thumb object.
12863 * @param file The path to file that will be used as thumb.
12864 * @param key The key used in case of an EET file.
12866 * The file can be an image or a video (in that case, acceptable extensions are:
12867 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12868 * function elm_thumb_animate().
12870 * @see elm_thumb_file_get()
12871 * @see elm_thumb_reload()
12872 * @see elm_thumb_animate()
12876 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12878 * Get the image or video path and key used to generate the thumbnail.
12880 * @param obj The thumb object.
12881 * @param file Pointer to filename.
12882 * @param key Pointer to key.
12884 * @see elm_thumb_file_set()
12885 * @see elm_thumb_path_get()
12889 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12891 * Get the path and key to the image or video generated by ethumb.
12893 * One just need to make sure that the thumbnail was generated before getting
12894 * its path; otherwise, the path will be NULL. One way to do that is by asking
12895 * for the path when/after the "generate,stop" smart callback is called.
12897 * @param obj The thumb object.
12898 * @param file Pointer to thumb path.
12899 * @param key Pointer to thumb key.
12901 * @see elm_thumb_file_get()
12905 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12907 * Set the animation state for the thumb object. If its content is an animated
12908 * video, you may start/stop the animation or tell it to play continuously and
12911 * @param obj The thumb object.
12912 * @param setting The animation setting.
12914 * @see elm_thumb_file_set()
12918 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12920 * Get the animation state for the thumb object.
12922 * @param obj The thumb object.
12923 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12926 * @see elm_thumb_animate_set()
12930 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12932 * Get the ethumb_client handle so custom configuration can be made.
12934 * @return Ethumb_Client instance or NULL.
12936 * This must be called before the objects are created to be sure no object is
12937 * visible and no generation started.
12939 * Example of usage:
12942 * #include <Elementary.h>
12943 * #ifndef ELM_LIB_QUICKLAUNCH
12945 * elm_main(int argc, char **argv)
12947 * Ethumb_Client *client;
12949 * elm_need_ethumb();
12953 * client = elm_thumb_ethumb_client_get();
12956 * ERR("could not get ethumb_client");
12959 * ethumb_client_size_set(client, 100, 100);
12960 * ethumb_client_crop_align_set(client, 0.5, 0.5);
12963 * // Create elm_thumb objects here
12973 * @note There's only one client handle for Ethumb, so once a configuration
12974 * change is done to it, any other request for thumbnails (for any thumbnail
12975 * object) will use that configuration. Thus, this configuration is global.
12979 EAPI void *elm_thumb_ethumb_client_get(void);
12981 * Get the ethumb_client connection state.
12983 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12986 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
12988 * Make the thumbnail 'editable'.
12990 * @param obj Thumb object.
12991 * @param set Turn on or off editability. Default is @c EINA_FALSE.
12993 * This means the thumbnail is a valid drag target for drag and drop, and can be
12994 * cut or pasted too.
12996 * @see elm_thumb_editable_get()
13000 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13002 * Make the thumbnail 'editable'.
13004 * @param obj Thumb object.
13005 * @return Editability.
13007 * This means the thumbnail is a valid drag target for drag and drop, and can be
13008 * cut or pasted too.
13010 * @see elm_thumb_editable_set()
13014 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13021 * @defgroup Web Web
13023 * @image html img/widget/web/preview-00.png
13024 * @image latex img/widget/web/preview-00.eps
13026 * A web object is used for displaying web pages (HTML/CSS/JS)
13027 * using WebKit-EFL. You must have compiled Elementary with
13030 * Signals that you can add callbacks for are:
13031 * @li "download,request": A file download has been requested. Event info is
13032 * a pointer to a Elm_Web_Download
13033 * @li "editorclient,contents,changed": Editor client's contents changed
13034 * @li "editorclient,selection,changed": Editor client's selection changed
13035 * @li "frame,created": A new frame was created. Event info is an
13036 * Evas_Object which can be handled with WebKit's ewk_frame API
13037 * @li "icon,received": An icon was received by the main frame
13038 * @li "inputmethod,changed": Input method changed. Event info is an
13039 * Eina_Bool indicating whether it's enabled or not
13040 * @li "js,windowobject,clear": JS window object has been cleared
13041 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13042 * is a char *link[2], where the first string contains the URL the link
13043 * points to, and the second one the title of the link
13044 * @li "link,hover,out": Mouse cursor left the link
13045 * @li "load,document,finished": Loading of a document finished. Event info
13046 * is the frame that finished loading
13047 * @li "load,error": Load failed. Event info is a pointer to
13048 * Elm_Web_Frame_Load_Error
13049 * @li "load,finished": Load finished. Event info is NULL on success, on
13050 * error it's a pointer to Elm_Web_Frame_Load_Error
13051 * @li "load,newwindow,show": A new window was created and is ready to be
13053 * @li "load,progress": Overall load progress. Event info is a pointer to
13054 * a double containing a value between 0.0 and 1.0
13055 * @li "load,provisional": Started provisional load
13056 * @li "load,started": Loading of a document started
13057 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13058 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13059 * the menubar is visible, or EINA_FALSE in case it's not
13060 * @li "menubar,visible,set": Informs menubar visibility. Event info is
13061 * an Eina_Bool indicating the visibility
13062 * @li "popup,created": A dropdown widget was activated, requesting its
13063 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13064 * @li "popup,willdelete": The web object is ready to destroy the popup
13065 * object created. Event info is a pointer to Elm_Web_Menu
13066 * @li "ready": Page is fully loaded
13067 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13068 * info is a pointer to Eina_Bool where the visibility state should be set
13069 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13070 * is an Eina_Bool with the visibility state set
13071 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13072 * a string with the new text
13073 * @li "statusbar,visible,get": Queries visibility of the status bar.
13074 * Event info is a pointer to Eina_Bool where the visibility state should be
13076 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13077 * an Eina_Bool with the visibility value
13078 * @li "title,changed": Title of the main frame changed. Event info is a
13079 * string with the new title
13080 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13081 * is a pointer to Eina_Bool where the visibility state should be set
13082 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13083 * info is an Eina_Bool with the visibility state
13084 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13085 * a string with the text to show
13086 * @li "uri,changed": URI of the main frame changed. Event info is a string
13088 * @li "view,resized": The web object internal's view changed sized
13089 * @li "windows,close,request": A JavaScript request to close the current
13090 * window was requested
13091 * @li "zoom,animated,end": Animated zoom finished
13093 * available styles:
13096 * An example of use of web:
13098 * - @ref web_example_01 TBD
13107 * Structure used to report load errors.
13109 * Load errors are reported as signal by elm_web. All the strings are
13110 * temporary references and should @b not be used after the signal
13111 * callback returns. If it's required, make copies with strdup() or
13112 * eina_stringshare_add() (they are not even guaranteed to be
13113 * stringshared, so must use eina_stringshare_add() and not
13114 * eina_stringshare_ref()).
13116 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13118 * Structure used to report load errors.
13120 * Load errors are reported as signal by elm_web. All the strings are
13121 * temporary references and should @b not be used after the signal
13122 * callback returns. If it's required, make copies with strdup() or
13123 * eina_stringshare_add() (they are not even guaranteed to be
13124 * stringshared, so must use eina_stringshare_add() and not
13125 * eina_stringshare_ref()).
13127 struct _Elm_Web_Frame_Load_Error
13129 int code; /**< Numeric error code */
13130 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13131 const char *domain; /**< Error domain name */
13132 const char *description; /**< Error description (already localized) */
13133 const char *failing_url; /**< The URL that failed to load */
13134 Evas_Object *frame; /**< Frame object that produced the error */
13138 * The possibles types that the items in a menu can be
13140 typedef enum _Elm_Web_Menu_Item_Type
13142 ELM_WEB_MENU_SEPARATOR,
13143 ELM_WEB_MENU_GROUP,
13144 ELM_WEB_MENU_OPTION
13145 } Elm_Web_Menu_Item_Type;
13148 * Structure describing the items in a menu
13150 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13152 * Structure describing the items in a menu
13154 struct _Elm_Web_Menu_Item
13156 const char *text; /**< The text for the item */
13157 Elm_Web_Menu_Item_Type type; /**< The type of the item */
13161 * Structure describing the menu of a popup
13163 * This structure will be passed as the @c event_info for the "popup,create"
13164 * signal, which is emitted when a dropdown menu is opened. Users wanting
13165 * to handle these popups by themselves should listen to this signal and
13166 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13167 * property as @c EINA_FALSE means that the user will not handle the popup
13168 * and the default implementation will be used.
13170 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13171 * will be emitted to notify the user that it can destroy any objects and
13172 * free all data related to it.
13174 * @see elm_web_popup_selected_set()
13175 * @see elm_web_popup_destroy()
13177 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13179 * Structure describing the menu of a popup
13181 * This structure will be passed as the @c event_info for the "popup,create"
13182 * signal, which is emitted when a dropdown menu is opened. Users wanting
13183 * to handle these popups by themselves should listen to this signal and
13184 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13185 * property as @c EINA_FALSE means that the user will not handle the popup
13186 * and the default implementation will be used.
13188 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13189 * will be emitted to notify the user that it can destroy any objects and
13190 * free all data related to it.
13192 * @see elm_web_popup_selected_set()
13193 * @see elm_web_popup_destroy()
13195 struct _Elm_Web_Menu
13197 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13198 int x; /**< The X position of the popup, relative to the elm_web object */
13199 int y; /**< The Y position of the popup, relative to the elm_web object */
13200 int width; /**< Width of the popup menu */
13201 int height; /**< Height of the popup menu */
13203 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. */
13206 typedef struct _Elm_Web_Download Elm_Web_Download;
13207 struct _Elm_Web_Download
13213 * Types of zoom available.
13215 typedef enum _Elm_Web_Zoom_Mode
13217 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13218 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13219 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13220 ELM_WEB_ZOOM_MODE_LAST
13221 } Elm_Web_Zoom_Mode;
13223 * Opaque handler containing the features (such as statusbar, menubar, etc)
13224 * that are to be set on a newly requested window.
13226 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13228 * Callback type for the create_window hook.
13230 * The function parameters are:
13231 * @li @p data User data pointer set when setting the hook function
13232 * @li @p obj The elm_web object requesting the new window
13233 * @li @p js Set to @c EINA_TRUE if the request was originated from
13234 * JavaScript. @c EINA_FALSE otherwise.
13235 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13236 * the features requested for the new window.
13238 * The returned value of the function should be the @c elm_web widget where
13239 * the request will be loaded. That is, if a new window or tab is created,
13240 * the elm_web widget in it should be returned, and @b NOT the window
13242 * Returning @c NULL should cancel the request.
13244 * @see elm_web_window_create_hook_set()
13246 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13248 * Callback type for the JS alert hook.
13250 * The function parameters are:
13251 * @li @p data User data pointer set when setting the hook function
13252 * @li @p obj The elm_web object requesting the new window
13253 * @li @p message The message to show in the alert dialog
13255 * The function should return the object representing the alert dialog.
13256 * Elm_Web will run a second main loop to handle the dialog and normal
13257 * flow of the application will be restored when the object is deleted, so
13258 * the user should handle the popup properly in order to delete the object
13259 * when the action is finished.
13260 * If the function returns @c NULL the popup will be ignored.
13262 * @see elm_web_dialog_alert_hook_set()
13264 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13266 * Callback type for the JS confirm hook.
13268 * The function parameters are:
13269 * @li @p data User data pointer set when setting the hook function
13270 * @li @p obj The elm_web object requesting the new window
13271 * @li @p message The message to show in the confirm dialog
13272 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13273 * the user selected @c Ok, @c EINA_FALSE otherwise.
13275 * The function should return the object representing the confirm dialog.
13276 * Elm_Web will run a second main loop to handle the dialog and normal
13277 * flow of the application will be restored when the object is deleted, so
13278 * the user should handle the popup properly in order to delete the object
13279 * when the action is finished.
13280 * If the function returns @c NULL the popup will be ignored.
13282 * @see elm_web_dialog_confirm_hook_set()
13284 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13286 * Callback type for the JS prompt hook.
13288 * The function parameters are:
13289 * @li @p data User data pointer set when setting the hook function
13290 * @li @p obj The elm_web object requesting the new window
13291 * @li @p message The message to show in the prompt dialog
13292 * @li @p def_value The default value to present the user in the entry
13293 * @li @p value Pointer where to store the value given by the user. Must
13294 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13295 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13296 * the user selected @c Ok, @c EINA_FALSE otherwise.
13298 * The function should return the object representing the prompt dialog.
13299 * Elm_Web will run a second main loop to handle the dialog and normal
13300 * flow of the application will be restored when the object is deleted, so
13301 * the user should handle the popup properly in order to delete the object
13302 * when the action is finished.
13303 * If the function returns @c NULL the popup will be ignored.
13305 * @see elm_web_dialog_prompt_hook_set()
13307 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13309 * Callback type for the JS file selector hook.
13311 * The function parameters are:
13312 * @li @p data User data pointer set when setting the hook function
13313 * @li @p obj The elm_web object requesting the new window
13314 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13315 * @li @p accept_types Mime types accepted
13316 * @li @p selected Pointer where to store the list of malloc'ed strings
13317 * containing the path to each file selected. Must be @c NULL if the file
13318 * dialog is cancelled
13319 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13320 * the user selected @c Ok, @c EINA_FALSE otherwise.
13322 * The function should return the object representing the file selector
13324 * Elm_Web will run a second main loop to handle the dialog and normal
13325 * flow of the application will be restored when the object is deleted, so
13326 * the user should handle the popup properly in order to delete the object
13327 * when the action is finished.
13328 * If the function returns @c NULL the popup will be ignored.
13330 * @see elm_web_dialog_file selector_hook_set()
13332 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);
13334 * Callback type for the JS console message hook.
13336 * When a console message is added from JavaScript, any set function to the
13337 * console message hook will be called for the user to handle. There is no
13338 * default implementation of this hook.
13340 * The function parameters are:
13341 * @li @p data User data pointer set when setting the hook function
13342 * @li @p obj The elm_web object that originated the message
13343 * @li @p message The message sent
13344 * @li @p line_number The line number
13345 * @li @p source_id Source id
13347 * @see elm_web_console_message_hook_set()
13349 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13351 * Add a new web object to the parent.
13353 * @param parent The parent object.
13354 * @return The new object or NULL if it cannot be created.
13356 * @see elm_web_uri_set()
13357 * @see elm_web_webkit_view_get()
13359 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13362 * Get internal ewk_view object from web object.
13364 * Elementary may not provide some low level features of EWebKit,
13365 * instead of cluttering the API with proxy methods we opted to
13366 * return the internal reference. Be careful using it as it may
13367 * interfere with elm_web behavior.
13369 * @param obj The web object.
13370 * @return The internal ewk_view object or NULL if it does not
13371 * exist. (Failure to create or Elementary compiled without
13374 * @see elm_web_add()
13376 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13379 * Sets the function to call when a new window is requested
13381 * This hook will be called when a request to create a new window is
13382 * issued from the web page loaded.
13383 * There is no default implementation for this feature, so leaving this
13384 * unset or passing @c NULL in @p func will prevent new windows from
13387 * @param obj The web object where to set the hook function
13388 * @param func The hook function to be called when a window is requested
13389 * @param data User data
13391 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13393 * Sets the function to call when an alert dialog
13395 * This hook will be called when a JavaScript alert dialog is requested.
13396 * If no function is set or @c NULL is passed in @p func, the default
13397 * implementation will take place.
13399 * @param obj The web object where to set the hook function
13400 * @param func The callback function to be used
13401 * @param data User data
13403 * @see elm_web_inwin_mode_set()
13405 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13407 * Sets the function to call when an confirm dialog
13409 * This hook will be called when a JavaScript confirm dialog is requested.
13410 * If no function is set or @c NULL is passed in @p func, the default
13411 * implementation will take place.
13413 * @param obj The web object where to set the hook function
13414 * @param func The callback function to be used
13415 * @param data User data
13417 * @see elm_web_inwin_mode_set()
13419 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13421 * Sets the function to call when an prompt dialog
13423 * This hook will be called when a JavaScript prompt dialog is requested.
13424 * If no function is set or @c NULL is passed in @p func, the default
13425 * implementation will take place.
13427 * @param obj The web object where to set the hook function
13428 * @param func The callback function to be used
13429 * @param data User data
13431 * @see elm_web_inwin_mode_set()
13433 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13435 * Sets the function to call when an file selector dialog
13437 * This hook will be called when a JavaScript file selector dialog is
13439 * If no function is set or @c NULL is passed in @p func, the default
13440 * implementation will take place.
13442 * @param obj The web object where to set the hook function
13443 * @param func The callback function to be used
13444 * @param data User data
13446 * @see elm_web_inwin_mode_set()
13448 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13450 * Sets the function to call when a console message is emitted from JS
13452 * This hook will be called when a console message is emitted from
13453 * JavaScript. There is no default implementation for this feature.
13455 * @param obj The web object where to set the hook function
13456 * @param func The callback function to be used
13457 * @param data User data
13459 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13461 * Gets the status of the tab propagation
13463 * @param obj The web object to query
13464 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13466 * @see elm_web_tab_propagate_set()
13468 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13470 * Sets whether to use tab propagation
13472 * If tab propagation is enabled, whenever the user presses the Tab key,
13473 * Elementary will handle it and switch focus to the next widget.
13474 * The default value is disabled, where WebKit will handle the Tab key to
13475 * cycle focus though its internal objects, jumping to the next widget
13476 * only when that cycle ends.
13478 * @param obj The web object
13479 * @param propagate Whether to propagate Tab keys to Elementary or not
13481 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13483 * Sets the URI for the web object
13485 * It must be a full URI, with resource included, in the form
13486 * http://www.enlightenment.org or file:///tmp/something.html
13488 * @param obj The web object
13489 * @param uri The URI to set
13490 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13492 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13494 * Gets the current URI for the object
13496 * The returned string must not be freed and is guaranteed to be
13499 * @param obj The web object
13500 * @return A stringshared internal string with the current URI, or NULL on
13503 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13505 * Gets the current title
13507 * The returned string must not be freed and is guaranteed to be
13510 * @param obj The web object
13511 * @return A stringshared internal string with the current title, or NULL on
13514 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13516 * Sets the background color to be used by the web object
13518 * This is the color that will be used by default when the loaded page
13519 * does not set it's own. Color values are pre-multiplied.
13521 * @param obj The web object
13522 * @param r Red component
13523 * @param g Green component
13524 * @param b Blue component
13525 * @param a Alpha component
13527 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13529 * Gets the background color to be used by the web object
13531 * This is the color that will be used by default when the loaded page
13532 * does not set it's own. Color values are pre-multiplied.
13534 * @param obj The web object
13535 * @param r Red component
13536 * @param g Green component
13537 * @param b Blue component
13538 * @param a Alpha component
13540 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13542 * Gets a copy of the currently selected text
13544 * The string returned must be freed by the user when it's done with it.
13546 * @param obj The web object
13547 * @return A newly allocated string, or NULL if nothing is selected or an
13550 EAPI char *elm_view_selection_get(const Evas_Object *obj);
13552 * Tells the web object which index in the currently open popup was selected
13554 * When the user handles the popup creation from the "popup,created" signal,
13555 * it needs to tell the web object which item was selected by calling this
13556 * function with the index corresponding to the item.
13558 * @param obj The web object
13559 * @param index The index selected
13561 * @see elm_web_popup_destroy()
13563 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
13565 * Dismisses an open dropdown popup
13567 * When the popup from a dropdown widget is to be dismissed, either after
13568 * selecting an option or to cancel it, this function must be called, which
13569 * will later emit an "popup,willdelete" signal to notify the user that
13570 * any memory and objects related to this popup can be freed.
13572 * @param obj The web object
13573 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13574 * if there was no menu to destroy
13576 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
13578 * Searches the given string in a document.
13580 * @param obj The web object where to search the text
13581 * @param string String to search
13582 * @param case_sensitive If search should be case sensitive or not
13583 * @param forward If search is from cursor and on or backwards
13584 * @param wrap If search should wrap at the end
13586 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13589 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13591 * Marks matches of the given string in a document.
13593 * @param obj The web object where to search text
13594 * @param string String to match
13595 * @param case_sensitive If match should be case sensitive or not
13596 * @param highlight If matches should be highlighted
13597 * @param limit Maximum amount of matches, or zero to unlimited
13599 * @return number of matched @a string
13601 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13603 * Clears all marked matches in the document
13605 * @param obj The web object
13607 * @return EINA_TRUE on success, EINA_FALSE otherwise
13609 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
13611 * Sets whether to highlight the matched marks
13613 * If enabled, marks set with elm_web_text_matches_mark() will be
13616 * @param obj The web object
13617 * @param highlight Whether to highlight the marks or not
13619 * @return EINA_TRUE on success, EINA_FALSE otherwise
13621 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13623 * Gets whether highlighting marks is enabled
13625 * @param The web object
13627 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13630 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
13632 * Gets the overall loading progress of the page
13634 * Returns the estimated loading progress of the page, with a value between
13635 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13636 * included in the page.
13638 * @param The web object
13640 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13643 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
13645 * Stops loading the current page
13647 * Cancels the loading of the current page in the web object. This will
13648 * cause a "load,error" signal to be emitted, with the is_cancellation
13649 * flag set to EINA_TRUE.
13651 * @param obj The web object
13653 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13655 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
13657 * Requests a reload of the current document in the object
13659 * @param obj The web object
13661 * @return EINA_TRUE on success, EINA_FALSE otherwise
13663 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
13665 * Requests a reload of the current document, avoiding any existing caches
13667 * @param obj The web object
13669 * @return EINA_TRUE on success, EINA_FALSE otherwise
13671 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
13673 * Goes back one step in the browsing history
13675 * This is equivalent to calling elm_web_object_navigate(obj, -1);
13677 * @param obj The web object
13679 * @return EINA_TRUE on success, EINA_FALSE otherwise
13681 * @see elm_web_history_enable_set()
13682 * @see elm_web_back_possible()
13683 * @see elm_web_forward()
13684 * @see elm_web_navigate()
13686 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
13688 * Goes forward one step in the browsing history
13690 * This is equivalent to calling elm_web_object_navigate(obj, 1);
13692 * @param obj The web object
13694 * @return EINA_TRUE on success, EINA_FALSE otherwise
13696 * @see elm_web_history_enable_set()
13697 * @see elm_web_forward_possible()
13698 * @see elm_web_back()
13699 * @see elm_web_navigate()
13701 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
13703 * Jumps the given number of steps in the browsing history
13705 * The @p steps value can be a negative integer to back in history, or a
13706 * positive to move forward.
13708 * @param obj The web object
13709 * @param steps The number of steps to jump
13711 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13712 * history exists to jump the given number of steps
13714 * @see elm_web_history_enable_set()
13715 * @see elm_web_navigate_possible()
13716 * @see elm_web_back()
13717 * @see elm_web_forward()
13719 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
13721 * Queries whether it's possible to go back in history
13723 * @param obj The web object
13725 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13728 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
13730 * Queries whether it's possible to go forward in history
13732 * @param obj The web object
13734 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13737 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
13739 * Queries whether it's possible to jump the given number of steps
13741 * The @p steps value can be a negative integer to back in history, or a
13742 * positive to move forward.
13744 * @param obj The web object
13745 * @param steps The number of steps to check for
13747 * @return EINA_TRUE if enough history exists to perform the given jump,
13748 * EINA_FALSE otherwise
13750 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
13752 * Gets whether browsing history is enabled for the given object
13754 * @param obj The web object
13756 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13758 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
13760 * Enables or disables the browsing history
13762 * @param obj The web object
13763 * @param enable Whether to enable or disable the browsing history
13765 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13767 * Sets the zoom level of the web object
13769 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
13770 * values meaning zoom in and lower meaning zoom out. This function will
13771 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
13772 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
13774 * @param obj The web object
13775 * @param zoom The zoom level to set
13777 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
13779 * Gets the current zoom level set on the web object
13781 * Note that this is the zoom level set on the web object and not that
13782 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
13783 * the two zoom levels should match, but for the other two modes the
13784 * Webkit zoom is calculated internally to match the chosen mode without
13785 * changing the zoom level set for the web object.
13787 * @param obj The web object
13789 * @return The zoom level set on the object
13791 EAPI double elm_web_zoom_get(const Evas_Object *obj);
13793 * Sets the zoom mode to use
13795 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
13796 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
13798 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
13799 * with the elm_web_zoom_set() function.
13800 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
13801 * make sure the entirety of the web object's contents are shown.
13802 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
13803 * fit the contents in the web object's size, without leaving any space
13806 * @param obj The web object
13807 * @param mode The mode to set
13809 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
13811 * Gets the currently set zoom mode
13813 * @param obj The web object
13815 * @return The current zoom mode set for the object, or
13816 * ::ELM_WEB_ZOOM_MODE_LAST on error
13818 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
13820 * Shows the given region in the web object
13822 * @param obj The web object
13823 * @param x The x coordinate of the region to show
13824 * @param y The y coordinate of the region to show
13825 * @param w The width of the region to show
13826 * @param h The height of the region to show
13828 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
13830 * Brings in the region to the visible area
13832 * Like elm_web_region_show(), but it animates the scrolling of the object
13835 * @param obj The web object
13836 * @param x The x coordinate of the region to show
13837 * @param y The y coordinate of the region to show
13838 * @param w The width of the region to show
13839 * @param h The height of the region to show
13841 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
13843 * Sets the default dialogs to use an Inwin instead of a normal window
13845 * If set, then the default implementation for the JavaScript dialogs and
13846 * file selector will be opened in an Inwin. Otherwise they will use a
13847 * normal separated window.
13849 * @param obj The web object
13850 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
13852 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
13854 * Gets whether Inwin mode is set for the current object
13856 * @param obj The web object
13858 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
13860 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
13862 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
13863 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
13864 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);
13865 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
13872 * @defgroup Hoversel Hoversel
13874 * @image html img/widget/hoversel/preview-00.png
13875 * @image latex img/widget/hoversel/preview-00.eps
13877 * A hoversel is a button that pops up a list of items (automatically
13878 * choosing the direction to display) that have a label and, optionally, an
13879 * icon to select from. It is a convenience widget to avoid the need to do
13880 * all the piecing together yourself. It is intended for a small number of
13881 * items in the hoversel menu (no more than 8), though is capable of many
13884 * Signals that you can add callbacks for are:
13885 * "clicked" - the user clicked the hoversel button and popped up the sel
13886 * "selected" - an item in the hoversel list is selected. event_info is the item
13887 * "dismissed" - the hover is dismissed
13889 * See @ref tutorial_hoversel for an example.
13892 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
13894 * @brief Add a new Hoversel object
13896 * @param parent The parent object
13897 * @return The new object or NULL if it cannot be created
13899 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13901 * @brief This sets the hoversel to expand horizontally.
13903 * @param obj The hoversel object
13904 * @param horizontal If true, the hover will expand horizontally to the
13907 * @note The initial button will display horizontally regardless of this
13910 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
13912 * @brief This returns whether the hoversel is set to expand horizontally.
13914 * @param obj The hoversel object
13915 * @return If true, the hover will expand horizontally to the right.
13917 * @see elm_hoversel_horizontal_set()
13919 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13921 * @brief Set the Hover parent
13923 * @param obj The hoversel object
13924 * @param parent The parent to use
13926 * Sets the hover parent object, the area that will be darkened when the
13927 * hoversel is clicked. Should probably be the window that the hoversel is
13928 * in. See @ref Hover objects for more information.
13930 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13932 * @brief Get the Hover parent
13934 * @param obj The hoversel object
13935 * @return The used parent
13937 * Gets the hover parent object.
13939 * @see elm_hoversel_hover_parent_set()
13941 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13943 * @brief Set the hoversel button label
13945 * @param obj The hoversel object
13946 * @param label The label text.
13948 * This sets the label of the button that is always visible (before it is
13949 * clicked and expanded).
13951 * @deprecated elm_object_text_set()
13953 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13955 * @brief Get the hoversel button label
13957 * @param obj The hoversel object
13958 * @return The label text.
13960 * @deprecated elm_object_text_get()
13962 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13964 * @brief Set the icon of the hoversel button
13966 * @param obj The hoversel object
13967 * @param icon The icon object
13969 * Sets the icon of the button that is always visible (before it is clicked
13970 * and expanded). Once the icon object is set, a previously set one will be
13971 * deleted, if you want to keep that old content object, use the
13972 * elm_hoversel_icon_unset() function.
13974 * @see elm_button_icon_set()
13976 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13978 * @brief Get the icon of the hoversel button
13980 * @param obj The hoversel object
13981 * @return The icon object
13983 * Get the icon of the button that is always visible (before it is clicked
13984 * and expanded). Also see elm_button_icon_get().
13986 * @see elm_hoversel_icon_set()
13988 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13990 * @brief Get and unparent the icon of the hoversel button
13992 * @param obj The hoversel object
13993 * @return The icon object that was being used
13995 * Unparent and return the icon of the button that is always visible
13996 * (before it is clicked and expanded).
13998 * @see elm_hoversel_icon_set()
13999 * @see elm_button_icon_unset()
14001 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14003 * @brief This triggers the hoversel popup from code, the same as if the user
14004 * had clicked the button.
14006 * @param obj The hoversel object
14008 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14010 * @brief This dismisses the hoversel popup as if the user had clicked
14011 * outside the hover.
14013 * @param obj The hoversel object
14015 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14017 * @brief Returns whether the hoversel is expanded.
14019 * @param obj The hoversel object
14020 * @return This will return EINA_TRUE if the hoversel is expanded or
14021 * EINA_FALSE if it is not expanded.
14023 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14025 * @brief This will remove all the children items from the hoversel.
14027 * @param obj The hoversel object
14029 * @warning Should @b not be called while the hoversel is active; use
14030 * elm_hoversel_expanded_get() to check first.
14032 * @see elm_hoversel_item_del_cb_set()
14033 * @see elm_hoversel_item_del()
14035 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14037 * @brief Get the list of items within the given hoversel.
14039 * @param obj The hoversel object
14040 * @return Returns a list of Elm_Hoversel_Item*
14042 * @see elm_hoversel_item_add()
14044 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14046 * @brief Add an item to the hoversel button
14048 * @param obj The hoversel object
14049 * @param label The text label to use for the item (NULL if not desired)
14050 * @param icon_file An image file path on disk to use for the icon or standard
14051 * icon name (NULL if not desired)
14052 * @param icon_type The icon type if relevant
14053 * @param func Convenience function to call when this item is selected
14054 * @param data Data to pass to item-related functions
14055 * @return A handle to the item added.
14057 * This adds an item to the hoversel to show when it is clicked. Note: if you
14058 * need to use an icon from an edje file then use
14059 * elm_hoversel_item_icon_set() right after the this function, and set
14060 * icon_file to NULL here.
14062 * For more information on what @p icon_file and @p icon_type are see the
14063 * @ref Icon "icon documentation".
14065 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);
14067 * @brief Delete an item from the hoversel
14069 * @param item The item to delete
14071 * This deletes the item from the hoversel (should not be called while the
14072 * hoversel is active; use elm_hoversel_expanded_get() to check first).
14074 * @see elm_hoversel_item_add()
14075 * @see elm_hoversel_item_del_cb_set()
14077 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14079 * @brief Set the function to be called when an item from the hoversel is
14082 * @param item The item to set the callback on
14083 * @param func The function called
14085 * That function will receive these parameters:
14086 * @li void *item_data
14087 * @li Evas_Object *the_item_object
14088 * @li Elm_Hoversel_Item *the_object_struct
14090 * @see elm_hoversel_item_add()
14092 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14094 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14095 * that will be passed to associated function callbacks.
14097 * @param item The item to get the data from
14098 * @return The data pointer set with elm_hoversel_item_add()
14100 * @see elm_hoversel_item_add()
14102 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14104 * @brief This returns the label text of the given hoversel item.
14106 * @param item The item to get the label
14107 * @return The label text of the hoversel item
14109 * @see elm_hoversel_item_add()
14111 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14113 * @brief This sets the icon for the given hoversel item.
14115 * @param item The item to set the icon
14116 * @param icon_file An image file path on disk to use for the icon or standard
14118 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14119 * to NULL if the icon is not an edje file
14120 * @param icon_type The icon type
14122 * The icon can be loaded from the standard set, from an image file, or from
14125 * @see elm_hoversel_item_add()
14127 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);
14129 * @brief Get the icon object of the hoversel item
14131 * @param item The item to get the icon from
14132 * @param icon_file The image file path on disk used for the icon or standard
14134 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14135 * if the icon is not an edje file
14136 * @param icon_type The icon type
14138 * @see elm_hoversel_item_icon_set()
14139 * @see elm_hoversel_item_add()
14141 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);
14147 * @defgroup Toolbar Toolbar
14148 * @ingroup Elementary
14150 * @image html img/widget/toolbar/preview-00.png
14151 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14153 * @image html img/toolbar.png
14154 * @image latex img/toolbar.eps width=\textwidth
14156 * A toolbar is a widget that displays a list of items inside
14157 * a box. It can be scrollable, show a menu with items that don't fit
14158 * to toolbar size or even crop them.
14160 * Only one item can be selected at a time.
14162 * Items can have multiple states, or show menus when selected by the user.
14164 * Smart callbacks one can listen to:
14165 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14166 * - "language,changed" - when the program language changes
14168 * Available styles for it:
14170 * - @c "transparent" - no background or shadow, just show the content
14172 * List of examples:
14173 * @li @ref toolbar_example_01
14174 * @li @ref toolbar_example_02
14175 * @li @ref toolbar_example_03
14179 * @addtogroup Toolbar
14184 * @enum _Elm_Toolbar_Shrink_Mode
14185 * @typedef Elm_Toolbar_Shrink_Mode
14187 * Set toolbar's items display behavior, it can be scrollabel,
14188 * show a menu with exceeding items, or simply hide them.
14190 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14193 * Values <b> don't </b> work as bitmask, only one can be choosen.
14195 * @see elm_toolbar_mode_shrink_set()
14196 * @see elm_toolbar_mode_shrink_get()
14200 typedef enum _Elm_Toolbar_Shrink_Mode
14202 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14203 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14204 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14205 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
14206 } Elm_Toolbar_Shrink_Mode;
14208 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(). */
14210 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(). */
14213 * Add a new toolbar widget to the given parent Elementary
14214 * (container) object.
14216 * @param parent The parent object.
14217 * @return a new toolbar widget handle or @c NULL, on errors.
14219 * This function inserts a new toolbar widget on the canvas.
14223 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14226 * Set the icon size, in pixels, to be used by toolbar items.
14228 * @param obj The toolbar object
14229 * @param icon_size The icon size in pixels
14231 * @note Default value is @c 32. It reads value from elm config.
14233 * @see elm_toolbar_icon_size_get()
14237 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14240 * Get the icon size, in pixels, to be used by toolbar items.
14242 * @param obj The toolbar object.
14243 * @return The icon size in pixels.
14245 * @see elm_toolbar_icon_size_set() for details.
14249 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14252 * Sets icon lookup order, for toolbar items' icons.
14254 * @param obj The toolbar object.
14255 * @param order The icon lookup order.
14257 * Icons added before calling this function will not be affected.
14258 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14260 * @see elm_toolbar_icon_order_lookup_get()
14264 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14267 * Gets the icon lookup order.
14269 * @param obj The toolbar object.
14270 * @return The icon lookup order.
14272 * @see elm_toolbar_icon_order_lookup_set() for details.
14276 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14279 * Set whether the toolbar should always have an item selected.
14281 * @param obj The toolbar object.
14282 * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14285 * This will cause the toolbar to always have an item selected, and clicking
14286 * the selected item will not cause a selected event to be emitted. Enabling this mode
14287 * will immediately select the first toolbar item.
14289 * Always-selected is disabled by default.
14291 * @see elm_toolbar_always_select_mode_get().
14295 EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14298 * Get whether the toolbar should always have an item selected.
14300 * @param obj The toolbar object.
14301 * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14302 * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14304 * @see elm_toolbar_always_select_mode_set() for details.
14308 EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14311 * Set whether the toolbar items' should be selected by the user or not.
14313 * @param obj The toolbar object.
14314 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14317 * This will turn off the ability to select items entirely and they will
14318 * neither appear selected nor emit selected signals. The clicked
14319 * callback function will still be called.
14321 * Selection is enabled by default.
14323 * @see elm_toolbar_no_select_mode_get().
14327 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14330 * Set whether the toolbar items' should be selected by the user or not.
14332 * @param obj The toolbar object.
14333 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14334 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14336 * @see elm_toolbar_no_select_mode_set() for details.
14340 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14343 * Append item to the toolbar.
14345 * @param obj The toolbar object.
14346 * @param icon A string with icon name or the absolute path of an image file.
14347 * @param label The label of the item.
14348 * @param func The function to call when the item is clicked.
14349 * @param data The data to associate with the item for related callbacks.
14350 * @return The created item or @c NULL upon failure.
14352 * A new item will be created and appended to the toolbar, i.e., will
14353 * be set as @b last item.
14355 * Items created with this method can be deleted with
14356 * elm_toolbar_item_del().
14358 * Associated @p data can be properly freed when item is deleted if a
14359 * callback function is set with elm_toolbar_item_del_cb_set().
14361 * If a function is passed as argument, it will be called everytime this item
14362 * is selected, i.e., the user clicks over an unselected item.
14363 * If such function isn't needed, just passing
14364 * @c NULL as @p func is enough. The same should be done for @p data.
14366 * Toolbar will load icon image from fdo or current theme.
14367 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14368 * If an absolute path is provided it will load it direct from a file.
14370 * @see elm_toolbar_item_icon_set()
14371 * @see elm_toolbar_item_del()
14372 * @see elm_toolbar_item_del_cb_set()
14376 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);
14379 * Prepend item to the toolbar.
14381 * @param obj The toolbar object.
14382 * @param icon A string with icon name or the absolute path of an image file.
14383 * @param label The label of the item.
14384 * @param func The function to call when the item is clicked.
14385 * @param data The data to associate with the item for related callbacks.
14386 * @return The created item or @c NULL upon failure.
14388 * A new item will be created and prepended to the toolbar, i.e., will
14389 * be set as @b first item.
14391 * Items created with this method can be deleted with
14392 * elm_toolbar_item_del().
14394 * Associated @p data can be properly freed when item is deleted if a
14395 * callback function is set with elm_toolbar_item_del_cb_set().
14397 * If a function is passed as argument, it will be called everytime this item
14398 * is selected, i.e., the user clicks over an unselected item.
14399 * If such function isn't needed, just passing
14400 * @c NULL as @p func is enough. The same should be done for @p data.
14402 * Toolbar will load icon image from fdo or current theme.
14403 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14404 * If an absolute path is provided it will load it direct from a file.
14406 * @see elm_toolbar_item_icon_set()
14407 * @see elm_toolbar_item_del()
14408 * @see elm_toolbar_item_del_cb_set()
14412 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);
14415 * Insert a new item into the toolbar object before item @p before.
14417 * @param obj The toolbar object.
14418 * @param before The toolbar item to insert before.
14419 * @param icon A string with icon name or the absolute path of an image file.
14420 * @param label The label of the item.
14421 * @param func The function to call when the item is clicked.
14422 * @param data The data to associate with the item for related callbacks.
14423 * @return The created item or @c NULL upon failure.
14425 * A new item will be created and added to the toolbar. Its position in
14426 * this toolbar will be just before item @p before.
14428 * Items created with this method can be deleted with
14429 * elm_toolbar_item_del().
14431 * Associated @p data can be properly freed when item is deleted if a
14432 * callback function is set with elm_toolbar_item_del_cb_set().
14434 * If a function is passed as argument, it will be called everytime this item
14435 * is selected, i.e., the user clicks over an unselected item.
14436 * If such function isn't needed, just passing
14437 * @c NULL as @p func is enough. The same should be done for @p data.
14439 * Toolbar will load icon image from fdo or current theme.
14440 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14441 * If an absolute path is provided it will load it direct from a file.
14443 * @see elm_toolbar_item_icon_set()
14444 * @see elm_toolbar_item_del()
14445 * @see elm_toolbar_item_del_cb_set()
14449 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);
14452 * Insert a new item into the toolbar object after item @p after.
14454 * @param obj The toolbar object.
14455 * @param before The toolbar item to insert before.
14456 * @param icon A string with icon name or the absolute path of an image file.
14457 * @param label The label of the item.
14458 * @param func The function to call when the item is clicked.
14459 * @param data The data to associate with the item for related callbacks.
14460 * @return The created item or @c NULL upon failure.
14462 * A new item will be created and added to the toolbar. Its position in
14463 * this toolbar will be just after item @p after.
14465 * Items created with this method can be deleted with
14466 * elm_toolbar_item_del().
14468 * Associated @p data can be properly freed when item is deleted if a
14469 * callback function is set with elm_toolbar_item_del_cb_set().
14471 * If a function is passed as argument, it will be called everytime this item
14472 * is selected, i.e., the user clicks over an unselected item.
14473 * If such function isn't needed, just passing
14474 * @c NULL as @p func is enough. The same should be done for @p data.
14476 * Toolbar will load icon image from fdo or current theme.
14477 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14478 * If an absolute path is provided it will load it direct from a file.
14480 * @see elm_toolbar_item_icon_set()
14481 * @see elm_toolbar_item_del()
14482 * @see elm_toolbar_item_del_cb_set()
14486 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);
14489 * Get the first item in the given toolbar widget's list of
14492 * @param obj The toolbar object
14493 * @return The first item or @c NULL, if it has no items (and on
14496 * @see elm_toolbar_item_append()
14497 * @see elm_toolbar_last_item_get()
14501 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14504 * Get the last item in the given toolbar widget's list of
14507 * @param obj The toolbar object
14508 * @return The last item or @c NULL, if it has no items (and on
14511 * @see elm_toolbar_item_prepend()
14512 * @see elm_toolbar_first_item_get()
14516 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14519 * Get the item after @p item in toolbar.
14521 * @param item The toolbar item.
14522 * @return The item after @p item, or @c NULL if none or on failure.
14524 * @note If it is the last item, @c NULL will be returned.
14526 * @see elm_toolbar_item_append()
14530 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14533 * Get the item before @p item in toolbar.
14535 * @param item The toolbar item.
14536 * @return The item before @p item, or @c NULL if none or on failure.
14538 * @note If it is the first item, @c NULL will be returned.
14540 * @see elm_toolbar_item_prepend()
14544 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14547 * Get the toolbar object from an item.
14549 * @param item The item.
14550 * @return The toolbar object.
14552 * This returns the toolbar object itself that an item belongs to.
14556 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14559 * Set the priority of a toolbar item.
14561 * @param item The toolbar item.
14562 * @param priority The item priority. The default is zero.
14564 * This is used only when the toolbar shrink mode is set to
14565 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14566 * When space is less than required, items with low priority
14567 * will be removed from the toolbar and added to a dynamically-created menu,
14568 * while items with higher priority will remain on the toolbar,
14569 * with the same order they were added.
14571 * @see elm_toolbar_item_priority_get()
14575 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14578 * Get the priority of a toolbar item.
14580 * @param item The toolbar item.
14581 * @return The @p item priority, or @c 0 on failure.
14583 * @see elm_toolbar_item_priority_set() for details.
14587 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14590 * Get the label of item.
14592 * @param item The item of toolbar.
14593 * @return The label of item.
14595 * The return value is a pointer to the label associated to @p item when
14596 * it was created, with function elm_toolbar_item_append() or similar,
14598 * with function elm_toolbar_item_label_set. If no label
14599 * was passed as argument, it will return @c NULL.
14601 * @see elm_toolbar_item_label_set() for more details.
14602 * @see elm_toolbar_item_append()
14606 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14609 * Set the label of item.
14611 * @param item The item of toolbar.
14612 * @param text The label of item.
14614 * The label to be displayed by the item.
14615 * Label will be placed at icons bottom (if set).
14617 * If a label was passed as argument on item creation, with function
14618 * elm_toolbar_item_append() or similar, it will be already
14619 * displayed by the item.
14621 * @see elm_toolbar_item_label_get()
14622 * @see elm_toolbar_item_append()
14626 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14629 * Return the data associated with a given toolbar widget item.
14631 * @param item The toolbar widget item handle.
14632 * @return The data associated with @p item.
14634 * @see elm_toolbar_item_data_set()
14638 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14641 * Set the data associated with a given toolbar widget item.
14643 * @param item The toolbar widget item handle.
14644 * @param data The new data pointer to set to @p item.
14646 * This sets new item data on @p item.
14648 * @warning The old data pointer won't be touched by this function, so
14649 * the user had better to free that old data himself/herself.
14653 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14656 * Returns a pointer to a toolbar item by its label.
14658 * @param obj The toolbar object.
14659 * @param label The label of the item to find.
14661 * @return The pointer to the toolbar item matching @p label or @c NULL
14666 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14669 * Get whether the @p item is selected or not.
14671 * @param item The toolbar item.
14672 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14673 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14675 * @see elm_toolbar_selected_item_set() for details.
14676 * @see elm_toolbar_item_selected_get()
14680 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14683 * Set the selected state of an item.
14685 * @param item The toolbar item
14686 * @param selected The selected state
14688 * This sets the selected state of the given item @p it.
14689 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14691 * If a new item is selected the previosly selected will be unselected.
14692 * Previoulsy selected item can be get with function
14693 * elm_toolbar_selected_item_get().
14695 * Selected items will be highlighted.
14697 * @see elm_toolbar_item_selected_get()
14698 * @see elm_toolbar_selected_item_get()
14702 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14705 * Get the selected item.
14707 * @param obj The toolbar object.
14708 * @return The selected toolbar item.
14710 * The selected item can be unselected with function
14711 * elm_toolbar_item_selected_set().
14713 * The selected item always will be highlighted on toolbar.
14715 * @see elm_toolbar_selected_items_get()
14719 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14722 * Set the icon associated with @p item.
14724 * @param obj The parent of this item.
14725 * @param item The toolbar item.
14726 * @param icon A string with icon name or the absolute path of an image file.
14728 * Toolbar will load icon image from fdo or current theme.
14729 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14730 * If an absolute path is provided it will load it direct from a file.
14732 * @see elm_toolbar_icon_order_lookup_set()
14733 * @see elm_toolbar_icon_order_lookup_get()
14737 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14740 * Get the string used to set the icon of @p item.
14742 * @param item The toolbar item.
14743 * @return The string associated with the icon object.
14745 * @see elm_toolbar_item_icon_set() for details.
14749 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14752 * Get the object of @p item.
14754 * @param item The toolbar item.
14755 * @return The object
14759 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14762 * Get the icon object of @p item.
14764 * @param item The toolbar item.
14765 * @return The icon object
14767 * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14771 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14774 * Set the icon associated with @p item to an image in a binary buffer.
14776 * @param item The toolbar item.
14777 * @param img The binary data that will be used as an image
14778 * @param size The size of binary data @p img
14779 * @param format Optional format of @p img to pass to the image loader
14780 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
14782 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
14784 * @note The icon image set by this function can be changed by
14785 * elm_toolbar_item_icon_set().
14789 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);
14792 * Delete them item from the toolbar.
14794 * @param item The item of toolbar to be deleted.
14796 * @see elm_toolbar_item_append()
14797 * @see elm_toolbar_item_del_cb_set()
14801 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14804 * Set the function called when a toolbar item is freed.
14806 * @param item The item to set the callback on.
14807 * @param func The function called.
14809 * If there is a @p func, then it will be called prior item's memory release.
14810 * That will be called with the following arguments:
14812 * @li item's Evas object;
14815 * This way, a data associated to a toolbar item could be properly freed.
14819 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14822 * Get a value whether toolbar item is disabled or not.
14824 * @param item The item.
14825 * @return The disabled state.
14827 * @see elm_toolbar_item_disabled_set() for more details.
14831 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14834 * Sets the disabled/enabled state of a toolbar item.
14836 * @param item The item.
14837 * @param disabled The disabled state.
14839 * A disabled item cannot be selected or unselected. It will also
14840 * change its appearance (generally greyed out). This sets the
14841 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
14846 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14849 * Set or unset item as a separator.
14851 * @param item The toolbar item.
14852 * @param setting @c EINA_TRUE to set item @p item as separator or
14853 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
14855 * Items aren't set as separator by default.
14857 * If set as separator it will display separator theme, so won't display
14860 * @see elm_toolbar_item_separator_get()
14864 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
14867 * Get a value whether item is a separator or not.
14869 * @param item The toolbar item.
14870 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
14871 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
14873 * @see elm_toolbar_item_separator_set() for details.
14877 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14880 * Set the shrink state of toolbar @p obj.
14882 * @param obj The toolbar object.
14883 * @param shrink_mode Toolbar's items display behavior.
14885 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
14886 * but will enforce a minimun size so all the items will fit, won't scroll
14887 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
14888 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
14889 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
14893 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
14896 * Get the shrink mode of toolbar @p obj.
14898 * @param obj The toolbar object.
14899 * @return Toolbar's items display behavior.
14901 * @see elm_toolbar_mode_shrink_set() for details.
14905 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14908 * Enable/disable homogenous mode.
14910 * @param obj The toolbar object
14911 * @param homogeneous Assume the items within the toolbar are of the
14912 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14914 * This will enable the homogeneous mode where items are of the same size.
14915 * @see elm_toolbar_homogeneous_get()
14919 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
14922 * Get whether the homogenous mode is enabled.
14924 * @param obj The toolbar object.
14925 * @return Assume the items within the toolbar are of the same height
14926 * and width (EINA_TRUE = on, EINA_FALSE = off).
14928 * @see elm_toolbar_homogeneous_set()
14932 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14935 * Enable/disable homogenous mode.
14937 * @param obj The toolbar object
14938 * @param homogeneous Assume the items within the toolbar are of the
14939 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14941 * This will enable the homogeneous mode where items are of the same size.
14942 * @see elm_toolbar_homogeneous_get()
14944 * @deprecated use elm_toolbar_homogeneous_set() instead.
14948 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
14951 * Get whether the homogenous mode is enabled.
14953 * @param obj The toolbar object.
14954 * @return Assume the items within the toolbar are of the same height
14955 * and width (EINA_TRUE = on, EINA_FALSE = off).
14957 * @see elm_toolbar_homogeneous_set()
14958 * @deprecated use elm_toolbar_homogeneous_get() instead.
14962 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14965 * Set the parent object of the toolbar items' menus.
14967 * @param obj The toolbar object.
14968 * @param parent The parent of the menu objects.
14970 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
14972 * For more details about setting the parent for toolbar menus, see
14973 * elm_menu_parent_set().
14975 * @see elm_menu_parent_set() for details.
14976 * @see elm_toolbar_item_menu_set() for details.
14980 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14983 * Get the parent object of the toolbar items' menus.
14985 * @param obj The toolbar object.
14986 * @return The parent of the menu objects.
14988 * @see elm_toolbar_menu_parent_set() for details.
14992 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14995 * Set the alignment of the items.
14997 * @param obj The toolbar object.
14998 * @param align The new alignment, a float between <tt> 0.0 </tt>
14999 * and <tt> 1.0 </tt>.
15001 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15002 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15005 * Centered items by default.
15007 * @see elm_toolbar_align_get()
15011 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15014 * Get the alignment of the items.
15016 * @param obj The toolbar object.
15017 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15020 * @see elm_toolbar_align_set() for details.
15024 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15027 * Set whether the toolbar item opens a menu.
15029 * @param item The toolbar item.
15030 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15032 * A toolbar item can be set to be a menu, using this function.
15034 * Once it is set to be a menu, it can be manipulated through the
15035 * menu-like function elm_toolbar_menu_parent_set() and the other
15036 * elm_menu functions, using the Evas_Object @c menu returned by
15037 * elm_toolbar_item_menu_get().
15039 * So, items to be displayed in this item's menu should be added with
15040 * elm_menu_item_add().
15042 * The following code exemplifies the most basic usage:
15044 * tb = elm_toolbar_add(win)
15045 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15046 * elm_toolbar_item_menu_set(item, EINA_TRUE);
15047 * elm_toolbar_menu_parent_set(tb, win);
15048 * menu = elm_toolbar_item_menu_get(item);
15049 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15050 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15054 * @see elm_toolbar_item_menu_get()
15058 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15061 * Get toolbar item's menu.
15063 * @param item The toolbar item.
15064 * @return Item's menu object or @c NULL on failure.
15066 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15067 * this function will set it.
15069 * @see elm_toolbar_item_menu_set() for details.
15073 EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15076 * Add a new state to @p item.
15078 * @param item The item.
15079 * @param icon A string with icon name or the absolute path of an image file.
15080 * @param label The label of the new state.
15081 * @param func The function to call when the item is clicked when this
15082 * state is selected.
15083 * @param data The data to associate with the state.
15084 * @return The toolbar item state, or @c NULL upon failure.
15086 * Toolbar will load icon image from fdo or current theme.
15087 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15088 * If an absolute path is provided it will load it direct from a file.
15090 * States created with this function can be removed with
15091 * elm_toolbar_item_state_del().
15093 * @see elm_toolbar_item_state_del()
15094 * @see elm_toolbar_item_state_sel()
15095 * @see elm_toolbar_item_state_get()
15099 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);
15102 * Delete a previoulsy added state to @p item.
15104 * @param item The toolbar item.
15105 * @param state The state to be deleted.
15106 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15108 * @see elm_toolbar_item_state_add()
15110 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15113 * Set @p state as the current state of @p it.
15115 * @param it The item.
15116 * @param state The state to use.
15117 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15119 * If @p state is @c NULL, it won't select any state and the default item's
15120 * icon and label will be used. It's the same behaviour than
15121 * elm_toolbar_item_state_unser().
15123 * @see elm_toolbar_item_state_unset()
15127 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15130 * Unset the state of @p it.
15132 * @param it The item.
15134 * The default icon and label from this item will be displayed.
15136 * @see elm_toolbar_item_state_set() for more details.
15140 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15143 * Get the current state of @p it.
15145 * @param item The item.
15146 * @return The selected state or @c NULL if none is selected or on failure.
15148 * @see elm_toolbar_item_state_set() for details.
15149 * @see elm_toolbar_item_state_unset()
15150 * @see elm_toolbar_item_state_add()
15154 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15157 * Get the state after selected state in toolbar's @p item.
15159 * @param it The toolbar item to change state.
15160 * @return The state after current state, or @c NULL on failure.
15162 * If last state is selected, this function will return first state.
15164 * @see elm_toolbar_item_state_set()
15165 * @see elm_toolbar_item_state_add()
15169 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15172 * Get the state before selected state in toolbar's @p item.
15174 * @param it The toolbar item to change state.
15175 * @return The state before current state, or @c NULL on failure.
15177 * If first state is selected, this function will return last state.
15179 * @see elm_toolbar_item_state_set()
15180 * @see elm_toolbar_item_state_add()
15184 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15187 * Set the text to be shown in a given toolbar item's tooltips.
15189 * @param item Target item.
15190 * @param text The text to set in the content.
15192 * Setup the text as tooltip to object. The item can have only one tooltip,
15193 * so any previous tooltip data - set with this function or
15194 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15196 * @see elm_object_tooltip_text_set() for more details.
15200 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15203 * Set the content to be shown in the tooltip item.
15205 * Setup the tooltip to item. The item can have only one tooltip,
15206 * so any previous tooltip data is removed. @p func(with @p data) will
15207 * be called every time that need show the tooltip and it should
15208 * return a valid Evas_Object. This object is then managed fully by
15209 * tooltip system and is deleted when the tooltip is gone.
15211 * @param item the toolbar item being attached a tooltip.
15212 * @param func the function used to create the tooltip contents.
15213 * @param data what to provide to @a func as callback data/context.
15214 * @param del_cb called when data is not needed anymore, either when
15215 * another callback replaces @a func, the tooltip is unset with
15216 * elm_toolbar_item_tooltip_unset() or the owner @a item
15217 * dies. This callback receives as the first parameter the
15218 * given @a data, and @c event_info is the item.
15220 * @see elm_object_tooltip_content_cb_set() for more details.
15224 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);
15227 * Unset tooltip from item.
15229 * @param item toolbar item to remove previously set tooltip.
15231 * Remove tooltip from item. The callback provided as del_cb to
15232 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15233 * it is not used anymore.
15235 * @see elm_object_tooltip_unset() for more details.
15236 * @see elm_toolbar_item_tooltip_content_cb_set()
15240 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15243 * Sets a different style for this item tooltip.
15245 * @note before you set a style you should define a tooltip with
15246 * elm_toolbar_item_tooltip_content_cb_set() or
15247 * elm_toolbar_item_tooltip_text_set()
15249 * @param item toolbar item with tooltip already set.
15250 * @param style the theme style to use (default, transparent, ...)
15252 * @see elm_object_tooltip_style_set() for more details.
15256 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15259 * Get the style for this item tooltip.
15261 * @param item toolbar item with tooltip already set.
15262 * @return style the theme style in use, defaults to "default". If the
15263 * object does not have a tooltip set, then NULL is returned.
15265 * @see elm_object_tooltip_style_get() for more details.
15266 * @see elm_toolbar_item_tooltip_style_set()
15270 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15273 * Set the type of mouse pointer/cursor decoration to be shown,
15274 * when the mouse pointer is over the given toolbar widget item
15276 * @param item toolbar item to customize cursor on
15277 * @param cursor the cursor type's name
15279 * This function works analogously as elm_object_cursor_set(), but
15280 * here the cursor's changing area is restricted to the item's
15281 * area, and not the whole widget's. Note that that item cursors
15282 * have precedence over widget cursors, so that a mouse over an
15283 * item with custom cursor set will always show @b that cursor.
15285 * If this function is called twice for an object, a previously set
15286 * cursor will be unset on the second call.
15288 * @see elm_object_cursor_set()
15289 * @see elm_toolbar_item_cursor_get()
15290 * @see elm_toolbar_item_cursor_unset()
15294 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15297 * Get the type of mouse pointer/cursor decoration set to be shown,
15298 * when the mouse pointer is over the given toolbar widget item
15300 * @param item toolbar item with custom cursor set
15301 * @return the cursor type's name or @c NULL, if no custom cursors
15302 * were set to @p item (and on errors)
15304 * @see elm_object_cursor_get()
15305 * @see elm_toolbar_item_cursor_set()
15306 * @see elm_toolbar_item_cursor_unset()
15310 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15313 * Unset any custom mouse pointer/cursor decoration set to be
15314 * shown, when the mouse pointer is over the given toolbar widget
15315 * item, thus making it show the @b default cursor again.
15317 * @param item a toolbar item
15319 * Use this call to undo any custom settings on this item's cursor
15320 * decoration, bringing it back to defaults (no custom style set).
15322 * @see elm_object_cursor_unset()
15323 * @see elm_toolbar_item_cursor_set()
15327 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15330 * Set a different @b style for a given custom cursor set for a
15333 * @param item toolbar item with custom cursor set
15334 * @param style the <b>theme style</b> to use (e.g. @c "default",
15335 * @c "transparent", etc)
15337 * This function only makes sense when one is using custom mouse
15338 * cursor decorations <b>defined in a theme file</b>, which can have,
15339 * given a cursor name/type, <b>alternate styles</b> on it. It
15340 * works analogously as elm_object_cursor_style_set(), but here
15341 * applyed only to toolbar item objects.
15343 * @warning Before you set a cursor style you should have definen a
15344 * custom cursor previously on the item, with
15345 * elm_toolbar_item_cursor_set()
15347 * @see elm_toolbar_item_cursor_engine_only_set()
15348 * @see elm_toolbar_item_cursor_style_get()
15352 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15355 * Get the current @b style set for a given toolbar item's custom
15358 * @param item toolbar item with custom cursor set.
15359 * @return style the cursor style in use. If the object does not
15360 * have a cursor set, then @c NULL is returned.
15362 * @see elm_toolbar_item_cursor_style_set() for more details
15366 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15369 * Set if the (custom)cursor for a given toolbar item should be
15370 * searched in its theme, also, or should only rely on the
15371 * rendering engine.
15373 * @param item item with custom (custom) cursor already set on
15374 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15375 * only on those provided by the rendering engine, @c EINA_FALSE to
15376 * have them searched on the widget's theme, as well.
15378 * @note This call is of use only if you've set a custom cursor
15379 * for toolbar items, with elm_toolbar_item_cursor_set().
15381 * @note By default, cursors will only be looked for between those
15382 * provided by the rendering engine.
15386 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15389 * Get if the (custom) cursor for a given toolbar item is being
15390 * searched in its theme, also, or is only relying on the rendering
15393 * @param item a toolbar item
15394 * @return @c EINA_TRUE, if cursors are being looked for only on
15395 * those provided by the rendering engine, @c EINA_FALSE if they
15396 * are being searched on the widget's theme, as well.
15398 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15402 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15405 * Change a toolbar's orientation
15406 * @param obj The toolbar object
15407 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15408 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15411 EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15414 * Get a toolbar's orientation
15415 * @param obj The toolbar object
15416 * @return If @c EINA_TRUE, the toolbar is vertical
15417 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15420 EAPI Eina_Bool elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
15427 * @defgroup Tooltips Tooltips
15429 * The Tooltip is an (internal, for now) smart object used to show a
15430 * content in a frame on mouse hover of objects(or widgets), with
15431 * tips/information about them.
15436 EAPI double elm_tooltip_delay_get(void);
15437 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15438 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15439 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15440 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15441 EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15442 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15443 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);
15444 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15445 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15446 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15447 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
15448 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
15455 * @defgroup Cursors Cursors
15457 * The Elementary cursor is an internal smart object used to
15458 * customize the mouse cursor displayed over objects (or
15459 * widgets). In the most common scenario, the cursor decoration
15460 * comes from the graphical @b engine Elementary is running
15461 * on. Those engines may provide different decorations for cursors,
15462 * and Elementary provides functions to choose them (think of X11
15463 * cursors, as an example).
15465 * There's also the possibility of, besides using engine provided
15466 * cursors, also use ones coming from Edje theming files. Both
15467 * globally and per widget, Elementary makes it possible for one to
15468 * make the cursors lookup to be held on engines only or on
15469 * Elementary's theme file, too.
15475 * Set the cursor to be shown when mouse is over the object
15477 * Set the cursor that will be displayed when mouse is over the
15478 * object. The object can have only one cursor set to it, so if
15479 * this function is called twice for an object, the previous set
15481 * If using X cursors, a definition of all the valid cursor names
15482 * is listed on Elementary_Cursors.h. If an invalid name is set
15483 * the default cursor will be used.
15485 * @param obj the object being set a cursor.
15486 * @param cursor the cursor name to be used.
15490 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15493 * Get the cursor to be shown when mouse is over the object
15495 * @param obj an object with cursor already set.
15496 * @return the cursor name.
15500 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15503 * Unset cursor for object
15505 * Unset cursor for object, and set the cursor to default if the mouse
15506 * was over this object.
15508 * @param obj Target object
15509 * @see elm_object_cursor_set()
15513 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15516 * Sets a different style for this object cursor.
15518 * @note before you set a style you should define a cursor with
15519 * elm_object_cursor_set()
15521 * @param obj an object with cursor already set.
15522 * @param style the theme style to use (default, transparent, ...)
15526 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15529 * Get the style for this object cursor.
15531 * @param obj an object with cursor already set.
15532 * @return style the theme style in use, defaults to "default". If the
15533 * object does not have a cursor set, then NULL is returned.
15537 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15540 * Set if the cursor set should be searched on the theme or should use
15541 * the provided by the engine, only.
15543 * @note before you set if should look on theme you should define a cursor
15544 * with elm_object_cursor_set(). By default it will only look for cursors
15545 * provided by the engine.
15547 * @param obj an object with cursor already set.
15548 * @param engine_only boolean to define it cursors should be looked only
15549 * between the provided by the engine or searched on widget's theme as well.
15553 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15556 * Get the cursor engine only usage for this object cursor.
15558 * @param obj an object with cursor already set.
15559 * @return engine_only boolean to define it cursors should be
15560 * looked only between the provided by the engine or searched on
15561 * widget's theme as well. If the object does not have a cursor
15562 * set, then EINA_FALSE is returned.
15566 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15569 * Get the configured cursor engine only usage
15571 * This gets the globally configured exclusive usage of engine cursors.
15573 * @return 1 if only engine cursors should be used
15576 EAPI int elm_cursor_engine_only_get(void);
15579 * Set the configured cursor engine only usage
15581 * This sets the globally configured exclusive usage of engine cursors.
15582 * It won't affect cursors set before changing this value.
15584 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15585 * look for them on theme before.
15586 * @return EINA_TRUE if value is valid and setted (0 or 1)
15589 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
15596 * @defgroup Menu Menu
15598 * @image html img/widget/menu/preview-00.png
15599 * @image latex img/widget/menu/preview-00.eps
15601 * A menu is a list of items displayed above its parent. When the menu is
15602 * showing its parent is darkened. Each item can have a sub-menu. The menu
15603 * object can be used to display a menu on a right click event, in a toolbar,
15606 * Signals that you can add callbacks for are:
15607 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15608 * event_info is NULL.
15610 * @see @ref tutorial_menu
15613 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15615 * @brief Add a new menu to the parent
15617 * @param parent The parent object.
15618 * @return The new object or NULL if it cannot be created.
15620 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15622 * @brief Set the parent for the given menu widget
15624 * @param obj The menu object.
15625 * @param parent The new parent.
15627 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15629 * @brief Get the parent for the given menu widget
15631 * @param obj The menu object.
15632 * @return The parent.
15634 * @see elm_menu_parent_set()
15636 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15638 * @brief Move the menu to a new position
15640 * @param obj The menu object.
15641 * @param x The new position.
15642 * @param y The new position.
15644 * Sets the top-left position of the menu to (@p x,@p y).
15646 * @note @p x and @p y coordinates are relative to parent.
15648 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15650 * @brief Close a opened menu
15652 * @param obj the menu object
15655 * Hides the menu and all it's sub-menus.
15657 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15659 * @brief Returns a list of @p item's items.
15661 * @param obj The menu object
15662 * @return An Eina_List* of @p item's items
15664 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15666 * @brief Get the Evas_Object of an Elm_Menu_Item
15668 * @param item The menu item object.
15669 * @return The edje object containing the swallowed content
15671 * @warning Don't manipulate this object!
15673 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15675 * @brief Add an item at the end of the given menu widget
15677 * @param obj The menu object.
15678 * @param parent The parent menu item (optional)
15679 * @param icon A icon display on the item. The icon will be destryed by the menu.
15680 * @param label The label of the item.
15681 * @param func Function called when the user select the item.
15682 * @param data Data sent by the callback.
15683 * @return Returns the new item.
15685 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);
15687 * @brief Add an object swallowed in an item at the end of the given menu
15690 * @param obj The menu object.
15691 * @param parent The parent menu item (optional)
15692 * @param subobj The object to swallow
15693 * @param func Function called when the user select the item.
15694 * @param data Data sent by the callback.
15695 * @return Returns the new item.
15697 * Add an evas object as an item to the menu.
15699 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);
15701 * @brief Set the label of a menu item
15703 * @param item The menu item object.
15704 * @param label The label to set for @p item
15706 * @warning Don't use this funcion on items created with
15707 * elm_menu_item_add_object() or elm_menu_item_separator_add().
15709 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15711 * @brief Get the label of a menu item
15713 * @param item The menu item object.
15714 * @return The label of @p item
15716 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15718 * @brief Set the icon of a menu item to the standard icon with name @p icon
15720 * @param item The menu item object.
15721 * @param icon The icon object to set for the content of @p item
15723 * Once this icon is set, any previously set icon will be deleted.
15725 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15727 * @brief Get the string representation from the icon of a menu item
15729 * @param item The menu item object.
15730 * @return The string representation of @p item's icon or NULL
15732 * @see elm_menu_item_object_icon_name_set()
15734 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15736 * @brief Set the content object of a menu item
15738 * @param item The menu item object
15739 * @param The content object or NULL
15740 * @return EINA_TRUE on success, else EINA_FALSE
15742 * Use this function to change the object swallowed by a menu item, deleting
15743 * any previously swallowed object.
15745 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
15747 * @brief Get the content object of a menu item
15749 * @param item The menu item object
15750 * @return The content object or NULL
15751 * @note If @p item was added with elm_menu_item_add_object, this
15752 * function will return the object passed, else it will return the
15755 * @see elm_menu_item_object_content_set()
15757 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15759 * @brief Set the selected state of @p item.
15761 * @param item The menu item object.
15762 * @param selected The selected/unselected state of the item
15764 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15766 * @brief Get the selected state of @p item.
15768 * @param item The menu item object.
15769 * @return The selected/unselected state of the item
15771 * @see elm_menu_item_selected_set()
15773 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15775 * @brief Set the disabled state of @p item.
15777 * @param item The menu item object.
15778 * @param disabled The enabled/disabled state of the item
15780 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15782 * @brief Get the disabled state of @p item.
15784 * @param item The menu item object.
15785 * @return The enabled/disabled state of the item
15787 * @see elm_menu_item_disabled_set()
15789 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15791 * @brief Add a separator item to menu @p obj under @p parent.
15793 * @param obj The menu object
15794 * @param parent The item to add the separator under
15795 * @return The created item or NULL on failure
15797 * This is item is a @ref Separator.
15799 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
15801 * @brief Returns whether @p item is a separator.
15803 * @param item The item to check
15804 * @return If true, @p item is a separator
15806 * @see elm_menu_item_separator_add()
15808 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15810 * @brief Deletes an item from the menu.
15812 * @param item The item to delete.
15814 * @see elm_menu_item_add()
15816 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15818 * @brief Set the function called when a menu item is deleted.
15820 * @param item The item to set the callback on
15821 * @param func The function called
15823 * @see elm_menu_item_add()
15824 * @see elm_menu_item_del()
15826 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15828 * @brief Returns the data associated with menu item @p item.
15830 * @param item The item
15831 * @return The data associated with @p item or NULL if none was set.
15833 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
15835 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15837 * @brief Sets the data to be associated with menu item @p item.
15839 * @param item The item
15840 * @param data The data to be associated with @p item
15842 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
15844 * @brief Returns a list of @p item's subitems.
15846 * @param item The item
15847 * @return An Eina_List* of @p item's subitems
15849 * @see elm_menu_add()
15851 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15853 * @brief Get the position of a menu item
15855 * @param item The menu item
15856 * @return The item's index
15858 * This function returns the index position of a menu item in a menu.
15859 * For a sub-menu, this number is relative to the first item in the sub-menu.
15861 * @note Index values begin with 0
15863 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
15865 * @brief @brief Return a menu item's owner menu
15867 * @param item The menu item
15868 * @return The menu object owning @p item, or NULL on failure
15870 * Use this function to get the menu object owning an item.
15872 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
15874 * @brief Get the selected item in the menu
15876 * @param obj The menu object
15877 * @return The selected item, or NULL if none
15879 * @see elm_menu_item_selected_get()
15880 * @see elm_menu_item_selected_set()
15882 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15884 * @brief Get the last item in the menu
15886 * @param obj The menu object
15887 * @return The last item, or NULL if none
15889 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15891 * @brief Get the first item in the menu
15893 * @param obj The menu object
15894 * @return The first item, or NULL if none
15896 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15898 * @brief Get the next item in the menu.
15900 * @param item The menu item object.
15901 * @return The item after it, or NULL if none
15903 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15905 * @brief Get the previous item in the menu.
15907 * @param item The menu item object.
15908 * @return The item before it, or NULL if none
15910 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15916 * @defgroup List List
15917 * @ingroup Elementary
15919 * @image html img/widget/list/preview-00.png
15920 * @image latex img/widget/list/preview-00.eps width=\textwidth
15922 * @image html img/list.png
15923 * @image latex img/list.eps width=\textwidth
15925 * A list widget is a container whose children are displayed vertically or
15926 * horizontally, in order, and can be selected.
15927 * The list can accept only one or multiple items selection. Also has many
15928 * modes of items displaying.
15930 * A list is a very simple type of list widget. For more robust
15931 * lists, @ref Genlist should probably be used.
15933 * Smart callbacks one can listen to:
15934 * - @c "activated" - The user has double-clicked or pressed
15935 * (enter|return|spacebar) on an item. The @c event_info parameter
15936 * is the item that was activated.
15937 * - @c "clicked,double" - The user has double-clicked an item.
15938 * The @c event_info parameter is the item that was double-clicked.
15939 * - "selected" - when the user selected an item
15940 * - "unselected" - when the user unselected an item
15941 * - "longpressed" - an item in the list is long-pressed
15942 * - "edge,top" - the list is scrolled until the top edge
15943 * - "edge,bottom" - the list is scrolled until the bottom edge
15944 * - "edge,left" - the list is scrolled until the left edge
15945 * - "edge,right" - the list is scrolled until the right edge
15946 * - "language,changed" - the program's language changed
15948 * Available styles for it:
15951 * List of examples:
15952 * @li @ref list_example_01
15953 * @li @ref list_example_02
15954 * @li @ref list_example_03
15963 * @enum _Elm_List_Mode
15964 * @typedef Elm_List_Mode
15966 * Set list's resize behavior, transverse axis scroll and
15967 * items cropping. See each mode's description for more details.
15969 * @note Default value is #ELM_LIST_SCROLL.
15971 * Values <b> don't </b> work as bitmask, only one can be choosen.
15973 * @see elm_list_mode_set()
15974 * @see elm_list_mode_get()
15978 typedef enum _Elm_List_Mode
15980 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. */
15981 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). */
15982 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. */
15983 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. */
15984 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
15987 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(). */
15990 * Add a new list widget to the given parent Elementary
15991 * (container) object.
15993 * @param parent The parent object.
15994 * @return a new list widget handle or @c NULL, on errors.
15996 * This function inserts a new list widget on the canvas.
16000 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16005 * @param obj The list object
16007 * @note Call before running show() on the list object.
16008 * @warning If not called, it won't display the list properly.
16011 * li = elm_list_add(win);
16012 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16013 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16015 * evas_object_show(li);
16020 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16023 * Enable or disable multiple items selection on the list object.
16025 * @param obj The list object
16026 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16029 * Disabled by default. If disabled, the user can select a single item of
16030 * the list each time. Selected items are highlighted on list.
16031 * If enabled, many items can be selected.
16033 * If a selected item is selected again, it will be unselected.
16035 * @see elm_list_multi_select_get()
16039 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16042 * Get a value whether multiple items selection is enabled or not.
16044 * @see elm_list_multi_select_set() for details.
16046 * @param obj The list object.
16047 * @return @c EINA_TRUE means multiple items selection is enabled.
16048 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16049 * @c EINA_FALSE is returned.
16053 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16056 * Set which mode to use for the list object.
16058 * @param obj The list object
16059 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16060 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16062 * Set list's resize behavior, transverse axis scroll and
16063 * items cropping. See each mode's description for more details.
16065 * @note Default value is #ELM_LIST_SCROLL.
16067 * Only one can be set, if a previous one was set, it will be changed
16068 * by the new mode set. Bitmask won't work as well.
16070 * @see elm_list_mode_get()
16074 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16077 * Get the mode the list is at.
16079 * @param obj The list object
16080 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16081 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16083 * @note see elm_list_mode_set() for more information.
16087 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16090 * Enable or disable horizontal mode on the list object.
16092 * @param obj The list object.
16093 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16094 * disable it, i.e., to enable vertical mode.
16096 * @note Vertical mode is set by default.
16098 * On horizontal mode items are displayed on list from left to right,
16099 * instead of from top to bottom. Also, the list will scroll horizontally.
16100 * Each item will presents left icon on top and right icon, or end, at
16103 * @see elm_list_horizontal_get()
16107 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16110 * Get a value whether horizontal mode is enabled or not.
16112 * @param obj The list object.
16113 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16114 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16115 * @c EINA_FALSE is returned.
16117 * @see elm_list_horizontal_set() for details.
16121 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16124 * Enable or disable always select mode on the list object.
16126 * @param obj The list object
16127 * @param always_select @c EINA_TRUE to enable always select mode or
16128 * @c EINA_FALSE to disable it.
16130 * @note Always select mode is disabled by default.
16132 * Default behavior of list items is to only call its callback function
16133 * the first time it's pressed, i.e., when it is selected. If a selected
16134 * item is pressed again, and multi-select is disabled, it won't call
16135 * this function (if multi-select is enabled it will unselect the item).
16137 * If always select is enabled, it will call the callback function
16138 * everytime a item is pressed, so it will call when the item is selected,
16139 * and again when a selected item is pressed.
16141 * @see elm_list_always_select_mode_get()
16142 * @see elm_list_multi_select_set()
16146 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16149 * Get a value whether always select mode is enabled or not, meaning that
16150 * an item will always call its callback function, even if already selected.
16152 * @param obj The list object
16153 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16154 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16155 * @c EINA_FALSE is returned.
16157 * @see elm_list_always_select_mode_set() for details.
16161 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16164 * Set bouncing behaviour when the scrolled content reaches an edge.
16166 * Tell the internal scroller object whether it should bounce or not
16167 * when it reaches the respective edges for each axis.
16169 * @param obj The list object
16170 * @param h_bounce Whether to bounce or not in the horizontal axis.
16171 * @param v_bounce Whether to bounce or not in the vertical axis.
16173 * @see elm_scroller_bounce_set()
16177 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16180 * Get the bouncing behaviour of the internal scroller.
16182 * Get whether the internal scroller should bounce when the edge of each
16183 * axis is reached scrolling.
16185 * @param obj The list object.
16186 * @param h_bounce Pointer where to store the bounce state of the horizontal
16188 * @param v_bounce Pointer where to store the bounce state of the vertical
16191 * @see elm_scroller_bounce_get()
16192 * @see elm_list_bounce_set()
16196 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16199 * Set the scrollbar policy.
16201 * @param obj The list object
16202 * @param policy_h Horizontal scrollbar policy.
16203 * @param policy_v Vertical scrollbar policy.
16205 * This sets the scrollbar visibility policy for the given scroller.
16206 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16207 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16208 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16209 * This applies respectively for the horizontal and vertical scrollbars.
16211 * The both are disabled by default, i.e., are set to
16212 * #ELM_SCROLLER_POLICY_OFF.
16216 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16219 * Get the scrollbar policy.
16221 * @see elm_list_scroller_policy_get() for details.
16223 * @param obj The list object.
16224 * @param policy_h Pointer where to store horizontal scrollbar policy.
16225 * @param policy_v Pointer where to store vertical scrollbar policy.
16229 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);
16232 * Append a new item to the list object.
16234 * @param obj The list object.
16235 * @param label The label of the list item.
16236 * @param icon The icon object to use for the left side of the item. An
16237 * icon can be any Evas object, but usually it is an icon created
16238 * with elm_icon_add().
16239 * @param end The icon object to use for the right side of the item. An
16240 * icon can be any Evas object.
16241 * @param func The function to call when the item is clicked.
16242 * @param data The data to associate with the item for related callbacks.
16244 * @return The created item or @c NULL upon failure.
16246 * A new item will be created and appended to the list, i.e., will
16247 * be set as @b last item.
16249 * Items created with this method can be deleted with
16250 * elm_list_item_del().
16252 * Associated @p data can be properly freed when item is deleted if a
16253 * callback function is set with elm_list_item_del_cb_set().
16255 * If a function is passed as argument, it will be called everytime this item
16256 * is selected, i.e., the user clicks over an unselected item.
16257 * If always select is enabled it will call this function every time
16258 * user clicks over an item (already selected or not).
16259 * If such function isn't needed, just passing
16260 * @c NULL as @p func is enough. The same should be done for @p data.
16262 * Simple example (with no function callback or data associated):
16264 * li = elm_list_add(win);
16265 * ic = elm_icon_add(win);
16266 * elm_icon_file_set(ic, "path/to/image", NULL);
16267 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16268 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16270 * evas_object_show(li);
16273 * @see elm_list_always_select_mode_set()
16274 * @see elm_list_item_del()
16275 * @see elm_list_item_del_cb_set()
16276 * @see elm_list_clear()
16277 * @see elm_icon_add()
16281 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);
16284 * Prepend a new item to the list object.
16286 * @param obj The list object.
16287 * @param label The label of the list item.
16288 * @param icon The icon object to use for the left side of the item. An
16289 * icon can be any Evas object, but usually it is an icon created
16290 * with elm_icon_add().
16291 * @param end The icon object to use for the right side of the item. An
16292 * icon can be any Evas object.
16293 * @param func The function to call when the item is clicked.
16294 * @param data The data to associate with the item for related callbacks.
16296 * @return The created item or @c NULL upon failure.
16298 * A new item will be created and prepended to the list, i.e., will
16299 * be set as @b first item.
16301 * Items created with this method can be deleted with
16302 * elm_list_item_del().
16304 * Associated @p data can be properly freed when item is deleted if a
16305 * callback function is set with elm_list_item_del_cb_set().
16307 * If a function is passed as argument, it will be called everytime this item
16308 * is selected, i.e., the user clicks over an unselected item.
16309 * If always select is enabled it will call this function every time
16310 * user clicks over an item (already selected or not).
16311 * If such function isn't needed, just passing
16312 * @c NULL as @p func is enough. The same should be done for @p data.
16314 * @see elm_list_item_append() for a simple code example.
16315 * @see elm_list_always_select_mode_set()
16316 * @see elm_list_item_del()
16317 * @see elm_list_item_del_cb_set()
16318 * @see elm_list_clear()
16319 * @see elm_icon_add()
16323 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);
16326 * Insert a new item into the list object before item @p before.
16328 * @param obj The list object.
16329 * @param before The list item to insert before.
16330 * @param label The label of the list item.
16331 * @param icon The icon object to use for the left side of the item. An
16332 * icon can be any Evas object, but usually it is an icon created
16333 * with elm_icon_add().
16334 * @param end The icon object to use for the right side of the item. An
16335 * icon can be any Evas object.
16336 * @param func The function to call when the item is clicked.
16337 * @param data The data to associate with the item for related callbacks.
16339 * @return The created item or @c NULL upon failure.
16341 * A new item will be created and added to the list. Its position in
16342 * this list will be just before item @p before.
16344 * Items created with this method can be deleted with
16345 * elm_list_item_del().
16347 * Associated @p data can be properly freed when item is deleted if a
16348 * callback function is set with elm_list_item_del_cb_set().
16350 * If a function is passed as argument, it will be called everytime this item
16351 * is selected, i.e., the user clicks over an unselected item.
16352 * If always select is enabled it will call this function every time
16353 * user clicks over an item (already selected or not).
16354 * If such function isn't needed, just passing
16355 * @c NULL as @p func is enough. The same should be done for @p data.
16357 * @see elm_list_item_append() for a simple code example.
16358 * @see elm_list_always_select_mode_set()
16359 * @see elm_list_item_del()
16360 * @see elm_list_item_del_cb_set()
16361 * @see elm_list_clear()
16362 * @see elm_icon_add()
16366 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);
16369 * Insert a new item into the list object after item @p after.
16371 * @param obj The list object.
16372 * @param after The list item to insert after.
16373 * @param label The label of the list item.
16374 * @param icon The icon object to use for the left side of the item. An
16375 * icon can be any Evas object, but usually it is an icon created
16376 * with elm_icon_add().
16377 * @param end The icon object to use for the right side of the item. An
16378 * icon can be any Evas object.
16379 * @param func The function to call when the item is clicked.
16380 * @param data The data to associate with the item for related callbacks.
16382 * @return The created item or @c NULL upon failure.
16384 * A new item will be created and added to the list. Its position in
16385 * this list will be just after item @p after.
16387 * Items created with this method can be deleted with
16388 * elm_list_item_del().
16390 * Associated @p data can be properly freed when item is deleted if a
16391 * callback function is set with elm_list_item_del_cb_set().
16393 * If a function is passed as argument, it will be called everytime this item
16394 * is selected, i.e., the user clicks over an unselected item.
16395 * If always select is enabled it will call this function every time
16396 * user clicks over an item (already selected or not).
16397 * If such function isn't needed, just passing
16398 * @c NULL as @p func is enough. The same should be done for @p data.
16400 * @see elm_list_item_append() for a simple code example.
16401 * @see elm_list_always_select_mode_set()
16402 * @see elm_list_item_del()
16403 * @see elm_list_item_del_cb_set()
16404 * @see elm_list_clear()
16405 * @see elm_icon_add()
16409 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);
16412 * Insert a new item into the sorted list object.
16414 * @param obj The list object.
16415 * @param label The label of the list item.
16416 * @param icon The icon object to use for the left side of the item. An
16417 * icon can be any Evas object, but usually it is an icon created
16418 * with elm_icon_add().
16419 * @param end The icon object to use for the right side of the item. An
16420 * icon can be any Evas object.
16421 * @param func The function to call when the item is clicked.
16422 * @param data The data to associate with the item for related callbacks.
16423 * @param cmp_func The comparing function to be used to sort list
16424 * items <b>by #Elm_List_Item item handles</b>. This function will
16425 * receive two items and compare them, returning a non-negative integer
16426 * if the second item should be place after the first, or negative value
16427 * if should be placed before.
16429 * @return The created item or @c NULL upon failure.
16431 * @note This function inserts values into a list object assuming it was
16432 * sorted and the result will be sorted.
16434 * A new item will be created and added to the list. Its position in
16435 * this list will be found comparing the new item with previously inserted
16436 * items using function @p cmp_func.
16438 * Items created with this method can be deleted with
16439 * elm_list_item_del().
16441 * Associated @p data can be properly freed when item is deleted if a
16442 * callback function is set with elm_list_item_del_cb_set().
16444 * If a function is passed as argument, it will be called everytime this item
16445 * is selected, i.e., the user clicks over an unselected item.
16446 * If always select is enabled it will call this function every time
16447 * user clicks over an item (already selected or not).
16448 * If such function isn't needed, just passing
16449 * @c NULL as @p func is enough. The same should be done for @p data.
16451 * @see elm_list_item_append() for a simple code example.
16452 * @see elm_list_always_select_mode_set()
16453 * @see elm_list_item_del()
16454 * @see elm_list_item_del_cb_set()
16455 * @see elm_list_clear()
16456 * @see elm_icon_add()
16460 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);
16463 * Remove all list's items.
16465 * @param obj The list object
16467 * @see elm_list_item_del()
16468 * @see elm_list_item_append()
16472 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16475 * Get a list of all the list items.
16477 * @param obj The list object
16478 * @return An @c Eina_List of list items, #Elm_List_Item,
16479 * or @c NULL on failure.
16481 * @see elm_list_item_append()
16482 * @see elm_list_item_del()
16483 * @see elm_list_clear()
16487 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16490 * Get the selected item.
16492 * @param obj The list object.
16493 * @return The selected list item.
16495 * The selected item can be unselected with function
16496 * elm_list_item_selected_set().
16498 * The selected item always will be highlighted on list.
16500 * @see elm_list_selected_items_get()
16504 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16507 * Return a list of the currently selected list items.
16509 * @param obj The list object.
16510 * @return An @c Eina_List of list items, #Elm_List_Item,
16511 * or @c NULL on failure.
16513 * Multiple items can be selected if multi select is enabled. It can be
16514 * done with elm_list_multi_select_set().
16516 * @see elm_list_selected_item_get()
16517 * @see elm_list_multi_select_set()
16521 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16524 * Set the selected state of an item.
16526 * @param item The list item
16527 * @param selected The selected state
16529 * This sets the selected state of the given item @p it.
16530 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16532 * If a new item is selected the previosly selected will be unselected,
16533 * unless multiple selection is enabled with elm_list_multi_select_set().
16534 * Previoulsy selected item can be get with function
16535 * elm_list_selected_item_get().
16537 * Selected items will be highlighted.
16539 * @see elm_list_item_selected_get()
16540 * @see elm_list_selected_item_get()
16541 * @see elm_list_multi_select_set()
16545 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16548 * Get whether the @p item is selected or not.
16550 * @param item The list item.
16551 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16552 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16554 * @see elm_list_selected_item_set() for details.
16555 * @see elm_list_item_selected_get()
16559 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16562 * Set or unset item as a separator.
16564 * @param it The list item.
16565 * @param setting @c EINA_TRUE to set item @p it as separator or
16566 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16568 * Items aren't set as separator by default.
16570 * If set as separator it will display separator theme, so won't display
16573 * @see elm_list_item_separator_get()
16577 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16580 * Get a value whether item is a separator or not.
16582 * @see elm_list_item_separator_set() for details.
16584 * @param it The list item.
16585 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16586 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16590 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16593 * Show @p item in the list view.
16595 * @param item The list item to be shown.
16597 * It won't animate list until item is visible. If such behavior is wanted,
16598 * use elm_list_bring_in() intead.
16602 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16605 * Bring in the given item to list view.
16607 * @param item The item.
16609 * This causes list to jump to the given item @p item and show it
16610 * (by scrolling), if it is not fully visible.
16612 * This may use animation to do so and take a period of time.
16614 * If animation isn't wanted, elm_list_item_show() can be used.
16618 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16621 * Delete them item from the list.
16623 * @param item The item of list to be deleted.
16625 * If deleting all list items is required, elm_list_clear()
16626 * should be used instead of getting items list and deleting each one.
16628 * @see elm_list_clear()
16629 * @see elm_list_item_append()
16630 * @see elm_list_item_del_cb_set()
16634 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16637 * Set the function called when a list item is freed.
16639 * @param item The item to set the callback on
16640 * @param func The function called
16642 * If there is a @p func, then it will be called prior item's memory release.
16643 * That will be called with the following arguments:
16645 * @li item's Evas object;
16648 * This way, a data associated to a list item could be properly freed.
16652 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16655 * Get the data associated to the item.
16657 * @param item The list item
16658 * @return The data associated to @p item
16660 * The return value is a pointer to data associated to @p item when it was
16661 * created, with function elm_list_item_append() or similar. If no data
16662 * was passed as argument, it will return @c NULL.
16664 * @see elm_list_item_append()
16668 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16671 * Get the left side icon associated to the item.
16673 * @param item The list item
16674 * @return The left side icon associated to @p item
16676 * The return value is a pointer to the icon associated to @p item when
16678 * created, with function elm_list_item_append() or similar, or later
16679 * with function elm_list_item_icon_set(). If no icon
16680 * was passed as argument, it will return @c NULL.
16682 * @see elm_list_item_append()
16683 * @see elm_list_item_icon_set()
16687 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16690 * Set the left side icon associated to the item.
16692 * @param item The list item
16693 * @param icon The left side icon object to associate with @p item
16695 * The icon object to use at left side of the item. An
16696 * icon can be any Evas object, but usually it is an icon created
16697 * with elm_icon_add().
16699 * Once the icon object is set, a previously set one will be deleted.
16700 * @warning Setting the same icon for two items will cause the icon to
16701 * dissapear from the first item.
16703 * If an icon was passed as argument on item creation, with function
16704 * elm_list_item_append() or similar, it will be already
16705 * associated to the item.
16707 * @see elm_list_item_append()
16708 * @see elm_list_item_icon_get()
16712 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16715 * Get the right side icon associated to the item.
16717 * @param item The list item
16718 * @return The right side icon associated to @p item
16720 * The return value is a pointer to the icon associated to @p item when
16722 * created, with function elm_list_item_append() or similar, or later
16723 * with function elm_list_item_icon_set(). If no icon
16724 * was passed as argument, it will return @c NULL.
16726 * @see elm_list_item_append()
16727 * @see elm_list_item_icon_set()
16731 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16734 * Set the right side icon associated to the item.
16736 * @param item The list item
16737 * @param end The right side icon object to associate with @p item
16739 * The icon object to use at right side of the item. An
16740 * icon can be any Evas object, but usually it is an icon created
16741 * with elm_icon_add().
16743 * Once the icon object is set, a previously set one will be deleted.
16744 * @warning Setting the same icon for two items will cause the icon to
16745 * dissapear from the first item.
16747 * If an icon was passed as argument on item creation, with function
16748 * elm_list_item_append() or similar, it will be already
16749 * associated to the item.
16751 * @see elm_list_item_append()
16752 * @see elm_list_item_end_get()
16756 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
16759 * Gets the base object of the item.
16761 * @param item The list item
16762 * @return The base object associated with @p item
16764 * Base object is the @c Evas_Object that represents that item.
16768 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16769 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16772 * Get the label of item.
16774 * @param item The item of list.
16775 * @return The label of item.
16777 * The return value is a pointer to the label associated to @p item when
16778 * it was created, with function elm_list_item_append(), or later
16779 * with function elm_list_item_label_set. If no label
16780 * was passed as argument, it will return @c NULL.
16782 * @see elm_list_item_label_set() for more details.
16783 * @see elm_list_item_append()
16787 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16790 * Set the label of item.
16792 * @param item The item of list.
16793 * @param text The label of item.
16795 * The label to be displayed by the item.
16796 * Label will be placed between left and right side icons (if set).
16798 * If a label was passed as argument on item creation, with function
16799 * elm_list_item_append() or similar, it will be already
16800 * displayed by the item.
16802 * @see elm_list_item_label_get()
16803 * @see elm_list_item_append()
16807 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16811 * Get the item before @p it in list.
16813 * @param it The list item.
16814 * @return The item before @p it, or @c NULL if none or on failure.
16816 * @note If it is the first item, @c NULL will be returned.
16818 * @see elm_list_item_append()
16819 * @see elm_list_items_get()
16823 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16826 * Get the item after @p it in list.
16828 * @param it The list item.
16829 * @return The item after @p it, or @c NULL if none or on failure.
16831 * @note If it is the last item, @c NULL will be returned.
16833 * @see elm_list_item_append()
16834 * @see elm_list_items_get()
16838 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16841 * Sets the disabled/enabled state of a list item.
16843 * @param it The item.
16844 * @param disabled The disabled state.
16846 * A disabled item cannot be selected or unselected. It will also
16847 * change its appearance (generally greyed out). This sets the
16848 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
16853 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16856 * Get a value whether list item is disabled or not.
16858 * @param it The item.
16859 * @return The disabled state.
16861 * @see elm_list_item_disabled_set() for more details.
16865 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16868 * Set the text to be shown in a given list item's tooltips.
16870 * @param item Target item.
16871 * @param text The text to set in the content.
16873 * Setup the text as tooltip to object. The item can have only one tooltip,
16874 * so any previous tooltip data - set with this function or
16875 * elm_list_item_tooltip_content_cb_set() - is removed.
16877 * @see elm_object_tooltip_text_set() for more details.
16881 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16885 * @brief Disable size restrictions on an object's tooltip
16886 * @param item The tooltip's anchor object
16887 * @param disable If EINA_TRUE, size restrictions are disabled
16888 * @return EINA_FALSE on failure, EINA_TRUE on success
16890 * This function allows a tooltip to expand beyond 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_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
16895 * @brief Retrieve size restriction state of an object's tooltip
16896 * @param obj The tooltip's anchor object
16897 * @return If EINA_TRUE, size restrictions are disabled
16899 * This function returns whether a tooltip is allowed to expand beyond
16900 * its parant window's canvas.
16901 * It will instead be limited only by the size of the display.
16903 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16906 * Set the content to be shown in the tooltip item.
16908 * Setup the tooltip to item. The item can have only one tooltip,
16909 * so any previous tooltip data is removed. @p func(with @p data) will
16910 * be called every time that need show the tooltip and it should
16911 * return a valid Evas_Object. This object is then managed fully by
16912 * tooltip system and is deleted when the tooltip is gone.
16914 * @param item the list item being attached a tooltip.
16915 * @param func the function used to create the tooltip contents.
16916 * @param data what to provide to @a func as callback data/context.
16917 * @param del_cb called when data is not needed anymore, either when
16918 * another callback replaces @a func, the tooltip is unset with
16919 * elm_list_item_tooltip_unset() or the owner @a item
16920 * dies. This callback receives as the first parameter the
16921 * given @a data, and @c event_info is the item.
16923 * @see elm_object_tooltip_content_cb_set() for more details.
16927 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);
16930 * Unset tooltip from item.
16932 * @param item list item to remove previously set tooltip.
16934 * Remove tooltip from item. The callback provided as del_cb to
16935 * elm_list_item_tooltip_content_cb_set() will be called to notify
16936 * it is not used anymore.
16938 * @see elm_object_tooltip_unset() for more details.
16939 * @see elm_list_item_tooltip_content_cb_set()
16943 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16946 * Sets a different style for this item tooltip.
16948 * @note before you set a style you should define a tooltip with
16949 * elm_list_item_tooltip_content_cb_set() or
16950 * elm_list_item_tooltip_text_set()
16952 * @param item list item with tooltip already set.
16953 * @param style the theme style to use (default, transparent, ...)
16955 * @see elm_object_tooltip_style_set() for more details.
16959 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
16962 * Get the style for this item tooltip.
16964 * @param item list item with tooltip already set.
16965 * @return style the theme style in use, defaults to "default". If the
16966 * object does not have a tooltip set, then NULL is returned.
16968 * @see elm_object_tooltip_style_get() for more details.
16969 * @see elm_list_item_tooltip_style_set()
16973 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16976 * Set the type of mouse pointer/cursor decoration to be shown,
16977 * when the mouse pointer is over the given list widget item
16979 * @param item list item to customize cursor on
16980 * @param cursor the cursor type's name
16982 * This function works analogously as elm_object_cursor_set(), but
16983 * here the cursor's changing area is restricted to the item's
16984 * area, and not the whole widget's. Note that that item cursors
16985 * have precedence over widget cursors, so that a mouse over an
16986 * item with custom cursor set will always show @b that cursor.
16988 * If this function is called twice for an object, a previously set
16989 * cursor will be unset on the second call.
16991 * @see elm_object_cursor_set()
16992 * @see elm_list_item_cursor_get()
16993 * @see elm_list_item_cursor_unset()
16997 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17000 * Get the type of mouse pointer/cursor decoration set to be shown,
17001 * when the mouse pointer is over the given list widget item
17003 * @param item list item with custom cursor set
17004 * @return the cursor type's name or @c NULL, if no custom cursors
17005 * were set to @p item (and on errors)
17007 * @see elm_object_cursor_get()
17008 * @see elm_list_item_cursor_set()
17009 * @see elm_list_item_cursor_unset()
17013 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17016 * Unset any custom mouse pointer/cursor decoration set to be
17017 * shown, when the mouse pointer is over the given list widget
17018 * item, thus making it show the @b default cursor again.
17020 * @param item a list item
17022 * Use this call to undo any custom settings on this item's cursor
17023 * decoration, bringing it back to defaults (no custom style set).
17025 * @see elm_object_cursor_unset()
17026 * @see elm_list_item_cursor_set()
17030 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17033 * Set a different @b style for a given custom cursor set for a
17036 * @param item list item with custom cursor set
17037 * @param style the <b>theme style</b> to use (e.g. @c "default",
17038 * @c "transparent", etc)
17040 * This function only makes sense when one is using custom mouse
17041 * cursor decorations <b>defined in a theme file</b>, which can have,
17042 * given a cursor name/type, <b>alternate styles</b> on it. It
17043 * works analogously as elm_object_cursor_style_set(), but here
17044 * applyed only to list item objects.
17046 * @warning Before you set a cursor style you should have definen a
17047 * custom cursor previously on the item, with
17048 * elm_list_item_cursor_set()
17050 * @see elm_list_item_cursor_engine_only_set()
17051 * @see elm_list_item_cursor_style_get()
17055 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17058 * Get the current @b style set for a given list item's custom
17061 * @param item list item with custom cursor set.
17062 * @return style the cursor style in use. If the object does not
17063 * have a cursor set, then @c NULL is returned.
17065 * @see elm_list_item_cursor_style_set() for more details
17069 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17072 * Set if the (custom)cursor for a given list item should be
17073 * searched in its theme, also, or should only rely on the
17074 * rendering engine.
17076 * @param item item with custom (custom) cursor already set on
17077 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17078 * only on those provided by the rendering engine, @c EINA_FALSE to
17079 * have them searched on the widget's theme, as well.
17081 * @note This call is of use only if you've set a custom cursor
17082 * for list items, with elm_list_item_cursor_set().
17084 * @note By default, cursors will only be looked for between those
17085 * provided by the rendering engine.
17089 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17092 * Get if the (custom) cursor for a given list item is being
17093 * searched in its theme, also, or is only relying on the rendering
17096 * @param item a list item
17097 * @return @c EINA_TRUE, if cursors are being looked for only on
17098 * those provided by the rendering engine, @c EINA_FALSE if they
17099 * are being searched on the widget's theme, as well.
17101 * @see elm_list_item_cursor_engine_only_set(), for more details
17105 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17112 * @defgroup Slider Slider
17113 * @ingroup Elementary
17115 * @image html img/widget/slider/preview-00.png
17116 * @image latex img/widget/slider/preview-00.eps width=\textwidth
17118 * The slider adds a dragable “slider” widget for selecting the value of
17119 * something within a range.
17121 * A slider can be horizontal or vertical. It can contain an Icon and has a
17122 * primary label as well as a units label (that is formatted with floating
17123 * point values and thus accepts a printf-style format string, like
17124 * “%1.2f units”. There is also an indicator string that may be somewhere
17125 * else (like on the slider itself) that also accepts a format string like
17126 * units. Label, Icon Unit and Indicator strings/objects are optional.
17128 * A slider may be inverted which means values invert, with high vales being
17129 * on the left or top and low values on the right or bottom (as opposed to
17130 * normally being low on the left or top and high on the bottom and right).
17132 * The slider should have its minimum and maximum values set by the
17133 * application with elm_slider_min_max_set() and value should also be set by
17134 * the application before use with elm_slider_value_set(). The span of the
17135 * slider is its length (horizontally or vertically). This will be scaled by
17136 * the object or applications scaling factor. At any point code can query the
17137 * slider for its value with elm_slider_value_get().
17139 * Smart callbacks one can listen to:
17140 * - "changed" - Whenever the slider value is changed by the user.
17141 * - "slider,drag,start" - dragging the slider indicator around has started.
17142 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17143 * - "delay,changed" - A short time after the value is changed by the user.
17144 * This will be called only when the user stops dragging for
17145 * a very short period or when they release their
17146 * finger/mouse, so it avoids possibly expensive reactions to
17147 * the value change.
17149 * Available styles for it:
17152 * Here is an example on its usage:
17153 * @li @ref slider_example
17157 * @addtogroup Slider
17162 * Add a new slider widget to the given parent Elementary
17163 * (container) object.
17165 * @param parent The parent object.
17166 * @return a new slider widget handle or @c NULL, on errors.
17168 * This function inserts a new slider widget on the canvas.
17172 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17175 * Set the label of a given slider widget
17177 * @param obj The progress bar object
17178 * @param label The text label string, in UTF-8
17181 * @deprecated use elm_object_text_set() instead.
17183 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17186 * Get the label of a given slider widget
17188 * @param obj The progressbar object
17189 * @return The text label string, in UTF-8
17192 * @deprecated use elm_object_text_get() instead.
17194 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17197 * Set the icon object of the slider object.
17199 * @param obj The slider object.
17200 * @param icon The icon object.
17202 * On horizontal mode, icon is placed at left, and on vertical mode,
17205 * @note Once the icon object is set, a previously set one will be deleted.
17206 * If you want to keep that old content object, use the
17207 * elm_slider_icon_unset() function.
17209 * @warning If the object being set does not have minimum size hints set,
17210 * it won't get properly displayed.
17214 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17217 * Unset an icon set on a given slider widget.
17219 * @param obj The slider object.
17220 * @return The icon object that was being used, if any was set, or
17221 * @c NULL, otherwise (and on errors).
17223 * On horizontal mode, icon is placed at left, and on vertical mode,
17226 * This call will unparent and return the icon object which was set
17227 * for this widget, previously, on success.
17229 * @see elm_slider_icon_set() for more details
17230 * @see elm_slider_icon_get()
17234 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17237 * Retrieve the icon object set for a given slider widget.
17239 * @param obj The slider object.
17240 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17241 * otherwise (and on errors).
17243 * On horizontal mode, icon is placed at left, and on vertical mode,
17246 * @see elm_slider_icon_set() for more details
17247 * @see elm_slider_icon_unset()
17251 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17254 * Set the end object of the slider object.
17256 * @param obj The slider object.
17257 * @param end The end object.
17259 * On horizontal mode, end is placed at left, and on vertical mode,
17260 * placed at bottom.
17262 * @note Once the icon object is set, a previously set one will be deleted.
17263 * If you want to keep that old content object, use the
17264 * elm_slider_end_unset() function.
17266 * @warning If the object being set does not have minimum size hints set,
17267 * it won't get properly displayed.
17271 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17274 * Unset an end object set on a given slider widget.
17276 * @param obj The slider object.
17277 * @return The end object that was being used, if any was set, or
17278 * @c NULL, otherwise (and on errors).
17280 * On horizontal mode, end is placed at left, and on vertical mode,
17281 * placed at bottom.
17283 * This call will unparent and return the icon object which was set
17284 * for this widget, previously, on success.
17286 * @see elm_slider_end_set() for more details.
17287 * @see elm_slider_end_get()
17291 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17294 * Retrieve the end object set for a given slider widget.
17296 * @param obj The slider object.
17297 * @return The end object's handle, if @p obj had one set, or @c NULL,
17298 * otherwise (and on errors).
17300 * On horizontal mode, icon is placed at right, and on vertical mode,
17301 * placed at bottom.
17303 * @see elm_slider_end_set() for more details.
17304 * @see elm_slider_end_unset()
17308 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17311 * Set the (exact) length of the bar region of a given slider widget.
17313 * @param obj The slider object.
17314 * @param size The length of the slider's bar region.
17316 * This sets the minimum width (when in horizontal mode) or height
17317 * (when in vertical mode) of the actual bar area of the slider
17318 * @p obj. This in turn affects the object's minimum size. Use
17319 * this when you're not setting other size hints expanding on the
17320 * given direction (like weight and alignment hints) and you would
17321 * like it to have a specific size.
17323 * @note Icon, end, label, indicator and unit text around @p obj
17324 * will require their
17325 * own space, which will make @p obj to require more the @p size,
17328 * @see elm_slider_span_size_get()
17332 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17335 * Get the length set for the bar region of a given slider widget
17337 * @param obj The slider object.
17338 * @return The length of the slider's bar region.
17340 * If that size was not set previously, with
17341 * elm_slider_span_size_set(), this call will return @c 0.
17345 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17348 * Set the format string for the unit label.
17350 * @param obj The slider object.
17351 * @param format The format string for the unit display.
17353 * Unit label is displayed all the time, if set, after slider's bar.
17354 * In horizontal mode, at right and in vertical mode, at bottom.
17356 * If @c NULL, unit label won't be visible. If not it sets the format
17357 * string for the label text. To the label text is provided a floating point
17358 * value, so the label text can display up to 1 floating point value.
17359 * Note that this is optional.
17361 * Use a format string such as "%1.2f meters" for example, and it will
17362 * display values like: "3.14 meters" for a value equal to 3.14159.
17364 * Default is unit label disabled.
17366 * @see elm_slider_indicator_format_get()
17370 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17373 * Get the unit label format of the slider.
17375 * @param obj The slider object.
17376 * @return The unit label format string in UTF-8.
17378 * Unit label is displayed all the time, if set, after slider's bar.
17379 * In horizontal mode, at right and in vertical mode, at bottom.
17381 * @see elm_slider_unit_format_set() for more
17382 * information on how this works.
17386 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17389 * Set the format string for the indicator label.
17391 * @param obj The slider object.
17392 * @param indicator The format string for the indicator display.
17394 * The slider may display its value somewhere else then unit label,
17395 * for example, above the slider knob that is dragged around. This function
17396 * sets the format string used for this.
17398 * If @c NULL, indicator label won't be visible. If not it sets the format
17399 * string for the label text. To the label text is provided a floating point
17400 * value, so the label text can display up to 1 floating point value.
17401 * Note that this is optional.
17403 * Use a format string such as "%1.2f meters" for example, and it will
17404 * display values like: "3.14 meters" for a value equal to 3.14159.
17406 * Default is indicator label disabled.
17408 * @see elm_slider_indicator_format_get()
17412 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17415 * Get the indicator label format of the slider.
17417 * @param obj The slider object.
17418 * @return The indicator label format string in UTF-8.
17420 * The slider may display its value somewhere else then unit label,
17421 * for example, above the slider knob that is dragged around. This function
17422 * gets the format string used for this.
17424 * @see elm_slider_indicator_format_set() for more
17425 * information on how this works.
17429 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17432 * Set the format function pointer for the indicator label
17434 * @param obj The slider object.
17435 * @param func The indicator format function.
17436 * @param free_func The freeing function for the format string.
17438 * Set the callback function to format the indicator string.
17440 * @see elm_slider_indicator_format_set() for more info on how this works.
17444 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);
17447 * Set the format function pointer for the units label
17449 * @param obj The slider object.
17450 * @param func The units format function.
17451 * @param free_func The freeing function for the format string.
17453 * Set the callback function to format the indicator string.
17455 * @see elm_slider_units_format_set() for more info on how this works.
17459 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);
17462 * Set the orientation of a given slider widget.
17464 * @param obj The slider object.
17465 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17466 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17468 * Use this function to change how your slider is to be
17469 * disposed: vertically or horizontally.
17471 * By default it's displayed horizontally.
17473 * @see elm_slider_horizontal_get()
17477 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17480 * Retrieve the orientation of a given slider widget
17482 * @param obj The slider object.
17483 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17484 * @c EINA_FALSE if it's @b vertical (and on errors).
17486 * @see elm_slider_horizontal_set() for more details.
17490 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17493 * Set the minimum and maximum values for the slider.
17495 * @param obj The slider object.
17496 * @param min The minimum value.
17497 * @param max The maximum value.
17499 * Define the allowed range of values to be selected by the user.
17501 * If actual value is less than @p min, it will be updated to @p min. If it
17502 * is bigger then @p max, will be updated to @p max. Actual value can be
17503 * get with elm_slider_value_get().
17505 * By default, min is equal to 0.0, and max is equal to 1.0.
17507 * @warning Maximum must be greater than minimum, otherwise behavior
17510 * @see elm_slider_min_max_get()
17514 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17517 * Get the minimum and maximum values of the slider.
17519 * @param obj The slider object.
17520 * @param min Pointer where to store the minimum value.
17521 * @param max Pointer where to store the maximum value.
17523 * @note If only one value is needed, the other pointer can be passed
17526 * @see elm_slider_min_max_set() for details.
17530 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17533 * Set the value the slider displays.
17535 * @param obj The slider object.
17536 * @param val The value to be displayed.
17538 * Value will be presented on the unit label following format specified with
17539 * elm_slider_unit_format_set() and on indicator with
17540 * elm_slider_indicator_format_set().
17542 * @warning The value must to be between min and max values. This values
17543 * are set by elm_slider_min_max_set().
17545 * @see elm_slider_value_get()
17546 * @see elm_slider_unit_format_set()
17547 * @see elm_slider_indicator_format_set()
17548 * @see elm_slider_min_max_set()
17552 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17555 * Get the value displayed by the spinner.
17557 * @param obj The spinner object.
17558 * @return The value displayed.
17560 * @see elm_spinner_value_set() for details.
17564 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17567 * Invert a given slider widget's displaying values order
17569 * @param obj The slider object.
17570 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17571 * @c EINA_FALSE to bring it back to default, non-inverted values.
17573 * A slider may be @b inverted, in which state it gets its
17574 * values inverted, with high vales being on the left or top and
17575 * low values on the right or bottom, as opposed to normally have
17576 * the low values on the former and high values on the latter,
17577 * respectively, for horizontal and vertical modes.
17579 * @see elm_slider_inverted_get()
17583 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17586 * Get whether a given slider widget's displaying values are
17589 * @param obj The slider object.
17590 * @return @c EINA_TRUE, if @p obj has inverted values,
17591 * @c EINA_FALSE otherwise (and on errors).
17593 * @see elm_slider_inverted_set() for more details.
17597 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17600 * Set whether to enlarge slider indicator (augmented knob) or not.
17602 * @param obj The slider object.
17603 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17604 * let the knob always at default size.
17606 * By default, indicator will be bigger while dragged by the user.
17608 * @warning It won't display values set with
17609 * elm_slider_indicator_format_set() if you disable indicator.
17613 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17616 * Get whether a given slider widget's enlarging indicator or not.
17618 * @param obj The slider object.
17619 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17620 * @c EINA_FALSE otherwise (and on errors).
17622 * @see elm_slider_indicator_show_set() for details.
17626 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17633 * @addtogroup Actionslider Actionslider
17635 * @image html img/widget/actionslider/preview-00.png
17636 * @image latex img/widget/actionslider/preview-00.eps
17638 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
17639 * properties. The indicator is the element the user drags to choose a label.
17640 * When the position is set with magnet, when released the indicator will be
17641 * moved to it if it's nearest the magnetized position.
17643 * @note By default all positions are set as enabled.
17645 * Signals that you can add callbacks for are:
17647 * "selected" - when user selects an enabled position (the label is passed
17650 * "pos_changed" - when the indicator reaches any of the positions("left",
17651 * "right" or "center").
17653 * See an example of actionslider usage @ref actionslider_example_page "here"
17656 typedef enum _Elm_Actionslider_Pos
17658 ELM_ACTIONSLIDER_NONE = 0,
17659 ELM_ACTIONSLIDER_LEFT = 1 << 0,
17660 ELM_ACTIONSLIDER_CENTER = 1 << 1,
17661 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
17662 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
17663 } Elm_Actionslider_Pos;
17666 * Add a new actionslider to the parent.
17668 * @param parent The parent object
17669 * @return The new actionslider object or NULL if it cannot be created
17671 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17673 * Set actionslider labels.
17675 * @param obj The actionslider object
17676 * @param left_label The label to be set on the left.
17677 * @param center_label The label to be set on the center.
17678 * @param right_label The label to be set on the right.
17679 * @deprecated use elm_object_text_set() instead.
17681 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);
17683 * Get actionslider labels.
17685 * @param obj The actionslider object
17686 * @param left_label A char** to place the left_label of @p obj into.
17687 * @param center_label A char** to place the center_label of @p obj into.
17688 * @param right_label A char** to place the right_label of @p obj into.
17689 * @deprecated use elm_object_text_set() instead.
17691 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);
17693 * Get actionslider selected label.
17695 * @param obj The actionslider object
17696 * @return The selected label
17698 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17700 * Set actionslider indicator position.
17702 * @param obj The actionslider object.
17703 * @param pos The position of the indicator.
17705 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17707 * Get actionslider indicator position.
17709 * @param obj The actionslider object.
17710 * @return The position of the indicator.
17712 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17714 * Set actionslider magnet position. To make multiple positions magnets @c or
17715 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
17717 * @param obj The actionslider object.
17718 * @param pos Bit mask indicating the magnet positions.
17720 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17722 * Get actionslider magnet position.
17724 * @param obj The actionslider object.
17725 * @return The positions with magnet property.
17727 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17729 * Set actionslider enabled position. To set multiple positions as enabled @c or
17730 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
17732 * @note All the positions are enabled by default.
17734 * @param obj The actionslider object.
17735 * @param pos Bit mask indicating the enabled positions.
17737 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17739 * Get actionslider enabled position.
17741 * @param obj The actionslider object.
17742 * @return The enabled positions.
17744 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17746 * Set the label used on the indicator.
17748 * @param obj The actionslider object
17749 * @param label The label to be set on the indicator.
17750 * @deprecated use elm_object_text_set() instead.
17752 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17754 * Get the label used on the indicator object.
17756 * @param obj The actionslider object
17757 * @return The indicator label
17758 * @deprecated use elm_object_text_get() instead.
17760 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
17766 * @defgroup Genlist Genlist
17768 * @image html img/widget/genlist/preview-00.png
17769 * @image latex img/widget/genlist/preview-00.eps
17770 * @image html img/genlist.png
17771 * @image latex img/genlist.eps
17773 * This widget aims to have more expansive list than the simple list in
17774 * Elementary that could have more flexible items and allow many more entries
17775 * while still being fast and low on memory usage. At the same time it was
17776 * also made to be able to do tree structures. But the price to pay is more
17777 * complexity when it comes to usage. If all you want is a simple list with
17778 * icons and a single label, use the normal @ref List object.
17780 * Genlist has a fairly large API, mostly because it's relatively complex,
17781 * trying to be both expansive, powerful and efficient. First we will begin
17782 * an overview on the theory behind genlist.
17784 * @section Genlist_Item_Class Genlist item classes - creating items
17786 * In order to have the ability to add and delete items on the fly, genlist
17787 * implements a class (callback) system where the application provides a
17788 * structure with information about that type of item (genlist may contain
17789 * multiple different items with different classes, states and styles).
17790 * Genlist will call the functions in this struct (methods) when an item is
17791 * "realized" (i.e., created dynamically, while the user is scrolling the
17792 * grid). All objects will simply be deleted when no longer needed with
17793 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
17794 * following members:
17795 * - @c item_style - This is a constant string and simply defines the name
17796 * of the item style. It @b must be specified and the default should be @c
17799 * - @c func - A struct with pointers to functions that will be called when
17800 * an item is going to be actually created. All of them receive a @c data
17801 * parameter that will point to the same data passed to
17802 * elm_genlist_item_append() and related item creation functions, and a @c
17803 * obj parameter that points to the genlist object itself.
17805 * The function pointers inside @c func are @c label_get, @c icon_get, @c
17806 * state_get and @c del. The 3 first functions also receive a @c part
17807 * parameter described below. A brief description of these functions follows:
17809 * - @c label_get - The @c part parameter is the name string of one of the
17810 * existing text parts in the Edje group implementing the item's theme.
17811 * This function @b must return a strdup'()ed string, as the caller will
17812 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
17813 * - @c icon_get - The @c part parameter is the name string of one of the
17814 * existing (icon) swallow parts in the Edje group implementing the item's
17815 * theme. It must return @c NULL, when no icon is desired, or a valid
17816 * object handle, otherwise. The object will be deleted by the genlist on
17817 * its deletion or when the item is "unrealized". See
17818 * #Elm_Genlist_Item_Icon_Get_Cb.
17819 * - @c func.state_get - The @c part parameter is the name string of one of
17820 * the state parts in the Edje group implementing the item's theme. Return
17821 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
17822 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
17823 * and @c "elm" as "emission" and "source" arguments, respectively, when
17824 * the state is true (the default is false), where @c XXX is the name of
17825 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
17826 * - @c func.del - This is intended for use when genlist items are deleted,
17827 * so any data attached to the item (e.g. its data parameter on creation)
17828 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
17830 * available item styles:
17832 * - default_style - The text part is a textblock
17834 * @image html img/widget/genlist/preview-04.png
17835 * @image latex img/widget/genlist/preview-04.eps
17839 * @image html img/widget/genlist/preview-01.png
17840 * @image latex img/widget/genlist/preview-01.eps
17842 * - icon_top_text_bottom
17844 * @image html img/widget/genlist/preview-02.png
17845 * @image latex img/widget/genlist/preview-02.eps
17849 * @image html img/widget/genlist/preview-03.png
17850 * @image latex img/widget/genlist/preview-03.eps
17852 * @section Genlist_Items Structure of items
17854 * An item in a genlist can have 0 or more text labels (they can be regular
17855 * text or textblock Evas objects - that's up to the style to determine), 0
17856 * or more icons (which are simply objects swallowed into the genlist item's
17857 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
17858 * behavior left to the user to define. The Edje part names for each of
17859 * these properties will be looked up, in the theme file for the genlist,
17860 * under the Edje (string) data items named @c "labels", @c "icons" and @c
17861 * "states", respectively. For each of those properties, if more than one
17862 * part is provided, they must have names listed separated by spaces in the
17863 * data fields. For the default genlist item theme, we have @b one label
17864 * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
17865 * "elm.swallow.end") and @b no state parts.
17867 * A genlist item may be at one of several styles. Elementary provides one
17868 * by default - "default", but this can be extended by system or application
17869 * custom themes/overlays/extensions (see @ref Theme "themes" for more
17872 * @section Genlist_Manipulation Editing and Navigating
17874 * Items can be added by several calls. All of them return a @ref
17875 * Elm_Genlist_Item handle that is an internal member inside the genlist.
17876 * They all take a data parameter that is meant to be used for a handle to
17877 * the applications internal data (eg the struct with the original item
17878 * data). The parent parameter is the parent genlist item this belongs to if
17879 * it is a tree or an indexed group, and NULL if there is no parent. The
17880 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
17881 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
17882 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
17883 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
17884 * is set then this item is group index item that is displayed at the top
17885 * until the next group comes. The func parameter is a convenience callback
17886 * that is called when the item is selected and the data parameter will be
17887 * the func_data parameter, obj be the genlist object and event_info will be
17888 * the genlist item.
17890 * elm_genlist_item_append() adds an item to the end of the list, or if
17891 * there is a parent, to the end of all the child items of the parent.
17892 * elm_genlist_item_prepend() is the same but adds to the beginning of
17893 * the list or children list. elm_genlist_item_insert_before() inserts at
17894 * item before another item and elm_genlist_item_insert_after() inserts after
17895 * the indicated item.
17897 * The application can clear the list with elm_genlist_clear() which deletes
17898 * all the items in the list and elm_genlist_item_del() will delete a specific
17899 * item. elm_genlist_item_subitems_clear() will clear all items that are
17900 * children of the indicated parent item.
17902 * To help inspect list items you can jump to the item at the top of the list
17903 * with elm_genlist_first_item_get() which will return the item pointer, and
17904 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
17905 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
17906 * and previous items respectively relative to the indicated item. Using
17907 * these calls you can walk the entire item list/tree. Note that as a tree
17908 * the items are flattened in the list, so elm_genlist_item_parent_get() will
17909 * let you know which item is the parent (and thus know how to skip them if
17912 * @section Genlist_Muti_Selection Multi-selection
17914 * If the application wants multiple items to be able to be selected,
17915 * elm_genlist_multi_select_set() can enable this. If the list is
17916 * single-selection only (the default), then elm_genlist_selected_item_get()
17917 * will return the selected item, if any, or NULL I none is selected. If the
17918 * list is multi-select then elm_genlist_selected_items_get() will return a
17919 * list (that is only valid as long as no items are modified (added, deleted,
17920 * selected or unselected)).
17922 * @section Genlist_Usage_Hints Usage hints
17924 * There are also convenience functions. elm_genlist_item_genlist_get() will
17925 * return the genlist object the item belongs to. elm_genlist_item_show()
17926 * will make the scroller scroll to show that specific item so its visible.
17927 * elm_genlist_item_data_get() returns the data pointer set by the item
17928 * creation functions.
17930 * If an item changes (state of boolean changes, label or icons change),
17931 * then use elm_genlist_item_update() to have genlist update the item with
17932 * the new state. Genlist will re-realize the item thus call the functions
17933 * in the _Elm_Genlist_Item_Class for that item.
17935 * To programmatically (un)select an item use elm_genlist_item_selected_set().
17936 * To get its selected state use elm_genlist_item_selected_get(). Similarly
17937 * to expand/contract an item and get its expanded state, use
17938 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
17939 * again to make an item disabled (unable to be selected and appear
17940 * differently) use elm_genlist_item_disabled_set() to set this and
17941 * elm_genlist_item_disabled_get() to get the disabled state.
17943 * In general to indicate how the genlist should expand items horizontally to
17944 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
17945 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
17946 * mode means that if items are too wide to fit, the scroller will scroll
17947 * horizontally. Otherwise items are expanded to fill the width of the
17948 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
17949 * to the viewport width and limited to that size. This can be combined with
17950 * a different style that uses edjes' ellipsis feature (cutting text off like
17953 * Items will only call their selection func and callback when first becoming
17954 * selected. Any further clicks will do nothing, unless you enable always
17955 * select with elm_genlist_always_select_mode_set(). This means even if
17956 * selected, every click will make the selected callbacks be called.
17957 * elm_genlist_no_select_mode_set() will turn off the ability to select
17958 * items entirely and they will neither appear selected nor call selected
17959 * callback functions.
17961 * Remember that you can create new styles and add your own theme augmentation
17962 * per application with elm_theme_extension_add(). If you absolutely must
17963 * have a specific style that overrides any theme the user or system sets up
17964 * you can use elm_theme_overlay_add() to add such a file.
17966 * @section Genlist_Implementation Implementation
17968 * Evas tracks every object you create. Every time it processes an event
17969 * (mouse move, down, up etc.) it needs to walk through objects and find out
17970 * what event that affects. Even worse every time it renders display updates,
17971 * in order to just calculate what to re-draw, it needs to walk through many
17972 * many many objects. Thus, the more objects you keep active, the more
17973 * overhead Evas has in just doing its work. It is advisable to keep your
17974 * active objects to the minimum working set you need. Also remember that
17975 * object creation and deletion carries an overhead, so there is a
17976 * middle-ground, which is not easily determined. But don't keep massive lists
17977 * of objects you can't see or use. Genlist does this with list objects. It
17978 * creates and destroys them dynamically as you scroll around. It groups them
17979 * into blocks so it can determine the visibility etc. of a whole block at
17980 * once as opposed to having to walk the whole list. This 2-level list allows
17981 * for very large numbers of items to be in the list (tests have used up to
17982 * 2,000,000 items). Also genlist employs a queue for adding items. As items
17983 * may be different sizes, every item added needs to be calculated as to its
17984 * size and thus this presents a lot of overhead on populating the list, this
17985 * genlist employs a queue. Any item added is queued and spooled off over
17986 * time, actually appearing some time later, so if your list has many members
17987 * you may find it takes a while for them to all appear, with your process
17988 * consuming a lot of CPU while it is busy spooling.
17990 * Genlist also implements a tree structure, but it does so with callbacks to
17991 * the application, with the application filling in tree structures when
17992 * requested (allowing for efficient building of a very deep tree that could
17993 * even be used for file-management). See the above smart signal callbacks for
17996 * @section Genlist_Smart_Events Genlist smart events
17998 * Signals that you can add callbacks for are:
17999 * - @c "activated" - The user has double-clicked or pressed
18000 * (enter|return|spacebar) on an item. The @c event_info parameter is the
18001 * item that was activated.
18002 * - @c "clicked,double" - The user has double-clicked an item. The @c
18003 * event_info parameter is the item that was double-clicked.
18004 * - @c "selected" - This is called when a user has made an item selected.
18005 * The event_info parameter is the genlist item that was selected.
18006 * - @c "unselected" - This is called when a user has made an item
18007 * unselected. The event_info parameter is the genlist item that was
18009 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18010 * called and the item is now meant to be expanded. The event_info
18011 * parameter is the genlist item that was indicated to expand. It is the
18012 * job of this callback to then fill in the child items.
18013 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18014 * called and the item is now meant to be contracted. The event_info
18015 * parameter is the genlist item that was indicated to contract. It is the
18016 * job of this callback to then delete the child items.
18017 * - @c "expand,request" - This is called when a user has indicated they want
18018 * to expand a tree branch item. The callback should decide if the item can
18019 * expand (has any children) and then call elm_genlist_item_expanded_set()
18020 * appropriately to set the state. The event_info parameter is the genlist
18021 * item that was indicated to expand.
18022 * - @c "contract,request" - This is called when a user has indicated they
18023 * want to contract a tree branch item. The callback should decide if the
18024 * item can contract (has any children) and then call
18025 * elm_genlist_item_expanded_set() appropriately to set the state. The
18026 * event_info parameter is the genlist item that was indicated to contract.
18027 * - @c "realized" - This is called when the item in the list is created as a
18028 * real evas object. event_info parameter is the genlist item that was
18029 * created. The object may be deleted at any time, so it is up to the
18030 * caller to not use the object pointer from elm_genlist_item_object_get()
18031 * in a way where it may point to freed objects.
18032 * - @c "unrealized" - This is called just before an item is unrealized.
18033 * After this call icon objects provided will be deleted and the item
18034 * object itself delete or be put into a floating cache.
18035 * - @c "drag,start,up" - This is called when the item in the list has been
18036 * dragged (not scrolled) up.
18037 * - @c "drag,start,down" - This is called when the item in the list has been
18038 * dragged (not scrolled) down.
18039 * - @c "drag,start,left" - This is called when the item in the list has been
18040 * dragged (not scrolled) left.
18041 * - @c "drag,start,right" - This is called when the item in the list has
18042 * been dragged (not scrolled) right.
18043 * - @c "drag,stop" - This is called when the item in the list has stopped
18045 * - @c "drag" - This is called when the item in the list is being dragged.
18046 * - @c "longpressed" - This is called when the item is pressed for a certain
18047 * amount of time. By default it's 1 second.
18048 * - @c "scroll,anim,start" - This is called when scrolling animation has
18050 * - @c "scroll,anim,stop" - This is called when scrolling animation has
18052 * - @c "scroll,drag,start" - This is called when dragging the content has
18054 * - @c "scroll,drag,stop" - This is called when dragging the content has
18056 * - @c "edge,top" - This is called when the genlist is scrolled until
18058 * - @c "edge,bottom" - This is called when the genlist is scrolled
18059 * until the bottom edge.
18060 * - @c "edge,left" - This is called when the genlist is scrolled
18061 * until the left edge.
18062 * - @c "edge,right" - This is called when the genlist is scrolled
18063 * until the right edge.
18064 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18066 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18068 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18070 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18072 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18073 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
18074 * multi-touch pinched in.
18075 * - @c "swipe" - This is called when the genlist is swiped.
18076 * - @c "moved" - This is called when a genlist item is moved.
18077 * - @c "language,changed" - This is called when the program's language is
18080 * @section Genlist_Examples Examples
18082 * Here is a list of examples that use the genlist, trying to show some of
18083 * its capabilities:
18084 * - @ref genlist_example_01
18085 * - @ref genlist_example_02
18086 * - @ref genlist_example_03
18087 * - @ref genlist_example_04
18088 * - @ref genlist_example_05
18092 * @addtogroup Genlist
18097 * @enum _Elm_Genlist_Item_Flags
18098 * @typedef Elm_Genlist_Item_Flags
18100 * Defines if the item is of any special type (has subitems or it's the
18101 * index of a group), or is just a simple item.
18105 typedef enum _Elm_Genlist_Item_Flags
18107 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18108 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18109 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18110 } Elm_Genlist_Item_Flags;
18111 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
18112 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18113 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
18114 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
18115 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. */
18116 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. */
18117 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
18120 * @struct _Elm_Genlist_Item_Class
18122 * Genlist item class definition structs.
18124 * This struct contains the style and fetching functions that will define the
18125 * contents of each item.
18127 * @see @ref Genlist_Item_Class
18129 struct _Elm_Genlist_Item_Class
18131 const char *item_style; /**< style of this class. */
18134 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
18135 Elm_Genlist_Item_Icon_Get_Cb icon_get; /**< Icon fetching class function for genlist item classes. */
18136 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
18137 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
18142 * Add a new genlist widget to the given parent Elementary
18143 * (container) object
18145 * @param parent The parent object
18146 * @return a new genlist widget handle or @c NULL, on errors
18148 * This function inserts a new genlist widget on the canvas.
18150 * @see elm_genlist_item_append()
18151 * @see elm_genlist_item_del()
18152 * @see elm_genlist_clear()
18156 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18158 * Remove all items from a given genlist widget.
18160 * @param obj The genlist object
18162 * This removes (and deletes) all items in @p obj, leaving it empty.
18164 * @see elm_genlist_item_del(), to remove just one item.
18168 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18170 * Enable or disable multi-selection in the genlist
18172 * @param obj The genlist object
18173 * @param multi Multi-select enable/disable. Default is disabled.
18175 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18176 * the list. This allows more than 1 item to be selected. To retrieve the list
18177 * of selected items, use elm_genlist_selected_items_get().
18179 * @see elm_genlist_selected_items_get()
18180 * @see elm_genlist_multi_select_get()
18184 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18186 * Gets if multi-selection in genlist is enabled or disabled.
18188 * @param obj The genlist object
18189 * @return Multi-select enabled/disabled
18190 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18192 * @see elm_genlist_multi_select_set()
18196 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18198 * This sets the horizontal stretching mode.
18200 * @param obj The genlist object
18201 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18203 * This sets the mode used for sizing items horizontally. Valid modes
18204 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18205 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18206 * the scroller will scroll horizontally. Otherwise items are expanded
18207 * to fill the width of the viewport of the scroller. If it is
18208 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18209 * limited to that size.
18211 * @see elm_genlist_horizontal_get()
18215 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18216 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18218 * Gets the horizontal stretching mode.
18220 * @param obj The genlist object
18221 * @return The mode to use
18222 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18224 * @see elm_genlist_horizontal_set()
18228 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18229 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18231 * Set the always select mode.
18233 * @param obj The genlist object
18234 * @param always_select The always select mode (@c EINA_TRUE = on, @c
18235 * EINA_FALSE = off). Default is @c EINA_FALSE.
18237 * Items will only call their selection func and callback when first
18238 * becoming selected. Any further clicks will do nothing, unless you
18239 * enable always select with elm_genlist_always_select_mode_set().
18240 * This means that, even if selected, every click will make the selected
18241 * callbacks be called.
18243 * @see elm_genlist_always_select_mode_get()
18247 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18249 * Get the always select mode.
18251 * @param obj The genlist object
18252 * @return The always select mode
18253 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18255 * @see elm_genlist_always_select_mode_set()
18259 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18261 * Enable/disable the no select mode.
18263 * @param obj The genlist object
18264 * @param no_select The no select mode
18265 * (EINA_TRUE = on, EINA_FALSE = off)
18267 * This will turn off the ability to select items entirely and they
18268 * will neither appear selected nor call selected callback functions.
18270 * @see elm_genlist_no_select_mode_get()
18274 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18276 * Gets whether the no select mode is enabled.
18278 * @param obj The genlist object
18279 * @return The no select mode
18280 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18282 * @see elm_genlist_no_select_mode_set()
18286 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18288 * Enable/disable compress mode.
18290 * @param obj The genlist object
18291 * @param compress The compress mode
18292 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18294 * This will enable the compress mode where items are "compressed"
18295 * horizontally to fit the genlist scrollable viewport width. This is
18296 * special for genlist. Do not rely on
18297 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18298 * work as genlist needs to handle it specially.
18300 * @see elm_genlist_compress_mode_get()
18304 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18306 * Get whether the compress mode is enabled.
18308 * @param obj The genlist object
18309 * @return The compress mode
18310 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18312 * @see elm_genlist_compress_mode_set()
18316 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18318 * Enable/disable height-for-width mode.
18320 * @param obj The genlist object
18321 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18322 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18324 * With height-for-width mode the item width will be fixed (restricted
18325 * to a minimum of) to the list width when calculating its size in
18326 * order to allow the height to be calculated based on it. This allows,
18327 * for instance, text block to wrap lines if the Edje part is
18328 * configured with "text.min: 0 1".
18330 * @note This mode will make list resize slower as it will have to
18331 * recalculate every item height again whenever the list width
18334 * @note When height-for-width mode is enabled, it also enables
18335 * compress mode (see elm_genlist_compress_mode_set()) and
18336 * disables homogeneous (see elm_genlist_homogeneous_set()).
18340 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18342 * Get whether the height-for-width mode is enabled.
18344 * @param obj The genlist object
18345 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18350 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18352 * Enable/disable horizontal and vertical bouncing effect.
18354 * @param obj The genlist object
18355 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18356 * EINA_FALSE = off). Default is @c EINA_FALSE.
18357 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18358 * EINA_FALSE = off). Default is @c EINA_TRUE.
18360 * This will enable or disable the scroller bouncing effect for the
18361 * genlist. See elm_scroller_bounce_set() for details.
18363 * @see elm_scroller_bounce_set()
18364 * @see elm_genlist_bounce_get()
18368 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18370 * Get whether the horizontal and vertical bouncing effect is enabled.
18372 * @param obj The genlist object
18373 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18375 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18378 * @see elm_genlist_bounce_set()
18382 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18384 * Enable/disable homogenous mode.
18386 * @param obj The genlist object
18387 * @param homogeneous Assume the items within the genlist are of the
18388 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18391 * This will enable the homogeneous mode where items are of the same
18392 * height and width so that genlist may do the lazy-loading at its
18393 * maximum (which increases the performance for scrolling the list). This
18394 * implies 'compressed' mode.
18396 * @see elm_genlist_compress_mode_set()
18397 * @see elm_genlist_homogeneous_get()
18401 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18403 * Get whether the homogenous mode is enabled.
18405 * @param obj The genlist object
18406 * @return Assume the items within the genlist are of the same height
18407 * and width (EINA_TRUE = on, EINA_FALSE = off)
18409 * @see elm_genlist_homogeneous_set()
18413 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18415 * Set the maximum number of items within an item block
18417 * @param obj The genlist object
18418 * @param n Maximum number of items within an item block. Default is 32.
18420 * This will configure the block count to tune to the target with
18421 * particular performance matrix.
18423 * A block of objects will be used to reduce the number of operations due to
18424 * many objects in the screen. It can determine the visibility, or if the
18425 * object has changed, it theme needs to be updated, etc. doing this kind of
18426 * calculation to the entire block, instead of per object.
18428 * The default value for the block count is enough for most lists, so unless
18429 * you know you will have a lot of objects visible in the screen at the same
18430 * time, don't try to change this.
18432 * @see elm_genlist_block_count_get()
18433 * @see @ref Genlist_Implementation
18437 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18439 * Get the maximum number of items within an item block
18441 * @param obj The genlist object
18442 * @return Maximum number of items within an item block
18444 * @see elm_genlist_block_count_set()
18448 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18450 * Set the timeout in seconds for the longpress event.
18452 * @param obj The genlist object
18453 * @param timeout timeout in seconds. Default is 1.
18455 * This option will change how long it takes to send an event "longpressed"
18456 * after the mouse down signal is sent to the list. If this event occurs, no
18457 * "clicked" event will be sent.
18459 * @see elm_genlist_longpress_timeout_set()
18463 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18465 * Get the timeout in seconds for the longpress event.
18467 * @param obj The genlist object
18468 * @return timeout in seconds
18470 * @see elm_genlist_longpress_timeout_get()
18474 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18476 * Append a new item in a given genlist widget.
18478 * @param obj The genlist object
18479 * @param itc The item class for the item
18480 * @param data The item data
18481 * @param parent The parent item, or NULL if none
18482 * @param flags Item flags
18483 * @param func Convenience function called when the item is selected
18484 * @param func_data Data passed to @p func above.
18485 * @return A handle to the item added or @c NULL if not possible
18487 * This adds the given item to the end of the list or the end of
18488 * the children list if the @p parent is given.
18490 * @see elm_genlist_item_prepend()
18491 * @see elm_genlist_item_insert_before()
18492 * @see elm_genlist_item_insert_after()
18493 * @see elm_genlist_item_del()
18497 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);
18499 * Prepend a new item in a given genlist widget.
18501 * @param obj The genlist object
18502 * @param itc The item class for the item
18503 * @param data The item data
18504 * @param parent The parent item, or NULL if none
18505 * @param flags Item flags
18506 * @param func Convenience function called when the item is selected
18507 * @param func_data Data passed to @p func above.
18508 * @return A handle to the item added or NULL if not possible
18510 * This adds an item to the beginning of the list or beginning of the
18511 * children of the parent if given.
18513 * @see elm_genlist_item_append()
18514 * @see elm_genlist_item_insert_before()
18515 * @see elm_genlist_item_insert_after()
18516 * @see elm_genlist_item_del()
18520 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);
18522 * Insert an item before another in a genlist widget
18524 * @param obj The genlist object
18525 * @param itc The item class for the item
18526 * @param data The item data
18527 * @param before The item to place this new one before.
18528 * @param flags Item flags
18529 * @param func Convenience function called when the item is selected
18530 * @param func_data Data passed to @p func above.
18531 * @return A handle to the item added or @c NULL if not possible
18533 * This inserts an item before another in the list. It will be in the
18534 * same tree level or group as the item it is inserted before.
18536 * @see elm_genlist_item_append()
18537 * @see elm_genlist_item_prepend()
18538 * @see elm_genlist_item_insert_after()
18539 * @see elm_genlist_item_del()
18543 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);
18545 * Insert an item after another in a genlist widget
18547 * @param obj The genlist object
18548 * @param itc The item class for the item
18549 * @param data The item data
18550 * @param after The item to place this new one after.
18551 * @param flags Item flags
18552 * @param func Convenience function called when the item is selected
18553 * @param func_data Data passed to @p func above.
18554 * @return A handle to the item added or @c NULL if not possible
18556 * This inserts an item after another in the list. It will be in the
18557 * same tree level or group as the item it is inserted after.
18559 * @see elm_genlist_item_append()
18560 * @see elm_genlist_item_prepend()
18561 * @see elm_genlist_item_insert_before()
18562 * @see elm_genlist_item_del()
18566 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);
18568 * Insert a new item into the sorted genlist object
18570 * @param obj The genlist object
18571 * @param itc The item class for the item
18572 * @param data The item data
18573 * @param parent The parent item, or NULL if none
18574 * @param flags Item flags
18575 * @param comp The function called for the sort
18576 * @param func Convenience function called when item selected
18577 * @param func_data Data passed to @p func above.
18578 * @return A handle to the item added or NULL if not possible
18582 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);
18583 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);
18584 /* operations to retrieve existing items */
18586 * Get the selectd item in the genlist.
18588 * @param obj The genlist object
18589 * @return The selected item, or NULL if none is selected.
18591 * This gets the selected item in the list (if multi-selection is enabled, only
18592 * the item that was first selected in the list is returned - which is not very
18593 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18596 * If no item is selected, NULL is returned.
18598 * @see elm_genlist_selected_items_get()
18602 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18604 * Get a list of selected items in the genlist.
18606 * @param obj The genlist object
18607 * @return The list of selected items, or NULL if none are selected.
18609 * It returns a list of the selected items. This list pointer is only valid so
18610 * long as the selection doesn't change (no items are selected or unselected, or
18611 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18612 * pointers. The order of the items in this list is the order which they were
18613 * selected, i.e. the first item in this list is the first item that was
18614 * selected, and so on.
18616 * @note If not in multi-select mode, consider using function
18617 * elm_genlist_selected_item_get() instead.
18619 * @see elm_genlist_multi_select_set()
18620 * @see elm_genlist_selected_item_get()
18624 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18626 * Get the mode item style of items in the genlist
18627 * @param obj The genlist object
18628 * @return The mode item style string, or NULL if none is specified
18630 * This is a constant string and simply defines the name of the
18631 * style that will be used for mode animations. It can be
18632 * @c NULL if you don't plan to use Genlist mode. See
18633 * elm_genlist_item_mode_set() for more info.
18637 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18639 * Set the mode item style of items in the genlist
18640 * @param obj The genlist object
18641 * @param style The mode item style string, or NULL if none is desired
18643 * This is a constant string and simply defines the name of the
18644 * style that will be used for mode animations. It can be
18645 * @c NULL if you don't plan to use Genlist mode. See
18646 * elm_genlist_item_mode_set() for more info.
18650 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
18652 * Get a list of realized items in genlist
18654 * @param obj The genlist object
18655 * @return The list of realized items, nor NULL if none are realized.
18657 * This returns a list of the realized items in the genlist. The list
18658 * contains Elm_Genlist_Item pointers. The list must be freed by the
18659 * caller when done with eina_list_free(). The item pointers in the
18660 * list are only valid so long as those items are not deleted or the
18661 * genlist is not deleted.
18663 * @see elm_genlist_realized_items_update()
18667 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18669 * Get the item that is at the x, y canvas coords.
18671 * @param obj The gelinst object.
18672 * @param x The input x coordinate
18673 * @param y The input y coordinate
18674 * @param posret The position relative to the item returned here
18675 * @return The item at the coordinates or NULL if none
18677 * This returns the item at the given coordinates (which are canvas
18678 * relative, not object-relative). If an item is at that coordinate,
18679 * that item handle is returned, and if @p posret is not NULL, the
18680 * integer pointed to is set to a value of -1, 0 or 1, depending if
18681 * the coordinate is on the upper portion of that item (-1), on the
18682 * middle section (0) or on the lower part (1). If NULL is returned as
18683 * an item (no item found there), then posret may indicate -1 or 1
18684 * based if the coordinate is above or below all items respectively in
18689 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);
18691 * Get the first item in the genlist
18693 * This returns the first item in the list.
18695 * @param obj The genlist object
18696 * @return The first item, or NULL if none
18700 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18702 * Get the last item in the genlist
18704 * This returns the last item in the list.
18706 * @return The last item, or NULL if none
18710 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18712 * Set the scrollbar policy
18714 * @param obj The genlist object
18715 * @param policy_h Horizontal scrollbar policy.
18716 * @param policy_v Vertical scrollbar policy.
18718 * This sets the scrollbar visibility policy for the given genlist
18719 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
18720 * made visible if it is needed, and otherwise kept hidden.
18721 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
18722 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
18723 * respectively for the horizontal and vertical scrollbars. Default is
18724 * #ELM_SMART_SCROLLER_POLICY_AUTO
18726 * @see elm_genlist_scroller_policy_get()
18730 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
18732 * Get the scrollbar policy
18734 * @param obj The genlist object
18735 * @param policy_h Pointer to store the horizontal scrollbar policy.
18736 * @param policy_v Pointer to store the vertical scrollbar policy.
18738 * @see elm_genlist_scroller_policy_set()
18742 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);
18744 * Get the @b next item in a genlist widget's internal list of items,
18745 * given a handle to one of those items.
18747 * @param item The genlist item to fetch next from
18748 * @return The item after @p item, or @c NULL if there's none (and
18751 * This returns the item placed after the @p item, on the container
18754 * @see elm_genlist_item_prev_get()
18758 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18760 * Get the @b previous item in a genlist widget's internal list of items,
18761 * given a handle to one of those items.
18763 * @param item The genlist item to fetch previous from
18764 * @return The item before @p item, or @c NULL if there's none (and
18767 * This returns the item placed before the @p item, on the container
18770 * @see elm_genlist_item_next_get()
18774 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18776 * Get the genlist object's handle which contains a given genlist
18779 * @param item The item to fetch the container from
18780 * @return The genlist (parent) object
18782 * This returns the genlist object itself that an item belongs to.
18786 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18788 * Get the parent item of the given item
18790 * @param it The item
18791 * @return The parent of the item or @c NULL if it has no parent.
18793 * This returns the item that was specified as parent of the item @p it on
18794 * elm_genlist_item_append() and insertion related functions.
18798 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18800 * Remove all sub-items (children) of the given item
18802 * @param it The item
18804 * This removes all items that are children (and their descendants) of the
18805 * given item @p it.
18807 * @see elm_genlist_clear()
18808 * @see elm_genlist_item_del()
18812 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18814 * Set whether a given genlist item is selected or not
18816 * @param it The item
18817 * @param selected Use @c EINA_TRUE, to make it selected, @c
18818 * EINA_FALSE to make it unselected
18820 * This sets the selected state of an item. If multi selection is
18821 * not enabled on the containing genlist and @p selected is @c
18822 * EINA_TRUE, any other previously selected items will get
18823 * unselected in favor of this new one.
18825 * @see elm_genlist_item_selected_get()
18829 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
18831 * Get whether a given genlist item is selected or not
18833 * @param it The item
18834 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
18836 * @see elm_genlist_item_selected_set() for more details
18840 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18842 * Sets the expanded state of an item.
18844 * @param it The item
18845 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
18847 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
18850 * The theme will respond to this change visually, and a signal "expanded" or
18851 * "contracted" will be sent from the genlist with a pointer to the item that
18852 * has been expanded/contracted.
18854 * Calling this function won't show or hide any child of this item (if it is
18855 * a parent). You must manually delete and create them on the callbacks fo
18856 * the "expanded" or "contracted" signals.
18858 * @see elm_genlist_item_expanded_get()
18862 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
18864 * Get the expanded state of an item
18866 * @param it The item
18867 * @return The expanded state
18869 * This gets the expanded state of an item.
18871 * @see elm_genlist_item_expanded_set()
18875 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18877 * Get the depth of expanded item
18879 * @param it The genlist item object
18880 * @return The depth of expanded item
18884 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18886 * Set whether a given genlist item is disabled or not.
18888 * @param it The item
18889 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
18890 * to enable it back.
18892 * A disabled item cannot be selected or unselected. It will also
18893 * change its appearance, to signal the user it's disabled.
18895 * @see elm_genlist_item_disabled_get()
18899 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
18901 * Get whether a given genlist item is disabled or not.
18903 * @param it The item
18904 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
18907 * @see elm_genlist_item_disabled_set() for more details
18911 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18913 * Sets the display only state of an item.
18915 * @param it The item
18916 * @param display_only @c EINA_TRUE if the item is display only, @c
18917 * EINA_FALSE otherwise.
18919 * A display only item cannot be selected or unselected. It is for
18920 * display only and not selecting or otherwise clicking, dragging
18921 * etc. by the user, thus finger size rules will not be applied to
18924 * It's good to set group index items to display only state.
18926 * @see elm_genlist_item_display_only_get()
18930 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
18932 * Get the display only state of an item
18934 * @param it The item
18935 * @return @c EINA_TRUE if the item is display only, @c
18936 * EINA_FALSE otherwise.
18938 * @see elm_genlist_item_display_only_set()
18942 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18944 * Show the portion of a genlist's internal list containing a given
18945 * item, immediately.
18947 * @param it The item to display
18949 * This causes genlist to jump to the given item @p it and show it (by
18950 * immediately scrolling to that position), if it is not fully visible.
18952 * @see elm_genlist_item_bring_in()
18953 * @see elm_genlist_item_top_show()
18954 * @see elm_genlist_item_middle_show()
18958 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18960 * Animatedly bring in, to the visible are of a genlist, a given
18963 * @param it The item to display
18965 * This causes genlist to jump to the given item @p it and show it (by
18966 * animatedly scrolling), if it is not fully visible. This may use animation
18967 * to do so and take a period of time
18969 * @see elm_genlist_item_show()
18970 * @see elm_genlist_item_top_bring_in()
18971 * @see elm_genlist_item_middle_bring_in()
18975 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18977 * Show the portion of a genlist's internal list containing a given
18978 * item, immediately.
18980 * @param it The item to display
18982 * This causes genlist to jump to the given item @p it and show it (by
18983 * immediately scrolling to that position), if it is not fully visible.
18985 * The item will be positioned at the top of the genlist viewport.
18987 * @see elm_genlist_item_show()
18988 * @see elm_genlist_item_top_bring_in()
18992 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18994 * Animatedly bring in, to the visible are of a genlist, a given
18997 * @param it The item
18999 * This causes genlist to jump to the given item @p it and show it (by
19000 * animatedly scrolling), if it is not fully visible. This may use animation
19001 * to do so and take a period of time
19003 * The item will be positioned at the top of the genlist viewport.
19005 * @see elm_genlist_item_bring_in()
19006 * @see elm_genlist_item_top_show()
19010 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19012 * Show the portion of a genlist's internal list containing a given
19013 * item, immediately.
19015 * @param it The item to display
19017 * This causes genlist to jump to the given item @p it and show it (by
19018 * immediately scrolling to that position), if it is not fully visible.
19020 * The item will be positioned at the middle of the genlist viewport.
19022 * @see elm_genlist_item_show()
19023 * @see elm_genlist_item_middle_bring_in()
19027 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19029 * Animatedly bring in, to the visible are of a genlist, a given
19032 * @param it The item
19034 * This causes genlist to jump to the given item @p it and show it (by
19035 * animatedly scrolling), if it is not fully visible. This may use animation
19036 * to do so and take a period of time
19038 * The item will be positioned at the middle of the genlist viewport.
19040 * @see elm_genlist_item_bring_in()
19041 * @see elm_genlist_item_middle_show()
19045 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19047 * Remove a genlist item from the its parent, deleting it.
19049 * @param item The item to be removed.
19050 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19052 * @see elm_genlist_clear(), to remove all items in a genlist at
19057 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19059 * Return the data associated to a given genlist item
19061 * @param item The genlist item.
19062 * @return the data associated to this item.
19064 * This returns the @c data value passed on the
19065 * elm_genlist_item_append() and related item addition calls.
19067 * @see elm_genlist_item_append()
19068 * @see elm_genlist_item_data_set()
19072 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19074 * Set the data associated to a given genlist item
19076 * @param item The genlist item
19077 * @param data The new data pointer to set on it
19079 * This @b overrides the @c data value passed on the
19080 * elm_genlist_item_append() and related item addition calls. This
19081 * function @b won't call elm_genlist_item_update() automatically,
19082 * so you'd issue it afterwards if you want to hove the item
19083 * updated to reflect the that new data.
19085 * @see elm_genlist_item_data_get()
19089 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19091 * Tells genlist to "orphan" icons fetchs by the item class
19093 * @param it The item
19095 * This instructs genlist to release references to icons in the item,
19096 * meaning that they will no longer be managed by genlist and are
19097 * floating "orphans" that can be re-used elsewhere if the user wants
19102 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19104 * Get the real Evas object created to implement the view of a
19105 * given genlist item
19107 * @param item The genlist item.
19108 * @return the Evas object implementing this item's view.
19110 * This returns the actual Evas object used to implement the
19111 * specified genlist item's view. This may be @c NULL, as it may
19112 * not have been created or may have been deleted, at any time, by
19113 * the genlist. <b>Do not modify this object</b> (move, resize,
19114 * show, hide, etc.), as the genlist is controlling it. This
19115 * function is for querying, emitting custom signals or hooking
19116 * lower level callbacks for events on that object. Do not delete
19117 * this object under any circumstances.
19119 * @see elm_genlist_item_data_get()
19123 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19125 * Update the contents of an item
19127 * @param it The item
19129 * This updates an item by calling all the item class functions again
19130 * to get the icons, labels and states. Use this when the original
19131 * item data has changed and the changes are desired to be reflected.
19133 * Use elm_genlist_realized_items_update() to update all already realized
19136 * @see elm_genlist_realized_items_update()
19140 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19142 * Update the item class of an item
19144 * @param it The item
19145 * @param itc The item class for the item
19147 * This sets another class fo the item, changing the way that it is
19148 * displayed. After changing the item class, elm_genlist_item_update() is
19149 * called on the item @p it.
19153 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19154 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19156 * Set the text to be shown in a given genlist item's tooltips.
19158 * @param item The genlist item
19159 * @param text The text to set in the content
19161 * This call will setup the text to be used as tooltip to that item
19162 * (analogous to elm_object_tooltip_text_set(), but being item
19163 * tooltips with higher precedence than object tooltips). It can
19164 * have only one tooltip at a time, so any previous tooltip data
19165 * will get removed.
19167 * In order to set an icon or something else as a tooltip, look at
19168 * elm_genlist_item_tooltip_content_cb_set().
19172 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19174 * Set the content to be shown in a given genlist item's tooltips
19176 * @param item The genlist item.
19177 * @param func The function returning the tooltip contents.
19178 * @param data What to provide to @a func as callback data/context.
19179 * @param del_cb Called when data is not needed anymore, either when
19180 * another callback replaces @p func, the tooltip is unset with
19181 * elm_genlist_item_tooltip_unset() or the owner @p item
19182 * dies. This callback receives as its first parameter the
19183 * given @p data, being @c event_info the item handle.
19185 * This call will setup the tooltip's contents to @p item
19186 * (analogous to elm_object_tooltip_content_cb_set(), but being
19187 * item tooltips with higher precedence than object tooltips). It
19188 * can have only one tooltip at a time, so any previous tooltip
19189 * content will get removed. @p func (with @p data) will be called
19190 * every time Elementary needs to show the tooltip and it should
19191 * return a valid Evas object, which will be fully managed by the
19192 * tooltip system, getting deleted when the tooltip is gone.
19194 * In order to set just a text as a tooltip, look at
19195 * elm_genlist_item_tooltip_text_set().
19199 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);
19201 * Unset a tooltip from a given genlist item
19203 * @param item genlist item to remove a previously set tooltip from.
19205 * This call removes any tooltip set on @p item. The callback
19206 * provided as @c del_cb to
19207 * elm_genlist_item_tooltip_content_cb_set() will be called to
19208 * notify it is not used anymore (and have resources cleaned, if
19211 * @see elm_genlist_item_tooltip_content_cb_set()
19215 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19217 * Set a different @b style for a given genlist item's tooltip.
19219 * @param item genlist item with tooltip set
19220 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19221 * "default", @c "transparent", etc)
19223 * Tooltips can have <b>alternate styles</b> to be displayed on,
19224 * which are defined by the theme set on Elementary. This function
19225 * works analogously as elm_object_tooltip_style_set(), but here
19226 * applied only to genlist item objects. The default style for
19227 * tooltips is @c "default".
19229 * @note before you set a style you should define a tooltip with
19230 * elm_genlist_item_tooltip_content_cb_set() or
19231 * elm_genlist_item_tooltip_text_set()
19233 * @see elm_genlist_item_tooltip_style_get()
19237 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19239 * Get the style set a given genlist item's tooltip.
19241 * @param item genlist item with tooltip already set on.
19242 * @return style the theme style in use, which defaults to
19243 * "default". If the object does not have a tooltip set,
19244 * then @c NULL is returned.
19246 * @see elm_genlist_item_tooltip_style_set() for more details
19250 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19252 * @brief Disable size restrictions on an object's tooltip
19253 * @param item The tooltip's anchor object
19254 * @param disable If EINA_TRUE, size restrictions are disabled
19255 * @return EINA_FALSE on failure, EINA_TRUE on success
19257 * This function allows a tooltip to expand beyond its parant window's canvas.
19258 * It will instead be limited only by the size of the display.
19260 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19262 * @brief Retrieve size restriction state of an object's tooltip
19263 * @param item The tooltip's anchor object
19264 * @return If EINA_TRUE, size restrictions are disabled
19266 * This function returns whether a tooltip is allowed to expand beyond
19267 * its parant window's canvas.
19268 * It will instead be limited only by the size of the display.
19270 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19272 * Set the type of mouse pointer/cursor decoration to be shown,
19273 * when the mouse pointer is over the given genlist widget item
19275 * @param item genlist item to customize cursor on
19276 * @param cursor the cursor type's name
19278 * This function works analogously as elm_object_cursor_set(), but
19279 * here the cursor's changing area is restricted to the item's
19280 * area, and not the whole widget's. Note that that item cursors
19281 * have precedence over widget cursors, so that a mouse over @p
19282 * item will always show cursor @p type.
19284 * If this function is called twice for an object, a previously set
19285 * cursor will be unset on the second call.
19287 * @see elm_object_cursor_set()
19288 * @see elm_genlist_item_cursor_get()
19289 * @see elm_genlist_item_cursor_unset()
19293 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19295 * Get the type of mouse pointer/cursor decoration set to be shown,
19296 * when the mouse pointer is over the given genlist widget item
19298 * @param item genlist item with custom cursor set
19299 * @return the cursor type's name or @c NULL, if no custom cursors
19300 * were set to @p item (and on errors)
19302 * @see elm_object_cursor_get()
19303 * @see elm_genlist_item_cursor_set() for more details
19304 * @see elm_genlist_item_cursor_unset()
19308 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19310 * Unset any custom mouse pointer/cursor decoration set to be
19311 * shown, when the mouse pointer is over the given genlist widget
19312 * item, thus making it show the @b default cursor again.
19314 * @param item a genlist item
19316 * Use this call to undo any custom settings on this item's cursor
19317 * decoration, bringing it back to defaults (no custom style set).
19319 * @see elm_object_cursor_unset()
19320 * @see elm_genlist_item_cursor_set() for more details
19324 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19326 * Set a different @b style for a given custom cursor set for a
19329 * @param item genlist item with custom cursor set
19330 * @param style the <b>theme style</b> to use (e.g. @c "default",
19331 * @c "transparent", etc)
19333 * This function only makes sense when one is using custom mouse
19334 * cursor decorations <b>defined in a theme file</b> , which can
19335 * have, given a cursor name/type, <b>alternate styles</b> on
19336 * it. It works analogously as elm_object_cursor_style_set(), but
19337 * here applied only to genlist item objects.
19339 * @warning Before you set a cursor style you should have defined a
19340 * custom cursor previously on the item, with
19341 * elm_genlist_item_cursor_set()
19343 * @see elm_genlist_item_cursor_engine_only_set()
19344 * @see elm_genlist_item_cursor_style_get()
19348 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19350 * Get the current @b style set for a given genlist item's custom
19353 * @param item genlist item with custom cursor set.
19354 * @return style the cursor style in use. If the object does not
19355 * have a cursor set, then @c NULL is returned.
19357 * @see elm_genlist_item_cursor_style_set() for more details
19361 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19363 * Set if the (custom) cursor for a given genlist item should be
19364 * searched in its theme, also, or should only rely on the
19365 * rendering engine.
19367 * @param item item with custom (custom) cursor already set on
19368 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19369 * only on those provided by the rendering engine, @c EINA_FALSE to
19370 * have them searched on the widget's theme, as well.
19372 * @note This call is of use only if you've set a custom cursor
19373 * for genlist items, with elm_genlist_item_cursor_set().
19375 * @note By default, cursors will only be looked for between those
19376 * provided by the rendering engine.
19380 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19382 * Get if the (custom) cursor for a given genlist item is being
19383 * searched in its theme, also, or is only relying on the rendering
19386 * @param item a genlist item
19387 * @return @c EINA_TRUE, if cursors are being looked for only on
19388 * those provided by the rendering engine, @c EINA_FALSE if they
19389 * are being searched on the widget's theme, as well.
19391 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19395 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19397 * Update the contents of all realized items.
19399 * @param obj The genlist object.
19401 * This updates all realized items by calling all the item class functions again
19402 * to get the icons, labels and states. Use this when the original
19403 * item data has changed and the changes are desired to be reflected.
19405 * To update just one item, use elm_genlist_item_update().
19407 * @see elm_genlist_realized_items_get()
19408 * @see elm_genlist_item_update()
19412 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19414 * Activate a genlist mode on an item
19416 * @param item The genlist item
19417 * @param mode Mode name
19418 * @param mode_set Boolean to define set or unset mode.
19420 * A genlist mode is a different way of selecting an item. Once a mode is
19421 * activated on an item, any other selected item is immediately unselected.
19422 * This feature provides an easy way of implementing a new kind of animation
19423 * for selecting an item, without having to entirely rewrite the item style
19424 * theme. However, the elm_genlist_selected_* API can't be used to get what
19425 * item is activate for a mode.
19427 * The current item style will still be used, but applying a genlist mode to
19428 * an item will select it using a different kind of animation.
19430 * The current active item for a mode can be found by
19431 * elm_genlist_mode_item_get().
19433 * The characteristics of genlist mode are:
19434 * - Only one mode can be active at any time, and for only one item.
19435 * - Genlist handles deactivating other items when one item is activated.
19436 * - A mode is defined in the genlist theme (edc), and more modes can easily
19438 * - A mode style and the genlist item style are different things. They
19439 * can be combined to provide a default style to the item, with some kind
19440 * of animation for that item when the mode is activated.
19442 * When a mode is activated on an item, a new view for that item is created.
19443 * The theme of this mode defines the animation that will be used to transit
19444 * the item from the old view to the new view. This second (new) view will be
19445 * active for that item while the mode is active on the item, and will be
19446 * destroyed after the mode is totally deactivated from that item.
19448 * @see elm_genlist_mode_get()
19449 * @see elm_genlist_mode_item_get()
19453 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19455 * Get the last (or current) genlist mode used.
19457 * @param obj The genlist object
19459 * This function just returns the name of the last used genlist mode. It will
19460 * be the current mode if it's still active.
19462 * @see elm_genlist_item_mode_set()
19463 * @see elm_genlist_mode_item_get()
19467 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19469 * Get active genlist mode item
19471 * @param obj The genlist object
19472 * @return The active item for that current mode. Or @c NULL if no item is
19473 * activated with any mode.
19475 * This function returns the item that was activated with a mode, by the
19476 * function elm_genlist_item_mode_set().
19478 * @see elm_genlist_item_mode_set()
19479 * @see elm_genlist_mode_get()
19483 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19488 * @param obj The genlist object
19489 * @param reorder_mode The reorder mode
19490 * (EINA_TRUE = on, EINA_FALSE = off)
19494 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19497 * Get the reorder mode
19499 * @param obj The genlist object
19500 * @return The reorder mode
19501 * (EINA_TRUE = on, EINA_FALSE = off)
19505 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19512 * @defgroup Check Check
19514 * @image html img/widget/check/preview-00.png
19515 * @image latex img/widget/check/preview-00.eps
19516 * @image html img/widget/check/preview-01.png
19517 * @image latex img/widget/check/preview-01.eps
19518 * @image html img/widget/check/preview-02.png
19519 * @image latex img/widget/check/preview-02.eps
19521 * @brief The check widget allows for toggling a value between true and
19524 * Check objects are a lot like radio objects in layout and functionality
19525 * except they do not work as a group, but independently and only toggle the
19526 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19527 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19528 * returns the current state. For convenience, like the radio objects, you
19529 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19530 * for it to modify.
19532 * Signals that you can add callbacks for are:
19533 * "changed" - This is called whenever the user changes the state of one of
19534 * the check object(event_info is NULL).
19536 * @ref tutorial_check should give you a firm grasp of how to use this widget.
19540 * @brief Add a new Check object
19542 * @param parent The parent object
19543 * @return The new object or NULL if it cannot be created
19545 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19547 * @brief Set the text label of the check object
19549 * @param obj The check object
19550 * @param label The text label string in UTF-8
19552 * @deprecated use elm_object_text_set() instead.
19554 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19556 * @brief Get the text label of the check object
19558 * @param obj The check object
19559 * @return The text label string in UTF-8
19561 * @deprecated use elm_object_text_get() instead.
19563 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19565 * @brief Set the icon object of the check object
19567 * @param obj The check object
19568 * @param icon The icon object
19570 * Once the icon object is set, a previously set one will be deleted.
19571 * If you want to keep that old content object, use the
19572 * elm_check_icon_unset() function.
19574 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19576 * @brief Get the icon object of the check object
19578 * @param obj The check object
19579 * @return The icon object
19581 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19583 * @brief Unset the icon used for the check object
19585 * @param obj The check object
19586 * @return The icon object that was being used
19588 * Unparent and return the icon object which was set for this widget.
19590 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19592 * @brief Set the on/off state of the check object
19594 * @param obj The check object
19595 * @param state The state to use (1 == on, 0 == off)
19597 * This sets the state of the check. If set
19598 * with elm_check_state_pointer_set() the state of that variable is also
19599 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19601 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19603 * @brief Get the state of the check object
19605 * @param obj The check object
19606 * @return The boolean state
19608 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19610 * @brief Set a convenience pointer to a boolean to change
19612 * @param obj The check object
19613 * @param statep Pointer to the boolean to modify
19615 * This sets a pointer to a boolean, that, in addition to the check objects
19616 * state will also be modified directly. To stop setting the object pointed
19617 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19618 * then when this is called, the check objects state will also be modified to
19619 * reflect the value of the boolean @p statep points to, just like calling
19620 * elm_check_state_set().
19622 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19623 EINA_DEPRECATED EAPI void elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
19624 EINA_DEPRECATED EAPI void elm_check_states_labels_get(const Evas_Object *obj, const char **ontext, const char **offtext) EINA_ARG_NONNULL(1,2,3);
19631 * @defgroup Radio Radio
19633 * @image html img/widget/radio/preview-00.png
19634 * @image latex img/widget/radio/preview-00.eps
19636 * @brief Radio is a widget that allows for 1 or more options to be displayed
19637 * and have the user choose only 1 of them.
19639 * A radio object contains an indicator, an optional Label and an optional
19640 * icon object. While it's possible to have a group of only one radio they,
19641 * are normally used in groups of 2 or more. To add a radio to a group use
19642 * elm_radio_group_add(). The radio object(s) will select from one of a set
19643 * of integer values, so any value they are configuring needs to be mapped to
19644 * a set of integers. To configure what value that radio object represents,
19645 * use elm_radio_state_value_set() to set the integer it represents. To set
19646 * the value the whole group(which one is currently selected) is to indicate
19647 * use elm_radio_value_set() on any group member, and to get the groups value
19648 * use elm_radio_value_get(). For convenience the radio objects are also able
19649 * to directly set an integer(int) to the value that is selected. To specify
19650 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19651 * The radio objects will modify this directly. That implies the pointer must
19652 * point to valid memory for as long as the radio objects exist.
19654 * Signals that you can add callbacks for are:
19655 * @li changed - This is called whenever the user changes the state of one of
19656 * the radio objects within the group of radio objects that work together.
19658 * @ref tutorial_radio show most of this API in action.
19662 * @brief Add a new radio to the parent
19664 * @param parent The parent object
19665 * @return The new object or NULL if it cannot be created
19667 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19669 * @brief Set the text label of the radio object
19671 * @param obj The radio object
19672 * @param label The text label string in UTF-8
19674 * @deprecated use elm_object_text_set() instead.
19676 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19678 * @brief Get the text label of the radio object
19680 * @param obj The radio object
19681 * @return The text label string in UTF-8
19683 * @deprecated use elm_object_text_set() instead.
19685 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19687 * @brief Set the icon object of the radio object
19689 * @param obj The radio object
19690 * @param icon The icon object
19692 * Once the icon object is set, a previously set one will be deleted. If you
19693 * want to keep that old content object, use the elm_radio_icon_unset()
19696 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19698 * @brief Get the icon object of the radio object
19700 * @param obj The radio object
19701 * @return The icon object
19703 * @see elm_radio_icon_set()
19705 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19707 * @brief Unset the icon used for the radio object
19709 * @param obj The radio object
19710 * @return The icon object that was being used
19712 * Unparent and return the icon object which was set for this widget.
19714 * @see elm_radio_icon_set()
19716 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19718 * @brief Add this radio to a group of other radio objects
19720 * @param obj The radio object
19721 * @param group Any object whose group the @p obj is to join.
19723 * Radio objects work in groups. Each member should have a different integer
19724 * value assigned. In order to have them work as a group, they need to know
19725 * about each other. This adds the given radio object to the group of which
19726 * the group object indicated is a member.
19728 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
19730 * @brief Set the integer value that this radio object represents
19732 * @param obj The radio object
19733 * @param value The value to use if this radio object is selected
19735 * This sets the value of the radio.
19737 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19739 * @brief Get the integer value that this radio object represents
19741 * @param obj The radio object
19742 * @return The value used if this radio object is selected
19744 * This gets the value of the radio.
19746 * @see elm_radio_value_set()
19748 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19750 * @brief Set the value of the radio.
19752 * @param obj The radio object
19753 * @param value The value to use for the group
19755 * This sets the value of the radio group and will also set the value if
19756 * pointed to, to the value supplied, but will not call any callbacks.
19758 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19760 * @brief Get the state of the radio object
19762 * @param obj The radio object
19763 * @return The integer state
19765 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19767 * @brief Set a convenience pointer to a integer to change
19769 * @param obj The radio object
19770 * @param valuep Pointer to the integer to modify
19772 * This sets a pointer to a integer, that, in addition to the radio objects
19773 * state will also be modified directly. To stop setting the object pointed
19774 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
19775 * when this is called, the radio objects state will also be modified to
19776 * reflect the value of the integer valuep points to, just like calling
19777 * elm_radio_value_set().
19779 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
19785 * @defgroup Pager Pager
19787 * @image html img/widget/pager/preview-00.png
19788 * @image latex img/widget/pager/preview-00.eps
19790 * @brief Widget that allows flipping between 1 or more “pages” of objects.
19792 * The flipping between “pages” of objects is animated. All content in pager
19793 * is kept in a stack, the last content to be added will be on the top of the
19794 * stack(be visible).
19796 * Objects can be pushed or popped from the stack or deleted as normal.
19797 * Pushes and pops will animate (and a pop will delete the object once the
19798 * animation is finished). Any object already in the pager can be promoted to
19799 * the top(from its current stacking position) through the use of
19800 * elm_pager_content_promote(). Objects are pushed to the top with
19801 * elm_pager_content_push() and when the top item is no longer wanted, simply
19802 * pop it with elm_pager_content_pop() and it will also be deleted. If an
19803 * object is no longer needed and is not the top item, just delete it as
19804 * normal. You can query which objects are the top and bottom with
19805 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
19807 * Signals that you can add callbacks for are:
19808 * "hide,finished" - when the previous page is hided
19810 * This widget has the following styles available:
19813 * @li fade_translucide
19814 * @li fade_invisible
19815 * @note This styles affect only the flipping animations, the appearance when
19816 * not animating is unaffected by styles.
19818 * @ref tutorial_pager gives a good overview of the usage of the API.
19822 * Add a new pager to the parent
19824 * @param parent The parent object
19825 * @return The new object or NULL if it cannot be created
19829 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19831 * @brief Push an object to the top of the pager stack (and show it).
19833 * @param obj The pager object
19834 * @param content The object to push
19836 * The object pushed becomes a child of the pager, it will be controlled and
19837 * deleted when the pager is deleted.
19839 * @note If the content is already in the stack use
19840 * elm_pager_content_promote().
19841 * @warning Using this function on @p content already in the stack results in
19842 * undefined behavior.
19844 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19846 * @brief Pop the object that is on top of the stack
19848 * @param obj The pager object
19850 * This pops the object that is on the top(visible) of the pager, makes it
19851 * disappear, then deletes the object. The object that was underneath it on
19852 * the stack will become visible.
19854 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
19856 * @brief Moves an object already in the pager stack to the top of the stack.
19858 * @param obj The pager object
19859 * @param content The object to promote
19861 * This will take the @p content and move it to the top of the stack as
19862 * if it had been pushed there.
19864 * @note If the content isn't already in the stack use
19865 * elm_pager_content_push().
19866 * @warning Using this function on @p content not already in the stack
19867 * results in undefined behavior.
19869 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19871 * @brief Return the object at the bottom of the pager stack
19873 * @param obj The pager object
19874 * @return The bottom object or NULL if none
19876 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19878 * @brief Return the object at the top of the pager stack
19880 * @param obj The pager object
19881 * @return The top object or NULL if none
19883 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19890 * @defgroup Slideshow Slideshow
19892 * @image html img/widget/slideshow/preview-00.png
19893 * @image latex img/widget/slideshow/preview-00.eps
19895 * This widget, as the name indicates, is a pre-made image
19896 * slideshow panel, with API functions acting on (child) image
19897 * items presentation. Between those actions, are:
19898 * - advance to next/previous image
19899 * - select the style of image transition animation
19900 * - set the exhibition time for each image
19901 * - start/stop the slideshow
19903 * The transition animations are defined in the widget's theme,
19904 * consequently new animations can be added without having to
19905 * update the widget's code.
19907 * @section Slideshow_Items Slideshow items
19909 * For slideshow items, just like for @ref Genlist "genlist" ones,
19910 * the user defines a @b classes, specifying functions that will be
19911 * called on the item's creation and deletion times.
19913 * The #Elm_Slideshow_Item_Class structure contains the following
19916 * - @c func.get - When an item is displayed, this function is
19917 * called, and it's where one should create the item object, de
19918 * facto. For example, the object can be a pure Evas image object
19919 * or an Elementary @ref Photocam "photocam" widget. See
19920 * #SlideshowItemGetFunc.
19921 * - @c func.del - When an item is no more displayed, this function
19922 * is called, where the user must delete any data associated to
19923 * the item. See #SlideshowItemDelFunc.
19925 * @section Slideshow_Caching Slideshow caching
19927 * The slideshow provides facilities to have items adjacent to the
19928 * one being displayed <b>already "realized"</b> (i.e. loaded) for
19929 * you, so that the system does not have to decode image data
19930 * anymore at the time it has to actually switch images on its
19931 * viewport. The user is able to set the numbers of items to be
19932 * cached @b before and @b after the current item, in the widget's
19935 * Smart events one can add callbacks for are:
19937 * - @c "changed" - when the slideshow switches its view to a new
19940 * List of examples for the slideshow widget:
19941 * @li @ref slideshow_example
19945 * @addtogroup Slideshow
19949 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
19950 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
19951 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
19952 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
19953 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
19956 * @struct _Elm_Slideshow_Item_Class
19958 * Slideshow item class definition. See @ref Slideshow_Items for
19961 struct _Elm_Slideshow_Item_Class
19963 struct _Elm_Slideshow_Item_Class_Func
19965 SlideshowItemGetFunc get;
19966 SlideshowItemDelFunc del;
19968 }; /**< #Elm_Slideshow_Item_Class member definitions */
19971 * Add a new slideshow widget to the given parent Elementary
19972 * (container) object
19974 * @param parent The parent object
19975 * @return A new slideshow widget handle or @c NULL, on errors
19977 * This function inserts a new slideshow widget on the canvas.
19979 * @ingroup Slideshow
19981 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19984 * Add (append) a new item in a given slideshow widget.
19986 * @param obj The slideshow object
19987 * @param itc The item class for the item
19988 * @param data The item's data
19989 * @return A handle to the item added or @c NULL, on errors
19991 * Add a new item to @p obj's internal list of items, appending it.
19992 * The item's class must contain the function really fetching the
19993 * image object to show for this item, which could be an Evas image
19994 * object or an Elementary photo, for example. The @p data
19995 * parameter is going to be passed to both class functions of the
19998 * @see #Elm_Slideshow_Item_Class
19999 * @see elm_slideshow_item_sorted_insert()
20001 * @ingroup Slideshow
20003 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20006 * Insert a new item into the given slideshow widget, using the @p func
20007 * function to sort items (by item handles).
20009 * @param obj The slideshow object
20010 * @param itc The item class for the item
20011 * @param data The item's data
20012 * @param func The comparing function to be used to sort slideshow
20013 * items <b>by #Elm_Slideshow_Item item handles</b>
20014 * @return Returns The slideshow item handle, on success, or
20015 * @c NULL, on errors
20017 * Add a new item to @p obj's internal list of items, in a position
20018 * determined by the @p func comparing function. The item's class
20019 * must contain the function really fetching the image object to
20020 * show for this item, which could be an Evas image object or an
20021 * Elementary photo, for example. The @p data parameter is going to
20022 * be passed to both class functions of the item.
20024 * @see #Elm_Slideshow_Item_Class
20025 * @see elm_slideshow_item_add()
20027 * @ingroup Slideshow
20029 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);
20032 * Display a given slideshow widget's item, programmatically.
20034 * @param obj The slideshow object
20035 * @param item The item to display on @p obj's viewport
20037 * The change between the current item and @p item will use the
20038 * transition @p obj is set to use (@see
20039 * elm_slideshow_transition_set()).
20041 * @ingroup Slideshow
20043 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20046 * Slide to the @b next item, in a given slideshow widget
20048 * @param obj The slideshow object
20050 * The sliding animation @p obj is set to use will be the
20051 * transition effect used, after this call is issued.
20053 * @note If the end of the slideshow's internal list of items is
20054 * reached, it'll wrap around to the list's beginning, again.
20056 * @ingroup Slideshow
20058 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20061 * Slide to the @b previous item, in a given slideshow widget
20063 * @param obj The slideshow object
20065 * The sliding animation @p obj is set to use will be the
20066 * transition effect used, after this call is issued.
20068 * @note If the beginning of the slideshow's internal list of items
20069 * is reached, it'll wrap around to the list's end, again.
20071 * @ingroup Slideshow
20073 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20076 * Returns the list of sliding transition/effect names available, for a
20077 * given slideshow widget.
20079 * @param obj The slideshow object
20080 * @return The list of transitions (list of @b stringshared strings
20083 * The transitions, which come from @p obj's theme, must be an EDC
20084 * data item named @c "transitions" on the theme file, with (prefix)
20085 * names of EDC programs actually implementing them.
20087 * The available transitions for slideshows on the default theme are:
20088 * - @c "fade" - the current item fades out, while the new one
20089 * fades in to the slideshow's viewport.
20090 * - @c "black_fade" - the current item fades to black, and just
20091 * then, the new item will fade in.
20092 * - @c "horizontal" - the current item slides horizontally, until
20093 * it gets out of the slideshow's viewport, while the new item
20094 * comes from the left to take its place.
20095 * - @c "vertical" - the current item slides vertically, until it
20096 * gets out of the slideshow's viewport, while the new item comes
20097 * from the bottom to take its place.
20098 * - @c "square" - the new item starts to appear from the middle of
20099 * the current one, but with a tiny size, growing until its
20100 * target (full) size and covering the old one.
20102 * @warning The stringshared strings get no new references
20103 * exclusive to the user grabbing the list, here, so if you'd like
20104 * to use them out of this call's context, you'd better @c
20105 * eina_stringshare_ref() them.
20107 * @see elm_slideshow_transition_set()
20109 * @ingroup Slideshow
20111 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20114 * Set the current slide transition/effect in use for a given
20117 * @param obj The slideshow object
20118 * @param transition The new transition's name string
20120 * If @p transition is implemented in @p obj's theme (i.e., is
20121 * contained in the list returned by
20122 * elm_slideshow_transitions_get()), this new sliding effect will
20123 * be used on the widget.
20125 * @see elm_slideshow_transitions_get() for more details
20127 * @ingroup Slideshow
20129 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20132 * Get the current slide transition/effect in use for a given
20135 * @param obj The slideshow object
20136 * @return The current transition's name
20138 * @see elm_slideshow_transition_set() for more details
20140 * @ingroup Slideshow
20142 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20145 * Set the interval between each image transition on a given
20146 * slideshow widget, <b>and start the slideshow, itself</b>
20148 * @param obj The slideshow object
20149 * @param timeout The new displaying timeout for images
20151 * After this call, the slideshow widget will start cycling its
20152 * view, sequentially and automatically, with the images of the
20153 * items it has. The time between each new image displayed is going
20154 * to be @p timeout, in @b seconds. If a different timeout was set
20155 * previously and an slideshow was in progress, it will continue
20156 * with the new time between transitions, after this call.
20158 * @note A value less than or equal to 0 on @p timeout will disable
20159 * the widget's internal timer, thus halting any slideshow which
20160 * could be happening on @p obj.
20162 * @see elm_slideshow_timeout_get()
20164 * @ingroup Slideshow
20166 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20169 * Get the interval set for image transitions on a given slideshow
20172 * @param obj The slideshow object
20173 * @return Returns the timeout set on it
20175 * @see elm_slideshow_timeout_set() for more details
20177 * @ingroup Slideshow
20179 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20182 * Set if, after a slideshow is started, for a given slideshow
20183 * widget, its items should be displayed cyclically or not.
20185 * @param obj The slideshow object
20186 * @param loop Use @c EINA_TRUE to make it cycle through items or
20187 * @c EINA_FALSE for it to stop at the end of @p obj's internal
20190 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20191 * ignore what is set by this functions, i.e., they'll @b always
20192 * cycle through items. This affects only the "automatic"
20193 * slideshow, as set by elm_slideshow_timeout_set().
20195 * @see elm_slideshow_loop_get()
20197 * @ingroup Slideshow
20199 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20202 * Get if, after a slideshow is started, for a given slideshow
20203 * widget, its items are to be displayed cyclically or not.
20205 * @param obj The slideshow object
20206 * @return @c EINA_TRUE, if the items in @p obj will be cycled
20207 * through or @c EINA_FALSE, otherwise
20209 * @see elm_slideshow_loop_set() for more details
20211 * @ingroup Slideshow
20213 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20216 * Remove all items from a given slideshow widget
20218 * @param obj The slideshow object
20220 * This removes (and deletes) all items in @p obj, leaving it
20223 * @see elm_slideshow_item_del(), to remove just one item.
20225 * @ingroup Slideshow
20227 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20230 * Get the internal list of items in a given slideshow widget.
20232 * @param obj The slideshow object
20233 * @return The list of items (#Elm_Slideshow_Item as data) or
20234 * @c NULL on errors.
20236 * This list is @b not to be modified in any way and must not be
20237 * freed. Use the list members with functions like
20238 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20240 * @warning This list is only valid until @p obj object's internal
20241 * items list is changed. It should be fetched again with another
20242 * call to this function when changes happen.
20244 * @ingroup Slideshow
20246 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20249 * Delete a given item from a slideshow widget.
20251 * @param item The slideshow item
20253 * @ingroup Slideshow
20255 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20258 * Return the data associated with a given slideshow item
20260 * @param item The slideshow item
20261 * @return Returns the data associated to this item
20263 * @ingroup Slideshow
20265 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20268 * Returns the currently displayed item, in a given slideshow widget
20270 * @param obj The slideshow object
20271 * @return A handle to the item being displayed in @p obj or
20272 * @c NULL, if none is (and on errors)
20274 * @ingroup Slideshow
20276 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20279 * Get the real Evas object created to implement the view of a
20280 * given slideshow item
20282 * @param item The slideshow item.
20283 * @return the Evas object implementing this item's view.
20285 * This returns the actual Evas object used to implement the
20286 * specified slideshow item's view. This may be @c NULL, as it may
20287 * not have been created or may have been deleted, at any time, by
20288 * the slideshow. <b>Do not modify this object</b> (move, resize,
20289 * show, hide, etc.), as the slideshow is controlling it. This
20290 * function is for querying, emitting custom signals or hooking
20291 * lower level callbacks for events on that object. Do not delete
20292 * this object under any circumstances.
20294 * @see elm_slideshow_item_data_get()
20296 * @ingroup Slideshow
20298 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20301 * Get the the item, in a given slideshow widget, placed at
20302 * position @p nth, in its internal items list
20304 * @param obj The slideshow object
20305 * @param nth The number of the item to grab a handle to (0 being
20307 * @return The item stored in @p obj at position @p nth or @c NULL,
20308 * if there's no item with that index (and on errors)
20310 * @ingroup Slideshow
20312 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20315 * Set the current slide layout in use for a given slideshow widget
20317 * @param obj The slideshow object
20318 * @param layout The new layout's name string
20320 * If @p layout is implemented in @p obj's theme (i.e., is contained
20321 * in the list returned by elm_slideshow_layouts_get()), this new
20322 * images layout will be used on the widget.
20324 * @see elm_slideshow_layouts_get() for more details
20326 * @ingroup Slideshow
20328 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20331 * Get the current slide layout in use for a given slideshow widget
20333 * @param obj The slideshow object
20334 * @return The current layout's name
20336 * @see elm_slideshow_layout_set() for more details
20338 * @ingroup Slideshow
20340 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20343 * Returns the list of @b layout names available, for a given
20344 * slideshow widget.
20346 * @param obj The slideshow object
20347 * @return The list of layouts (list of @b stringshared strings
20350 * Slideshow layouts will change how the widget is to dispose each
20351 * image item in its viewport, with regard to cropping, scaling,
20354 * The layouts, which come from @p obj's theme, must be an EDC
20355 * data item name @c "layouts" on the theme file, with (prefix)
20356 * names of EDC programs actually implementing them.
20358 * The available layouts for slideshows on the default theme are:
20359 * - @c "fullscreen" - item images with original aspect, scaled to
20360 * touch top and down slideshow borders or, if the image's heigh
20361 * is not enough, left and right slideshow borders.
20362 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20363 * one, but always leaving 10% of the slideshow's dimensions of
20364 * distance between the item image's borders and the slideshow
20365 * borders, for each axis.
20367 * @warning The stringshared strings get no new references
20368 * exclusive to the user grabbing the list, here, so if you'd like
20369 * to use them out of this call's context, you'd better @c
20370 * eina_stringshare_ref() them.
20372 * @see elm_slideshow_layout_set()
20374 * @ingroup Slideshow
20376 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20379 * Set the number of items to cache, on a given slideshow widget,
20380 * <b>before the current item</b>
20382 * @param obj The slideshow object
20383 * @param count Number of items to cache before the current one
20385 * The default value for this property is @c 2. See
20386 * @ref Slideshow_Caching "slideshow caching" for more details.
20388 * @see elm_slideshow_cache_before_get()
20390 * @ingroup Slideshow
20392 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20395 * Retrieve the number of items to cache, on a given slideshow widget,
20396 * <b>before the current item</b>
20398 * @param obj The slideshow object
20399 * @return The number of items set to be cached before the current one
20401 * @see elm_slideshow_cache_before_set() for more details
20403 * @ingroup Slideshow
20405 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20408 * Set the number of items to cache, on a given slideshow widget,
20409 * <b>after the current item</b>
20411 * @param obj The slideshow object
20412 * @param count Number of items to cache after the current one
20414 * The default value for this property is @c 2. See
20415 * @ref Slideshow_Caching "slideshow caching" for more details.
20417 * @see elm_slideshow_cache_after_get()
20419 * @ingroup Slideshow
20421 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20424 * Retrieve the number of items to cache, on a given slideshow widget,
20425 * <b>after the current item</b>
20427 * @param obj The slideshow object
20428 * @return The number of items set to be cached after the current one
20430 * @see elm_slideshow_cache_after_set() for more details
20432 * @ingroup Slideshow
20434 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20437 * Get the number of items stored in a given slideshow widget
20439 * @param obj The slideshow object
20440 * @return The number of items on @p obj, at the moment of this call
20442 * @ingroup Slideshow
20444 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20451 * @defgroup Fileselector File Selector
20453 * @image html img/widget/fileselector/preview-00.png
20454 * @image latex img/widget/fileselector/preview-00.eps
20456 * A file selector is a widget that allows a user to navigate
20457 * through a file system, reporting file selections back via its
20460 * It contains shortcut buttons for home directory (@c ~) and to
20461 * jump one directory upwards (..), as well as cancel/ok buttons to
20462 * confirm/cancel a given selection. After either one of those two
20463 * former actions, the file selector will issue its @c "done" smart
20466 * There's a text entry on it, too, showing the name of the current
20467 * selection. There's the possibility of making it editable, so it
20468 * is useful on file saving dialogs on applications, where one
20469 * gives a file name to save contents to, in a given directory in
20470 * the system. This custom file name will be reported on the @c
20471 * "done" smart callback (explained in sequence).
20473 * Finally, it has a view to display file system items into in two
20478 * If Elementary is built with support of the Ethumb thumbnailing
20479 * library, the second form of view will display preview thumbnails
20480 * of files which it supports.
20482 * Smart callbacks one can register to:
20484 * - @c "selected" - the user has clicked on a file (when not in
20485 * folders-only mode) or directory (when in folders-only mode)
20486 * - @c "directory,open" - the list has been populated with new
20487 * content (@c event_info is a pointer to the directory's
20488 * path, a @b stringshared string)
20489 * - @c "done" - the user has clicked on the "ok" or "cancel"
20490 * buttons (@c event_info is a pointer to the selection's
20491 * path, a @b stringshared string)
20493 * Here is an example on its usage:
20494 * @li @ref fileselector_example
20498 * @addtogroup Fileselector
20503 * Defines how a file selector widget is to layout its contents
20504 * (file system entries).
20506 typedef enum _Elm_Fileselector_Mode
20508 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20509 ELM_FILESELECTOR_GRID, /**< layout as a grid */
20510 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20511 } Elm_Fileselector_Mode;
20514 * Add a new file selector widget to the given parent Elementary
20515 * (container) object
20517 * @param parent The parent object
20518 * @return a new file selector widget handle or @c NULL, on errors
20520 * This function inserts a new file selector widget on the canvas.
20522 * @ingroup Fileselector
20524 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20527 * Enable/disable the file name entry box where the user can type
20528 * in a name for a file, in a given file selector widget
20530 * @param obj The file selector object
20531 * @param is_save @c EINA_TRUE to make the file selector a "saving
20532 * dialog", @c EINA_FALSE otherwise
20534 * Having the entry editable is useful on file saving dialogs on
20535 * applications, where one gives a file name to save contents to,
20536 * in a given directory in the system. This custom file name will
20537 * be reported on the @c "done" smart callback.
20539 * @see elm_fileselector_is_save_get()
20541 * @ingroup Fileselector
20543 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20546 * Get whether the given file selector is in "saving dialog" mode
20548 * @param obj The file selector object
20549 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20550 * mode, @c EINA_FALSE otherwise (and on errors)
20552 * @see elm_fileselector_is_save_set() for more details
20554 * @ingroup Fileselector
20556 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20559 * Enable/disable folder-only view for a given file selector widget
20561 * @param obj The file selector object
20562 * @param only @c EINA_TRUE to make @p obj only display
20563 * directories, @c EINA_FALSE to make files to be displayed in it
20566 * If enabled, the widget's view will only display folder items,
20569 * @see elm_fileselector_folder_only_get()
20571 * @ingroup Fileselector
20573 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20576 * Get whether folder-only view is set for a given file selector
20579 * @param obj The file selector object
20580 * @return only @c EINA_TRUE if @p obj is only displaying
20581 * directories, @c EINA_FALSE if files are being displayed in it
20582 * too (and on errors)
20584 * @see elm_fileselector_folder_only_get()
20586 * @ingroup Fileselector
20588 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20591 * Enable/disable the "ok" and "cancel" buttons on a given file
20594 * @param obj The file selector object
20595 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20597 * @note A file selector without those buttons will never emit the
20598 * @c "done" smart event, and is only usable if one is just hooking
20599 * to the other two events.
20601 * @see elm_fileselector_buttons_ok_cancel_get()
20603 * @ingroup Fileselector
20605 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20608 * Get whether the "ok" and "cancel" buttons on a given file
20609 * selector widget are being shown.
20611 * @param obj The file selector object
20612 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20613 * otherwise (and on errors)
20615 * @see elm_fileselector_buttons_ok_cancel_set() for more details
20617 * @ingroup Fileselector
20619 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20622 * Enable/disable a tree view in the given file selector widget,
20623 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20625 * @param obj The file selector object
20626 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20629 * In a tree view, arrows are created on the sides of directories,
20630 * allowing them to expand in place.
20632 * @note If it's in other mode, the changes made by this function
20633 * will only be visible when one switches back to "list" mode.
20635 * @see elm_fileselector_expandable_get()
20637 * @ingroup Fileselector
20639 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20642 * Get whether tree view is enabled for the given file selector
20645 * @param obj The file selector object
20646 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20647 * otherwise (and or errors)
20649 * @see elm_fileselector_expandable_set() for more details
20651 * @ingroup Fileselector
20653 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20656 * Set, programmatically, the @b directory that a given file
20657 * selector widget will display contents from
20659 * @param obj The file selector object
20660 * @param path The path to display in @p obj
20662 * This will change the @b directory that @p obj is displaying. It
20663 * will also clear the text entry area on the @p obj object, which
20664 * displays select files' names.
20666 * @see elm_fileselector_path_get()
20668 * @ingroup Fileselector
20670 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20673 * Get the parent directory's path that a given file selector
20674 * widget is displaying
20676 * @param obj The file selector object
20677 * @return The (full) path of the directory the file selector is
20678 * displaying, a @b stringshared string
20680 * @see elm_fileselector_path_set()
20682 * @ingroup Fileselector
20684 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20687 * Set, programmatically, the currently selected file/directory in
20688 * the given file selector widget
20690 * @param obj The file selector object
20691 * @param path The (full) path to a file or directory
20692 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
20693 * latter case occurs if the directory or file pointed to do not
20696 * @see elm_fileselector_selected_get()
20698 * @ingroup Fileselector
20700 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20703 * Get the currently selected item's (full) path, in the given file
20706 * @param obj The file selector object
20707 * @return The absolute path of the selected item, a @b
20708 * stringshared string
20710 * @note Custom editions on @p obj object's text entry, if made,
20711 * will appear on the return string of this function, naturally.
20713 * @see elm_fileselector_selected_set() for more details
20715 * @ingroup Fileselector
20717 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20720 * Set the mode in which a given file selector widget will display
20721 * (layout) file system entries in its view
20723 * @param obj The file selector object
20724 * @param mode The mode of the fileselector, being it one of
20725 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
20726 * first one, naturally, will display the files in a list. The
20727 * latter will make the widget to display its entries in a grid
20730 * @note By using elm_fileselector_expandable_set(), the user may
20731 * trigger a tree view for that list.
20733 * @note If Elementary is built with support of the Ethumb
20734 * thumbnailing library, the second form of view will display
20735 * preview thumbnails of files which it supports. You must have
20736 * elm_need_ethumb() called in your Elementary for thumbnailing to
20739 * @see elm_fileselector_expandable_set().
20740 * @see elm_fileselector_mode_get().
20742 * @ingroup Fileselector
20744 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
20747 * Get the mode in which a given file selector widget is displaying
20748 * (layouting) file system entries in its view
20750 * @param obj The fileselector object
20751 * @return The mode in which the fileselector is at
20753 * @see elm_fileselector_mode_set() for more details
20755 * @ingroup Fileselector
20757 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20764 * @defgroup Progressbar Progress bar
20766 * The progress bar is a widget for visually representing the
20767 * progress status of a given job/task.
20769 * A progress bar may be horizontal or vertical. It may display an
20770 * icon besides it, as well as primary and @b units labels. The
20771 * former is meant to label the widget as a whole, while the
20772 * latter, which is formatted with floating point values (and thus
20773 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
20774 * units"</c>), is meant to label the widget's <b>progress
20775 * value</b>. Label, icon and unit strings/objects are @b optional
20776 * for progress bars.
20778 * A progress bar may be @b inverted, in which state it gets its
20779 * values inverted, with high values being on the left or top and
20780 * low values on the right or bottom, as opposed to normally have
20781 * the low values on the former and high values on the latter,
20782 * respectively, for horizontal and vertical modes.
20784 * The @b span of the progress, as set by
20785 * elm_progressbar_span_size_set(), is its length (horizontally or
20786 * vertically), unless one puts size hints on the widget to expand
20787 * on desired directions, by any container. That length will be
20788 * scaled by the object or applications scaling factor. At any
20789 * point code can query the progress bar for its value with
20790 * elm_progressbar_value_get().
20792 * Available widget styles for progress bars:
20794 * - @c "wheel" (simple style, no text, no progression, only
20795 * "pulse" effect is available)
20797 * Here is an example on its usage:
20798 * @li @ref progressbar_example
20802 * Add a new progress bar widget to the given parent Elementary
20803 * (container) object
20805 * @param parent The parent object
20806 * @return a new progress bar widget handle or @c NULL, on errors
20808 * This function inserts a new progress bar widget on the canvas.
20810 * @ingroup Progressbar
20812 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20815 * Set whether a given progress bar widget is at "pulsing mode" or
20818 * @param obj The progress bar object
20819 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
20820 * @c EINA_FALSE to put it back to its default one
20822 * By default, progress bars will display values from the low to
20823 * high value boundaries. There are, though, contexts in which the
20824 * state of progression of a given task is @b unknown. For those,
20825 * one can set a progress bar widget to a "pulsing state", to give
20826 * the user an idea that some computation is being held, but
20827 * without exact progress values. In the default theme it will
20828 * animate its bar with the contents filling in constantly and back
20829 * to non-filled, in a loop. To start and stop this pulsing
20830 * animation, one has to explicitly call elm_progressbar_pulse().
20832 * @see elm_progressbar_pulse_get()
20833 * @see elm_progressbar_pulse()
20835 * @ingroup Progressbar
20837 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
20840 * Get whether a given progress bar widget is at "pulsing mode" or
20843 * @param obj The progress bar object
20844 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
20845 * if it's in the default one (and on errors)
20847 * @ingroup Progressbar
20849 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20852 * Start/stop a given progress bar "pulsing" animation, if its
20855 * @param obj The progress bar object
20856 * @param state @c EINA_TRUE, to @b start the pulsing animation,
20857 * @c EINA_FALSE to @b stop it
20859 * @note This call won't do anything if @p obj is not under "pulsing mode".
20861 * @see elm_progressbar_pulse_set() for more details.
20863 * @ingroup Progressbar
20865 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20868 * Set the progress value (in percentage) on a given progress bar
20871 * @param obj The progress bar object
20872 * @param val The progress value (@b must be between @c 0.0 and @c
20875 * Use this call to set progress bar levels.
20877 * @note If you passes a value out of the specified range for @p
20878 * val, it will be interpreted as the @b closest of the @b boundary
20879 * values in the range.
20881 * @ingroup Progressbar
20883 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
20886 * Get the progress value (in percentage) on a given progress bar
20889 * @param obj The progress bar object
20890 * @return The value of the progressbar
20892 * @see elm_progressbar_value_set() for more details
20894 * @ingroup Progressbar
20896 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20899 * Set the label of a given progress bar widget
20901 * @param obj The progress bar object
20902 * @param label The text label string, in UTF-8
20904 * @ingroup Progressbar
20905 * @deprecated use elm_object_text_set() instead.
20907 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20910 * Get the label of a given progress bar widget
20912 * @param obj The progressbar object
20913 * @return The text label string, in UTF-8
20915 * @ingroup Progressbar
20916 * @deprecated use elm_object_text_set() instead.
20918 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20921 * Set the icon object of a given progress bar widget
20923 * @param obj The progress bar object
20924 * @param icon The icon object
20926 * Use this call to decorate @p obj with an icon next to it.
20928 * @note Once the icon object is set, a previously set one will be
20929 * deleted. If you want to keep that old content object, use the
20930 * elm_progressbar_icon_unset() function.
20932 * @see elm_progressbar_icon_get()
20934 * @ingroup Progressbar
20936 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20939 * Retrieve the icon object set for a given progress bar widget
20941 * @param obj The progress bar object
20942 * @return The icon object's handle, if @p obj had one set, or @c NULL,
20943 * otherwise (and on errors)
20945 * @see elm_progressbar_icon_set() for more details
20947 * @ingroup Progressbar
20949 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20952 * Unset an icon set on a given progress bar widget
20954 * @param obj The progress bar object
20955 * @return The icon object that was being used, if any was set, or
20956 * @c NULL, otherwise (and on errors)
20958 * This call will unparent and return the icon object which was set
20959 * for this widget, previously, on success.
20961 * @see elm_progressbar_icon_set() for more details
20963 * @ingroup Progressbar
20965 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20968 * Set the (exact) length of the bar region of a given progress bar
20971 * @param obj The progress bar object
20972 * @param size The length of the progress bar's bar region
20974 * This sets the minimum width (when in horizontal mode) or height
20975 * (when in vertical mode) of the actual bar area of the progress
20976 * bar @p obj. This in turn affects the object's minimum size. Use
20977 * this when you're not setting other size hints expanding on the
20978 * given direction (like weight and alignment hints) and you would
20979 * like it to have a specific size.
20981 * @note Icon, label and unit text around @p obj will require their
20982 * own space, which will make @p obj to require more the @p size,
20985 * @see elm_progressbar_span_size_get()
20987 * @ingroup Progressbar
20989 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
20992 * Get the length set for the bar region of a given progress bar
20995 * @param obj The progress bar object
20996 * @return The length of the progress bar's bar region
20998 * If that size was not set previously, with
20999 * elm_progressbar_span_size_set(), this call will return @c 0.
21001 * @ingroup Progressbar
21003 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21006 * Set the format string for a given progress bar widget's units
21009 * @param obj The progress bar object
21010 * @param format The format string for @p obj's units label
21012 * If @c NULL is passed on @p format, it will make @p obj's units
21013 * area to be hidden completely. If not, it'll set the <b>format
21014 * string</b> for the units label's @b text. The units label is
21015 * provided a floating point value, so the units text is up display
21016 * at most one floating point falue. Note that the units label is
21017 * optional. Use a format string such as "%1.2f meters" for
21020 * @note The default format string for a progress bar is an integer
21021 * percentage, as in @c "%.0f %%".
21023 * @see elm_progressbar_unit_format_get()
21025 * @ingroup Progressbar
21027 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21030 * Retrieve the format string set for a given progress bar widget's
21033 * @param obj The progress bar object
21034 * @return The format set string for @p obj's units label or
21035 * @c NULL, if none was set (and on errors)
21037 * @see elm_progressbar_unit_format_set() for more details
21039 * @ingroup Progressbar
21041 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21044 * Set the orientation of a given progress bar widget
21046 * @param obj The progress bar object
21047 * @param horizontal Use @c EINA_TRUE to make @p obj to be
21048 * @b horizontal, @c EINA_FALSE to make it @b vertical
21050 * Use this function to change how your progress bar is to be
21051 * disposed: vertically or horizontally.
21053 * @see elm_progressbar_horizontal_get()
21055 * @ingroup Progressbar
21057 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21060 * Retrieve the orientation of a given progress bar widget
21062 * @param obj The progress bar object
21063 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21064 * @c EINA_FALSE if it's @b vertical (and on errors)
21066 * @see elm_progressbar_horizontal_set() for more details
21068 * @ingroup Progressbar
21070 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21073 * Invert a given progress bar widget's displaying values order
21075 * @param obj The progress bar object
21076 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21077 * @c EINA_FALSE to bring it back to default, non-inverted values.
21079 * A progress bar may be @b inverted, in which state it gets its
21080 * values inverted, with high values being on the left or top and
21081 * low values on the right or bottom, as opposed to normally have
21082 * the low values on the former and high values on the latter,
21083 * respectively, for horizontal and vertical modes.
21085 * @see elm_progressbar_inverted_get()
21087 * @ingroup Progressbar
21089 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21092 * Get whether a given progress bar widget's displaying values are
21095 * @param obj The progress bar object
21096 * @return @c EINA_TRUE, if @p obj has inverted values,
21097 * @c EINA_FALSE otherwise (and on errors)
21099 * @see elm_progressbar_inverted_set() for more details
21101 * @ingroup Progressbar
21103 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21106 * @defgroup Separator Separator
21108 * @brief Separator is a very thin object used to separate other objects.
21110 * A separator can be vertical or horizontal.
21112 * @ref tutorial_separator is a good example of how to use a separator.
21116 * @brief Add a separator object to @p parent
21118 * @param parent The parent object
21120 * @return The separator object, or NULL upon failure
21122 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21124 * @brief Set the horizontal mode of a separator object
21126 * @param obj The separator object
21127 * @param horizontal If true, the separator is horizontal
21129 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21131 * @brief Get the horizontal mode of a separator object
21133 * @param obj The separator object
21134 * @return If true, the separator is horizontal
21136 * @see elm_separator_horizontal_set()
21138 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21144 * @defgroup Spinner Spinner
21145 * @ingroup Elementary
21147 * @image html img/widget/spinner/preview-00.png
21148 * @image latex img/widget/spinner/preview-00.eps
21150 * A spinner is a widget which allows the user to increase or decrease
21151 * numeric values using arrow buttons, or edit values directly, clicking
21152 * over it and typing the new value.
21154 * By default the spinner will not wrap and has a label
21155 * of "%.0f" (just showing the integer value of the double).
21157 * A spinner has a label that is formatted with floating
21158 * point values and thus accepts a printf-style format string, like
21161 * It also allows specific values to be replaced by pre-defined labels.
21163 * Smart callbacks one can register to:
21165 * - "changed" - Whenever the spinner value is changed.
21166 * - "delay,changed" - A short time after the value is changed by the user.
21167 * This will be called only when the user stops dragging for a very short
21168 * period or when they release their finger/mouse, so it avoids possibly
21169 * expensive reactions to the value change.
21171 * Available styles for it:
21173 * - @c "vertical": up/down buttons at the right side and text left aligned.
21175 * Here is an example on its usage:
21176 * @ref spinner_example
21180 * @addtogroup Spinner
21185 * Add a new spinner widget to the given parent Elementary
21186 * (container) object.
21188 * @param parent The parent object.
21189 * @return a new spinner widget handle or @c NULL, on errors.
21191 * This function inserts a new spinner widget on the canvas.
21196 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21199 * Set the format string of the displayed label.
21201 * @param obj The spinner object.
21202 * @param fmt The format string for the label display.
21204 * If @c NULL, this sets the format to "%.0f". If not it sets the format
21205 * string for the label text. The label text is provided a floating point
21206 * value, so the label text can display up to 1 floating point value.
21207 * Note that this is optional.
21209 * Use a format string such as "%1.2f meters" for example, and it will
21210 * display values like: "3.14 meters" for a value equal to 3.14159.
21212 * Default is "%0.f".
21214 * @see elm_spinner_label_format_get()
21218 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21221 * Get the label format of the spinner.
21223 * @param obj The spinner object.
21224 * @return The text label format string in UTF-8.
21226 * @see elm_spinner_label_format_set() for details.
21230 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21233 * Set the minimum and maximum values for the spinner.
21235 * @param obj The spinner object.
21236 * @param min The minimum value.
21237 * @param max The maximum value.
21239 * Define the allowed range of values to be selected by the user.
21241 * If actual value is less than @p min, it will be updated to @p min. If it
21242 * is bigger then @p max, will be updated to @p max. Actual value can be
21243 * get with elm_spinner_value_get().
21245 * By default, min is equal to 0, and max is equal to 100.
21247 * @warning Maximum must be greater than minimum.
21249 * @see elm_spinner_min_max_get()
21253 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21256 * Get the minimum and maximum values of the spinner.
21258 * @param obj The spinner object.
21259 * @param min Pointer where to store the minimum value.
21260 * @param max Pointer where to store the maximum value.
21262 * @note If only one value is needed, the other pointer can be passed
21265 * @see elm_spinner_min_max_set() for details.
21269 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21272 * Set the step used to increment or decrement the spinner value.
21274 * @param obj The spinner object.
21275 * @param step The step value.
21277 * This value will be incremented or decremented to the displayed value.
21278 * It will be incremented while the user keep right or top arrow pressed,
21279 * and will be decremented while the user keep left or bottom arrow pressed.
21281 * The interval to increment / decrement can be set with
21282 * elm_spinner_interval_set().
21284 * By default step value is equal to 1.
21286 * @see elm_spinner_step_get()
21290 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21293 * Get the step used to increment or decrement the spinner value.
21295 * @param obj The spinner object.
21296 * @return The step value.
21298 * @see elm_spinner_step_get() for more details.
21302 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21305 * Set the value the spinner displays.
21307 * @param obj The spinner object.
21308 * @param val The value to be displayed.
21310 * Value will be presented on the label following format specified with
21311 * elm_spinner_format_set().
21313 * @warning The value must to be between min and max values. This values
21314 * are set by elm_spinner_min_max_set().
21316 * @see elm_spinner_value_get().
21317 * @see elm_spinner_format_set().
21318 * @see elm_spinner_min_max_set().
21322 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21325 * Get the value displayed by the spinner.
21327 * @param obj The spinner object.
21328 * @return The value displayed.
21330 * @see elm_spinner_value_set() for details.
21334 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21337 * Set whether the spinner should wrap when it reaches its
21338 * minimum or maximum value.
21340 * @param obj The spinner object.
21341 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21344 * Disabled by default. If disabled, when the user tries to increment the
21346 * but displayed value plus step value is bigger than maximum value,
21348 * won't allow it. The same happens when the user tries to decrement it,
21349 * but the value less step is less than minimum value.
21351 * When wrap is enabled, in such situations it will allow these changes,
21352 * but will get the value that would be less than minimum and subtracts
21353 * from maximum. Or add the value that would be more than maximum to
21357 * @li min value = 10
21358 * @li max value = 50
21359 * @li step value = 20
21360 * @li displayed value = 20
21362 * When the user decrement value (using left or bottom arrow), it will
21363 * displays @c 40, because max - (min - (displayed - step)) is
21364 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21366 * @see elm_spinner_wrap_get().
21370 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21373 * Get whether the spinner should wrap when it reaches its
21374 * minimum or maximum value.
21376 * @param obj The spinner object
21377 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21378 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21380 * @see elm_spinner_wrap_set() for details.
21384 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21387 * Set whether the spinner can be directly edited by the user or not.
21389 * @param obj The spinner object.
21390 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21391 * don't allow users to edit it directly.
21393 * Spinner objects can have edition @b disabled, in which state they will
21394 * be changed only by arrows.
21395 * Useful for contexts
21396 * where you don't want your users to interact with it writting the value.
21398 * when using special values, the user can see real value instead
21399 * of special label on edition.
21401 * It's enabled by default.
21403 * @see elm_spinner_editable_get()
21407 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21410 * Get whether the spinner can be directly edited by the user or not.
21412 * @param obj The spinner object.
21413 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21414 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21416 * @see elm_spinner_editable_set() for details.
21420 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21423 * Set a special string to display in the place of the numerical value.
21425 * @param obj The spinner object.
21426 * @param value The value to be replaced.
21427 * @param label The label to be used.
21429 * It's useful for cases when a user should select an item that is
21430 * better indicated by a label than a value. For example, weekdays or months.
21434 * sp = elm_spinner_add(win);
21435 * elm_spinner_min_max_set(sp, 1, 3);
21436 * elm_spinner_special_value_add(sp, 1, "January");
21437 * elm_spinner_special_value_add(sp, 2, "February");
21438 * elm_spinner_special_value_add(sp, 3, "March");
21439 * evas_object_show(sp);
21444 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21447 * Set the interval on time updates for an user mouse button hold
21448 * on spinner widgets' arrows.
21450 * @param obj The spinner object.
21451 * @param interval The (first) interval value in seconds.
21453 * This interval value is @b decreased while the user holds the
21454 * mouse pointer either incrementing or decrementing spinner's value.
21456 * This helps the user to get to a given value distant from the
21457 * current one easier/faster, as it will start to change quicker and
21458 * quicker on mouse button holds.
21460 * The calculation for the next change interval value, starting from
21461 * the one set with this call, is the previous interval divided by
21462 * @c 1.05, so it decreases a little bit.
21464 * The default starting interval value for automatic changes is
21467 * @see elm_spinner_interval_get()
21471 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21474 * Get the interval on time updates for an user mouse button hold
21475 * on spinner widgets' arrows.
21477 * @param obj The spinner object.
21478 * @return The (first) interval value, in seconds, set on it.
21480 * @see elm_spinner_interval_set() for more details.
21484 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21491 * @defgroup Index Index
21493 * @image html img/widget/index/preview-00.png
21494 * @image latex img/widget/index/preview-00.eps
21496 * An index widget gives you an index for fast access to whichever
21497 * group of other UI items one might have. It's a list of text
21498 * items (usually letters, for alphabetically ordered access).
21500 * Index widgets are by default hidden and just appear when the
21501 * user clicks over it's reserved area in the canvas. In its
21502 * default theme, it's an area one @ref Fingers "finger" wide on
21503 * the right side of the index widget's container.
21505 * When items on the index are selected, smart callbacks get
21506 * called, so that its user can make other container objects to
21507 * show a given area or child object depending on the index item
21508 * selected. You'd probably be using an index together with @ref
21509 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21512 * Smart events one can add callbacks for are:
21513 * - @c "changed" - When the selected index item changes. @c
21514 * event_info is the selected item's data pointer.
21515 * - @c "delay,changed" - When the selected index item changes, but
21516 * after a small idling period. @c event_info is the selected
21517 * item's data pointer.
21518 * - @c "selected" - When the user releases a mouse button and
21519 * selects an item. @c event_info is the selected item's data
21521 * - @c "level,up" - when the user moves a finger from the first
21522 * level to the second level
21523 * - @c "level,down" - when the user moves a finger from the second
21524 * level to the first level
21526 * The @c "delay,changed" event is so that it'll wait a small time
21527 * before actually reporting those events and, moreover, just the
21528 * last event happening on those time frames will actually be
21531 * Here are some examples on its usage:
21532 * @li @ref index_example_01
21533 * @li @ref index_example_02
21537 * @addtogroup Index
21541 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21544 * Add a new index widget to the given parent Elementary
21545 * (container) object
21547 * @param parent The parent object
21548 * @return a new index widget handle or @c NULL, on errors
21550 * This function inserts a new index widget on the canvas.
21554 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21557 * Set whether a given index widget is or not visible,
21560 * @param obj The index object
21561 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21563 * Not to be confused with visible as in @c evas_object_show() --
21564 * visible with regard to the widget's auto hiding feature.
21566 * @see elm_index_active_get()
21570 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21573 * Get whether a given index widget is currently visible or not.
21575 * @param obj The index object
21576 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21578 * @see elm_index_active_set() for more details
21582 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21585 * Set the items level for a given index widget.
21587 * @param obj The index object.
21588 * @param level @c 0 or @c 1, the currently implemented levels.
21590 * @see elm_index_item_level_get()
21594 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21597 * Get the items level set for a given index widget.
21599 * @param obj The index object.
21600 * @return @c 0 or @c 1, which are the levels @p obj might be at.
21602 * @see elm_index_item_level_set() for more information
21606 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21609 * Returns the last selected item's data, for a given index widget.
21611 * @param obj The index object.
21612 * @return The item @b data associated to the last selected item on
21613 * @p obj (or @c NULL, on errors).
21615 * @warning The returned value is @b not an #Elm_Index_Item item
21616 * handle, but the data associated to it (see the @c item parameter
21617 * in elm_index_item_append(), as an example).
21621 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21624 * Append a new item on a given index widget.
21626 * @param obj The index object.
21627 * @param letter Letter under which the item should be indexed
21628 * @param item The item data to set for the index's item
21630 * Despite the most common usage of the @p letter argument is for
21631 * single char strings, one could use arbitrary strings as index
21634 * @c item will be the pointer returned back on @c "changed", @c
21635 * "delay,changed" and @c "selected" smart events.
21639 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21642 * Prepend a new item on a given index widget.
21644 * @param obj The index object.
21645 * @param letter Letter under which the item should be indexed
21646 * @param item The item data to set for the index's item
21648 * Despite the most common usage of the @p letter argument is for
21649 * single char strings, one could use arbitrary strings as index
21652 * @c item will be the pointer returned back on @c "changed", @c
21653 * "delay,changed" and @c "selected" smart events.
21657 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21660 * Append a new item, on a given index widget, <b>after the item
21661 * having @p relative as data</b>.
21663 * @param obj The index object.
21664 * @param letter Letter under which the item should be indexed
21665 * @param item The item data to set for the index's item
21666 * @param relative The item data of the index item to be the
21667 * predecessor of this new one
21669 * Despite the most common usage of the @p letter argument is for
21670 * single char strings, one could use arbitrary strings as index
21673 * @c item will be the pointer returned back on @c "changed", @c
21674 * "delay,changed" and @c "selected" smart events.
21676 * @note If @p relative is @c NULL or if it's not found to be data
21677 * set on any previous item on @p obj, this function will behave as
21678 * elm_index_item_append().
21682 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21685 * Prepend a new item, on a given index widget, <b>after the item
21686 * having @p relative as data</b>.
21688 * @param obj The index object.
21689 * @param letter Letter under which the item should be indexed
21690 * @param item The item data to set for the index's item
21691 * @param relative The item data of the index item to be the
21692 * successor of this new one
21694 * Despite the most common usage of the @p letter argument is for
21695 * single char strings, one could use arbitrary strings as index
21698 * @c item will be the pointer returned back on @c "changed", @c
21699 * "delay,changed" and @c "selected" smart events.
21701 * @note If @p relative is @c NULL or if it's not found to be data
21702 * set on any previous item on @p obj, this function will behave as
21703 * elm_index_item_prepend().
21707 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21710 * Insert a new item into the given index widget, using @p cmp_func
21711 * function to sort items (by item handles).
21713 * @param obj The index object.
21714 * @param letter Letter under which the item should be indexed
21715 * @param item The item data to set for the index's item
21716 * @param cmp_func The comparing function to be used to sort index
21717 * items <b>by #Elm_Index_Item item handles</b>
21718 * @param cmp_data_func A @b fallback function to be called for the
21719 * sorting of index items <b>by item data</b>). It will be used
21720 * when @p cmp_func returns @c 0 (equality), which means an index
21721 * item with provided item data already exists. To decide which
21722 * data item should be pointed to by the index item in question, @p
21723 * cmp_data_func will be used. If @p cmp_data_func returns a
21724 * non-negative value, the previous index item data will be
21725 * replaced by the given @p item pointer. If the previous data need
21726 * to be freed, it should be done by the @p cmp_data_func function,
21727 * because all references to it will be lost. If this function is
21728 * not provided (@c NULL is given), index items will be @b
21729 * duplicated, if @p cmp_func returns @c 0.
21731 * Despite the most common usage of the @p letter argument is for
21732 * single char strings, one could use arbitrary strings as index
21735 * @c item will be the pointer returned back on @c "changed", @c
21736 * "delay,changed" and @c "selected" smart events.
21740 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);
21743 * Remove an item from a given index widget, <b>to be referenced by
21744 * it's data value</b>.
21746 * @param obj The index object
21747 * @param item The item's data pointer for the item to be removed
21750 * If a deletion callback is set, via elm_index_item_del_cb_set(),
21751 * that callback function will be called by this one.
21753 * @warning The item to be removed from @p obj will be found via
21754 * its item data pointer, and not by an #Elm_Index_Item handle.
21758 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21761 * Find a given index widget's item, <b>using item data</b>.
21763 * @param obj The index object
21764 * @param item The item data pointed to by the desired index item
21765 * @return The index item handle, if found, or @c NULL otherwise
21769 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21772 * Removes @b all items from a given index widget.
21774 * @param obj The index object.
21776 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
21777 * that callback function will be called for each item in @p obj.
21781 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21784 * Go to a given items level on a index widget
21786 * @param obj The index object
21787 * @param level The index level (one of @c 0 or @c 1)
21791 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21794 * Return the data associated with a given index widget item
21796 * @param it The index widget item handle
21797 * @return The data associated with @p it
21799 * @see elm_index_item_data_set()
21803 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21806 * Set the data associated with a given index widget item
21808 * @param it The index widget item handle
21809 * @param data The new data pointer to set to @p it
21811 * This sets new item data on @p it.
21813 * @warning The old data pointer won't be touched by this function, so
21814 * the user had better to free that old data himself/herself.
21818 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
21821 * Set the function to be called when a given index widget item is freed.
21823 * @param it The item to set the callback on
21824 * @param func The function to call on the item's deletion
21826 * When called, @p func will have both @c data and @c event_info
21827 * arguments with the @p it item's data value and, naturally, the
21828 * @c obj argument with a handle to the parent index widget.
21832 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
21835 * Get the letter (string) set on a given index widget item.
21837 * @param it The index item handle
21838 * @return The letter string set on @p it
21842 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21849 * @defgroup Photocam Photocam
21851 * @image html img/widget/photocam/preview-00.png
21852 * @image latex img/widget/photocam/preview-00.eps
21854 * This is a widget specifically for displaying high-resolution digital
21855 * camera photos giving speedy feedback (fast load), low memory footprint
21856 * and zooming and panning as well as fitting logic. It is entirely focused
21857 * on jpeg images, and takes advantage of properties of the jpeg format (via
21858 * evas loader features in the jpeg loader).
21860 * Signals that you can add callbacks for are:
21861 * @li "clicked" - This is called when a user has clicked the photo without
21863 * @li "press" - This is called when a user has pressed down on the photo.
21864 * @li "longpressed" - This is called when a user has pressed down on the
21865 * photo for a long time without dragging around.
21866 * @li "clicked,double" - This is called when a user has double-clicked the
21868 * @li "load" - Photo load begins.
21869 * @li "loaded" - This is called when the image file load is complete for the
21870 * first view (low resolution blurry version).
21871 * @li "load,detail" - Photo detailed data load begins.
21872 * @li "loaded,detail" - This is called when the image file load is complete
21873 * for the detailed image data (full resolution needed).
21874 * @li "zoom,start" - Zoom animation started.
21875 * @li "zoom,stop" - Zoom animation stopped.
21876 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
21877 * @li "scroll" - the content has been scrolled (moved)
21878 * @li "scroll,anim,start" - scrolling animation has started
21879 * @li "scroll,anim,stop" - scrolling animation has stopped
21880 * @li "scroll,drag,start" - dragging the contents around has started
21881 * @li "scroll,drag,stop" - dragging the contents around has stopped
21883 * @ref tutorial_photocam shows the API in action.
21887 * @brief Types of zoom available.
21889 typedef enum _Elm_Photocam_Zoom_Mode
21891 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
21892 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
21893 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
21894 ELM_PHOTOCAM_ZOOM_MODE_LAST
21895 } Elm_Photocam_Zoom_Mode;
21897 * @brief Add a new Photocam object
21899 * @param parent The parent object
21900 * @return The new object or NULL if it cannot be created
21902 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21904 * @brief Set the photo file to be shown
21906 * @param obj The photocam object
21907 * @param file The photo file
21908 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
21910 * This sets (and shows) the specified file (with a relative or absolute
21911 * path) and will return a load error (same error that
21912 * evas_object_image_load_error_get() will return). The image will change and
21913 * adjust its size at this point and begin a background load process for this
21914 * photo that at some time in the future will be displayed at the full
21917 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
21919 * @brief Returns the path of the current image file
21921 * @param obj The photocam object
21922 * @return Returns the path
21924 * @see elm_photocam_file_set()
21926 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21928 * @brief Set the zoom level of the photo
21930 * @param obj The photocam object
21931 * @param zoom The zoom level to set
21933 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
21934 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
21935 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
21936 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
21939 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
21941 * @brief Get the zoom level of the photo
21943 * @param obj The photocam object
21944 * @return The current zoom level
21946 * This returns the current zoom level of the photocam object. Note that if
21947 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
21948 * (which is the default), the zoom level may be changed at any time by the
21949 * photocam object itself to account for photo size and photocam viewpoer
21952 * @see elm_photocam_zoom_set()
21953 * @see elm_photocam_zoom_mode_set()
21955 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21957 * @brief Set the zoom mode
21959 * @param obj The photocam object
21960 * @param mode The desired mode
21962 * This sets the zoom mode to manual or one of several automatic levels.
21963 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
21964 * elm_photocam_zoom_set() and will stay at that level until changed by code
21965 * or until zoom mode is changed. This is the default mode. The Automatic
21966 * modes will allow the photocam object to automatically adjust zoom mode
21967 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
21968 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
21969 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
21970 * pixels within the frame are left unfilled.
21972 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
21974 * @brief Get the zoom mode
21976 * @param obj The photocam object
21977 * @return The current zoom mode
21979 * This gets the current zoom mode of the photocam object.
21981 * @see elm_photocam_zoom_mode_set()
21983 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21985 * @brief Get the current image pixel width and height
21987 * @param obj The photocam object
21988 * @param w A pointer to the width return
21989 * @param h A pointer to the height return
21991 * This gets the current photo pixel width and height (for the original).
21992 * The size will be returned in the integers @p w and @p h that are pointed
21995 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
21997 * @brief Get the area of the image that is currently shown
22000 * @param x A pointer to the X-coordinate of region
22001 * @param y A pointer to the Y-coordinate of region
22002 * @param w A pointer to the width
22003 * @param h A pointer to the height
22005 * @see elm_photocam_image_region_show()
22006 * @see elm_photocam_image_region_bring_in()
22008 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22010 * @brief Set the viewed portion of the image
22012 * @param obj The photocam object
22013 * @param x X-coordinate of region in image original pixels
22014 * @param y Y-coordinate of region in image original pixels
22015 * @param w Width of region in image original pixels
22016 * @param h Height of region in image original pixels
22018 * This shows the region of the image without using animation.
22020 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22022 * @brief Bring in the viewed portion of the image
22024 * @param obj The photocam object
22025 * @param x X-coordinate of region in image original pixels
22026 * @param y Y-coordinate of region in image original pixels
22027 * @param w Width of region in image original pixels
22028 * @param h Height of region in image original pixels
22030 * This shows the region of the image using animation.
22032 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22034 * @brief Set the paused state for photocam
22036 * @param obj The photocam object
22037 * @param paused The pause state to set
22039 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22040 * photocam. The default is off. This will stop zooming using animation on
22041 * zoom levels changes and change instantly. This will stop any existing
22042 * animations that are running.
22044 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22046 * @brief Get the paused state for photocam
22048 * @param obj The photocam object
22049 * @return The current paused state
22051 * This gets the current paused state for the photocam object.
22053 * @see elm_photocam_paused_set()
22055 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22057 * @brief Get the internal low-res image used for photocam
22059 * @param obj The photocam object
22060 * @return The internal image object handle, or NULL if none exists
22062 * This gets the internal image object inside photocam. Do not modify it. It
22063 * is for inspection only, and hooking callbacks to. Nothing else. It may be
22064 * deleted at any time as well.
22066 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22068 * @brief Set the photocam scrolling bouncing.
22070 * @param obj The photocam object
22071 * @param h_bounce bouncing for horizontal
22072 * @param v_bounce bouncing for vertical
22074 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22076 * @brief Get the photocam scrolling bouncing.
22078 * @param obj The photocam object
22079 * @param h_bounce bouncing for horizontal
22080 * @param v_bounce bouncing for vertical
22082 * @see elm_photocam_bounce_set()
22084 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22090 * @defgroup Map Map
22091 * @ingroup Elementary
22093 * @image html img/widget/map/preview-00.png
22094 * @image latex img/widget/map/preview-00.eps
22096 * This is a widget specifically for displaying a map. It uses basically
22097 * OpenStreetMap provider http://www.openstreetmap.org/,
22098 * but custom providers can be added.
22100 * It supports some basic but yet nice features:
22101 * @li zoom and scroll
22102 * @li markers with content to be displayed when user clicks over it
22103 * @li group of markers
22106 * Smart callbacks one can listen to:
22108 * - "clicked" - This is called when a user has clicked the map without
22110 * - "press" - This is called when a user has pressed down on the map.
22111 * - "longpressed" - This is called when a user has pressed down on the map
22112 * for a long time without dragging around.
22113 * - "clicked,double" - This is called when a user has double-clicked
22115 * - "load,detail" - Map detailed data load begins.
22116 * - "loaded,detail" - This is called when all currently visible parts of
22117 * the map are loaded.
22118 * - "zoom,start" - Zoom animation started.
22119 * - "zoom,stop" - Zoom animation stopped.
22120 * - "zoom,change" - Zoom changed when using an auto zoom mode.
22121 * - "scroll" - the content has been scrolled (moved).
22122 * - "scroll,anim,start" - scrolling animation has started.
22123 * - "scroll,anim,stop" - scrolling animation has stopped.
22124 * - "scroll,drag,start" - dragging the contents around has started.
22125 * - "scroll,drag,stop" - dragging the contents around has stopped.
22126 * - "downloaded" - This is called when all currently required map images
22128 * - "route,load" - This is called when route request begins.
22129 * - "route,loaded" - This is called when route request ends.
22130 * - "name,load" - This is called when name request begins.
22131 * - "name,loaded- This is called when name request ends.
22133 * Available style for map widget:
22136 * Available style for markers:
22141 * Available style for marker bubble:
22144 * List of examples:
22145 * @li @ref map_example_01
22146 * @li @ref map_example_02
22147 * @li @ref map_example_03
22156 * @enum _Elm_Map_Zoom_Mode
22157 * @typedef Elm_Map_Zoom_Mode
22159 * Set map's zoom behavior. It can be set to manual or automatic.
22161 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22163 * Values <b> don't </b> work as bitmask, only one can be choosen.
22165 * @note Valid sizes are 2^zoom, consequently the map may be smaller
22166 * than the scroller view.
22168 * @see elm_map_zoom_mode_set()
22169 * @see elm_map_zoom_mode_get()
22173 typedef enum _Elm_Map_Zoom_Mode
22175 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22176 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22177 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22178 ELM_MAP_ZOOM_MODE_LAST
22179 } Elm_Map_Zoom_Mode;
22182 * @enum _Elm_Map_Route_Sources
22183 * @typedef Elm_Map_Route_Sources
22185 * Set route service to be used. By default used source is
22186 * #ELM_MAP_ROUTE_SOURCE_YOURS.
22188 * @see elm_map_route_source_set()
22189 * @see elm_map_route_source_get()
22193 typedef enum _Elm_Map_Route_Sources
22195 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22196 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. */
22197 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22198 ELM_MAP_ROUTE_SOURCE_LAST
22199 } Elm_Map_Route_Sources;
22201 typedef enum _Elm_Map_Name_Sources
22203 ELM_MAP_NAME_SOURCE_NOMINATIM,
22204 ELM_MAP_NAME_SOURCE_LAST
22205 } Elm_Map_Name_Sources;
22208 * @enum _Elm_Map_Route_Type
22209 * @typedef Elm_Map_Route_Type
22211 * Set type of transport used on route.
22213 * @see elm_map_route_add()
22217 typedef enum _Elm_Map_Route_Type
22219 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22220 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22221 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22222 ELM_MAP_ROUTE_TYPE_LAST
22223 } Elm_Map_Route_Type;
22226 * @enum _Elm_Map_Route_Method
22227 * @typedef Elm_Map_Route_Method
22229 * Set the routing method, what should be priorized, time or distance.
22231 * @see elm_map_route_add()
22235 typedef enum _Elm_Map_Route_Method
22237 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22238 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22239 ELM_MAP_ROUTE_METHOD_LAST
22240 } Elm_Map_Route_Method;
22242 typedef enum _Elm_Map_Name_Method
22244 ELM_MAP_NAME_METHOD_SEARCH,
22245 ELM_MAP_NAME_METHOD_REVERSE,
22246 ELM_MAP_NAME_METHOD_LAST
22247 } Elm_Map_Name_Method;
22249 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(). */
22250 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(). */
22251 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(). */
22252 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(). */
22253 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
22254 typedef struct _Elm_Map_Track Elm_Map_Track;
22256 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. */
22257 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22258 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22259 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22261 typedef char *(*ElmMapModuleSourceFunc) (void);
22262 typedef int (*ElmMapModuleZoomMinFunc) (void);
22263 typedef int (*ElmMapModuleZoomMaxFunc) (void);
22264 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22265 typedef int (*ElmMapModuleRouteSourceFunc) (void);
22266 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22267 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22268 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22269 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22272 * Add a new map widget to the given parent Elementary (container) object.
22274 * @param parent The parent object.
22275 * @return a new map widget handle or @c NULL, on errors.
22277 * This function inserts a new map widget on the canvas.
22281 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22284 * Set the zoom level of the map.
22286 * @param obj The map object.
22287 * @param zoom The zoom level to set.
22289 * This sets the zoom level.
22291 * It will respect limits defined by elm_map_source_zoom_min_set() and
22292 * elm_map_source_zoom_max_set().
22294 * By default these values are 0 (world map) and 18 (maximum zoom).
22296 * This function should be used when zoom mode is set to
22297 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22298 * with elm_map_zoom_mode_set().
22300 * @see elm_map_zoom_mode_set().
22301 * @see elm_map_zoom_get().
22305 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22308 * Get the zoom level of the map.
22310 * @param obj The map object.
22311 * @return The current zoom level.
22313 * This returns the current zoom level of the map object.
22315 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22316 * (which is the default), the zoom level may be changed at any time by the
22317 * map object itself to account for map size and map viewport size.
22319 * @see elm_map_zoom_set() for details.
22323 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22326 * Set the zoom mode used by the map object.
22328 * @param obj The map object.
22329 * @param mode The zoom mode of the map, being it one of
22330 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22331 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22333 * This sets the zoom mode to manual or one of the automatic levels.
22334 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22335 * elm_map_zoom_set() and will stay at that level until changed by code
22336 * or until zoom mode is changed. This is the default mode.
22338 * The Automatic modes will allow the map object to automatically
22339 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22340 * adjust zoom so the map fits inside the scroll frame with no pixels
22341 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22342 * ensure no pixels within the frame are left unfilled. Do not forget that
22343 * the valid sizes are 2^zoom, consequently the map may be smaller than
22344 * the scroller view.
22346 * @see elm_map_zoom_set()
22350 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22353 * Get the zoom mode used by the map object.
22355 * @param obj The map object.
22356 * @return The zoom mode of the map, being it one of
22357 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22358 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22360 * This function returns the current zoom mode used by the map object.
22362 * @see elm_map_zoom_mode_set() for more details.
22366 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22369 * Get the current coordinates of the map.
22371 * @param obj The map object.
22372 * @param lon Pointer where to store longitude.
22373 * @param lat Pointer where to store latitude.
22375 * This gets the current center coordinates of the map object. It can be
22376 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22378 * @see elm_map_geo_region_bring_in()
22379 * @see elm_map_geo_region_show()
22383 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22386 * Animatedly bring in given coordinates to the center of the map.
22388 * @param obj The map object.
22389 * @param lon Longitude to center at.
22390 * @param lat Latitude to center at.
22392 * This causes map to jump to the given @p lat and @p lon coordinates
22393 * and show it (by scrolling) in the center of the viewport, if it is not
22394 * already centered. This will use animation to do so and take a period
22395 * of time to complete.
22397 * @see elm_map_geo_region_show() for a function to avoid animation.
22398 * @see elm_map_geo_region_get()
22402 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22405 * Show the given coordinates at the center of the map, @b immediately.
22407 * @param obj The map object.
22408 * @param lon Longitude to center at.
22409 * @param lat Latitude to center at.
22411 * This causes map to @b redraw its viewport's contents to the
22412 * region contining the given @p lat and @p lon, that will be moved to the
22413 * center of the map.
22415 * @see elm_map_geo_region_bring_in() for a function to move with animation.
22416 * @see elm_map_geo_region_get()
22420 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22423 * Pause or unpause the map.
22425 * @param obj The map object.
22426 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22429 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22432 * The default is off.
22434 * This will stop zooming using animation, changing zoom levels will
22435 * change instantly. This will stop any existing animations that are running.
22437 * @see elm_map_paused_get()
22441 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22444 * Get a value whether map is paused or not.
22446 * @param obj The map object.
22447 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22448 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22450 * This gets the current paused state for the map object.
22452 * @see elm_map_paused_set() for details.
22456 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22459 * Set to show markers during zoom level changes or not.
22461 * @param obj The map object.
22462 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22465 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22468 * The default is off.
22470 * This will stop zooming using animation, changing zoom levels will
22471 * change instantly. This will stop any existing animations that are running.
22473 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22476 * The default is off.
22478 * Enabling it will force the map to stop displaying the markers during
22479 * zoom level changes. Set to on if you have a large number of markers.
22481 * @see elm_map_paused_markers_get()
22485 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22488 * Get a value whether markers will be displayed on zoom level changes or not
22490 * @param obj The map object.
22491 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22492 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22494 * This gets the current markers paused state for the map object.
22496 * @see elm_map_paused_markers_set() for details.
22500 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22503 * Get the information of downloading status.
22505 * @param obj The map object.
22506 * @param try_num Pointer where to store number of tiles being downloaded.
22507 * @param finish_num Pointer where to store number of tiles successfully
22510 * This gets the current downloading status for the map object, the number
22511 * of tiles being downloaded and the number of tiles already downloaded.
22515 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22518 * Convert a pixel coordinate (x,y) into a geographic coordinate
22519 * (longitude, latitude).
22521 * @param obj The map object.
22522 * @param x the coordinate.
22523 * @param y the coordinate.
22524 * @param size the size in pixels of the map.
22525 * The map is a square and generally his size is : pow(2.0, zoom)*256.
22526 * @param lon Pointer where to store the longitude that correspond to x.
22527 * @param lat Pointer where to store the latitude that correspond to y.
22529 * @note Origin pixel point is the top left corner of the viewport.
22530 * Map zoom and size are taken on account.
22532 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22536 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);
22539 * Convert a geographic coordinate (longitude, latitude) into a pixel
22540 * coordinate (x, y).
22542 * @param obj The map object.
22543 * @param lon the longitude.
22544 * @param lat the latitude.
22545 * @param size the size in pixels of the map. The map is a square
22546 * and generally his size is : pow(2.0, zoom)*256.
22547 * @param x Pointer where to store the horizontal pixel coordinate that
22548 * correspond to the longitude.
22549 * @param y Pointer where to store the vertical pixel coordinate that
22550 * correspond to the latitude.
22552 * @note Origin pixel point is the top left corner of the viewport.
22553 * Map zoom and size are taken on account.
22555 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22559 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);
22562 * Convert a geographic coordinate (longitude, latitude) into a name
22565 * @param obj The map object.
22566 * @param lon the longitude.
22567 * @param lat the latitude.
22568 * @return name A #Elm_Map_Name handle for this coordinate.
22570 * To get the string for this address, elm_map_name_address_get()
22573 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22577 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22580 * Convert a name (address) into a geographic coordinate
22581 * (longitude, latitude).
22583 * @param obj The map object.
22584 * @param name The address.
22585 * @return name A #Elm_Map_Name handle for this address.
22587 * To get the longitude and latitude, elm_map_name_region_get()
22590 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22594 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22597 * Convert a pixel coordinate into a rotated pixel coordinate.
22599 * @param obj The map object.
22600 * @param x horizontal coordinate of the point to rotate.
22601 * @param y vertical coordinate of the point to rotate.
22602 * @param cx rotation's center horizontal position.
22603 * @param cy rotation's center vertical position.
22604 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22605 * @param xx Pointer where to store rotated x.
22606 * @param yy Pointer where to store rotated y.
22610 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);
22613 * Add a new marker to the map object.
22615 * @param obj The map object.
22616 * @param lon The longitude of the marker.
22617 * @param lat The latitude of the marker.
22618 * @param clas The class, to use when marker @b isn't grouped to others.
22619 * @param clas_group The class group, to use when marker is grouped to others
22620 * @param data The data passed to the callbacks.
22622 * @return The created marker or @c NULL upon failure.
22624 * A marker will be created and shown in a specific point of the map, defined
22625 * by @p lon and @p lat.
22627 * It will be displayed using style defined by @p class when this marker
22628 * is displayed alone (not grouped). A new class can be created with
22629 * elm_map_marker_class_new().
22631 * If the marker is grouped to other markers, it will be displayed with
22632 * style defined by @p class_group. Markers with the same group are grouped
22633 * if they are close. A new group class can be created with
22634 * elm_map_marker_group_class_new().
22636 * Markers created with this method can be deleted with
22637 * elm_map_marker_remove().
22639 * A marker can have associated content to be displayed by a bubble,
22640 * when a user click over it, as well as an icon. These objects will
22641 * be fetch using class' callback functions.
22643 * @see elm_map_marker_class_new()
22644 * @see elm_map_marker_group_class_new()
22645 * @see elm_map_marker_remove()
22649 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);
22652 * Set the maximum numbers of markers' content to be displayed in a group.
22654 * @param obj The map object.
22655 * @param max The maximum numbers of items displayed in a bubble.
22657 * A bubble will be displayed when the user clicks over the group,
22658 * and will place the content of markers that belong to this group
22661 * A group can have a long list of markers, consequently the creation
22662 * of the content of the bubble can be very slow.
22664 * In order to avoid this, a maximum number of items is displayed
22667 * By default this number is 30.
22669 * Marker with the same group class are grouped if they are close.
22671 * @see elm_map_marker_add()
22675 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
22678 * Remove a marker from the map.
22680 * @param marker The marker to remove.
22682 * @see elm_map_marker_add()
22686 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22689 * Get the current coordinates of the marker.
22691 * @param marker marker.
22692 * @param lat Pointer where to store the marker's latitude.
22693 * @param lon Pointer where to store the marker's longitude.
22695 * These values are set when adding markers, with function
22696 * elm_map_marker_add().
22698 * @see elm_map_marker_add()
22702 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
22705 * Animatedly bring in given marker to the center of the map.
22707 * @param marker The marker to center at.
22709 * This causes map to jump to the given @p marker's coordinates
22710 * and show it (by scrolling) in the center of the viewport, if it is not
22711 * already centered. This will use animation to do so and take a period
22712 * of time to complete.
22714 * @see elm_map_marker_show() for a function to avoid animation.
22715 * @see elm_map_marker_region_get()
22719 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22722 * Show the given marker at the center of the map, @b immediately.
22724 * @param marker The marker to center at.
22726 * This causes map to @b redraw its viewport's contents to the
22727 * region contining the given @p marker's coordinates, that will be
22728 * moved to the center of the map.
22730 * @see elm_map_marker_bring_in() for a function to move with animation.
22731 * @see elm_map_markers_list_show() if more than one marker need to be
22733 * @see elm_map_marker_region_get()
22737 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22740 * Move and zoom the map to display a list of markers.
22742 * @param markers A list of #Elm_Map_Marker handles.
22744 * The map will be centered on the center point of the markers in the list.
22745 * Then the map will be zoomed in order to fit the markers using the maximum
22746 * zoom which allows display of all the markers.
22748 * @warning All the markers should belong to the same map object.
22750 * @see elm_map_marker_show() to show a single marker.
22751 * @see elm_map_marker_bring_in()
22755 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
22758 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
22760 * @param marker The marker wich content should be returned.
22761 * @return Return the evas object if it exists, else @c NULL.
22763 * To set callback function #ElmMapMarkerGetFunc for the marker class,
22764 * elm_map_marker_class_get_cb_set() should be used.
22766 * This content is what will be inside the bubble that will be displayed
22767 * when an user clicks over the marker.
22769 * This returns the actual Evas object used to be placed inside
22770 * the bubble. This may be @c NULL, as it may
22771 * not have been created or may have been deleted, at any time, by
22772 * the map. <b>Do not modify this object</b> (move, resize,
22773 * show, hide, etc.), as the map is controlling it. This
22774 * function is for querying, emitting custom signals or hooking
22775 * lower level callbacks for events on that object. Do not delete
22776 * this object under any circumstances.
22780 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22783 * Update the marker
22785 * @param marker The marker to be updated.
22787 * If a content is set to this marker, it will call function to delete it,
22788 * #ElmMapMarkerDelFunc, and then will fetch the content again with
22789 * #ElmMapMarkerGetFunc.
22791 * These functions are set for the marker class with
22792 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
22796 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22799 * Close all the bubbles opened by the user.
22801 * @param obj The map object.
22803 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
22804 * when the user clicks on a marker.
22806 * This functions is set for the marker class with
22807 * elm_map_marker_class_get_cb_set().
22811 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
22814 * Create a new group class.
22816 * @param obj The map object.
22817 * @return Returns the new group class.
22819 * Each marker must be associated to a group class. Markers in the same
22820 * group are grouped if they are close.
22822 * The group class defines the style of the marker when a marker is grouped
22823 * to others markers. When it is alone, another class will be used.
22825 * A group class will need to be provided when creating a marker with
22826 * elm_map_marker_add().
22828 * Some properties and functions can be set by class, as:
22829 * - style, with elm_map_group_class_style_set()
22830 * - data - to be associated to the group class. It can be set using
22831 * elm_map_group_class_data_set().
22832 * - min zoom to display markers, set with
22833 * elm_map_group_class_zoom_displayed_set().
22834 * - max zoom to group markers, set using
22835 * elm_map_group_class_zoom_grouped_set().
22836 * - visibility - set if markers will be visible or not, set with
22837 * elm_map_group_class_hide_set().
22838 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
22839 * It can be set using elm_map_group_class_icon_cb_set().
22841 * @see elm_map_marker_add()
22842 * @see elm_map_group_class_style_set()
22843 * @see elm_map_group_class_data_set()
22844 * @see elm_map_group_class_zoom_displayed_set()
22845 * @see elm_map_group_class_zoom_grouped_set()
22846 * @see elm_map_group_class_hide_set()
22847 * @see elm_map_group_class_icon_cb_set()
22851 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
22854 * Set the marker's style of a group class.
22856 * @param clas The group class.
22857 * @param style The style to be used by markers.
22859 * Each marker must be associated to a group class, and will use the style
22860 * defined by such class when grouped to other markers.
22862 * The following styles are provided by default theme:
22863 * @li @c radio - blue circle
22864 * @li @c radio2 - green circle
22867 * @see elm_map_group_class_new() for more details.
22868 * @see elm_map_marker_add()
22872 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
22875 * Set the icon callback function of a group class.
22877 * @param clas The group class.
22878 * @param icon_get The callback function that will return the icon.
22880 * Each marker must be associated to a group class, and it can display a
22881 * custom icon. The function @p icon_get must return this icon.
22883 * @see elm_map_group_class_new() for more details.
22884 * @see elm_map_marker_add()
22888 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
22891 * Set the data associated to the group class.
22893 * @param clas The group class.
22894 * @param data The new user data.
22896 * This data will be passed for callback functions, like icon get callback,
22897 * that can be set with elm_map_group_class_icon_cb_set().
22899 * If a data was previously set, the object will lose the pointer for it,
22900 * so if needs to be freed, you must do it yourself.
22902 * @see elm_map_group_class_new() for more details.
22903 * @see elm_map_group_class_icon_cb_set()
22904 * @see elm_map_marker_add()
22908 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
22911 * Set the minimum zoom from where the markers are displayed.
22913 * @param clas The group class.
22914 * @param zoom The minimum zoom.
22916 * Markers only will be displayed when the map is displayed at @p zoom
22919 * @see elm_map_group_class_new() for more details.
22920 * @see elm_map_marker_add()
22924 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
22927 * Set the zoom from where the markers are no more grouped.
22929 * @param clas The group class.
22930 * @param zoom The maximum zoom.
22932 * Markers only will be grouped when the map is displayed at
22933 * less than @p zoom.
22935 * @see elm_map_group_class_new() for more details.
22936 * @see elm_map_marker_add()
22940 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
22943 * Set if the markers associated to the group class @clas are hidden or not.
22945 * @param clas The group class.
22946 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
22949 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
22954 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
22957 * Create a new marker class.
22959 * @param obj The map object.
22960 * @return Returns the new group class.
22962 * Each marker must be associated to a class.
22964 * The marker class defines the style of the marker when a marker is
22965 * displayed alone, i.e., not grouped to to others markers. When grouped
22966 * it will use group class style.
22968 * A marker class will need to be provided when creating a marker with
22969 * elm_map_marker_add().
22971 * Some properties and functions can be set by class, as:
22972 * - style, with elm_map_marker_class_style_set()
22973 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
22974 * It can be set using elm_map_marker_class_icon_cb_set().
22975 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
22976 * Set using elm_map_marker_class_get_cb_set().
22977 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
22978 * Set using elm_map_marker_class_del_cb_set().
22980 * @see elm_map_marker_add()
22981 * @see elm_map_marker_class_style_set()
22982 * @see elm_map_marker_class_icon_cb_set()
22983 * @see elm_map_marker_class_get_cb_set()
22984 * @see elm_map_marker_class_del_cb_set()
22988 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
22991 * Set the marker's style of a marker class.
22993 * @param clas The marker class.
22994 * @param style The style to be used by markers.
22996 * Each marker must be associated to a marker class, and will use the style
22997 * defined by such class when alone, i.e., @b not grouped to other markers.
22999 * The following styles are provided by default theme:
23004 * @see elm_map_marker_class_new() for more details.
23005 * @see elm_map_marker_add()
23009 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23012 * Set the icon callback function of a marker class.
23014 * @param clas The marker class.
23015 * @param icon_get The callback function that will return the icon.
23017 * Each marker must be associated to a marker class, and it can display a
23018 * custom icon. The function @p icon_get must return this icon.
23020 * @see elm_map_marker_class_new() for more details.
23021 * @see elm_map_marker_add()
23025 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23028 * Set the bubble content callback function of a marker class.
23030 * @param clas The marker class.
23031 * @param get The callback function that will return the content.
23033 * Each marker must be associated to a marker class, and it can display a
23034 * a content on a bubble that opens when the user click over the marker.
23035 * The function @p get must return this content object.
23037 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23040 * @see elm_map_marker_class_new() for more details.
23041 * @see elm_map_marker_class_del_cb_set()
23042 * @see elm_map_marker_add()
23046 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23049 * Set the callback function used to delete bubble content of a marker class.
23051 * @param clas The marker class.
23052 * @param del The callback function that will delete the content.
23054 * Each marker must be associated to a marker class, and it can display a
23055 * a content on a bubble that opens when the user click over the marker.
23056 * The function to return such content can be set with
23057 * elm_map_marker_class_get_cb_set().
23059 * If this content must be freed, a callback function need to be
23060 * set for that task with this function.
23062 * If this callback is defined it will have to delete (or not) the
23063 * object inside, but if the callback is not defined the object will be
23064 * destroyed with evas_object_del().
23066 * @see elm_map_marker_class_new() for more details.
23067 * @see elm_map_marker_class_get_cb_set()
23068 * @see elm_map_marker_add()
23072 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23075 * Get the list of available sources.
23077 * @param obj The map object.
23078 * @return The source names list.
23080 * It will provide a list with all available sources, that can be set as
23081 * current source with elm_map_source_name_set(), or get with
23082 * elm_map_source_name_get().
23084 * Available sources:
23090 * @see elm_map_source_name_set() for more details.
23091 * @see elm_map_source_name_get()
23095 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23098 * Set the source of the map.
23100 * @param obj The map object.
23101 * @param source The source to be used.
23103 * Map widget retrieves images that composes the map from a web service.
23104 * This web service can be set with this method.
23106 * A different service can return a different maps with different
23107 * information and it can use different zoom values.
23109 * The @p source_name need to match one of the names provided by
23110 * elm_map_source_names_get().
23112 * The current source can be get using elm_map_source_name_get().
23114 * @see elm_map_source_names_get()
23115 * @see elm_map_source_name_get()
23120 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23123 * Get the name of currently used source.
23125 * @param obj The map object.
23126 * @return Returns the name of the source in use.
23128 * @see elm_map_source_name_set() for more details.
23132 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23135 * Set the source of the route service to be used by the map.
23137 * @param obj The map object.
23138 * @param source The route service to be used, being it one of
23139 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23140 * and #ELM_MAP_ROUTE_SOURCE_ORS.
23142 * Each one has its own algorithm, so the route retrieved may
23143 * differ depending on the source route. Now, only the default is working.
23145 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23146 * http://www.yournavigation.org/.
23148 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23149 * assumptions. Its routing core is based on Contraction Hierarchies.
23151 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23153 * @see elm_map_route_source_get().
23157 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23160 * Get the current route source.
23162 * @param obj The map object.
23163 * @return The source of the route service used by the map.
23165 * @see elm_map_route_source_set() for details.
23169 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23172 * Set the minimum zoom of the source.
23174 * @param obj The map object.
23175 * @param zoom New minimum zoom value to be used.
23177 * By default, it's 0.
23181 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23184 * Get the minimum zoom of the source.
23186 * @param obj The map object.
23187 * @return Returns the minimum zoom of the source.
23189 * @see elm_map_source_zoom_min_set() for details.
23193 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23196 * Set the maximum zoom of the source.
23198 * @param obj The map object.
23199 * @param zoom New maximum zoom value to be used.
23201 * By default, it's 18.
23205 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23208 * Get the maximum zoom of the source.
23210 * @param obj The map object.
23211 * @return Returns the maximum zoom of the source.
23213 * @see elm_map_source_zoom_min_set() for details.
23217 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23220 * Set the user agent used by the map object to access routing services.
23222 * @param obj The map object.
23223 * @param user_agent The user agent to be used by the map.
23225 * User agent is a client application implementing a network protocol used
23226 * in communications within a client–server distributed computing system
23228 * The @p user_agent identification string will transmitted in a header
23229 * field @c User-Agent.
23231 * @see elm_map_user_agent_get()
23235 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23238 * Get the user agent used by the map object.
23240 * @param obj The map object.
23241 * @return The user agent identification string used by the map.
23243 * @see elm_map_user_agent_set() for details.
23247 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23250 * Add a new route to the map object.
23252 * @param obj The map object.
23253 * @param type The type of transport to be considered when tracing a route.
23254 * @param method The routing method, what should be priorized.
23255 * @param flon The start longitude.
23256 * @param flat The start latitude.
23257 * @param tlon The destination longitude.
23258 * @param tlat The destination latitude.
23260 * @return The created route or @c NULL upon failure.
23262 * A route will be traced by point on coordinates (@p flat, @p flon)
23263 * to point on coordinates (@p tlat, @p tlon), using the route service
23264 * set with elm_map_route_source_set().
23266 * It will take @p type on consideration to define the route,
23267 * depending if the user will be walking or driving, the route may vary.
23268 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23269 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23271 * Another parameter is what the route should priorize, the minor distance
23272 * or the less time to be spend on the route. So @p method should be one
23273 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23275 * Routes created with this method can be deleted with
23276 * elm_map_route_remove(), colored with elm_map_route_color_set(),
23277 * and distance can be get with elm_map_route_distance_get().
23279 * @see elm_map_route_remove()
23280 * @see elm_map_route_color_set()
23281 * @see elm_map_route_distance_get()
23282 * @see elm_map_route_source_set()
23286 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);
23289 * Remove a route from the map.
23291 * @param route The route to remove.
23293 * @see elm_map_route_add()
23297 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23300 * Set the route color.
23302 * @param route The route object.
23303 * @param r Red channel value, from 0 to 255.
23304 * @param g Green channel value, from 0 to 255.
23305 * @param b Blue channel value, from 0 to 255.
23306 * @param a Alpha channel value, from 0 to 255.
23308 * It uses an additive color model, so each color channel represents
23309 * how much of each primary colors must to be used. 0 represents
23310 * ausence of this color, so if all of the three are set to 0,
23311 * the color will be black.
23313 * These component values should be integers in the range 0 to 255,
23314 * (single 8-bit byte).
23316 * This sets the color used for the route. By default, it is set to
23317 * solid red (r = 255, g = 0, b = 0, a = 255).
23319 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23321 * @see elm_map_route_color_get()
23325 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23328 * Get the route color.
23330 * @param route The route object.
23331 * @param r Pointer where to store the red channel value.
23332 * @param g Pointer where to store the green channel value.
23333 * @param b Pointer where to store the blue channel value.
23334 * @param a Pointer where to store the alpha channel value.
23336 * @see elm_map_route_color_set() for details.
23340 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23343 * Get the route distance in kilometers.
23345 * @param route The route object.
23346 * @return The distance of route (unit : km).
23350 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23353 * Get the information of route nodes.
23355 * @param route The route object.
23356 * @return Returns a string with the nodes of route.
23360 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23363 * Get the information of route waypoint.
23365 * @param route the route object.
23366 * @return Returns a string with information about waypoint of route.
23370 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23373 * Get the address of the name.
23375 * @param name The name handle.
23376 * @return Returns the address string of @p name.
23378 * This gets the coordinates of the @p name, created with one of the
23379 * conversion functions.
23381 * @see elm_map_utils_convert_name_into_coord()
23382 * @see elm_map_utils_convert_coord_into_name()
23386 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23389 * Get the current coordinates of the name.
23391 * @param name The name handle.
23392 * @param lat Pointer where to store the latitude.
23393 * @param lon Pointer where to store The longitude.
23395 * This gets the coordinates of the @p name, created with one of the
23396 * conversion functions.
23398 * @see elm_map_utils_convert_name_into_coord()
23399 * @see elm_map_utils_convert_coord_into_name()
23403 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23406 * Remove a name from the map.
23408 * @param name The name to remove.
23410 * Basically the struct handled by @p name will be freed, so convertions
23411 * between address and coordinates will be lost.
23413 * @see elm_map_utils_convert_name_into_coord()
23414 * @see elm_map_utils_convert_coord_into_name()
23418 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23423 * @param obj The map object.
23424 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23425 * @param cx Rotation's center horizontal position.
23426 * @param cy Rotation's center vertical position.
23428 * @see elm_map_rotate_get()
23432 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23435 * Get the rotate degree of the map
23437 * @param obj The map object
23438 * @param degree Pointer where to store degrees from 0.0 to 360.0
23439 * to rotate arount Z axis.
23440 * @param cx Pointer where to store rotation's center horizontal position.
23441 * @param cy Pointer where to store rotation's center vertical position.
23443 * @see elm_map_rotate_set() to set map rotation.
23447 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);
23450 * Enable or disable mouse wheel to be used to zoom in / out the map.
23452 * @param obj The map object.
23453 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23456 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23458 * It's disabled by default.
23460 * @see elm_map_wheel_disabled_get()
23464 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23467 * Get a value whether mouse wheel is enabled or not.
23469 * @param obj The map object.
23470 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23471 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23473 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23475 * @see elm_map_wheel_disabled_set() for details.
23479 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23483 * Add a track on the map
23485 * @param obj The map object.
23486 * @param emap The emap route object.
23487 * @return The route object. This is an elm object of type Route.
23489 * @see elm_route_add() for details.
23493 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23497 * Remove a track from the map
23499 * @param obj The map object.
23500 * @param route The track to remove.
23504 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23511 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23513 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23515 EAPI double elm_route_lon_min_get(Evas_Object *obj);
23516 EAPI double elm_route_lat_min_get(Evas_Object *obj);
23517 EAPI double elm_route_lon_max_get(Evas_Object *obj);
23518 EAPI double elm_route_lat_max_get(Evas_Object *obj);
23522 * @defgroup Panel Panel
23524 * @image html img/widget/panel/preview-00.png
23525 * @image latex img/widget/panel/preview-00.eps
23527 * @brief A panel is a type of animated container that contains subobjects.
23528 * It can be expanded or contracted by clicking the button on it's edge.
23530 * Orientations are as follows:
23531 * @li ELM_PANEL_ORIENT_TOP
23532 * @li ELM_PANEL_ORIENT_LEFT
23533 * @li ELM_PANEL_ORIENT_RIGHT
23535 * @ref tutorial_panel shows one way to use this widget.
23538 typedef enum _Elm_Panel_Orient
23540 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23541 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23542 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23543 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23544 } Elm_Panel_Orient;
23546 * @brief Adds a panel object
23548 * @param parent The parent object
23550 * @return The panel object, or NULL on failure
23552 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23554 * @brief Sets the orientation of the panel
23556 * @param parent The parent object
23557 * @param orient The panel orientation. Can be one of the following:
23558 * @li ELM_PANEL_ORIENT_TOP
23559 * @li ELM_PANEL_ORIENT_LEFT
23560 * @li ELM_PANEL_ORIENT_RIGHT
23562 * Sets from where the panel will (dis)appear.
23564 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23566 * @brief Get the orientation of the panel.
23568 * @param obj The panel object
23569 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23571 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23573 * @brief Set the content of the panel.
23575 * @param obj The panel object
23576 * @param content The panel content
23578 * Once the content object is set, a previously set one will be deleted.
23579 * If you want to keep that old content object, use the
23580 * elm_panel_content_unset() function.
23582 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23584 * @brief Get the content of the panel.
23586 * @param obj The panel object
23587 * @return The content that is being used
23589 * Return the content object which is set for this widget.
23591 * @see elm_panel_content_set()
23593 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23595 * @brief Unset the content of the panel.
23597 * @param obj The panel object
23598 * @return The content that was being used
23600 * Unparent and return the content object which was set for this widget.
23602 * @see elm_panel_content_set()
23604 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23606 * @brief Set the state of the panel.
23608 * @param obj The panel object
23609 * @param hidden If true, the panel will run the animation to contract
23611 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23613 * @brief Get the state of the panel.
23615 * @param obj The panel object
23616 * @param hidden If true, the panel is in the "hide" state
23618 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23620 * @brief Toggle the hidden state of the panel from code
23622 * @param obj The panel object
23624 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23630 * @defgroup Panes Panes
23631 * @ingroup Elementary
23633 * @image html img/widget/panes/preview-00.png
23634 * @image latex img/widget/panes/preview-00.eps width=\textwidth
23636 * @image html img/panes.png
23637 * @image latex img/panes.eps width=\textwidth
23639 * The panes adds a dragable bar between two contents. When dragged
23640 * this bar will resize contents size.
23642 * Panes can be displayed vertically or horizontally, and contents
23643 * size proportion can be customized (homogeneous by default).
23645 * Smart callbacks one can listen to:
23646 * - "press" - The panes has been pressed (button wasn't released yet).
23647 * - "unpressed" - The panes was released after being pressed.
23648 * - "clicked" - The panes has been clicked>
23649 * - "clicked,double" - The panes has been double clicked
23651 * Available styles for it:
23654 * Here is an example on its usage:
23655 * @li @ref panes_example
23659 * @addtogroup Panes
23664 * Add a new panes widget to the given parent Elementary
23665 * (container) object.
23667 * @param parent The parent object.
23668 * @return a new panes widget handle or @c NULL, on errors.
23670 * This function inserts a new panes widget on the canvas.
23674 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23677 * Set the left content of the panes widget.
23679 * @param obj The panes object.
23680 * @param content The new left content object.
23682 * Once the content object is set, a previously set one will be deleted.
23683 * If you want to keep that old content object, use the
23684 * elm_panes_content_left_unset() function.
23686 * If panes is displayed vertically, left content will be displayed at
23689 * @see elm_panes_content_left_get()
23690 * @see elm_panes_content_right_set() to set content on the other side.
23694 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23697 * Set the right content of the panes widget.
23699 * @param obj The panes object.
23700 * @param content The new right content object.
23702 * Once the content object is set, a previously set one will be deleted.
23703 * If you want to keep that old content object, use the
23704 * elm_panes_content_right_unset() function.
23706 * If panes is displayed vertically, left content will be displayed at
23709 * @see elm_panes_content_right_get()
23710 * @see elm_panes_content_left_set() to set content on the other side.
23714 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23717 * Get the left content of the panes.
23719 * @param obj The panes object.
23720 * @return The left content object that is being used.
23722 * Return the left content object which is set for this widget.
23724 * @see elm_panes_content_left_set() for details.
23728 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23731 * Get the right content of the panes.
23733 * @param obj The panes object
23734 * @return The right content object that is being used
23736 * Return the right content object which is set for this widget.
23738 * @see elm_panes_content_right_set() for details.
23742 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23745 * Unset the left content used for the panes.
23747 * @param obj The panes object.
23748 * @return The left content object that was being used.
23750 * Unparent and return the left content object which was set for this widget.
23752 * @see elm_panes_content_left_set() for details.
23753 * @see elm_panes_content_left_get().
23757 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23760 * Unset the right content used for the panes.
23762 * @param obj The panes object.
23763 * @return The right content object that was being used.
23765 * Unparent and return the right content object which was set for this
23768 * @see elm_panes_content_right_set() for details.
23769 * @see elm_panes_content_right_get().
23773 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23776 * Get the size proportion of panes widget's left side.
23778 * @param obj The panes object.
23779 * @return float value between 0.0 and 1.0 representing size proportion
23782 * @see elm_panes_content_left_size_set() for more details.
23786 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23789 * Set the size proportion of panes widget's left side.
23791 * @param obj The panes object.
23792 * @param size Value between 0.0 and 1.0 representing size proportion
23795 * By default it's homogeneous, i.e., both sides have the same size.
23797 * If something different is required, it can be set with this function.
23798 * For example, if the left content should be displayed over
23799 * 75% of the panes size, @p size should be passed as @c 0.75.
23800 * This way, right content will be resized to 25% of panes size.
23802 * If displayed vertically, left content is displayed at top, and
23803 * right content at bottom.
23805 * @note This proportion will change when user drags the panes bar.
23807 * @see elm_panes_content_left_size_get()
23811 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
23814 * Set the orientation of a given panes widget.
23816 * @param obj The panes object.
23817 * @param horizontal Use @c EINA_TRUE to make @p obj to be
23818 * @b horizontal, @c EINA_FALSE to make it @b vertical.
23820 * Use this function to change how your panes is to be
23821 * disposed: vertically or horizontally.
23823 * By default it's displayed horizontally.
23825 * @see elm_panes_horizontal_get()
23829 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
23832 * Retrieve the orientation of a given panes widget.
23834 * @param obj The panes object.
23835 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
23836 * @c EINA_FALSE if it's @b vertical (and on errors).
23838 * @see elm_panes_horizontal_set() for more details.
23842 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23843 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
23844 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23851 * @defgroup Flip Flip
23853 * @image html img/widget/flip/preview-00.png
23854 * @image latex img/widget/flip/preview-00.eps
23856 * This widget holds 2 content objects(Evas_Object): one on the front and one
23857 * on the back. It allows you to flip from front to back and vice-versa using
23858 * various animations.
23860 * If either the front or back contents are not set the flip will treat that
23861 * as transparent. So if you wore to set the front content but not the back,
23862 * and then call elm_flip_go() you would see whatever is below the flip.
23864 * For a list of supported animations see elm_flip_go().
23866 * Signals that you can add callbacks for are:
23867 * "animate,begin" - when a flip animation was started
23868 * "animate,done" - when a flip animation is finished
23870 * @ref tutorial_flip show how to use most of the API.
23874 typedef enum _Elm_Flip_Mode
23876 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
23877 ELM_FLIP_ROTATE_X_CENTER_AXIS,
23878 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
23879 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
23880 ELM_FLIP_CUBE_LEFT,
23881 ELM_FLIP_CUBE_RIGHT,
23883 ELM_FLIP_CUBE_DOWN,
23884 ELM_FLIP_PAGE_LEFT,
23885 ELM_FLIP_PAGE_RIGHT,
23889 typedef enum _Elm_Flip_Interaction
23891 ELM_FLIP_INTERACTION_NONE,
23892 ELM_FLIP_INTERACTION_ROTATE,
23893 ELM_FLIP_INTERACTION_CUBE,
23894 ELM_FLIP_INTERACTION_PAGE
23895 } Elm_Flip_Interaction;
23896 typedef enum _Elm_Flip_Direction
23898 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
23899 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
23900 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
23901 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
23902 } Elm_Flip_Direction;
23904 * @brief Add a new flip to the parent
23906 * @param parent The parent object
23907 * @return The new object or NULL if it cannot be created
23909 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23911 * @brief Set the front content of the flip widget.
23913 * @param obj The flip object
23914 * @param content The new front content object
23916 * Once the content object is set, a previously set one will be deleted.
23917 * If you want to keep that old content object, use the
23918 * elm_flip_content_front_unset() function.
23920 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23922 * @brief Set the back content of the flip widget.
23924 * @param obj The flip object
23925 * @param content The new back content object
23927 * Once the content object is set, a previously set one will be deleted.
23928 * If you want to keep that old content object, use the
23929 * elm_flip_content_back_unset() function.
23931 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23933 * @brief Get the front content used for the flip
23935 * @param obj The flip object
23936 * @return The front content object that is being used
23938 * Return the front content object which is set for this widget.
23940 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23942 * @brief Get the back content used for the flip
23944 * @param obj The flip object
23945 * @return The back content object that is being used
23947 * Return the back content object which is set for this widget.
23949 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23951 * @brief Unset the front content used for the flip
23953 * @param obj The flip object
23954 * @return The front content object that was being used
23956 * Unparent and return the front content object which was set for this widget.
23958 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23960 * @brief Unset the back content used for the flip
23962 * @param obj The flip object
23963 * @return The back content object that was being used
23965 * Unparent and return the back content object which was set for this widget.
23967 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23969 * @brief Get flip front visibility state
23971 * @param obj The flip objct
23972 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
23975 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23977 * @brief Set flip perspective
23979 * @param obj The flip object
23980 * @param foc The coordinate to set the focus on
23981 * @param x The X coordinate
23982 * @param y The Y coordinate
23984 * @warning This function currently does nothing.
23986 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
23988 * @brief Runs the flip animation
23990 * @param obj The flip object
23991 * @param mode The mode type
23993 * Flips the front and back contents using the @p mode animation. This
23994 * efectively hides the currently visible content and shows the hidden one.
23996 * There a number of possible animations to use for the flipping:
23997 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
23998 * around a horizontal axis in the middle of its height, the other content
23999 * is shown as the other side of the flip.
24000 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24001 * around a vertical axis in the middle of its width, the other content is
24002 * shown as the other side of the flip.
24003 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24004 * around a diagonal axis in the middle of its width, the other content is
24005 * shown as the other side of the flip.
24006 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24007 * around a diagonal axis in the middle of its height, the other content is
24008 * shown as the other side of the flip.
24009 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24010 * as if the flip was a cube, the other content is show as the right face of
24012 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24013 * right as if the flip was a cube, the other content is show as the left
24014 * face of the cube.
24015 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24016 * flip was a cube, the other content is show as the bottom face of the cube.
24017 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24018 * the flip was a cube, the other content is show as the upper face of the
24020 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24021 * if the flip was a book, the other content is shown as the page below that.
24022 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24023 * as if the flip was a book, the other content is shown as the page below
24025 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24026 * flip was a book, the other content is shown as the page below that.
24027 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24028 * flip was a book, the other content is shown as the page below that.
24030 * @image html elm_flip.png
24031 * @image latex elm_flip.eps width=\textwidth
24033 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24035 * @brief Set the interactive flip mode
24037 * @param obj The flip object
24038 * @param mode The interactive flip mode to use
24040 * This sets if the flip should be interactive (allow user to click and
24041 * drag a side of the flip to reveal the back page and cause it to flip).
24042 * By default a flip is not interactive. You may also need to set which
24043 * sides of the flip are "active" for flipping and how much space they use
24044 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24045 * and elm_flip_interacton_direction_hitsize_set()
24047 * The four avilable mode of interaction are:
24048 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24049 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24050 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24051 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24053 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24054 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24055 * happen, those can only be acheived with elm_flip_go();
24057 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24059 * @brief Get the interactive flip mode
24061 * @param obj The flip object
24062 * @return The interactive flip mode
24064 * Returns the interactive flip mode set by elm_flip_interaction_set()
24066 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24068 * @brief Set which directions of the flip respond to interactive flip
24070 * @param obj The flip object
24071 * @param dir The direction to change
24072 * @param enabled If that direction is enabled or not
24074 * By default all directions are disabled, so you may want to enable the
24075 * desired directions for flipping if you need interactive flipping. You must
24076 * call this function once for each direction that should be enabled.
24078 * @see elm_flip_interaction_set()
24080 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24082 * @brief Get the enabled state of that flip direction
24084 * @param obj The flip object
24085 * @param dir The direction to check
24086 * @return If that direction is enabled or not
24088 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24090 * @see elm_flip_interaction_set()
24092 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24094 * @brief Set the amount of the flip that is sensitive to interactive flip
24096 * @param obj The flip object
24097 * @param dir The direction to modify
24098 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24100 * Set the amount of the flip that is sensitive to interactive flip, with 0
24101 * representing no area in the flip and 1 representing the entire flip. There
24102 * is however a consideration to be made in that the area will never be
24103 * smaller than the finger size set(as set in your Elementary configuration).
24105 * @see elm_flip_interaction_set()
24107 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24109 * @brief Get the amount of the flip that is sensitive to interactive flip
24111 * @param obj The flip object
24112 * @param dir The direction to check
24113 * @return The size set for that direction
24115 * Returns the amount os sensitive area set by
24116 * elm_flip_interacton_direction_hitsize_set().
24118 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24123 /* scrolledentry */
24124 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24125 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24126 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24127 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24128 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24129 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24130 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24131 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24132 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24133 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24134 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24135 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24136 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24137 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24138 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24139 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24140 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24141 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24142 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24143 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24144 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24145 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24146 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24147 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24148 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24149 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24150 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24151 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24152 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24153 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24154 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24155 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24156 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24157 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24158 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24159 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);
24160 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24161 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24162 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);
24163 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24164 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);
24165 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24166 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24167 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24168 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24169 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24170 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24171 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24172 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24173 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);
24174 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);
24175 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);
24176 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);
24177 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);
24178 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);
24179 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24180 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24181 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24182 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24183 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24184 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24185 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24188 * @defgroup Conformant Conformant
24189 * @ingroup Elementary
24191 * @image html img/widget/conformant/preview-00.png
24192 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24194 * @image html img/conformant.png
24195 * @image latex img/conformant.eps width=\textwidth
24197 * The aim is to provide a widget that can be used in elementary apps to
24198 * account for space taken up by the indicator, virtual keypad & softkey
24199 * windows when running the illume2 module of E17.
24201 * So conformant content will be sized and positioned considering the
24202 * space required for such stuff, and when they popup, as a keyboard
24203 * shows when an entry is selected, conformant content won't change.
24205 * Available styles for it:
24208 * See how to use this widget in this example:
24209 * @ref conformant_example
24213 * @addtogroup Conformant
24218 * Add a new conformant widget to the given parent Elementary
24219 * (container) object.
24221 * @param parent The parent object.
24222 * @return A new conformant widget handle or @c NULL, on errors.
24224 * This function inserts a new conformant widget on the canvas.
24226 * @ingroup Conformant
24228 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24231 * Set the content of the conformant widget.
24233 * @param obj The conformant object.
24234 * @param content The content to be displayed by the conformant.
24236 * Content will be sized and positioned considering the space required
24237 * to display a virtual keyboard. So it won't fill all the conformant
24238 * size. This way is possible to be sure that content won't resize
24239 * or be re-positioned after the keyboard is displayed.
24241 * Once the content object is set, a previously set one will be deleted.
24242 * If you want to keep that old content object, use the
24243 * elm_conformat_content_unset() function.
24245 * @see elm_conformant_content_unset()
24246 * @see elm_conformant_content_get()
24248 * @ingroup Conformant
24250 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24253 * Get the content of the conformant widget.
24255 * @param obj The conformant object.
24256 * @return The content that is being used.
24258 * Return the content object which is set for this widget.
24259 * It won't be unparent from conformant. For that, use
24260 * elm_conformant_content_unset().
24262 * @see elm_conformant_content_set() for more details.
24263 * @see elm_conformant_content_unset()
24265 * @ingroup Conformant
24267 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24270 * Unset the content of the conformant widget.
24272 * @param obj The conformant object.
24273 * @return The content that was being used.
24275 * Unparent and return the content object which was set for this widget.
24277 * @see elm_conformant_content_set() for more details.
24279 * @ingroup Conformant
24281 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24284 * Returns the Evas_Object that represents the content area.
24286 * @param obj The conformant object.
24287 * @return The content area of the widget.
24289 * @ingroup Conformant
24291 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24298 * @defgroup Mapbuf Mapbuf
24299 * @ingroup Elementary
24301 * @image html img/widget/mapbuf/preview-00.png
24302 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24304 * This holds one content object and uses an Evas Map of transformation
24305 * points to be later used with this content. So the content will be
24306 * moved, resized, etc as a single image. So it will improve performance
24307 * when you have a complex interafce, with a lot of elements, and will
24308 * need to resize or move it frequently (the content object and its
24311 * See how to use this widget in this example:
24312 * @ref mapbuf_example
24316 * @addtogroup Mapbuf
24321 * Add a new mapbuf widget to the given parent Elementary
24322 * (container) object.
24324 * @param parent The parent object.
24325 * @return A new mapbuf widget handle or @c NULL, on errors.
24327 * This function inserts a new mapbuf widget on the canvas.
24331 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24334 * Set the content of the mapbuf.
24336 * @param obj The mapbuf object.
24337 * @param content The content that will be filled in this mapbuf object.
24339 * Once the content object is set, a previously set one will be deleted.
24340 * If you want to keep that old content object, use the
24341 * elm_mapbuf_content_unset() function.
24343 * To enable map, elm_mapbuf_enabled_set() should be used.
24347 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24350 * Get the content of the mapbuf.
24352 * @param obj The mapbuf object.
24353 * @return The content that is being used.
24355 * Return the content object which is set for this widget.
24357 * @see elm_mapbuf_content_set() for details.
24361 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24364 * Unset the content of the mapbuf.
24366 * @param obj The mapbuf object.
24367 * @return The content that was being used.
24369 * Unparent and return the content object which was set for this widget.
24371 * @see elm_mapbuf_content_set() for details.
24375 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24378 * Enable or disable the map.
24380 * @param obj The mapbuf object.
24381 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24383 * This enables the map that is set or disables it. On enable, the object
24384 * geometry will be saved, and the new geometry will change (position and
24385 * size) to reflect the map geometry set.
24387 * Also, when enabled, alpha and smooth states will be used, so if the
24388 * content isn't solid, alpha should be enabled, for example, otherwise
24389 * a black retangle will fill the content.
24391 * When disabled, the stored map will be freed and geometry prior to
24392 * enabling the map will be restored.
24394 * It's disabled by default.
24396 * @see elm_mapbuf_alpha_set()
24397 * @see elm_mapbuf_smooth_set()
24401 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24404 * Get a value whether map is enabled or not.
24406 * @param obj The mapbuf object.
24407 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24408 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24410 * @see elm_mapbuf_enabled_set() for details.
24414 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24417 * Enable or disable smooth map rendering.
24419 * @param obj The mapbuf object.
24420 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24423 * This sets smoothing for map rendering. If the object is a type that has
24424 * its own smoothing settings, then both the smooth settings for this object
24425 * and the map must be turned off.
24427 * By default smooth maps are enabled.
24431 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24434 * Get a value whether smooth map rendering is enabled or not.
24436 * @param obj The mapbuf object.
24437 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24438 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24440 * @see elm_mapbuf_smooth_set() for details.
24444 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24447 * Set or unset alpha flag for map rendering.
24449 * @param obj The mapbuf object.
24450 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24453 * This sets alpha flag for map rendering. If the object is a type that has
24454 * its own alpha settings, then this will take precedence. Only image objects
24455 * have this currently. It stops alpha blending of the map area, and is
24456 * useful if you know the object and/or all sub-objects is 100% solid.
24458 * Alpha is enabled by default.
24462 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24465 * Get a value whether alpha blending is enabled or not.
24467 * @param obj The mapbuf object.
24468 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24469 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24471 * @see elm_mapbuf_alpha_set() for details.
24475 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24482 * @defgroup Flipselector Flip Selector
24484 * @image html img/widget/flipselector/preview-00.png
24485 * @image latex img/widget/flipselector/preview-00.eps
24487 * A flip selector is a widget to show a set of @b text items, one
24488 * at a time, with the same sheet switching style as the @ref Clock
24489 * "clock" widget, when one changes the current displaying sheet
24490 * (thus, the "flip" in the name).
24492 * User clicks to flip sheets which are @b held for some time will
24493 * make the flip selector to flip continuosly and automatically for
24494 * the user. The interval between flips will keep growing in time,
24495 * so that it helps the user to reach an item which is distant from
24496 * the current selection.
24498 * Smart callbacks one can register to:
24499 * - @c "selected" - when the widget's selected text item is changed
24500 * - @c "overflowed" - when the widget's current selection is changed
24501 * from the first item in its list to the last
24502 * - @c "underflowed" - when the widget's current selection is changed
24503 * from the last item in its list to the first
24505 * Available styles for it:
24508 * Here is an example on its usage:
24509 * @li @ref flipselector_example
24513 * @addtogroup Flipselector
24517 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24520 * Add a new flip selector widget to the given parent Elementary
24521 * (container) widget
24523 * @param parent The parent object
24524 * @return a new flip selector widget handle or @c NULL, on errors
24526 * This function inserts a new flip selector widget on the canvas.
24528 * @ingroup Flipselector
24530 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24533 * Programmatically select the next item of a flip selector widget
24535 * @param obj The flipselector object
24537 * @note The selection will be animated. Also, if it reaches the
24538 * end of its list of member items, it will continue with the first
24541 * @ingroup Flipselector
24543 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24546 * Programmatically select the previous item of a flip selector
24549 * @param obj The flipselector object
24551 * @note The selection will be animated. Also, if it reaches the
24552 * beginning of its list of member items, it will continue with the
24553 * last one backwards.
24555 * @ingroup Flipselector
24557 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24560 * Append a (text) item to a flip selector widget
24562 * @param obj The flipselector object
24563 * @param label The (text) label of the new item
24564 * @param func Convenience callback function to take place when
24566 * @param data Data passed to @p func, above
24567 * @return A handle to the item added or @c NULL, on errors
24569 * The widget's list of labels to show will be appended with the
24570 * given value. If the user wishes so, a callback function pointer
24571 * can be passed, which will get called when this same item is
24574 * @note The current selection @b won't be modified by appending an
24575 * element to the list.
24577 * @note The maximum length of the text label is going to be
24578 * determined <b>by the widget's theme</b>. Strings larger than
24579 * that value are going to be @b truncated.
24581 * @ingroup Flipselector
24583 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24586 * Prepend a (text) item to a flip selector widget
24588 * @param obj The flipselector object
24589 * @param label The (text) label of the new item
24590 * @param func Convenience callback function to take place when
24592 * @param data Data passed to @p func, above
24593 * @return A handle to the item added or @c NULL, on errors
24595 * The widget's list of labels to show will be prepended with the
24596 * given value. If the user wishes so, a callback function pointer
24597 * can be passed, which will get called when this same item is
24600 * @note The current selection @b won't be modified by prepending
24601 * an element to the list.
24603 * @note The maximum length of the text label is going to be
24604 * determined <b>by the widget's theme</b>. Strings larger than
24605 * that value are going to be @b truncated.
24607 * @ingroup Flipselector
24609 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24612 * Get the internal list of items in a given flip selector widget.
24614 * @param obj The flipselector object
24615 * @return The list of items (#Elm_Flipselector_Item as data) or
24616 * @c NULL on errors.
24618 * This list is @b not to be modified in any way and must not be
24619 * freed. Use the list members with functions like
24620 * elm_flipselector_item_label_set(),
24621 * elm_flipselector_item_label_get(),
24622 * elm_flipselector_item_del(),
24623 * elm_flipselector_item_selected_get(),
24624 * elm_flipselector_item_selected_set().
24626 * @warning This list is only valid until @p obj object's internal
24627 * items list is changed. It should be fetched again with another
24628 * call to this function when changes happen.
24630 * @ingroup Flipselector
24632 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24635 * Get the first item in the given flip selector widget's list of
24638 * @param obj The flipselector object
24639 * @return The first item or @c NULL, if it has no items (and on
24642 * @see elm_flipselector_item_append()
24643 * @see elm_flipselector_last_item_get()
24645 * @ingroup Flipselector
24647 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24650 * Get the last item in the given flip selector widget's list of
24653 * @param obj The flipselector object
24654 * @return The last item or @c NULL, if it has no items (and on
24657 * @see elm_flipselector_item_prepend()
24658 * @see elm_flipselector_first_item_get()
24660 * @ingroup Flipselector
24662 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24665 * Get the currently selected item in a flip selector widget.
24667 * @param obj The flipselector object
24668 * @return The selected item or @c NULL, if the widget has no items
24671 * @ingroup Flipselector
24673 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24676 * Set whether a given flip selector widget's item should be the
24677 * currently selected one.
24679 * @param item The flip selector item
24680 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
24682 * This sets whether @p item is or not the selected (thus, under
24683 * display) one. If @p item is different than one under display,
24684 * the latter will be unselected. If the @p item is set to be
24685 * unselected, on the other hand, the @b first item in the widget's
24686 * internal members list will be the new selected one.
24688 * @see elm_flipselector_item_selected_get()
24690 * @ingroup Flipselector
24692 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24695 * Get whether a given flip selector widget's item is the currently
24698 * @param item The flip selector item
24699 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
24702 * @see elm_flipselector_item_selected_set()
24704 * @ingroup Flipselector
24706 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24709 * Delete a given item from a flip selector widget.
24711 * @param item The item to delete
24713 * @ingroup Flipselector
24715 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24718 * Get the label of a given flip selector widget's item.
24720 * @param item The item to get label from
24721 * @return The text label of @p item or @c NULL, on errors
24723 * @see elm_flipselector_item_label_set()
24725 * @ingroup Flipselector
24727 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24730 * Set the label of a given flip selector widget's item.
24732 * @param item The item to set label on
24733 * @param label The text label string, in UTF-8 encoding
24735 * @see elm_flipselector_item_label_get()
24737 * @ingroup Flipselector
24739 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24742 * Gets the item before @p item in a flip selector widget's
24743 * internal list of items.
24745 * @param item The item to fetch previous from
24746 * @return The item before the @p item, in its parent's list. If
24747 * there is no previous item for @p item or there's an
24748 * error, @c NULL is returned.
24750 * @see elm_flipselector_item_next_get()
24752 * @ingroup Flipselector
24754 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24757 * Gets the item after @p item in a flip selector widget's
24758 * internal list of items.
24760 * @param item The item to fetch next from
24761 * @return The item after the @p item, in its parent's list. If
24762 * there is no next item for @p item or there's an
24763 * error, @c NULL is returned.
24765 * @see elm_flipselector_item_next_get()
24767 * @ingroup Flipselector
24769 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24772 * Set the interval on time updates for an user mouse button hold
24773 * on a flip selector widget.
24775 * @param obj The flip selector object
24776 * @param interval The (first) interval value in seconds
24778 * This interval value is @b decreased while the user holds the
24779 * mouse pointer either flipping up or flipping doww a given flip
24782 * This helps the user to get to a given item distant from the
24783 * current one easier/faster, as it will start to flip quicker and
24784 * quicker on mouse button holds.
24786 * The calculation for the next flip interval value, starting from
24787 * the one set with this call, is the previous interval divided by
24788 * 1.05, so it decreases a little bit.
24790 * The default starting interval value for automatic flips is
24793 * @see elm_flipselector_interval_get()
24795 * @ingroup Flipselector
24797 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
24800 * Get the interval on time updates for an user mouse button hold
24801 * on a flip selector widget.
24803 * @param obj The flip selector object
24804 * @return The (first) interval value, in seconds, set on it
24806 * @see elm_flipselector_interval_set() for more details
24808 * @ingroup Flipselector
24810 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24816 * @addtogroup Calendar
24821 * @enum _Elm_Calendar_Mark_Repeat
24822 * @typedef Elm_Calendar_Mark_Repeat
24824 * Event periodicity, used to define if a mark should be repeated
24825 * @b beyond event's day. It's set when a mark is added.
24827 * So, for a mark added to 13th May with periodicity set to WEEKLY,
24828 * there will be marks every week after this date. Marks will be displayed
24829 * at 13th, 20th, 27th, 3rd June ...
24831 * Values don't work as bitmask, only one can be choosen.
24833 * @see elm_calendar_mark_add()
24835 * @ingroup Calendar
24837 typedef enum _Elm_Calendar_Mark_Repeat
24839 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
24840 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
24841 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
24842 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*/
24843 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. */
24844 } Elm_Calendar_Mark_Repeat;
24846 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(). */
24849 * Add a new calendar widget to the given parent Elementary
24850 * (container) object.
24852 * @param parent The parent object.
24853 * @return a new calendar widget handle or @c NULL, on errors.
24855 * This function inserts a new calendar widget on the canvas.
24857 * @ref calendar_example_01
24859 * @ingroup Calendar
24861 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24864 * Get weekdays names displayed by the calendar.
24866 * @param obj The calendar object.
24867 * @return Array of seven strings to be used as weekday names.
24869 * By default, weekdays abbreviations get from system are displayed:
24870 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
24871 * The first string is related to Sunday, the second to Monday...
24873 * @see elm_calendar_weekdays_name_set()
24875 * @ref calendar_example_05
24877 * @ingroup Calendar
24879 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24882 * Set weekdays names to be displayed by the calendar.
24884 * @param obj The calendar object.
24885 * @param weekdays Array of seven strings to be used as weekday names.
24886 * @warning It must have 7 elements, or it will access invalid memory.
24887 * @warning The strings must be NULL terminated ('@\0').
24889 * By default, weekdays abbreviations get from system are displayed:
24890 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
24892 * The first string should be related to Sunday, the second to Monday...
24894 * The usage should be like this:
24896 * const char *weekdays[] =
24898 * "Sunday", "Monday", "Tuesday", "Wednesday",
24899 * "Thursday", "Friday", "Saturday"
24901 * elm_calendar_weekdays_names_set(calendar, weekdays);
24904 * @see elm_calendar_weekdays_name_get()
24906 * @ref calendar_example_02
24908 * @ingroup Calendar
24910 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
24913 * Set the minimum and maximum values for the year
24915 * @param obj The calendar object
24916 * @param min The minimum year, greater than 1901;
24917 * @param max The maximum year;
24919 * Maximum must be greater than minimum, except if you don't wan't to set
24921 * Default values are 1902 and -1.
24923 * If the maximum year is a negative value, it will be limited depending
24924 * on the platform architecture (year 2037 for 32 bits);
24926 * @see elm_calendar_min_max_year_get()
24928 * @ref calendar_example_03
24930 * @ingroup Calendar
24932 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
24935 * Get the minimum and maximum values for the year
24937 * @param obj The calendar object.
24938 * @param min The minimum year.
24939 * @param max The maximum year.
24941 * Default values are 1902 and -1.
24943 * @see elm_calendar_min_max_year_get() for more details.
24945 * @ref calendar_example_05
24947 * @ingroup Calendar
24949 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
24952 * Enable or disable day selection
24954 * @param obj The calendar object.
24955 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
24958 * Enabled by default. If disabled, the user still can select months,
24959 * but not days. Selected days are highlighted on calendar.
24960 * It should be used if you won't need such selection for the widget usage.
24962 * When a day is selected, or month is changed, smart callbacks for
24963 * signal "changed" will be called.
24965 * @see elm_calendar_day_selection_enable_get()
24967 * @ref calendar_example_04
24969 * @ingroup Calendar
24971 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24974 * Get a value whether day selection is enabled or not.
24976 * @see elm_calendar_day_selection_enable_set() for details.
24978 * @param obj The calendar object.
24979 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
24980 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
24982 * @ref calendar_example_05
24984 * @ingroup Calendar
24986 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24990 * Set selected date to be highlighted on calendar.
24992 * @param obj The calendar object.
24993 * @param selected_time A @b tm struct to represent the selected date.
24995 * Set the selected date, changing the displayed month if needed.
24996 * Selected date changes when the user goes to next/previous month or
24997 * select a day pressing over it on calendar.
24999 * @see elm_calendar_selected_time_get()
25001 * @ref calendar_example_04
25003 * @ingroup Calendar
25005 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25008 * Get selected date.
25010 * @param obj The calendar object
25011 * @param selected_time A @b tm struct to point to selected date
25012 * @return EINA_FALSE means an error ocurred and returned time shouldn't
25015 * Get date selected by the user or set by function
25016 * elm_calendar_selected_time_set().
25017 * Selected date changes when the user goes to next/previous month or
25018 * select a day pressing over it on calendar.
25020 * @see elm_calendar_selected_time_get()
25022 * @ref calendar_example_05
25024 * @ingroup Calendar
25026 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25029 * Set a function to format the string that will be used to display
25032 * @param obj The calendar object
25033 * @param format_function Function to set the month-year string given
25034 * the selected date
25036 * By default it uses strftime with "%B %Y" format string.
25037 * It should allocate the memory that will be used by the string,
25038 * that will be freed by the widget after usage.
25039 * A pointer to the string and a pointer to the time struct will be provided.
25044 * _format_month_year(struct tm *selected_time)
25047 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25048 * return strdup(buf);
25051 * elm_calendar_format_function_set(calendar, _format_month_year);
25054 * @ref calendar_example_02
25056 * @ingroup Calendar
25058 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25061 * Add a new mark to the calendar
25063 * @param obj The calendar object
25064 * @param mark_type A string used to define the type of mark. It will be
25065 * emitted to the theme, that should display a related modification on these
25066 * days representation.
25067 * @param mark_time A time struct to represent the date of inclusion of the
25068 * mark. For marks that repeats it will just be displayed after the inclusion
25069 * date in the calendar.
25070 * @param repeat Repeat the event following this periodicity. Can be a unique
25071 * mark (that don't repeat), daily, weekly, monthly or annually.
25072 * @return The created mark or @p NULL upon failure.
25074 * Add a mark that will be drawn in the calendar respecting the insertion
25075 * time and periodicity. It will emit the type as signal to the widget theme.
25076 * Default theme supports "holiday" and "checked", but it can be extended.
25078 * It won't immediately update the calendar, drawing the marks.
25079 * For this, call elm_calendar_marks_draw(). However, when user selects
25080 * next or previous month calendar forces marks drawn.
25082 * Marks created with this method can be deleted with
25083 * elm_calendar_mark_del().
25087 * struct tm selected_time;
25088 * time_t current_time;
25090 * current_time = time(NULL) + 5 * 84600;
25091 * localtime_r(¤t_time, &selected_time);
25092 * elm_calendar_mark_add(cal, "holiday", selected_time,
25093 * ELM_CALENDAR_ANNUALLY);
25095 * current_time = time(NULL) + 1 * 84600;
25096 * localtime_r(¤t_time, &selected_time);
25097 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25099 * elm_calendar_marks_draw(cal);
25102 * @see elm_calendar_marks_draw()
25103 * @see elm_calendar_mark_del()
25105 * @ref calendar_example_06
25107 * @ingroup Calendar
25109 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);
25112 * Delete mark from the calendar.
25114 * @param mark The mark to be deleted.
25116 * If deleting all calendar marks is required, elm_calendar_marks_clear()
25117 * should be used instead of getting marks list and deleting each one.
25119 * @see elm_calendar_mark_add()
25121 * @ref calendar_example_06
25123 * @ingroup Calendar
25125 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25128 * Remove all calendar's marks
25130 * @param obj The calendar object.
25132 * @see elm_calendar_mark_add()
25133 * @see elm_calendar_mark_del()
25135 * @ingroup Calendar
25137 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25141 * Get a list of all the calendar marks.
25143 * @param obj The calendar object.
25144 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25146 * @see elm_calendar_mark_add()
25147 * @see elm_calendar_mark_del()
25148 * @see elm_calendar_marks_clear()
25150 * @ingroup Calendar
25152 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25155 * Draw calendar marks.
25157 * @param obj The calendar object.
25159 * Should be used after adding, removing or clearing marks.
25160 * It will go through the entire marks list updating the calendar.
25161 * If lots of marks will be added, add all the marks and then call
25164 * When the month is changed, i.e. user selects next or previous month,
25165 * marks will be drawed.
25167 * @see elm_calendar_mark_add()
25168 * @see elm_calendar_mark_del()
25169 * @see elm_calendar_marks_clear()
25171 * @ref calendar_example_06
25173 * @ingroup Calendar
25175 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25178 * Set a day text color to the same that represents Saturdays.
25180 * @param obj The calendar object.
25181 * @param pos The text position. Position is the cell counter, from left
25182 * to right, up to down. It starts on 0 and ends on 41.
25184 * @deprecated use elm_calendar_mark_add() instead like:
25187 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25188 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25191 * @see elm_calendar_mark_add()
25193 * @ingroup Calendar
25195 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25198 * Set a day text color to the same that represents Sundays.
25200 * @param obj The calendar object.
25201 * @param pos The text position. Position is the cell counter, from left
25202 * to right, up to down. It starts on 0 and ends on 41.
25204 * @deprecated use elm_calendar_mark_add() instead like:
25207 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25208 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25211 * @see elm_calendar_mark_add()
25213 * @ingroup Calendar
25215 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25218 * Set a day text color to the same that represents Weekdays.
25220 * @param obj The calendar object
25221 * @param pos The text position. Position is the cell counter, from left
25222 * to right, up to down. It starts on 0 and ends on 41.
25224 * @deprecated use elm_calendar_mark_add() instead like:
25227 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25229 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25230 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25231 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25232 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25233 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25234 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25235 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25236 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25237 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25240 * @see elm_calendar_mark_add()
25242 * @ingroup Calendar
25244 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25247 * Set the interval on time updates for an user mouse button hold
25248 * on calendar widgets' month selection.
25250 * @param obj The calendar object
25251 * @param interval The (first) interval value in seconds
25253 * This interval value is @b decreased while the user holds the
25254 * mouse pointer either selecting next or previous month.
25256 * This helps the user to get to a given month distant from the
25257 * current one easier/faster, as it will start to change quicker and
25258 * quicker on mouse button holds.
25260 * The calculation for the next change interval value, starting from
25261 * the one set with this call, is the previous interval divided by
25262 * 1.05, so it decreases a little bit.
25264 * The default starting interval value for automatic changes is
25267 * @see elm_calendar_interval_get()
25269 * @ingroup Calendar
25271 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25274 * Get the interval on time updates for an user mouse button hold
25275 * on calendar widgets' month selection.
25277 * @param obj The calendar object
25278 * @return The (first) interval value, in seconds, set on it
25280 * @see elm_calendar_interval_set() for more details
25282 * @ingroup Calendar
25284 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25291 * @defgroup Diskselector Diskselector
25292 * @ingroup Elementary
25294 * @image html img/widget/diskselector/preview-00.png
25295 * @image latex img/widget/diskselector/preview-00.eps
25297 * A diskselector is a kind of list widget. It scrolls horizontally,
25298 * and can contain label and icon objects. Three items are displayed
25299 * with the selected one in the middle.
25301 * It can act like a circular list with round mode and labels can be
25302 * reduced for a defined length for side items.
25304 * Smart callbacks one can listen to:
25305 * - "selected" - when item is selected, i.e. scroller stops.
25307 * Available styles for it:
25310 * List of examples:
25311 * @li @ref diskselector_example_01
25312 * @li @ref diskselector_example_02
25316 * @addtogroup Diskselector
25320 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(). */
25323 * Add a new diskselector widget to the given parent Elementary
25324 * (container) object.
25326 * @param parent The parent object.
25327 * @return a new diskselector widget handle or @c NULL, on errors.
25329 * This function inserts a new diskselector widget on the canvas.
25331 * @ingroup Diskselector
25333 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25336 * Enable or disable round mode.
25338 * @param obj The diskselector object.
25339 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25342 * Disabled by default. If round mode is enabled the items list will
25343 * work like a circle list, so when the user reaches the last item,
25344 * the first one will popup.
25346 * @see elm_diskselector_round_get()
25348 * @ingroup Diskselector
25350 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25353 * Get a value whether round mode is enabled or not.
25355 * @see elm_diskselector_round_set() for details.
25357 * @param obj The diskselector object.
25358 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25359 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25361 * @ingroup Diskselector
25363 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25366 * Get the side labels max length.
25368 * @deprecated use elm_diskselector_side_label_length_get() instead:
25370 * @param obj The diskselector object.
25371 * @return The max length defined for side labels, or 0 if not a valid
25374 * @ingroup Diskselector
25376 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25379 * Set the side labels max length.
25381 * @deprecated use elm_diskselector_side_label_length_set() instead:
25383 * @param obj The diskselector object.
25384 * @param len The max length defined for side labels.
25386 * @ingroup Diskselector
25388 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25391 * Get the side labels max length.
25393 * @see elm_diskselector_side_label_length_set() for details.
25395 * @param obj The diskselector object.
25396 * @return The max length defined for side labels, or 0 if not a valid
25399 * @ingroup Diskselector
25401 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25404 * Set the side labels max length.
25406 * @param obj The diskselector object.
25407 * @param len The max length defined for side labels.
25409 * Length is the number of characters of items' label that will be
25410 * visible when it's set on side positions. It will just crop
25411 * the string after defined size. E.g.:
25413 * An item with label "January" would be displayed on side position as
25414 * "Jan" if max length is set to 3, or "Janu", if this property
25417 * When it's selected, the entire label will be displayed, except for
25418 * width restrictions. In this case label will be cropped and "..."
25419 * will be concatenated.
25421 * Default side label max length is 3.
25423 * This property will be applyed over all items, included before or
25424 * later this function call.
25426 * @ingroup Diskselector
25428 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25431 * Set the number of items to be displayed.
25433 * @param obj The diskselector object.
25434 * @param num The number of items the diskselector will display.
25436 * Default value is 3, and also it's the minimun. If @p num is less
25437 * than 3, it will be set to 3.
25439 * Also, it can be set on theme, using data item @c display_item_num
25440 * on group "elm/diskselector/item/X", where X is style set.
25443 * group { name: "elm/diskselector/item/X";
25445 * item: "display_item_num" "5";
25448 * @ingroup Diskselector
25450 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25453 * Get the number of items in the diskselector object.
25455 * @param obj The diskselector object.
25457 * @ingroup Diskselector
25459 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25462 * Set bouncing behaviour when the scrolled content reaches an edge.
25464 * Tell the internal scroller object whether it should bounce or not
25465 * when it reaches the respective edges for each axis.
25467 * @param obj The diskselector object.
25468 * @param h_bounce Whether to bounce or not in the horizontal axis.
25469 * @param v_bounce Whether to bounce or not in the vertical axis.
25471 * @see elm_scroller_bounce_set()
25473 * @ingroup Diskselector
25475 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25478 * Get the bouncing behaviour of the internal scroller.
25480 * Get whether the internal scroller should bounce when the edge of each
25481 * axis is reached scrolling.
25483 * @param obj The diskselector object.
25484 * @param h_bounce Pointer where to store the bounce state of the horizontal
25486 * @param v_bounce Pointer where to store the bounce state of the vertical
25489 * @see elm_scroller_bounce_get()
25490 * @see elm_diskselector_bounce_set()
25492 * @ingroup Diskselector
25494 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25497 * Get the scrollbar policy.
25499 * @see elm_diskselector_scroller_policy_get() for details.
25501 * @param obj The diskselector object.
25502 * @param policy_h Pointer where to store horizontal scrollbar policy.
25503 * @param policy_v Pointer where to store vertical scrollbar policy.
25505 * @ingroup Diskselector
25507 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);
25510 * Set the scrollbar policy.
25512 * @param obj The diskselector object.
25513 * @param policy_h Horizontal scrollbar policy.
25514 * @param policy_v Vertical scrollbar policy.
25516 * This sets the scrollbar visibility policy for the given scroller.
25517 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25518 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25519 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25520 * This applies respectively for the horizontal and vertical scrollbars.
25522 * The both are disabled by default, i.e., are set to
25523 * #ELM_SCROLLER_POLICY_OFF.
25525 * @ingroup Diskselector
25527 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
25530 * Remove all diskselector's items.
25532 * @param obj The diskselector object.
25534 * @see elm_diskselector_item_del()
25535 * @see elm_diskselector_item_append()
25537 * @ingroup Diskselector
25539 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25542 * Get a list of all the diskselector items.
25544 * @param obj The diskselector object.
25545 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
25546 * or @c NULL on failure.
25548 * @see elm_diskselector_item_append()
25549 * @see elm_diskselector_item_del()
25550 * @see elm_diskselector_clear()
25552 * @ingroup Diskselector
25554 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25557 * Appends a new item to the diskselector object.
25559 * @param obj The diskselector object.
25560 * @param label The label of the diskselector item.
25561 * @param icon The icon object to use at left side of the item. An
25562 * icon can be any Evas object, but usually it is an icon created
25563 * with elm_icon_add().
25564 * @param func The function to call when the item is selected.
25565 * @param data The data to associate with the item for related callbacks.
25567 * @return The created item or @c NULL upon failure.
25569 * A new item will be created and appended to the diskselector, i.e., will
25570 * be set as last item. Also, if there is no selected item, it will
25571 * be selected. This will always happens for the first appended item.
25573 * If no icon is set, label will be centered on item position, otherwise
25574 * the icon will be placed at left of the label, that will be shifted
25577 * Items created with this method can be deleted with
25578 * elm_diskselector_item_del().
25580 * Associated @p data can be properly freed when item is deleted if a
25581 * callback function is set with elm_diskselector_item_del_cb_set().
25583 * If a function is passed as argument, it will be called everytime this item
25584 * is selected, i.e., the user stops the diskselector with this
25585 * item on center position. If such function isn't needed, just passing
25586 * @c NULL as @p func is enough. The same should be done for @p data.
25588 * Simple example (with no function callback or data associated):
25590 * disk = elm_diskselector_add(win);
25591 * ic = elm_icon_add(win);
25592 * elm_icon_file_set(ic, "path/to/image", NULL);
25593 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25594 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
25597 * @see elm_diskselector_item_del()
25598 * @see elm_diskselector_item_del_cb_set()
25599 * @see elm_diskselector_clear()
25600 * @see elm_icon_add()
25602 * @ingroup Diskselector
25604 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);
25608 * Delete them item from the diskselector.
25610 * @param it The item of diskselector to be deleted.
25612 * If deleting all diskselector items is required, elm_diskselector_clear()
25613 * should be used instead of getting items list and deleting each one.
25615 * @see elm_diskselector_clear()
25616 * @see elm_diskselector_item_append()
25617 * @see elm_diskselector_item_del_cb_set()
25619 * @ingroup Diskselector
25621 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25624 * Set the function called when a diskselector item is freed.
25626 * @param it The item to set the callback on
25627 * @param func The function called
25629 * If there is a @p func, then it will be called prior item's memory release.
25630 * That will be called with the following arguments:
25632 * @li item's Evas object;
25635 * This way, a data associated to a diskselector item could be properly
25638 * @ingroup Diskselector
25640 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
25643 * Get the data associated to the item.
25645 * @param it The diskselector item
25646 * @return The data associated to @p it
25648 * The return value is a pointer to data associated to @p item when it was
25649 * created, with function elm_diskselector_item_append(). If no data
25650 * was passed as argument, it will return @c NULL.
25652 * @see elm_diskselector_item_append()
25654 * @ingroup Diskselector
25656 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25659 * Set the icon associated to the item.
25661 * @param it The diskselector item
25662 * @param icon The icon object to associate with @p it
25664 * The icon object to use at left side of the item. An
25665 * icon can be any Evas object, but usually it is an icon created
25666 * with elm_icon_add().
25668 * Once the icon object is set, a previously set one will be deleted.
25669 * @warning Setting the same icon for two items will cause the icon to
25670 * dissapear from the first item.
25672 * If an icon was passed as argument on item creation, with function
25673 * elm_diskselector_item_append(), it will be already
25674 * associated to the item.
25676 * @see elm_diskselector_item_append()
25677 * @see elm_diskselector_item_icon_get()
25679 * @ingroup Diskselector
25681 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
25684 * Get the icon associated to the item.
25686 * @param it The diskselector item
25687 * @return The icon associated to @p it
25689 * The return value is a pointer to the icon associated to @p item when it was
25690 * created, with function elm_diskselector_item_append(), or later
25691 * with function elm_diskselector_item_icon_set. If no icon
25692 * was passed as argument, it will return @c NULL.
25694 * @see elm_diskselector_item_append()
25695 * @see elm_diskselector_item_icon_set()
25697 * @ingroup Diskselector
25699 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25702 * Set the label of item.
25704 * @param it The item of diskselector.
25705 * @param label The label of item.
25707 * The label to be displayed by the item.
25709 * If no icon is set, label will be centered on item position, otherwise
25710 * the icon will be placed at left of the label, that will be shifted
25713 * An item with label "January" would be displayed on side position as
25714 * "Jan" if max length is set to 3 with function
25715 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
25718 * When this @p item is selected, the entire label will be displayed,
25719 * except for width restrictions.
25720 * In this case label will be cropped and "..." will be concatenated,
25721 * but only for display purposes. It will keep the entire string, so
25722 * if diskselector is resized the remaining characters will be displayed.
25724 * If a label was passed as argument on item creation, with function
25725 * elm_diskselector_item_append(), it will be already
25726 * displayed by the item.
25728 * @see elm_diskselector_side_label_lenght_set()
25729 * @see elm_diskselector_item_label_get()
25730 * @see elm_diskselector_item_append()
25732 * @ingroup Diskselector
25734 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
25737 * Get the label of item.
25739 * @param it The item of diskselector.
25740 * @return The label of item.
25742 * The return value is a pointer to the label associated to @p item when it was
25743 * created, with function elm_diskselector_item_append(), or later
25744 * with function elm_diskselector_item_label_set. If no label
25745 * was passed as argument, it will return @c NULL.
25747 * @see elm_diskselector_item_label_set() for more details.
25748 * @see elm_diskselector_item_append()
25750 * @ingroup Diskselector
25752 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25755 * Get the selected item.
25757 * @param obj The diskselector object.
25758 * @return The selected diskselector item.
25760 * The selected item can be unselected with function
25761 * elm_diskselector_item_selected_set(), and the first item of
25762 * diskselector will be selected.
25764 * The selected item always will be centered on diskselector, with
25765 * full label displayed, i.e., max lenght set to side labels won't
25766 * apply on the selected item. More details on
25767 * elm_diskselector_side_label_length_set().
25769 * @ingroup Diskselector
25771 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25774 * Set the selected state of an item.
25776 * @param it The diskselector item
25777 * @param selected The selected state
25779 * This sets the selected state of the given item @p it.
25780 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
25782 * If a new item is selected the previosly selected will be unselected.
25783 * Previoulsy selected item can be get with function
25784 * elm_diskselector_selected_item_get().
25786 * If the item @p it is unselected, the first item of diskselector will
25789 * Selected items will be visible on center position of diskselector.
25790 * So if it was on another position before selected, or was invisible,
25791 * diskselector will animate items until the selected item reaches center
25794 * @see elm_diskselector_item_selected_get()
25795 * @see elm_diskselector_selected_item_get()
25797 * @ingroup Diskselector
25799 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
25802 * Get whether the @p item is selected or not.
25804 * @param it The diskselector item.
25805 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
25806 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
25808 * @see elm_diskselector_selected_item_set() for details.
25809 * @see elm_diskselector_item_selected_get()
25811 * @ingroup Diskselector
25813 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25816 * Get the first item of the diskselector.
25818 * @param obj The diskselector object.
25819 * @return The first item, or @c NULL if none.
25821 * The list of items follows append order. So it will return the first
25822 * item appended to the widget that wasn't deleted.
25824 * @see elm_diskselector_item_append()
25825 * @see elm_diskselector_items_get()
25827 * @ingroup Diskselector
25829 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25832 * Get the last item of the diskselector.
25834 * @param obj The diskselector object.
25835 * @return The last item, or @c NULL if none.
25837 * The list of items follows append order. So it will return last first
25838 * item appended to the widget that wasn't deleted.
25840 * @see elm_diskselector_item_append()
25841 * @see elm_diskselector_items_get()
25843 * @ingroup Diskselector
25845 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25848 * Get the item before @p item in diskselector.
25850 * @param it The diskselector item.
25851 * @return The item before @p item, or @c NULL if none or on failure.
25853 * The list of items follows append order. So it will return item appended
25854 * just before @p item and that wasn't deleted.
25856 * If it is the first item, @c NULL will be returned.
25857 * First item can be get by elm_diskselector_first_item_get().
25859 * @see elm_diskselector_item_append()
25860 * @see elm_diskselector_items_get()
25862 * @ingroup Diskselector
25864 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25867 * Get the item after @p item in diskselector.
25869 * @param it The diskselector item.
25870 * @return The item after @p item, or @c NULL if none or on failure.
25872 * The list of items follows append order. So it will return item appended
25873 * just after @p item and that wasn't deleted.
25875 * If it is the last item, @c NULL will be returned.
25876 * Last item can be get by elm_diskselector_last_item_get().
25878 * @see elm_diskselector_item_append()
25879 * @see elm_diskselector_items_get()
25881 * @ingroup Diskselector
25883 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25886 * Set the text to be shown in the diskselector item.
25888 * @param item Target item
25889 * @param text The text to set in the content
25891 * Setup the text as tooltip to object. The item can have only one tooltip,
25892 * so any previous tooltip data is removed.
25894 * @see elm_object_tooltip_text_set() for more details.
25896 * @ingroup Diskselector
25898 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
25901 * Set the content to be shown in the tooltip item.
25903 * Setup the tooltip to item. The item can have only one tooltip,
25904 * so any previous tooltip data is removed. @p func(with @p data) will
25905 * be called every time that need show the tooltip and it should
25906 * return a valid Evas_Object. This object is then managed fully by
25907 * tooltip system and is deleted when the tooltip is gone.
25909 * @param item the diskselector item being attached a tooltip.
25910 * @param func the function used to create the tooltip contents.
25911 * @param data what to provide to @a func as callback data/context.
25912 * @param del_cb called when data is not needed anymore, either when
25913 * another callback replaces @p func, the tooltip is unset with
25914 * elm_diskselector_item_tooltip_unset() or the owner @a item
25915 * dies. This callback receives as the first parameter the
25916 * given @a data, and @c event_info is the item.
25918 * @see elm_object_tooltip_content_cb_set() for more details.
25920 * @ingroup Diskselector
25922 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);
25925 * Unset tooltip from item.
25927 * @param item diskselector item to remove previously set tooltip.
25929 * Remove tooltip from item. The callback provided as del_cb to
25930 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
25931 * it is not used anymore.
25933 * @see elm_object_tooltip_unset() for more details.
25934 * @see elm_diskselector_item_tooltip_content_cb_set()
25936 * @ingroup Diskselector
25938 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25942 * Sets a different style for this item tooltip.
25944 * @note before you set a style you should define a tooltip with
25945 * elm_diskselector_item_tooltip_content_cb_set() or
25946 * elm_diskselector_item_tooltip_text_set()
25948 * @param item diskselector item with tooltip already set.
25949 * @param style the theme style to use (default, transparent, ...)
25951 * @see elm_object_tooltip_style_set() for more details.
25953 * @ingroup Diskselector
25955 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
25958 * Get the style for this item tooltip.
25960 * @param item diskselector item with tooltip already set.
25961 * @return style the theme style in use, defaults to "default". If the
25962 * object does not have a tooltip set, then NULL is returned.
25964 * @see elm_object_tooltip_style_get() for more details.
25965 * @see elm_diskselector_item_tooltip_style_set()
25967 * @ingroup Diskselector
25969 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25972 * Set the cursor to be shown when mouse is over the diskselector item
25974 * @param item Target item
25975 * @param cursor the cursor name to be used.
25977 * @see elm_object_cursor_set() for more details.
25979 * @ingroup Diskselector
25981 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
25984 * Get the cursor to be shown when mouse is over the diskselector item
25986 * @param item diskselector item with cursor already set.
25987 * @return the cursor name.
25989 * @see elm_object_cursor_get() for more details.
25990 * @see elm_diskselector_cursor_set()
25992 * @ingroup Diskselector
25994 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25998 * Unset the cursor to be shown when mouse is over the diskselector item
26000 * @param item Target item
26002 * @see elm_object_cursor_unset() for more details.
26003 * @see elm_diskselector_cursor_set()
26005 * @ingroup Diskselector
26007 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26010 * Sets a different style for this item cursor.
26012 * @note before you set a style you should define a cursor with
26013 * elm_diskselector_item_cursor_set()
26015 * @param item diskselector item with cursor already set.
26016 * @param style the theme style to use (default, transparent, ...)
26018 * @see elm_object_cursor_style_set() for more details.
26020 * @ingroup Diskselector
26022 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26026 * Get the style for this item cursor.
26028 * @param item diskselector item with cursor already set.
26029 * @return style the theme style in use, defaults to "default". If the
26030 * object does not have a cursor set, then @c NULL is returned.
26032 * @see elm_object_cursor_style_get() for more details.
26033 * @see elm_diskselector_item_cursor_style_set()
26035 * @ingroup Diskselector
26037 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26041 * Set if the cursor set should be searched on the theme or should use
26042 * the provided by the engine, only.
26044 * @note before you set if should look on theme you should define a cursor
26045 * with elm_diskselector_item_cursor_set().
26046 * By default it will only look for cursors provided by the engine.
26048 * @param item widget item with cursor already set.
26049 * @param engine_only boolean to define if cursors set with
26050 * elm_diskselector_item_cursor_set() should be searched only
26051 * between cursors provided by the engine or searched on widget's
26054 * @see elm_object_cursor_engine_only_set() for more details.
26056 * @ingroup Diskselector
26058 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26061 * Get the cursor engine only usage for this item cursor.
26063 * @param item widget item with cursor already set.
26064 * @return engine_only boolean to define it cursors should be looked only
26065 * between the provided by the engine or searched on widget's theme as well.
26066 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26068 * @see elm_object_cursor_engine_only_get() for more details.
26069 * @see elm_diskselector_item_cursor_engine_only_set()
26071 * @ingroup Diskselector
26073 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26080 * @defgroup Colorselector Colorselector
26084 * @image html img/widget/colorselector/preview-00.png
26085 * @image latex img/widget/colorselector/preview-00.eps
26087 * @brief Widget for user to select a color.
26089 * Signals that you can add callbacks for are:
26090 * "changed" - When the color value changes(event_info is NULL).
26092 * See @ref tutorial_colorselector.
26095 * @brief Add a new colorselector to the parent
26097 * @param parent The parent object
26098 * @return The new object or NULL if it cannot be created
26100 * @ingroup Colorselector
26102 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26104 * Set a color for the colorselector
26106 * @param obj Colorselector object
26107 * @param r r-value of color
26108 * @param g g-value of color
26109 * @param b b-value of color
26110 * @param a a-value of color
26112 * @ingroup Colorselector
26114 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26116 * Get a color from the colorselector
26118 * @param obj Colorselector object
26119 * @param r integer pointer for r-value of color
26120 * @param g integer pointer for g-value of color
26121 * @param b integer pointer for b-value of color
26122 * @param a integer pointer for a-value of color
26124 * @ingroup Colorselector
26126 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26132 * @defgroup Ctxpopup Ctxpopup
26134 * @image html img/widget/ctxpopup/preview-00.png
26135 * @image latex img/widget/ctxpopup/preview-00.eps
26137 * @brief Context popup widet.
26139 * A ctxpopup is a widget that, when shown, pops up a list of items.
26140 * It automatically chooses an area inside its parent object's view
26141 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26142 * optimally fit into it. In the default theme, it will also point an
26143 * arrow to it's top left position at the time one shows it. Ctxpopup
26144 * items have a label and/or an icon. It is intended for a small
26145 * number of items (hence the use of list, not genlist).
26147 * @note Ctxpopup is a especialization of @ref Hover.
26149 * Signals that you can add callbacks for are:
26150 * "dismissed" - the ctxpopup was dismissed
26152 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26155 typedef enum _Elm_Ctxpopup_Direction
26157 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26159 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26160 the clicked area */
26161 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26162 the clicked area */
26163 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26165 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26166 } Elm_Ctxpopup_Direction;
26169 * @brief Add a new Ctxpopup object to the parent.
26171 * @param parent Parent object
26172 * @return New object or @c NULL, if it cannot be created
26174 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26176 * @brief Set the Ctxpopup's parent
26178 * @param obj The ctxpopup object
26179 * @param area The parent to use
26181 * Set the parent object.
26183 * @note elm_ctxpopup_add() will automatically call this function
26184 * with its @c parent argument.
26186 * @see elm_ctxpopup_add()
26187 * @see elm_hover_parent_set()
26189 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26191 * @brief Get the Ctxpopup's parent
26193 * @param obj The ctxpopup object
26195 * @see elm_ctxpopup_hover_parent_set() for more information
26197 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26199 * @brief Clear all items in the given ctxpopup object.
26201 * @param obj Ctxpopup object
26203 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26205 * @brief Change the ctxpopup's orientation to horizontal or vertical.
26207 * @param obj Ctxpopup object
26208 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26210 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26212 * @brief Get the value of current ctxpopup object's orientation.
26214 * @param obj Ctxpopup object
26215 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26217 * @see elm_ctxpopup_horizontal_set()
26219 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26221 * @brief Add a new item to a ctxpopup object.
26223 * @param obj Ctxpopup object
26224 * @param icon Icon to be set on new item
26225 * @param label The Label of the new item
26226 * @param func Convenience function called when item selected
26227 * @param data Data passed to @p func
26228 * @return A handle to the item added or @c NULL, on errors
26230 * @warning Ctxpopup can't hold both an item list and a content at the same
26231 * time. When an item is added, any previous content will be removed.
26233 * @see elm_ctxpopup_content_set()
26235 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);
26237 * @brief Delete the given item in a ctxpopup object.
26239 * @param it Ctxpopup item to be deleted
26241 * @see elm_ctxpopup_item_append()
26243 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26245 * @brief Set the ctxpopup item's state as disabled or enabled.
26247 * @param it Ctxpopup item to be enabled/disabled
26248 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26250 * When disabled the item is greyed out to indicate it's state.
26252 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26254 * @brief Get the ctxpopup item's disabled/enabled state.
26256 * @param it Ctxpopup item to be enabled/disabled
26257 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26259 * @see elm_ctxpopup_item_disabled_set()
26261 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26263 * @brief Get the icon object for the given ctxpopup item.
26265 * @param it Ctxpopup item
26266 * @return icon object or @c NULL, if the item does not have icon or an error
26269 * @see elm_ctxpopup_item_append()
26270 * @see elm_ctxpopup_item_icon_set()
26272 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26274 * @brief Sets the side icon associated with the ctxpopup item
26276 * @param it Ctxpopup item
26277 * @param icon Icon object to be set
26279 * Once the icon object is set, a previously set one will be deleted.
26280 * @warning Setting the same icon for two items will cause the icon to
26281 * dissapear from the first item.
26283 * @see elm_ctxpopup_item_append()
26285 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26287 * @brief Get the label for the given ctxpopup item.
26289 * @param it Ctxpopup item
26290 * @return label string or @c NULL, if the item does not have label or an
26293 * @see elm_ctxpopup_item_append()
26294 * @see elm_ctxpopup_item_label_set()
26296 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26298 * @brief (Re)set the label on the given ctxpopup item.
26300 * @param it Ctxpopup item
26301 * @param label String to set as label
26303 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26305 * @brief Set an elm widget as the content of the ctxpopup.
26307 * @param obj Ctxpopup object
26308 * @param content Content to be swallowed
26310 * If the content object is already set, a previous one will bedeleted. If
26311 * you want to keep that old content object, use the
26312 * elm_ctxpopup_content_unset() function.
26314 * @deprecated use elm_object_content_set()
26316 * @warning Ctxpopup can't hold both a item list and a content at the same
26317 * time. When a content is set, any previous items will be removed.
26319 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26321 * @brief Unset the ctxpopup content
26323 * @param obj Ctxpopup object
26324 * @return The content that was being used
26326 * Unparent and return the content object which was set for this widget.
26328 * @deprecated use elm_object_content_unset()
26330 * @see elm_ctxpopup_content_set()
26332 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26334 * @brief Set the direction priority of a ctxpopup.
26336 * @param obj Ctxpopup object
26337 * @param first 1st priority of direction
26338 * @param second 2nd priority of direction
26339 * @param third 3th priority of direction
26340 * @param fourth 4th priority of direction
26342 * This functions gives a chance to user to set the priority of ctxpopup
26343 * showing direction. This doesn't guarantee the ctxpopup will appear in the
26344 * requested direction.
26346 * @see Elm_Ctxpopup_Direction
26348 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);
26350 * @brief Get the direction priority of a ctxpopup.
26352 * @param obj Ctxpopup object
26353 * @param first 1st priority of direction to be returned
26354 * @param second 2nd priority of direction to be returned
26355 * @param third 3th priority of direction to be returned
26356 * @param fourth 4th priority of direction to be returned
26358 * @see elm_ctxpopup_direction_priority_set() for more information.
26360 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);
26363 * @brief Get the current direction of a ctxpopup.
26365 * @param obj Ctxpopup object
26366 * @return current direction of a ctxpopup
26368 * @warning Once the ctxpopup showed up, the direction would be determined
26370 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26379 * @defgroup Transit Transit
26380 * @ingroup Elementary
26382 * Transit is designed to apply various animated transition effects to @c
26383 * Evas_Object, such like translation, rotation, etc. For using these
26384 * effects, create an @ref Elm_Transit and add the desired transition effects.
26386 * Once the effects are added into transit, they will be automatically
26387 * managed (their callback will be called until the duration is ended, and
26388 * they will be deleted on completion).
26392 * Elm_Transit *trans = elm_transit_add();
26393 * elm_transit_object_add(trans, obj);
26394 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26395 * elm_transit_duration_set(transit, 1);
26396 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26397 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26398 * elm_transit_repeat_times_set(transit, 3);
26401 * Some transition effects are used to change the properties of objects. They
26403 * @li @ref elm_transit_effect_translation_add
26404 * @li @ref elm_transit_effect_color_add
26405 * @li @ref elm_transit_effect_rotation_add
26406 * @li @ref elm_transit_effect_wipe_add
26407 * @li @ref elm_transit_effect_zoom_add
26408 * @li @ref elm_transit_effect_resizing_add
26410 * Other transition effects are used to make one object disappear and another
26411 * object appear on its old place. These effects are:
26413 * @li @ref elm_transit_effect_flip_add
26414 * @li @ref elm_transit_effect_resizable_flip_add
26415 * @li @ref elm_transit_effect_fade_add
26416 * @li @ref elm_transit_effect_blend_add
26418 * It's also possible to make a transition chain with @ref
26419 * elm_transit_chain_transit_add.
26421 * @warning We strongly recommend to use elm_transit just when edje can not do
26422 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26423 * animations can be manipulated inside the theme.
26425 * List of examples:
26426 * @li @ref transit_example_01_explained
26427 * @li @ref transit_example_02_explained
26428 * @li @ref transit_example_03_c
26429 * @li @ref transit_example_04_c
26435 * @enum Elm_Transit_Tween_Mode
26437 * The type of acceleration used in the transition.
26441 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26442 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26443 over time, then decrease again
26445 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26447 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26449 } Elm_Transit_Tween_Mode;
26452 * @enum Elm_Transit_Effect_Flip_Axis
26454 * The axis where flip effect should be applied.
26458 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26459 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26460 } Elm_Transit_Effect_Flip_Axis;
26462 * @enum Elm_Transit_Effect_Wipe_Dir
26464 * The direction where the wipe effect should occur.
26468 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26469 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26470 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26471 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26472 } Elm_Transit_Effect_Wipe_Dir;
26473 /** @enum Elm_Transit_Effect_Wipe_Type
26475 * Whether the wipe effect should show or hide the object.
26479 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26481 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26483 } Elm_Transit_Effect_Wipe_Type;
26486 * @typedef Elm_Transit
26488 * The Transit created with elm_transit_add(). This type has the information
26489 * about the objects which the transition will be applied, and the
26490 * transition effects that will be used. It also contains info about
26491 * duration, number of repetitions, auto-reverse, etc.
26493 typedef struct _Elm_Transit Elm_Transit;
26494 typedef void Elm_Transit_Effect;
26496 * @typedef Elm_Transit_Effect_Transition_Cb
26498 * Transition callback called for this effect on each transition iteration.
26500 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26502 * Elm_Transit_Effect_End_Cb
26504 * Transition callback called for this effect when the transition is over.
26506 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26509 * Elm_Transit_Del_Cb
26511 * A callback called when the transit is deleted.
26513 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26518 * @note Is not necessary to delete the transit object, it will be deleted at
26519 * the end of its operation.
26520 * @note The transit will start playing when the program enter in the main loop, is not
26521 * necessary to give a start to the transit.
26523 * @return The transit object.
26527 EAPI Elm_Transit *elm_transit_add(void);
26530 * Stops the animation and delete the @p transit object.
26532 * Call this function if you wants to stop the animation before the duration
26533 * time. Make sure the @p transit object is still alive with
26534 * elm_transit_del_cb_set() function.
26535 * All added effects will be deleted, calling its repective data_free_cb
26536 * functions. The function setted by elm_transit_del_cb_set() will be called.
26538 * @see elm_transit_del_cb_set()
26540 * @param transit The transit object to be deleted.
26543 * @warning Just call this function if you are sure the transit is alive.
26545 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26548 * Add a new effect to the transit.
26550 * @note The cb function and the data are the key to the effect. If you try to
26551 * add an already added effect, nothing is done.
26552 * @note After the first addition of an effect in @p transit, if its
26553 * effect list become empty again, the @p transit will be killed by
26554 * elm_transit_del(transit) function.
26558 * Elm_Transit *transit = elm_transit_add();
26559 * elm_transit_effect_add(transit,
26560 * elm_transit_effect_blend_op,
26561 * elm_transit_effect_blend_context_new(),
26562 * elm_transit_effect_blend_context_free);
26565 * @param transit The transit object.
26566 * @param transition_cb The operation function. It is called when the
26567 * animation begins, it is the function that actually performs the animation.
26568 * It is called with the @p data, @p transit and the time progression of the
26569 * animation (a double value between 0.0 and 1.0).
26570 * @param effect The context data of the effect.
26571 * @param end_cb The function to free the context data, it will be called
26572 * at the end of the effect, it must finalize the animation and free the
26576 * @warning The transit free the context data at the and of the transition with
26577 * the data_free_cb function, do not use the context data in another transit.
26579 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);
26582 * Delete an added effect.
26584 * This function will remove the effect from the @p transit, calling the
26585 * data_free_cb to free the @p data.
26587 * @see elm_transit_effect_add()
26589 * @note If the effect is not found, nothing is done.
26590 * @note If the effect list become empty, this function will call
26591 * elm_transit_del(transit), that is, it will kill the @p transit.
26593 * @param transit The transit object.
26594 * @param transition_cb The operation function.
26595 * @param effect The context data of the effect.
26599 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);
26602 * Add new object to apply the effects.
26604 * @note After the first addition of an object in @p transit, if its
26605 * object list become empty again, the @p transit will be killed by
26606 * elm_transit_del(transit) function.
26607 * @note If the @p obj belongs to another transit, the @p obj will be
26608 * removed from it and it will only belong to the @p transit. If the old
26609 * transit stays without objects, it will die.
26610 * @note When you add an object into the @p transit, its state from
26611 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26612 * transit ends, if you change this state whith evas_object_pass_events_set()
26613 * after add the object, this state will change again when @p transit stops to
26616 * @param transit The transit object.
26617 * @param obj Object to be animated.
26620 * @warning It is not allowed to add a new object after transit begins to go.
26622 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26625 * Removes an added object from the transit.
26627 * @note If the @p obj is not in the @p transit, nothing is done.
26628 * @note If the list become empty, this function will call
26629 * elm_transit_del(transit), that is, it will kill the @p transit.
26631 * @param transit The transit object.
26632 * @param obj Object to be removed from @p transit.
26635 * @warning It is not allowed to remove objects after transit begins to go.
26637 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26640 * Get the objects of the transit.
26642 * @param transit The transit object.
26643 * @return a Eina_List with the objects from the transit.
26647 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26650 * Enable/disable keeping up the objects states.
26651 * If it is not kept, the objects states will be reset when transition ends.
26653 * @note @p transit can not be NULL.
26654 * @note One state includes geometry, color, map data.
26656 * @param transit The transit object.
26657 * @param state_keep Keeping or Non Keeping.
26661 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
26664 * Get a value whether the objects states will be reset or not.
26666 * @note @p transit can not be NULL
26668 * @see elm_transit_objects_final_state_keep_set()
26670 * @param transit The transit object.
26671 * @return EINA_TRUE means the states of the objects will be reset.
26672 * If @p transit is NULL, EINA_FALSE is returned
26676 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26679 * Set the event enabled when transit is operating.
26681 * If @p enabled is EINA_TRUE, the objects of the transit will receives
26682 * events from mouse and keyboard during the animation.
26683 * @note When you add an object with elm_transit_object_add(), its state from
26684 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26685 * transit ends, if you change this state with evas_object_pass_events_set()
26686 * after adding the object, this state will change again when @p transit stops
26689 * @param transit The transit object.
26690 * @param enabled Events are received when enabled is @c EINA_TRUE, and
26691 * ignored otherwise.
26695 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26698 * Get the value of event enabled status.
26700 * @see elm_transit_event_enabled_set()
26702 * @param transit The Transit object
26703 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
26704 * EINA_FALSE is returned
26708 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26711 * Set the user-callback function when the transit is deleted.
26713 * @note Using this function twice will overwrite the first function setted.
26714 * @note the @p transit object will be deleted after call @p cb function.
26716 * @param transit The transit object.
26717 * @param cb Callback function pointer. This function will be called before
26718 * the deletion of the transit.
26719 * @param data Callback funtion user data. It is the @p op parameter.
26723 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
26726 * Set reverse effect automatically.
26728 * If auto reverse is setted, after running the effects with the progress
26729 * parameter from 0 to 1, it will call the effecs again with the progress
26730 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
26731 * where the duration was setted with the function elm_transit_add and
26732 * the repeat with the function elm_transit_repeat_times_set().
26734 * @param transit The transit object.
26735 * @param reverse EINA_TRUE means the auto_reverse is on.
26739 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
26742 * Get if the auto reverse is on.
26744 * @see elm_transit_auto_reverse_set()
26746 * @param transit The transit object.
26747 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
26748 * EINA_FALSE is returned
26752 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26755 * Set the transit repeat count. Effect will be repeated by repeat count.
26757 * This function sets the number of repetition the transit will run after
26758 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
26759 * If the @p repeat is a negative number, it will repeat infinite times.
26761 * @note If this function is called during the transit execution, the transit
26762 * will run @p repeat times, ignoring the times it already performed.
26764 * @param transit The transit object
26765 * @param repeat Repeat count
26769 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
26772 * Get the transit repeat count.
26774 * @see elm_transit_repeat_times_set()
26776 * @param transit The Transit object.
26777 * @return The repeat count. If @p transit is NULL
26782 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26785 * Set the transit animation acceleration type.
26787 * This function sets the tween mode of the transit that can be:
26788 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
26789 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
26790 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
26791 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
26793 * @param transit The transit object.
26794 * @param tween_mode The tween type.
26798 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
26801 * Get the transit animation acceleration type.
26803 * @note @p transit can not be NULL
26805 * @param transit The transit object.
26806 * @return The tween type. If @p transit is NULL
26807 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
26811 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26814 * Set the transit animation time
26816 * @note @p transit can not be NULL
26818 * @param transit The transit object.
26819 * @param duration The animation time.
26823 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
26826 * Get the transit animation time
26828 * @note @p transit can not be NULL
26830 * @param transit The transit object.
26832 * @return The transit animation time.
26836 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26839 * Starts the transition.
26840 * Once this API is called, the transit begins to measure the time.
26842 * @note @p transit can not be NULL
26844 * @param transit The transit object.
26848 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26851 * Pause/Resume the transition.
26853 * If you call elm_transit_go again, the transit will be started from the
26854 * beginning, and will be unpaused.
26856 * @note @p transit can not be NULL
26858 * @param transit The transit object.
26859 * @param paused Whether the transition should be paused or not.
26863 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
26866 * Get the value of paused status.
26868 * @see elm_transit_paused_set()
26870 * @note @p transit can not be NULL
26872 * @param transit The transit object.
26873 * @return EINA_TRUE means transition is paused. If @p transit is NULL
26874 * EINA_FALSE is returned
26878 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26881 * Get the time progression of the animation (a double value between 0.0 and 1.0).
26883 * The value returned is a fraction (current time / total time). It
26884 * represents the progression position relative to the total.
26886 * @note @p transit can not be NULL
26888 * @param transit The transit object.
26890 * @return The time progression value. If @p transit is NULL
26895 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26898 * Makes the chain relationship between two transits.
26900 * @note @p transit can not be NULL. Transit would have multiple chain transits.
26901 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
26903 * @param transit The transit object.
26904 * @param chain_transit The chain transit object. This transit will be operated
26905 * after transit is done.
26907 * This function adds @p chain_transit transition to a chain after the @p
26908 * transit, and will be started as soon as @p transit ends. See @ref
26909 * transit_example_02_explained for a full example.
26913 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
26916 * Cut off the chain relationship between two transits.
26918 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
26919 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
26921 * @param transit The transit object.
26922 * @param chain_transit The chain transit object.
26924 * This function remove the @p chain_transit transition from the @p transit.
26928 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
26931 * Get the current chain transit list.
26933 * @note @p transit can not be NULL.
26935 * @param transit The transit object.
26936 * @return chain transit list.
26940 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
26943 * Add the Resizing Effect to Elm_Transit.
26945 * @note This API is one of the facades. It creates resizing effect context
26946 * and add it's required APIs to elm_transit_effect_add.
26948 * @see elm_transit_effect_add()
26950 * @param transit Transit object.
26951 * @param from_w Object width size when effect begins.
26952 * @param from_h Object height size when effect begins.
26953 * @param to_w Object width size when effect ends.
26954 * @param to_h Object height size when effect ends.
26955 * @return Resizing effect context data.
26959 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);
26962 * Add the Translation Effect to Elm_Transit.
26964 * @note This API is one of the facades. It creates translation effect context
26965 * and add it's required APIs to elm_transit_effect_add.
26967 * @see elm_transit_effect_add()
26969 * @param transit Transit object.
26970 * @param from_dx X Position variation when effect begins.
26971 * @param from_dy Y Position variation when effect begins.
26972 * @param to_dx X Position variation when effect ends.
26973 * @param to_dy Y Position variation when effect ends.
26974 * @return Translation effect context data.
26977 * @warning It is highly recommended just create a transit with this effect when
26978 * the window that the objects of the transit belongs has already been created.
26979 * This is because this effect needs the geometry information about the objects,
26980 * and if the window was not created yet, it can get a wrong information.
26982 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);
26985 * Add the Zoom Effect to Elm_Transit.
26987 * @note This API is one of the facades. It creates zoom effect context
26988 * and add it's required APIs to elm_transit_effect_add.
26990 * @see elm_transit_effect_add()
26992 * @param transit Transit object.
26993 * @param from_rate Scale rate when effect begins (1 is current rate).
26994 * @param to_rate Scale rate when effect ends.
26995 * @return Zoom effect context data.
26998 * @warning It is highly recommended just create a transit with this effect when
26999 * the window that the objects of the transit belongs has already been created.
27000 * This is because this effect needs the geometry information about the objects,
27001 * and if the window was not created yet, it can get a wrong information.
27003 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27006 * Add the Flip Effect to Elm_Transit.
27008 * @note This API is one of the facades. It creates flip effect context
27009 * and add it's required APIs to elm_transit_effect_add.
27010 * @note This effect is applied to each pair of objects in the order they are listed
27011 * in the transit list of objects. The first object in the pair will be the
27012 * "front" object and the second will be the "back" object.
27014 * @see elm_transit_effect_add()
27016 * @param transit Transit object.
27017 * @param axis Flipping Axis(X or Y).
27018 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27019 * @return Flip effect context data.
27022 * @warning It is highly recommended just create a transit with this effect when
27023 * the window that the objects of the transit belongs has already been created.
27024 * This is because this effect needs the geometry information about the objects,
27025 * and if the window was not created yet, it can get a wrong information.
27027 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27030 * Add the Resizable Flip Effect to Elm_Transit.
27032 * @note This API is one of the facades. It creates resizable flip effect context
27033 * and add it's required APIs to elm_transit_effect_add.
27034 * @note This effect is applied to each pair of objects in the order they are listed
27035 * in the transit list of objects. The first object in the pair will be the
27036 * "front" object and the second will be the "back" object.
27038 * @see elm_transit_effect_add()
27040 * @param transit Transit object.
27041 * @param axis Flipping Axis(X or Y).
27042 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27043 * @return Resizable flip effect context data.
27046 * @warning It is highly recommended just create a transit with this effect when
27047 * the window that the objects of the transit belongs has already been created.
27048 * This is because this effect needs the geometry information about the objects,
27049 * and if the window was not created yet, it can get a wrong information.
27051 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27054 * Add the Wipe Effect to Elm_Transit.
27056 * @note This API is one of the facades. It creates wipe effect context
27057 * and add it's required APIs to elm_transit_effect_add.
27059 * @see elm_transit_effect_add()
27061 * @param transit Transit object.
27062 * @param type Wipe type. Hide or show.
27063 * @param dir Wipe Direction.
27064 * @return Wipe effect context data.
27067 * @warning It is highly recommended just create a transit with this effect when
27068 * the window that the objects of the transit belongs has already been created.
27069 * This is because this effect needs the geometry information about the objects,
27070 * and if the window was not created yet, it can get a wrong information.
27072 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27075 * Add the Color Effect to Elm_Transit.
27077 * @note This API is one of the facades. It creates color effect context
27078 * and add it's required APIs to elm_transit_effect_add.
27080 * @see elm_transit_effect_add()
27082 * @param transit Transit object.
27083 * @param from_r RGB R when effect begins.
27084 * @param from_g RGB G when effect begins.
27085 * @param from_b RGB B when effect begins.
27086 * @param from_a RGB A when effect begins.
27087 * @param to_r RGB R when effect ends.
27088 * @param to_g RGB G when effect ends.
27089 * @param to_b RGB B when effect ends.
27090 * @param to_a RGB A when effect ends.
27091 * @return Color effect context data.
27095 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);
27098 * Add the Fade Effect to Elm_Transit.
27100 * @note This API is one of the facades. It creates fade effect context
27101 * and add it's required APIs to elm_transit_effect_add.
27102 * @note This effect is applied to each pair of objects in the order they are listed
27103 * in the transit list of objects. The first object in the pair will be the
27104 * "before" object and the second will be the "after" object.
27106 * @see elm_transit_effect_add()
27108 * @param transit Transit object.
27109 * @return Fade effect context data.
27112 * @warning It is highly recommended just create a transit with this effect when
27113 * the window that the objects of the transit belongs has already been created.
27114 * This is because this effect needs the color information about the objects,
27115 * and if the window was not created yet, it can get a wrong information.
27117 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27120 * Add the Blend Effect to Elm_Transit.
27122 * @note This API is one of the facades. It creates blend effect context
27123 * and add it's required APIs to elm_transit_effect_add.
27124 * @note This effect is applied to each pair of objects in the order they are listed
27125 * in the transit list of objects. The first object in the pair will be the
27126 * "before" object and the second will be the "after" object.
27128 * @see elm_transit_effect_add()
27130 * @param transit Transit object.
27131 * @return Blend effect context data.
27134 * @warning It is highly recommended just create a transit with this effect when
27135 * the window that the objects of the transit belongs has already been created.
27136 * This is because this effect needs the color information about the objects,
27137 * and if the window was not created yet, it can get a wrong information.
27139 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27142 * Add the Rotation Effect to Elm_Transit.
27144 * @note This API is one of the facades. It creates rotation effect context
27145 * and add it's required APIs to elm_transit_effect_add.
27147 * @see elm_transit_effect_add()
27149 * @param transit Transit object.
27150 * @param from_degree Degree when effect begins.
27151 * @param to_degree Degree when effect is ends.
27152 * @return Rotation effect context data.
27155 * @warning It is highly recommended just create a transit with this effect when
27156 * the window that the objects of the transit belongs has already been created.
27157 * This is because this effect needs the geometry information about the objects,
27158 * and if the window was not created yet, it can get a wrong information.
27160 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27163 * Add the ImageAnimation Effect to Elm_Transit.
27165 * @note This API is one of the facades. It creates image animation effect context
27166 * and add it's required APIs to elm_transit_effect_add.
27167 * The @p images parameter is a list images paths. This list and
27168 * its contents will be deleted at the end of the effect by
27169 * elm_transit_effect_image_animation_context_free() function.
27173 * char buf[PATH_MAX];
27174 * Eina_List *images = NULL;
27175 * Elm_Transit *transi = elm_transit_add();
27177 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27178 * images = eina_list_append(images, eina_stringshare_add(buf));
27180 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27181 * images = eina_list_append(images, eina_stringshare_add(buf));
27182 * elm_transit_effect_image_animation_add(transi, images);
27186 * @see elm_transit_effect_add()
27188 * @param transit Transit object.
27189 * @param images Eina_List of images file paths. This list and
27190 * its contents will be deleted at the end of the effect by
27191 * elm_transit_effect_image_animation_context_free() function.
27192 * @return Image Animation effect context data.
27196 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27201 typedef struct _Elm_Store Elm_Store;
27202 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
27203 typedef struct _Elm_Store_Item Elm_Store_Item;
27204 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
27205 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
27206 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27207 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
27208 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
27209 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
27210 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
27211 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
27213 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27214 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
27215 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
27216 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27220 ELM_STORE_ITEM_MAPPING_NONE = 0,
27221 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27222 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27223 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27224 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27225 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27226 // can add more here as needed by common apps
27227 ELM_STORE_ITEM_MAPPING_LAST
27228 } Elm_Store_Item_Mapping_Type;
27230 struct _Elm_Store_Item_Mapping_Icon
27232 // FIXME: allow edje file icons
27234 Elm_Icon_Lookup_Order lookup_order;
27235 Eina_Bool standard_name : 1;
27236 Eina_Bool no_scale : 1;
27237 Eina_Bool smooth : 1;
27238 Eina_Bool scale_up : 1;
27239 Eina_Bool scale_down : 1;
27242 struct _Elm_Store_Item_Mapping_Empty
27247 struct _Elm_Store_Item_Mapping_Photo
27252 struct _Elm_Store_Item_Mapping_Custom
27254 Elm_Store_Item_Mapping_Cb func;
27257 struct _Elm_Store_Item_Mapping
27259 Elm_Store_Item_Mapping_Type type;
27264 Elm_Store_Item_Mapping_Empty empty;
27265 Elm_Store_Item_Mapping_Icon icon;
27266 Elm_Store_Item_Mapping_Photo photo;
27267 Elm_Store_Item_Mapping_Custom custom;
27268 // add more types here
27272 struct _Elm_Store_Item_Info
27274 Elm_Genlist_Item_Class *item_class;
27275 const Elm_Store_Item_Mapping *mapping;
27280 struct _Elm_Store_Item_Info_Filesystem
27282 Elm_Store_Item_Info base;
27286 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27287 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27289 EAPI void elm_store_free(Elm_Store *st);
27291 EAPI Elm_Store *elm_store_filesystem_new(void);
27292 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27293 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27294 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27296 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27298 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27299 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27300 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27301 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27302 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27303 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27305 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27306 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27307 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27308 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27309 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27310 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27311 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27314 * @defgroup SegmentControl SegmentControl
27315 * @ingroup Elementary
27317 * @image html img/widget/segment_control/preview-00.png
27318 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27320 * @image html img/segment_control.png
27321 * @image latex img/segment_control.eps width=\textwidth
27323 * Segment control widget is a horizontal control made of multiple segment
27324 * items, each segment item functioning similar to discrete two state button.
27325 * A segment control groups the items together and provides compact
27326 * single button with multiple equal size segments.
27328 * Segment item size is determined by base widget
27329 * size and the number of items added.
27330 * Only one segment item can be at selected state. A segment item can display
27331 * combination of Text and any Evas_Object like Images or other widget.
27333 * Smart callbacks one can listen to:
27334 * - "changed" - When the user clicks on a segment item which is not
27335 * previously selected and get selected. The event_info parameter is the
27336 * segment item index.
27338 * Available styles for it:
27341 * Here is an example on its usage:
27342 * @li @ref segment_control_example
27346 * @addtogroup SegmentControl
27350 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27353 * Add a new segment control widget to the given parent Elementary
27354 * (container) object.
27356 * @param parent The parent object.
27357 * @return a new segment control widget handle or @c NULL, on errors.
27359 * This function inserts a new segment control widget on the canvas.
27361 * @ingroup SegmentControl
27363 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27366 * Append a new item to the segment control object.
27368 * @param obj The segment control object.
27369 * @param icon The icon object to use for the left side of the item. An
27370 * icon can be any Evas object, but usually it is an icon created
27371 * with elm_icon_add().
27372 * @param label The label of the item.
27373 * Note that, NULL is different from empty string "".
27374 * @return The created item or @c NULL upon failure.
27376 * A new item will be created and appended to the segment control, i.e., will
27377 * be set as @b last item.
27379 * If it should be inserted at another position,
27380 * elm_segment_control_item_insert_at() should be used instead.
27382 * Items created with this function can be deleted with function
27383 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27385 * @note @p label set to @c NULL is different from empty string "".
27387 * only has icon, it will be displayed bigger and centered. If it has
27388 * icon and label, even that an empty string, icon will be smaller and
27389 * positioned at left.
27393 * sc = elm_segment_control_add(win);
27394 * ic = elm_icon_add(win);
27395 * elm_icon_file_set(ic, "path/to/image", NULL);
27396 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27397 * elm_segment_control_item_add(sc, ic, "label");
27398 * evas_object_show(sc);
27401 * @see elm_segment_control_item_insert_at()
27402 * @see elm_segment_control_item_del()
27404 * @ingroup SegmentControl
27406 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27409 * Insert a new item to the segment control object at specified position.
27411 * @param obj The segment control object.
27412 * @param icon The icon object to use for the left side of the item. An
27413 * icon can be any Evas object, but usually it is an icon created
27414 * with elm_icon_add().
27415 * @param label The label of the item.
27416 * @param index Item position. Value should be between 0 and items count.
27417 * @return The created item or @c NULL upon failure.
27419 * Index values must be between @c 0, when item will be prepended to
27420 * segment control, and items count, that can be get with
27421 * elm_segment_control_item_count_get(), case when item will be appended
27422 * to segment control, just like elm_segment_control_item_add().
27424 * Items created with this function can be deleted with function
27425 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27427 * @note @p label set to @c NULL is different from empty string "".
27429 * only has icon, it will be displayed bigger and centered. If it has
27430 * icon and label, even that an empty string, icon will be smaller and
27431 * positioned at left.
27433 * @see elm_segment_control_item_add()
27434 * @see elm_segment_control_item_count_get()
27435 * @see elm_segment_control_item_del()
27437 * @ingroup SegmentControl
27439 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);
27442 * Remove a segment control item from its parent, deleting it.
27444 * @param it The item to be removed.
27446 * Items can be added with elm_segment_control_item_add() or
27447 * elm_segment_control_item_insert_at().
27449 * @ingroup SegmentControl
27451 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27454 * Remove a segment control item at given index from its parent,
27457 * @param obj The segment control object.
27458 * @param index The position of the segment control item to be deleted.
27460 * Items can be added with elm_segment_control_item_add() or
27461 * elm_segment_control_item_insert_at().
27463 * @ingroup SegmentControl
27465 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27468 * Get the Segment items count from segment control.
27470 * @param obj The segment control object.
27471 * @return Segment items count.
27473 * It will just return the number of items added to segment control @p obj.
27475 * @ingroup SegmentControl
27477 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27480 * Get the item placed at specified index.
27482 * @param obj The segment control object.
27483 * @param index The index of the segment item.
27484 * @return The segment control item or @c NULL on failure.
27486 * Index is the position of an item in segment control widget. Its
27487 * range is from @c 0 to <tt> count - 1 </tt>.
27488 * Count is the number of items, that can be get with
27489 * elm_segment_control_item_count_get().
27491 * @ingroup SegmentControl
27493 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27496 * Get the label of item.
27498 * @param obj The segment control object.
27499 * @param index The index of the segment item.
27500 * @return The label of the item at @p index.
27502 * The return value is a pointer to the label associated to the item when
27503 * it was created, with function elm_segment_control_item_add(), or later
27504 * with function elm_segment_control_item_label_set. If no label
27505 * was passed as argument, it will return @c NULL.
27507 * @see elm_segment_control_item_label_set() for more details.
27508 * @see elm_segment_control_item_add()
27510 * @ingroup SegmentControl
27512 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27515 * Set the label of item.
27517 * @param it The item of segment control.
27518 * @param text The label of item.
27520 * The label to be displayed by the item.
27521 * Label will be at right of the icon (if set).
27523 * If a label was passed as argument on item creation, with function
27524 * elm_control_segment_item_add(), it will be already
27525 * displayed by the item.
27527 * @see elm_segment_control_item_label_get()
27528 * @see elm_segment_control_item_add()
27530 * @ingroup SegmentControl
27532 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
27535 * Get the icon associated to the item.
27537 * @param obj The segment control object.
27538 * @param index The index of the segment item.
27539 * @return The left side icon associated to the item at @p index.
27541 * The return value is a pointer to the icon associated to the item when
27542 * it was created, with function elm_segment_control_item_add(), or later
27543 * with function elm_segment_control_item_icon_set(). If no icon
27544 * was passed as argument, it will return @c NULL.
27546 * @see elm_segment_control_item_add()
27547 * @see elm_segment_control_item_icon_set()
27549 * @ingroup SegmentControl
27551 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27554 * Set the icon associated to the item.
27556 * @param it The segment control item.
27557 * @param icon The icon object to associate with @p it.
27559 * The icon object to use at left side of the item. An
27560 * icon can be any Evas object, but usually it is an icon created
27561 * with elm_icon_add().
27563 * Once the icon object is set, a previously set one will be deleted.
27564 * @warning Setting the same icon for two items will cause the icon to
27565 * dissapear from the first item.
27567 * If an icon was passed as argument on item creation, with function
27568 * elm_segment_control_item_add(), it will be already
27569 * associated to the item.
27571 * @see elm_segment_control_item_add()
27572 * @see elm_segment_control_item_icon_get()
27574 * @ingroup SegmentControl
27576 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27579 * Get the index of an item.
27581 * @param it The segment control item.
27582 * @return The position of item in segment control widget.
27584 * Index is the position of an item in segment control widget. Its
27585 * range is from @c 0 to <tt> count - 1 </tt>.
27586 * Count is the number of items, that can be get with
27587 * elm_segment_control_item_count_get().
27589 * @ingroup SegmentControl
27591 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27594 * Get the base object of the item.
27596 * @param it The segment control item.
27597 * @return The base object associated with @p it.
27599 * Base object is the @c Evas_Object that represents that item.
27601 * @ingroup SegmentControl
27603 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27606 * Get the selected item.
27608 * @param obj The segment control object.
27609 * @return The selected item or @c NULL if none of segment items is
27612 * The selected item can be unselected with function
27613 * elm_segment_control_item_selected_set().
27615 * The selected item always will be highlighted on segment control.
27617 * @ingroup SegmentControl
27619 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27622 * Set the selected state of an item.
27624 * @param it The segment control item
27625 * @param select The selected state
27627 * This sets the selected state of the given item @p it.
27628 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27630 * If a new item is selected the previosly selected will be unselected.
27631 * Previoulsy selected item can be get with function
27632 * elm_segment_control_item_selected_get().
27634 * The selected item always will be highlighted on segment control.
27636 * @see elm_segment_control_item_selected_get()
27638 * @ingroup SegmentControl
27640 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
27647 * @defgroup Grid Grid
27649 * The grid is a grid layout widget that lays out a series of children as a
27650 * fixed "grid" of widgets using a given percentage of the grid width and
27651 * height each using the child object.
27653 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
27654 * widgets size itself. The default is 100 x 100, so that means the
27655 * position and sizes of children will effectively be percentages (0 to 100)
27656 * of the width or height of the grid widget
27662 * Add a new grid to the parent
27664 * @param parent The parent object
27665 * @return The new object or NULL if it cannot be created
27669 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
27672 * Set the virtual size of the grid
27674 * @param obj The grid object
27675 * @param w The virtual width of the grid
27676 * @param h The virtual height of the grid
27680 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
27683 * Get the virtual size of the grid
27685 * @param obj The grid object
27686 * @param w Pointer to integer to store the virtual width of the grid
27687 * @param h Pointer to integer to store the virtual height of the grid
27691 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
27694 * Pack child at given position and size
27696 * @param obj The grid object
27697 * @param subobj The child to pack
27698 * @param x The virtual x coord at which to pack it
27699 * @param y The virtual y coord at which to pack it
27700 * @param w The virtual width at which to pack it
27701 * @param h The virtual height at which to pack it
27705 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
27708 * Unpack a child from a grid object
27710 * @param obj The grid object
27711 * @param subobj The child to unpack
27715 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
27718 * Faster way to remove all child objects from a grid object.
27720 * @param obj The grid object
27721 * @param clear If true, it will delete just removed children
27725 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
27728 * Set packing of an existing child at to position and size
27730 * @param subobj The child to set packing of
27731 * @param x The virtual x coord at which to pack it
27732 * @param y The virtual y coord at which to pack it
27733 * @param w The virtual width at which to pack it
27734 * @param h The virtual height at which to pack it
27738 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
27741 * get packing of a child
27743 * @param subobj The child to query
27744 * @param x Pointer to integer to store the virtual x coord
27745 * @param y Pointer to integer to store the virtual y coord
27746 * @param w Pointer to integer to store the virtual width
27747 * @param h Pointer to integer to store the virtual height
27751 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
27757 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
27758 EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
27759 EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
27760 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
27761 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
27762 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
27765 * @defgroup Video Video
27767 * @addtogroup Video
27770 * Elementary comes with two object that help design application that need
27771 * to display video. The main one, Elm_Video, display a video by using Emotion.
27772 * It does embedded the video inside an Edje object, so you can do some
27773 * animation depending on the video state change. It does also implement a
27774 * ressource management policy to remove this burden from the application writer.
27776 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
27777 * It take care of updating its content according to Emotion event and provide a
27778 * way to theme itself. It also does automatically raise the priority of the
27779 * linked Elm_Video so it will use the video decoder if available. It also does
27780 * activate the remember function on the linked Elm_Video object.
27782 * Signals that you can add callback for are :
27784 * "forward,clicked" - the user clicked the forward button.
27785 * "info,clicked" - the user clicked the info button.
27786 * "next,clicked" - the user clicked the next button.
27787 * "pause,clicked" - the user clicked the pause button.
27788 * "play,clicked" - the user clicked the play button.
27789 * "prev,clicked" - the user clicked the prev button.
27790 * "rewind,clicked" - the user clicked the rewind button.
27791 * "stop,clicked" - the user clicked the stop button.
27795 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
27797 * @param parent The parent object
27798 * @return a new player widget handle or @c NULL, on errors.
27800 * This function inserts a new player widget on the canvas.
27802 * @see elm_player_video_set()
27806 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
27809 * @brief Link a Elm_Payer with an Elm_Video object.
27811 * @param player the Elm_Player object.
27812 * @param video The Elm_Video object.
27814 * This mean that action on the player widget will affect the
27815 * video object and the state of the video will be reflected in
27816 * the player itself.
27818 * @see elm_player_add()
27819 * @see elm_video_add()
27823 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
27826 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
27828 * @param parent The parent object
27829 * @return a new video widget handle or @c NULL, on errors.
27831 * This function inserts a new video widget on the canvas.
27833 * @seeelm_video_file_set()
27834 * @see elm_video_uri_set()
27838 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
27841 * @brief Define the file that will be the video source.
27843 * @param video The video object to define the file for.
27844 * @param filename The file to target.
27846 * This function will explicitly define a filename as a source
27847 * for the video of the Elm_Video object.
27849 * @see elm_video_uri_set()
27850 * @see elm_video_add()
27851 * @see elm_player_add()
27855 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
27858 * @brief Define the uri that will be the video source.
27860 * @param video The video object to define the file for.
27861 * @param uri The uri to target.
27863 * This function will define an uri as a source for the video of the
27864 * Elm_Video object. URI could be remote source of video, like http:// or local source
27865 * like for example WebCam who are most of the time v4l2:// (but that depend and
27866 * you should use Emotion API to request and list the available Webcam on your system).
27868 * @see elm_video_file_set()
27869 * @see elm_video_add()
27870 * @see elm_player_add()
27874 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
27877 * @brief Get the underlying Emotion object.
27879 * @param video The video object to proceed the request on.
27880 * @return the underlying Emotion object.
27884 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
27887 * @brief Start to play the video
27889 * @param video The video object to proceed the request on.
27891 * Start to play the video and cancel all suspend state.
27895 EAPI void elm_video_play(Evas_Object *video);
27898 * @brief Pause the video
27900 * @param video The video object to proceed the request on.
27902 * Pause the video and start a timer to trigger suspend mode.
27906 EAPI void elm_video_pause(Evas_Object *video);
27909 * @brief Stop the video
27911 * @param video The video object to proceed the request on.
27913 * Stop the video and put the emotion in deep sleep mode.
27917 EAPI void elm_video_stop(Evas_Object *video);
27920 * @brief Is the video actually playing.
27922 * @param video The video object to proceed the request on.
27923 * @return EINA_TRUE if the video is actually playing.
27925 * You should consider watching event on the object instead of polling
27926 * the object state.
27930 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
27933 * @brief Is it possible to seek inside the video.
27935 * @param video The video object to proceed the request on.
27936 * @return EINA_TRUE if is possible to seek inside the video.
27940 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
27943 * @brief Is the audio muted.
27945 * @param video The video object to proceed the request on.
27946 * @return EINA_TRUE if the audio is muted.
27950 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
27953 * @brief Change the mute state of the Elm_Video object.
27955 * @param video The video object to proceed the request on.
27956 * @param mute The new mute state.
27960 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
27963 * @brief Get the audio level of the current video.
27965 * @param video The video object to proceed the request on.
27966 * @return the current audio level.
27970 EAPI double elm_video_audio_level_get(Evas_Object *video);
27973 * @brief Set the audio level of anElm_Video object.
27975 * @param video The video object to proceed the request on.
27976 * @param volume The new audio volume.
27980 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
27982 EAPI double elm_video_play_position_get(Evas_Object *video);
27983 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
27984 EAPI double elm_video_play_length_get(Evas_Object *video);
27985 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
27986 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
27987 EAPI const char *elm_video_title_get(Evas_Object *video);
27993 * @defgroup Naviframe Naviframe
27994 * @ingroup Elementary
27996 * @brief Naviframe is a kind of view manager for the applications.
27998 * Naviframe provides functions to switch different pages with stack
27999 * mechanism. It means if one page(item) needs to be changed to the new one,
28000 * then naviframe would push the new page to it's internal stack. Of course,
28001 * it can be back to the previous page by popping the top page. Naviframe
28002 * provides some transition effect while the pages are switching (same as
28005 * Since each item could keep the different styles, users could keep the
28006 * same look & feel for the pages or different styles for the items in it's
28009 * Signals that you can add callback for are:
28011 * @li "transition,finished" - When the transition is finished in changing
28013 * @li "title,clicked" - User clicked title area
28015 * Default contents parts for the naviframe items that you can use for are:
28017 * @li "elm.swallow.content" - The main content of the page
28018 * @li "elm.swallow.prev_btn" - The button to go to the previous page
28019 * @li "elm.swallow.next_btn" - The button to go to the next page
28021 * Default text parts of naviframe items that you can be used are:
28023 * @li "elm.text.title" - The title label in the title area
28025 * @ref tutorial_naviframe gives a good overview of the usage of the API.
28029 * @addtogroup Naviframe
28034 * @brief Add a new Naviframe object to the parent.
28036 * @param parent Parent object
28037 * @return New object or @c NULL, if it cannot be created
28039 * @ingroup Naviframe
28041 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28043 * @brief Push a new item to the top of the naviframe stack (and show it).
28045 * @param obj The naviframe object
28046 * @param title_label The label in the title area. The name of the title
28047 * label part is "elm.text.title"
28048 * @param prev_btn The button to go to the previous item. If it is NULL,
28049 * then naviframe will create a back button automatically. The name of
28050 * the prev_btn part is "elm.swallow.prev_btn"
28051 * @param next_btn The button to go to the next item. Or It could be just an
28052 * extra function button. The name of the next_btn part is
28053 * "elm.swallow.next_btn"
28054 * @param content The main content object. The name of content part is
28055 * "elm.swallow.content"
28056 * @param item_style The current item style name. @c NULL would be default.
28057 * @return The created item or @c NULL upon failure.
28059 * The item pushed becomes one page of the naviframe, this item will be
28060 * deleted when it is popped.
28062 * @see also elm_naviframe_item_style_set()
28064 * The following styles are available for this item:
28067 * @ingroup Naviframe
28069 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);
28071 * @brief Pop an item that is on top of the stack
28073 * @param obj The naviframe object
28074 * @return @c NULL or the content object(if the
28075 * elm_naviframe_content_preserve_on_pop_get is true).
28077 * This pops an item that is on the top(visible) of the naviframe, makes it
28078 * disappear, then deletes the item. The item that was underneath it on the
28079 * stack will become visible.
28081 * @see also elm_naviframe_content_preserve_on_pop_get()
28083 * @ingroup Naviframe
28085 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28087 * @brief Pop the items between the top and the above one on the given item.
28089 * @param it The naviframe item
28091 * @ingroup Naviframe
28093 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28095 * @brief Delete the given item instantly.
28097 * @param it The naviframe item
28099 * This just deletes the given item from the naviframe item list instantly.
28100 * So this would not emit any signals for view transitions but just change
28101 * the current view if the given item is a top one.
28103 * @ingroup Naviframe
28105 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28107 * @brief preserve the content objects when items are popped.
28109 * @param obj The naviframe object
28110 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28112 * @see also elm_naviframe_content_preserve_on_pop_get()
28114 * @ingroup Naviframe
28116 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28118 * @brief Get a value whether preserve mode is enabled or not.
28120 * @param obj The naviframe object
28121 * @return If @c EINA_TRUE, preserve mode is enabled
28123 * @see also elm_naviframe_content_preserve_on_pop_set()
28125 * @ingroup Naviframe
28127 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28129 * @brief Get a top item on the naviframe stack
28131 * @param obj The naviframe object
28132 * @return The top item on the naviframe stack or @c NULL, if the stack is
28135 * @ingroup Naviframe
28137 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28139 * @brief Get a bottom item on the naviframe stack
28141 * @param obj The naviframe object
28142 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28145 * @ingroup Naviframe
28147 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28149 * @brief Set an item style
28151 * @param obj The naviframe item
28152 * @param item_style The current item style name. @c NULL would be default
28154 * The following styles are available for this item:
28157 * @see also elm_naviframe_item_style_get()
28159 * @ingroup Naviframe
28161 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28163 * @brief Get an item style
28165 * @param obj The naviframe item
28166 * @return The current item style name
28168 * @see also elm_naviframe_item_style_set()
28170 * @ingroup Naviframe
28172 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28174 * @brief Show/Hide the title area
28176 * @param it The naviframe item
28177 * @param visible If @c EINA_TRUE, title area will be visible, hidden
28180 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
28182 * @see also elm_naviframe_item_title_visible_get()
28184 * @ingroup Naviframe
28186 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28188 * @brief Get a value whether title area is visible or not.
28190 * @param it The naviframe item
28191 * @return If @c EINA_TRUE, title area is visible
28193 * @see also elm_naviframe_item_title_visible_set()
28195 * @ingroup Naviframe
28197 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28200 * @brief Set creating prev button automatically or not
28202 * @param obj The naviframe object
28203 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28204 * be created internally when you pass the @c NULL to the prev_btn
28205 * parameter in elm_naviframe_item_push
28207 * @see also elm_naviframe_item_push()
28209 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28211 * @brief Get a value whether prev button(back button) will be auto pushed or
28214 * @param obj The naviframe object
28215 * @return If @c EINA_TRUE, prev button will be auto pushed.
28217 * @see also elm_naviframe_item_push()
28218 * elm_naviframe_prev_btn_auto_pushed_set()
28220 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);