3 * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
8 @brief Elementary Widget Library
13 @image html elementary.png
17 @section intro What is Elementary?
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
22 It is meant to make the programmers work almost brainless but give them lots
25 @li @ref Start - Go here to quickly get started with writing Apps
27 @section organization Organization
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers which hold the widgets.
34 @section license License
36 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
37 all files in the source tree.
39 @section ack Acknowledgements
40 There is a lot that goes into making a widget set, and they don't happen out of
41 nothing. It's like trying to make everyone everywhere happy, regardless of age,
42 gender, race or nationality - and that is really tough. So thanks to people and
43 organisations behind this, as listed in the @ref authors page.
48 * @defgroup Start Getting Started
50 * To write an Elementary app, you can get started with the following:
53 #include <Elementary.h>
55 elm_main(int argc, char **argv)
57 // create window(s) here and do any application init
58 elm_run(); // run main loop
59 elm_shutdown(); // after mainloop finishes running, shutdown
60 return 0; // exit 0 for exit code
65 * To use autotools (which helps in many ways in the long run, like being able
66 * to immediately create releases of your software directly from your tree
67 * and ensure everything needed to build it is there) you will need a
68 * configure.ac, Makefile.am and autogen.sh file.
73 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
75 AC_CONFIG_SRCDIR(configure.ac)
76 AM_CONFIG_HEADER(config.h)
78 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
79 PKG_CHECK_MODULES([ELEMENTARY], elementary)
86 AUTOMAKE_OPTIONS = 1.4 foreign
87 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
89 INCLUDES = -I$(top_srcdir)
93 myapp_SOURCES = main.c
94 myapp_LDADD = @ELEMENTARY_LIBS@
95 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
102 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
103 echo "Running autoheader..." ; autoheader || exit 1
104 echo "Running autoconf..." ; autoconf || exit 1
105 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
109 * To generate all the things needed to bootstrap just run:
115 * This will generate Makefile.in's, the confgure script and everything else.
116 * After this it works like all normal autotools projects:
123 * Note sudo was assumed to get root permissions, as this would install in
124 * /usr/local which is system-owned. Use any way you like to gain root, or
125 * specify a different prefix with configure:
128 ./confiugre --prefix=$HOME/mysoftware
131 * Also remember that autotools buys you some useful commands like:
136 * This uninstalls the software after it was installed with "make install".
137 * It is very useful to clear up what you built if you wish to clean the
144 * This firstly checks if your build tree is "clean" and ready for
145 * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
146 * ready to upload and distribute to the world, that contains the generated
147 * Makefile.in's and configure script. The users do not need to run
148 * autogen.sh - just configure and on. They don't need autotools installed.
149 * This tarball also builds cleanly, has all the sources it needs to build
150 * included (that is sources for your application, not libraries it depends
151 * on like Elementary). It builds cleanly in a buildroot and does not
152 * contain any files that are temporarily generated like binaries and other
153 * build-generated files, so the tarball is clean, and no need to worry
154 * about cleaning up your tree before packaging.
160 * This cleans up all build files (binaries, objects etc.) from the tree.
166 * This cleans out all files from the build and from configure's output too.
169 make maintainer-clean
172 * This deletes all the files autogen.sh will produce so the tree is clean
173 * to be put into a revision-control system (like CVS, SVN or GIT for example).
175 * There is a more advanced way of making use of the quicklaunch infrastructure
176 * in Elementary (which will not be covered here due to its more advanced
179 * Now let's actually create an interactive "Hello World" gui that you can
180 * click the ok button to exit. It's more code because this now does something
181 * much more significant, but it's still very simple:
184 #include <Elementary.h>
187 on_done(void *data, Evas_Object *obj, void *event_info)
189 // quit the mainloop (elm_run function will return)
194 elm_main(int argc, char **argv)
196 Evas_Object *win, *bg, *box, *lab, *btn;
198 // new window - do the usual and give it a name (hello) and title (Hello)
199 win = elm_win_util_standard_add("hello", "Hello");
200 // when the user clicks "close" on a window there is a request to delete
201 evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
203 // add a box object - default is vertical. a box holds children in a row,
204 // either horizontally or vertically. nothing more.
205 box = elm_box_add(win);
206 // make the box hotizontal
207 elm_box_horizontal_set(box, EINA_TRUE);
208 // add object as a resize object for the window (controls window minimum
209 // size as well as gets resized if window is resized)
210 elm_win_resize_object_add(win, box);
211 evas_object_show(box);
213 // add a label widget, set the text and put it in the pad frame
214 lab = elm_label_add(win);
215 // set default text of the label
216 elm_object_text_set(lab, "Hello out there world!");
217 // pack the label at the end of the box
218 elm_box_pack_end(box, lab);
219 evas_object_show(lab);
222 btn = elm_button_add(win);
223 // set default text of button to "OK"
224 elm_object_text_set(btn, "OK");
225 // pack the button at the end of the box
226 elm_box_pack_end(box, btn);
227 evas_object_show(btn);
228 // call on_done when button is clicked
229 evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
231 // now we are done, show the window
232 evas_object_show(win);
234 // run the mainloop and process events and callbacks
244 @page authors Authors
245 @author Carsten Haitzler <raster@@rasterman.com>
246 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
247 @author Cedric Bail <cedric.bail@@free.fr>
248 @author Vincent Torri <vtorri@@univ-evry.fr>
249 @author Daniel Kolesa <quaker66@@gmail.com>
250 @author Jaime Thomas <avi.thomas@@gmail.com>
251 @author Swisscom - http://www.swisscom.ch/
252 @author Christopher Michael <devilhorns@@comcast.net>
253 @author Marco Trevisan (TreviƱo) <mail@@3v1n0.net>
254 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
255 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
256 @author Brian Wang <brian.wang.0721@@gmail.com>
257 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
258 @author Samsung Electronics <tbd>
259 @author Samsung SAIT <tbd>
260 @author Brett Nash <nash@@nash.id.au>
261 @author Bruno Dilly <bdilly@@profusion.mobi>
262 @author Rafael Fonseca <rfonseca@@profusion.mobi>
263 @author Chuneon Park <hermet@@hermet.pe.kr>
264 @author Woohyun Jung <wh0705.jung@@samsung.com>
265 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
266 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
267 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
268 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
269 @author Gustavo Lima Chaves <glima@@profusion.mobi>
270 @author Fabiano FidĆŖncio <fidencio@@profusion.mobi>
271 @author Tiago FalcĆ£o <tiago@@profusion.mobi>
272 @author Otavio Pontes <otavio@@profusion.mobi>
273 @author Viktor Kojouharov <vkojouharov@@gmail.com>
274 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
275 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
276 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
277 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
278 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
279 @author Jihoon Kim <jihoon48.kim@@samsung.com>
280 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
281 @author Tom Hacohen <tom@@stosb.com>
282 @author Aharon Hillel <a.hillel@@partner.samsung.com>
283 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
284 @author Shinwoo Kim <kimcinoo@@gmail.com>
285 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
286 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
287 @author Sung W. Park <sungwoo@gmail.com>
288 @author Thierry el Borgi <thierry@substantiel.fr>
289 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
290 @author Chanwook Jung <joey.jung@samsung.com>
291 @author Hyoyoung Chang <hyoyoung.chang@samsung.com>
292 @author Guillaume "Kuri" Friloux <guillaume.friloux@asp64.com>
293 @author Kim Yunhan <spbear@gmail.com>
295 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
296 contact with the developers and maintainers.
304 * @brief Elementary's API
309 @ELM_UNIX_DEF@ ELM_UNIX
310 @ELM_WIN32_DEF@ ELM_WIN32
311 @ELM_WINCE_DEF@ ELM_WINCE
312 @ELM_EDBUS_DEF@ ELM_EDBUS
313 @ELM_EFREET_DEF@ ELM_EFREET
314 @ELM_ETHUMB_DEF@ ELM_ETHUMB
315 @ELM_WEB_DEF@ ELM_WEB
316 @ELM_EMAP_DEF@ ELM_EMAP
317 @ELM_DEBUG_DEF@ ELM_DEBUG
318 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
319 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
321 /* Standard headers for standard system calls etc. */
326 #include <sys/types.h>
327 #include <sys/stat.h>
328 #include <sys/time.h>
329 #include <sys/param.h>
342 # ifdef ELM_LIBINTL_H
343 # include <libintl.h>
354 #if defined (ELM_WIN32) || defined (ELM_WINCE)
357 # define alloca _alloca
368 #include <Ecore_Evas.h>
369 #include <Ecore_File.h>
370 #include <Ecore_IMF.h>
371 #include <Ecore_Con.h>
380 # include <Efreet_Mime.h>
381 # include <Efreet_Trash.h>
385 # include <Ethumb_Client.h>
397 # ifdef ELEMENTARY_BUILD
399 # define EAPI __declspec(dllexport)
402 # endif /* ! DLL_EXPORT */
404 # define EAPI __declspec(dllimport)
405 # endif /* ! EFL_EVAS_BUILD */
409 # define EAPI __attribute__ ((visibility("default")))
416 #endif /* ! _WIN32 */
421 # define EAPI_MAIN EAPI
424 /* allow usage from c++ */
429 #define ELM_VERSION_MAJOR @VMAJ@
430 #define ELM_VERSION_MINOR @VMIN@
432 typedef struct _Elm_Version
440 EAPI extern Elm_Version *elm_version;
443 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
444 #define ELM_PI 3.14159265358979323846
447 * @defgroup General General
449 * @brief General Elementary API. Functions that don't relate to
450 * Elementary objects specifically.
452 * Here are documented functions which init/shutdown the library,
453 * that apply to generic Elementary objects, that deal with
454 * configuration, et cetera.
456 * @ref general_functions_example_page "This" example contemplates
457 * some of these functions.
461 * @addtogroup General
466 * Defines couple of standard Evas_Object layers to be used
467 * with evas_object_layer_set().
469 * @note whenever extending with new values, try to keep some padding
470 * to siblings so there is room for further extensions.
472 typedef enum _Elm_Object_Layer
474 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
475 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
476 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
477 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
478 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
479 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
482 /**************************************************************************/
483 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
486 * Emitted when the application has reconfigured elementary settings due
487 * to an external configuration tool asking it to.
489 EAPI extern int ELM_EVENT_CONFIG_ALL_CHANGED;
492 * Emitted when any Elementary's policy value is changed.
494 EAPI extern int ELM_EVENT_POLICY_CHANGED;
497 * @typedef Elm_Event_Policy_Changed
499 * Data on the event when an Elementary policy has changed
501 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
504 * @struct _Elm_Event_Policy_Changed
506 * Data on the event when an Elementary policy has changed
508 struct _Elm_Event_Policy_Changed
510 unsigned int policy; /**< the policy identifier */
511 int new_value; /**< value the policy had before the change */
512 int old_value; /**< new value the policy got */
516 * Policy identifiers.
518 typedef enum _Elm_Policy
520 ELM_POLICY_QUIT, /**< under which circumstances the application
521 * should quit automatically. @see
525 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
528 typedef enum _Elm_Policy_Quit
530 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
532 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
534 * window is closed */
535 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
537 typedef enum _Elm_Focus_Direction
541 } Elm_Focus_Direction;
543 typedef enum _Elm_Text_Format
545 ELM_TEXT_FORMAT_PLAIN_UTF8,
546 ELM_TEXT_FORMAT_MARKUP_UTF8
550 * Line wrapping types.
552 typedef enum _Elm_Wrap_Type
554 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
555 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
556 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
557 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
563 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
564 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
565 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
566 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
567 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
568 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
569 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
570 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
571 ELM_INPUT_PANEL_LAYOUT_INVALID
572 } Elm_Input_Panel_Layout;
576 ELM_AUTOCAPITAL_TYPE_NONE,
577 ELM_AUTOCAPITAL_TYPE_WORD,
578 ELM_AUTOCAPITAL_TYPE_SENTENCE,
579 ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
580 } Elm_Autocapital_Type;
583 * @typedef Elm_Object_Item
584 * An Elementary Object item handle.
587 typedef struct _Elm_Object_Item Elm_Object_Item;
591 * Called back when a widget's tooltip is activated and needs content.
592 * @param data user-data given to elm_object_tooltip_content_cb_set()
593 * @param obj owner widget.
594 * @param tooltip The tooltip object (affix content to this!)
596 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
599 * Called back when a widget's item tooltip is activated and needs content.
600 * @param data user-data given to elm_object_tooltip_content_cb_set()
601 * @param obj owner widget.
602 * @param tooltip The tooltip object (affix content to this!)
603 * @param item context dependent item. As an example, if tooltip was
604 * set on Elm_List_Item, then it is of this type.
606 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
608 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info); /**< Function prototype definition for callbacks on input events happening on Elementary widgets. @a data will receive the user data pointer passed to elm_object_event_callback_add(). @a src will be a pointer to the widget on which the input event took place. @a type will get the type of this event and @a event_info, the struct with details on this event. */
610 #ifndef ELM_LIB_QUICKLAUNCH
611 #define ELM_MAIN() int main(int argc, char **argv) {elm_init(argc, argv); return elm_main(argc, argv);} /**< macro to be used after the elm_main() function */
613 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
616 /**************************************************************************/
620 * Initialize Elementary
622 * @param[in] argc System's argument count value
623 * @param[in] argv System's pointer to array of argument strings
624 * @return The init counter value.
626 * This function initializes Elementary and increments a counter of
627 * the number of calls to it. It returns the new counter's value.
629 * @warning This call is exported only for use by the @c ELM_MAIN()
630 * macro. There is no need to use this if you use this macro (which
631 * is highly advisable). An elm_main() should contain the entry
632 * point code for your application, having the same prototype as
633 * elm_init(), and @b not being static (putting the @c EAPI symbol
634 * in front of its type declaration is advisable). The @c
635 * ELM_MAIN() call should be placed just after it.
638 * @dontinclude bg_example_01.c
642 * See the full @ref bg_example_01_c "example".
644 * @see elm_shutdown().
647 EAPI int elm_init(int argc, char **argv);
650 * Shut down Elementary
652 * @return The init counter value.
654 * This should be called at the end of your application, just
655 * before it ceases to do any more processing. This will clean up
656 * any permanent resources your application may have allocated via
657 * Elementary that would otherwise persist.
659 * @see elm_init() for an example
663 EAPI int elm_shutdown(void);
666 * Run Elementary's main loop
668 * This call should be issued just after all initialization is
669 * completed. This function will not return until elm_exit() is
670 * called. It will keep looping, running the main
671 * (event/processing) loop for Elementary.
673 * @see elm_init() for an example
677 EAPI void elm_run(void);
680 * Exit Elementary's main loop
682 * If this call is issued, it will flag the main loop to cease
683 * processing and return back to its parent function (usually your
684 * elm_main() function).
686 * @see elm_init() for an example. There, just after a request to
687 * close the window comes, the main loop will be left.
689 * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
690 * applications, you'll be able to get this function called automatically for you.
694 EAPI void elm_exit(void);
697 * Provide information in order to make Elementary determine the @b
698 * run time location of the software in question, so other data files
699 * such as images, sound files, executable utilities, libraries,
700 * modules and locale files can be found.
702 * @param mainfunc This is your application's main function name,
703 * whose binary's location is to be found. Providing @c NULL
704 * will make Elementary not to use it
705 * @param dom This will be used as the application's "domain", in the
706 * form of a prefix to any environment variables that may
707 * override prefix detection and the directory name, inside the
708 * standard share or data directories, where the software's
709 * data files will be looked for.
710 * @param checkfile This is an (optional) magic file's path to check
711 * for existence (and it must be located in the data directory,
712 * under the share directory provided above). Its presence will
713 * help determine the prefix found was correct. Pass @c NULL if
714 * the check is not to be done.
716 * This function allows one to re-locate the application somewhere
717 * else after compilation, if the developer wishes for easier
718 * distribution of pre-compiled binaries.
720 * The prefix system is designed to locate where the given software is
721 * installed (under a common path prefix) at run time and then report
722 * specific locations of this prefix and common directories inside
723 * this prefix like the binary, library, data and locale directories,
724 * through the @c elm_app_*_get() family of functions.
726 * Call elm_app_info_set() early on before you change working
727 * directory or anything about @c argv[0], so it gets accurate
730 * It will then try and trace back which file @p mainfunc comes from,
731 * if provided, to determine the application's prefix directory.
733 * The @p dom parameter provides a string prefix to prepend before
734 * environment variables, allowing a fallback to @b specific
735 * environment variables to locate the software. You would most
736 * probably provide a lowercase string there, because it will also
737 * serve as directory domain, explained next. For environment
738 * variables purposes, this string is made uppercase. For example if
739 * @c "myapp" is provided as the prefix, then the program would expect
740 * @c "MYAPP_PREFIX" as a master environment variable to specify the
741 * exact install prefix for the software, or more specific environment
742 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
743 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
744 * the user or scripts before launching. If not provided (@c NULL),
745 * environment variables will not be used to override compiled-in
746 * defaults or auto detections.
748 * The @p dom string also provides a subdirectory inside the system
749 * shared data directory for data files. For example, if the system
750 * directory is @c /usr/local/share, then this directory name is
751 * appended, creating @c /usr/local/share/myapp, if it @p was @c
752 * "myapp". It is expected that the application installs data files in
755 * The @p checkfile is a file name or path of something inside the
756 * share or data directory to be used to test that the prefix
757 * detection worked. For example, your app will install a wallpaper
758 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
759 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
762 * @see elm_app_compile_bin_dir_set()
763 * @see elm_app_compile_lib_dir_set()
764 * @see elm_app_compile_data_dir_set()
765 * @see elm_app_compile_locale_set()
766 * @see elm_app_prefix_dir_get()
767 * @see elm_app_bin_dir_get()
768 * @see elm_app_lib_dir_get()
769 * @see elm_app_data_dir_get()
770 * @see elm_app_locale_dir_get()
772 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
775 * Provide information on the @b fallback application's binaries
776 * directory, in scenarios where they get overriden by
777 * elm_app_info_set().
779 * @param dir The path to the default binaries directory (compile time
782 * @note Elementary will as well use this path to determine actual
783 * names of binaries' directory paths, maybe changing it to be @c
784 * something/local/bin instead of @c something/bin, only, for
787 * @warning You should call this function @b before
788 * elm_app_info_set().
790 EAPI void elm_app_compile_bin_dir_set(const char *dir);
793 * Provide information on the @b fallback application's libraries
794 * directory, on scenarios where they get overriden by
795 * elm_app_info_set().
797 * @param dir The path to the default libraries directory (compile
800 * @note Elementary will as well use this path to determine actual
801 * names of libraries' directory paths, maybe changing it to be @c
802 * something/lib32 or @c something/lib64 instead of @c something/lib,
805 * @warning You should call this function @b before
806 * elm_app_info_set().
808 EAPI void elm_app_compile_lib_dir_set(const char *dir);
811 * Provide information on the @b fallback application's data
812 * directory, on scenarios where they get overriden by
813 * elm_app_info_set().
815 * @param dir The path to the default data directory (compile time
818 * @note Elementary will as well use this path to determine actual
819 * names of data directory paths, maybe changing it to be @c
820 * something/local/share instead of @c something/share, only, for
823 * @warning You should call this function @b before
824 * elm_app_info_set().
826 EAPI void elm_app_compile_data_dir_set(const char *dir);
829 * Provide information on the @b fallback application's locale
830 * directory, on scenarios where they get overriden by
831 * elm_app_info_set().
833 * @param dir The path to the default locale directory (compile time
836 * @warning You should call this function @b before
837 * elm_app_info_set().
839 EAPI void elm_app_compile_locale_set(const char *dir);
842 * Retrieve the application's run time prefix directory, as set by
843 * elm_app_info_set() and the way (environment) the application was
846 * @return The directory prefix the application is actually using.
848 EAPI const char *elm_app_prefix_dir_get(void);
851 * Retrieve the application's run time binaries prefix directory, as
852 * set by elm_app_info_set() and the way (environment) the application
855 * @return The binaries directory prefix the application is actually
858 EAPI const char *elm_app_bin_dir_get(void);
861 * Retrieve the application's run time libraries prefix directory, as
862 * set by elm_app_info_set() and the way (environment) the application
865 * @return The libraries directory prefix the application is actually
868 EAPI const char *elm_app_lib_dir_get(void);
871 * Retrieve the application's run time data prefix directory, as
872 * set by elm_app_info_set() and the way (environment) the application
875 * @return The data directory prefix the application is actually
878 EAPI const char *elm_app_data_dir_get(void);
881 * Retrieve the application's run time locale prefix directory, as
882 * set by elm_app_info_set() and the way (environment) the application
885 * @return The locale directory prefix the application is actually
888 EAPI const char *elm_app_locale_dir_get(void);
890 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
891 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
892 EAPI int elm_quicklaunch_init(int argc, char **argv);
893 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
894 EAPI int elm_quicklaunch_sub_shutdown(void);
895 EAPI int elm_quicklaunch_shutdown(void);
896 EAPI void elm_quicklaunch_seed(void);
897 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
898 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
899 EAPI void elm_quicklaunch_cleanup(void);
900 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
901 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
903 EAPI Eina_Bool elm_need_efreet(void);
904 EAPI Eina_Bool elm_need_e_dbus(void);
907 * This must be called before any other function that deals with
908 * elm_thumb objects or ethumb_client instances.
912 EAPI Eina_Bool elm_need_ethumb(void);
915 * This must be called before any other function that deals with
916 * elm_web objects or ewk_view instances.
920 EAPI Eina_Bool elm_need_web(void);
923 * Set a new policy's value (for a given policy group/identifier).
925 * @param policy policy identifier, as in @ref Elm_Policy.
926 * @param value policy value, which depends on the identifier
928 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
930 * Elementary policies define applications' behavior,
931 * somehow. These behaviors are divided in policy groups (see
932 * #Elm_Policy enumeration). This call will emit the Ecore event
933 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
934 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
937 * @note Currently, we have only one policy identifier/group
938 * (#ELM_POLICY_QUIT), which has two possible values.
942 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
945 * Gets the policy value for given policy identifier.
947 * @param policy policy identifier, as in #Elm_Policy.
948 * @return The currently set policy value, for that
949 * identifier. Will be @c 0 if @p policy passed is invalid.
953 EAPI int elm_policy_get(unsigned int policy);
956 * Change the language of the current application
958 * The @p lang passed must be the full name of the locale to use, for
959 * example "en_US.utf8" or "es_ES@euro".
961 * Changing language with this function will make Elementary run through
962 * all its widgets, translating strings set with
963 * elm_object_domain_translatable_text_part_set(). This way, an entire
964 * UI can have its language changed without having to restart the program.
966 * For more complex cases, like having formatted strings that need
967 * translation, widgets will also emit a "language,changed" signal that
968 * the user can listen to to manually translate the text.
970 * @param lang Language to set, must be the full name of the locale
974 EAPI void elm_language_set(const char *lang);
977 * Set a label of an object
979 * @param obj The Elementary object
980 * @param part The text part name to set (NULL for the default label)
981 * @param label The new text of the label
983 * @note Elementary objects may have many labels (e.g. Action Slider)
987 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
989 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
992 * Get a label of an object
994 * @param obj The Elementary object
995 * @param part The text part name to get (NULL for the default label)
996 * @return text of the label or NULL for any error
998 * @note Elementary objects may have many labels (e.g. Action Slider)
1002 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1004 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
1007 * Set the text for an objects' part, marking it as translatable.
1009 * The string to set as @p text must be the original one. Do not pass the
1010 * return of @c gettext() here. Elementary will translate the string
1011 * internally and set it on the object using elm_object_text_part_set(),
1012 * also storing the original string so that it can be automatically
1013 * translated when the language is changed with elm_language_set().
1015 * The @p domain will be stored along to find the translation in the
1016 * correct catalog. It can be NULL, in which case it will use whatever
1017 * domain was set by the application with @c textdomain(). This is useful
1018 * in case you are building a library on top of Elementary that will have
1019 * its own translatable strings, that should not be mixed with those of
1020 * programs using the library.
1022 * @param obj The object containing the text part
1023 * @param part The name of the part to set
1024 * @param domain The translation domain to use
1025 * @param text The original, non-translated text to set
1029 EAPI void elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1031 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1033 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1036 * Gets the original string set as translatable for an object
1038 * When setting translated strings, the function elm_object_text_part_get()
1039 * will return the translation returned by @c gettext(). To get the
1040 * original string use this function.
1042 * @param obj The object
1043 * @param part The name of the part that was set
1045 * @return The original, untranslated string
1049 EAPI const char *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1051 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1054 * Set a content of an object
1056 * @param obj The Elementary object
1057 * @param part The content part name to set (NULL for the default content)
1058 * @param content The new content of the object
1060 * @note Elementary objects may have many contents
1064 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1066 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
1069 * Get a content of an object
1071 * @param obj The Elementary object
1072 * @param item The content part name to get (NULL for the default content)
1073 * @return content of the object or NULL for any error
1075 * @note Elementary objects may have many contents
1079 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1081 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
1084 * Unset a content of an object
1086 * @param obj The Elementary object
1087 * @param item The content part name to unset (NULL for the default content)
1089 * @note Elementary objects may have many contents
1093 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1095 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1098 * Get the widget object's handle which contains a given item
1100 * @param item The Elementary object item
1101 * @return The widget object
1103 * @note This returns the widget object itself that an item belongs to.
1107 EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1110 * Set a content of an object item
1112 * @param it The Elementary object item
1113 * @param part The content part name to set (NULL for the default content)
1114 * @param content The new content of the object item
1116 * @note Elementary object items may have many contents
1120 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1122 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1125 * Get a content of an object item
1127 * @param it The Elementary object item
1128 * @param part The content part name to unset (NULL for the default content)
1129 * @return content of the object item or NULL for any error
1131 * @note Elementary object items may have many contents
1135 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1137 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1140 * Unset a content of an object item
1142 * @param it The Elementary object item
1143 * @param part The content part name to unset (NULL for the default content)
1145 * @note Elementary object items may have many contents
1149 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1151 #define elm_object_item_content_unset(it) elm_object_item_content_part_unset((it), NULL)
1154 * Set a label of an object item
1156 * @param it The Elementary object item
1157 * @param part The text part name to set (NULL for the default label)
1158 * @param label The new text of the label
1160 * @note Elementary object items may have many labels
1164 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1166 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1169 * Get a label of an object item
1171 * @param it The Elementary object item
1172 * @param part The text part name to get (NULL for the default label)
1173 * @return text of the label or NULL for any error
1175 * @note Elementary object items may have many labels
1179 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1181 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1184 * Set the text to read out when in accessibility mode
1186 * @param obj The object which is to be described
1187 * @param txt The text that describes the widget to people with poor or no vision
1191 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1194 * Set the text to read out when in accessibility mode
1196 * @param it The object item which is to be described
1197 * @param txt The text that describes the widget to people with poor or no vision
1201 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1204 * Get the data associated with an object item
1205 * @param it The object item
1206 * @return The data associated with @p it
1210 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1213 * Set the data associated with an object item
1214 * @param it The object item
1215 * @param data The data to be associated with @p it
1219 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1222 * Send a signal to the edje object of the widget item.
1224 * This function sends a signal to the edje object of the obj item. An
1225 * edje program can respond to a signal by specifying matching
1226 * 'signal' and 'source' fields.
1228 * @param it The Elementary object item
1229 * @param emission The signal's name.
1230 * @param source The signal's source.
1233 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1240 * @defgroup Caches Caches
1242 * These are functions which let one fine-tune some cache values for
1243 * Elementary applications, thus allowing for performance adjustments.
1249 * @brief Flush all caches.
1251 * Frees all data that was in cache and is not currently being used to reduce
1252 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1253 * to calling all of the following functions:
1254 * @li edje_file_cache_flush()
1255 * @li edje_collection_cache_flush()
1256 * @li eet_clearcache()
1257 * @li evas_image_cache_flush()
1258 * @li evas_font_cache_flush()
1259 * @li evas_render_dump()
1260 * @note Evas caches are flushed for every canvas associated with a window.
1264 EAPI void elm_all_flush(void);
1267 * Get the configured cache flush interval time
1269 * This gets the globally configured cache flush interval time, in
1272 * @return The cache flush interval time
1275 * @see elm_all_flush()
1277 EAPI int elm_cache_flush_interval_get(void);
1280 * Set the configured cache flush interval time
1282 * This sets the globally configured cache flush interval time, in ticks
1284 * @param size The cache flush interval time
1287 * @see elm_all_flush()
1289 EAPI void elm_cache_flush_interval_set(int size);
1292 * Set the configured cache flush interval time for all applications on the
1295 * This sets the globally configured cache flush interval time -- in ticks
1296 * -- for all applications on the display.
1298 * @param size The cache flush interval time
1301 EAPI void elm_cache_flush_interval_all_set(int size);
1304 * Get the configured cache flush enabled state
1306 * This gets the globally configured cache flush state - if it is enabled
1307 * or not. When cache flushing is enabled, elementary will regularly
1308 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1309 * memory and allow usage to re-seed caches and data in memory where it
1310 * can do so. An idle application will thus minimise its memory usage as
1311 * data will be freed from memory and not be re-loaded as it is idle and
1312 * not rendering or doing anything graphically right now.
1314 * @return The cache flush state
1317 * @see elm_all_flush()
1319 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1322 * Set the configured cache flush enabled state
1324 * This sets the globally configured cache flush enabled state.
1326 * @param size The cache flush enabled state
1329 * @see elm_all_flush()
1331 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1334 * Set the configured cache flush enabled state for all applications on the
1337 * This sets the globally configured cache flush enabled state for all
1338 * applications on the display.
1340 * @param size The cache flush enabled state
1343 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1346 * Get the configured font cache size
1348 * This gets the globally configured font cache size, in bytes.
1350 * @return The font cache size
1353 EAPI int elm_font_cache_get(void);
1356 * Set the configured font cache size
1358 * This sets the globally configured font cache size, in bytes
1360 * @param size The font cache size
1363 EAPI void elm_font_cache_set(int size);
1366 * Set the configured font cache size for all applications on the
1369 * This sets the globally configured font cache size -- in bytes
1370 * -- for all applications on the display.
1372 * @param size The font cache size
1375 EAPI void elm_font_cache_all_set(int size);
1378 * Get the configured image cache size
1380 * This gets the globally configured image cache size, in bytes
1382 * @return The image cache size
1385 EAPI int elm_image_cache_get(void);
1388 * Set the configured image cache size
1390 * This sets the globally configured image cache size, in bytes
1392 * @param size The image cache size
1395 EAPI void elm_image_cache_set(int size);
1398 * Set the configured image cache size for all applications on the
1401 * This sets the globally configured image cache size -- in bytes
1402 * -- for all applications on the display.
1404 * @param size The image cache size
1407 EAPI void elm_image_cache_all_set(int size);
1410 * Get the configured edje file cache size.
1412 * This gets the globally configured edje file cache size, in number
1415 * @return The edje file cache size
1418 EAPI int elm_edje_file_cache_get(void);
1421 * Set the configured edje file cache size
1423 * This sets the globally configured edje file cache size, in number
1426 * @param size The edje file cache size
1429 EAPI void elm_edje_file_cache_set(int size);
1432 * Set the configured edje file cache size for all applications on the
1435 * This sets the globally configured edje file cache size -- in number
1436 * of files -- for all applications on the display.
1438 * @param size The edje file cache size
1441 EAPI void elm_edje_file_cache_all_set(int size);
1444 * Get the configured edje collections (groups) cache size.
1446 * This gets the globally configured edje collections cache size, in
1447 * number of collections.
1449 * @return The edje collections cache size
1452 EAPI int elm_edje_collection_cache_get(void);
1455 * Set the configured edje collections (groups) cache size
1457 * This sets the globally configured edje collections cache size, in
1458 * number of collections.
1460 * @param size The edje collections cache size
1463 EAPI void elm_edje_collection_cache_set(int size);
1466 * Set the configured edje collections (groups) cache size for all
1467 * applications on the display
1469 * This sets the globally configured edje collections cache size -- in
1470 * number of collections -- for all applications on the display.
1472 * @param size The edje collections cache size
1475 EAPI void elm_edje_collection_cache_all_set(int size);
1482 * @defgroup Scaling Widget Scaling
1484 * Different widgets can be scaled independently. These functions
1485 * allow you to manipulate this scaling on a per-widget basis. The
1486 * object and all its children get their scaling factors multiplied
1487 * by the scale factor set. This is multiplicative, in that if a
1488 * child also has a scale size set it is in turn multiplied by its
1489 * parent's scale size. @c 1.0 means ādon't scaleā, @c 2.0 is
1490 * double size, @c 0.5 is half, etc.
1492 * @ref general_functions_example_page "This" example contemplates
1493 * some of these functions.
1497 * Get the global scaling factor
1499 * This gets the globally configured scaling factor that is applied to all
1502 * @return The scaling factor
1505 EAPI double elm_scale_get(void);
1508 * Set the global scaling factor
1510 * This sets the globally configured scaling factor that is applied to all
1513 * @param scale The scaling factor to set
1516 EAPI void elm_scale_set(double scale);
1519 * Set the global scaling factor for all applications on the display
1521 * This sets the globally configured scaling factor that is applied to all
1522 * objects for all applications.
1523 * @param scale The scaling factor to set
1526 EAPI void elm_scale_all_set(double scale);
1529 * Set the scaling factor for a given Elementary object
1531 * @param obj The Elementary to operate on
1532 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1537 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1540 * Get the scaling factor for a given Elementary object
1542 * @param obj The object
1543 * @return The scaling factor set by elm_object_scale_set()
1547 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1550 * @defgroup Password_last_show Password last input show
1552 * Last show feature of password mode enables user to view
1553 * the last input entered for few seconds before masking it.
1554 * These functions allow to set this feature in password mode
1555 * of entry widget and also allow to manipulate the duration
1556 * for which the input has to be visible.
1562 * Get show last setting of password mode.
1564 * This gets the show last input setting of password mode which might be
1565 * enabled or disabled.
1567 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1569 * @ingroup Password_last_show
1571 EAPI Eina_Bool elm_password_show_last_get(void);
1574 * Set show last setting in password mode.
1576 * This enables or disables show last setting of password mode.
1578 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1579 * @see elm_password_show_last_timeout_set()
1580 * @ingroup Password_last_show
1582 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1585 * Get's the timeout value in last show password mode.
1587 * This gets the time out value for which the last input entered in password
1588 * mode will be visible.
1590 * @return The timeout value of last show password mode.
1591 * @ingroup Password_last_show
1593 EAPI double elm_password_show_last_timeout_get(void);
1596 * Set's the timeout value in last show password mode.
1598 * This sets the time out value for which the last input entered in password
1599 * mode will be visible.
1601 * @param password_show_last_timeout The timeout value.
1602 * @see elm_password_show_last_set()
1603 * @ingroup Password_last_show
1605 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1612 * @defgroup UI-Mirroring Selective Widget mirroring
1614 * These functions allow you to set ui-mirroring on specific
1615 * widgets or the whole interface. Widgets can be in one of two
1616 * modes, automatic and manual. Automatic means they'll be changed
1617 * according to the system mirroring mode and manual means only
1618 * explicit changes will matter. You are not supposed to change
1619 * mirroring state of a widget set to automatic, will mostly work,
1620 * but the behavior is not really defined.
1625 EAPI Eina_Bool elm_mirrored_get(void);
1626 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1629 * Get the system mirrored mode. This determines the default mirrored mode
1632 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1634 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1637 * Set the system mirrored mode. This determines the default mirrored mode
1640 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1642 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1645 * Returns the widget's mirrored mode setting.
1647 * @param obj The widget.
1648 * @return mirrored mode setting of the object.
1651 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1654 * Sets the widget's mirrored mode setting.
1655 * When widget in automatic mode, it follows the system mirrored mode set by
1656 * elm_mirrored_set().
1657 * @param obj The widget.
1658 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1660 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1667 * Set the style to use by a widget
1669 * Sets the style name that will define the appearance of a widget. Styles
1670 * vary from widget to widget and may also be defined by other themes
1671 * by means of extensions and overlays.
1673 * @param obj The Elementary widget to style
1674 * @param style The style name to use
1676 * @see elm_theme_extension_add()
1677 * @see elm_theme_extension_del()
1678 * @see elm_theme_overlay_add()
1679 * @see elm_theme_overlay_del()
1683 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1685 * Get the style used by the widget
1687 * This gets the style being used for that widget. Note that the string
1688 * pointer is only valid as longas the object is valid and the style doesn't
1691 * @param obj The Elementary widget to query for its style
1692 * @return The style name used
1694 * @see elm_object_style_set()
1698 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1701 * @defgroup Styles Styles
1703 * Widgets can have different styles of look. These generic API's
1704 * set styles of widgets, if they support them (and if the theme(s)
1707 * @ref general_functions_example_page "This" example contemplates
1708 * some of these functions.
1712 * Set the disabled state of an Elementary object.
1714 * @param obj The Elementary object to operate on
1715 * @param disabled The state to put in in: @c EINA_TRUE for
1716 * disabled, @c EINA_FALSE for enabled
1718 * Elementary objects can be @b disabled, in which state they won't
1719 * receive input and, in general, will be themed differently from
1720 * their normal state, usually greyed out. Useful for contexts
1721 * where you don't want your users to interact with some of the
1722 * parts of you interface.
1724 * This sets the state for the widget, either disabling it or
1729 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1732 * Get the disabled state of an Elementary object.
1734 * @param obj The Elementary object to operate on
1735 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1736 * if it's enabled (or on errors)
1738 * This gets the state of the widget, which might be enabled or disabled.
1742 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1745 * @defgroup WidgetNavigation Widget Tree Navigation.
1747 * How to check if an Evas Object is an Elementary widget? How to
1748 * get the first elementary widget that is parent of the given
1749 * object? These are all covered in widget tree navigation.
1751 * @ref general_functions_example_page "This" example contemplates
1752 * some of these functions.
1756 * Check if the given Evas Object is an Elementary widget.
1758 * @param obj the object to query.
1759 * @return @c EINA_TRUE if it is an elementary widget variant,
1760 * @c EINA_FALSE otherwise
1761 * @ingroup WidgetNavigation
1763 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1766 * Get the first parent of the given object that is an Elementary
1769 * @param obj the Elementary object to query parent from.
1770 * @return the parent object that is an Elementary widget, or @c
1771 * NULL, if it was not found.
1773 * Use this to query for an object's parent widget.
1775 * @note Most of Elementary users wouldn't be mixing non-Elementary
1776 * smart objects in the objects tree of an application, as this is
1777 * an advanced usage of Elementary with Evas. So, except for the
1778 * application's window, which is the root of that tree, all other
1779 * objects would have valid Elementary widget parents.
1781 * @ingroup WidgetNavigation
1783 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1786 * Get the top level parent of an Elementary widget.
1788 * @param obj The object to query.
1789 * @return The top level Elementary widget, or @c NULL if parent cannot be
1791 * @ingroup WidgetNavigation
1793 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1796 * Get the string that represents this Elementary widget.
1798 * @note Elementary is weird and exposes itself as a single
1799 * Evas_Object_Smart_Class of type "elm_widget", so
1800 * evas_object_type_get() always return that, making debug and
1801 * language bindings hard. This function tries to mitigate this
1802 * problem, but the solution is to change Elementary to use
1803 * proper inheritance.
1805 * @param obj the object to query.
1806 * @return Elementary widget name, or @c NULL if not a valid widget.
1807 * @ingroup WidgetNavigation
1809 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1812 * @defgroup Config Elementary Config
1814 * Elementary configuration is formed by a set options bounded to a
1815 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1816 * "finger size", etc. These are functions with which one syncronizes
1817 * changes made to those values to the configuration storing files, de
1818 * facto. You most probably don't want to use the functions in this
1819 * group unlees you're writing an elementary configuration manager.
1825 * Save back Elementary's configuration, so that it will persist on
1828 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1831 * This function will take effect -- thus, do I/O -- immediately. Use
1832 * it when you want to apply all configuration changes at once. The
1833 * current configuration set will get saved onto the current profile
1834 * configuration file.
1837 EAPI Eina_Bool elm_config_save(void);
1840 * Reload Elementary's configuration, bounded to current selected
1843 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1846 * Useful when you want to force reloading of configuration values for
1847 * a profile. If one removes user custom configuration directories,
1848 * for example, it will force a reload with system values insted.
1851 EAPI void elm_config_reload(void);
1858 * @defgroup Profile Elementary Profile
1860 * Profiles are pre-set options that affect the whole look-and-feel of
1861 * Elementary-based applications. There are, for example, profiles
1862 * aimed at desktop computer applications and others aimed at mobile,
1863 * touchscreen-based ones. You most probably don't want to use the
1864 * functions in this group unlees you're writing an elementary
1865 * configuration manager.
1871 * Get Elementary's profile in use.
1873 * This gets the global profile that is applied to all Elementary
1876 * @return The profile's name
1879 EAPI const char *elm_profile_current_get(void);
1882 * Get an Elementary's profile directory path in the filesystem. One
1883 * may want to fetch a system profile's dir or an user one (fetched
1886 * @param profile The profile's name
1887 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1888 * or a system one (@c EINA_FALSE)
1889 * @return The profile's directory path.
1892 * @note You must free it with elm_profile_dir_free().
1894 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1897 * Free an Elementary's profile directory path, as returned by
1898 * elm_profile_dir_get().
1900 * @param p_dir The profile's path
1904 EAPI void elm_profile_dir_free(const char *p_dir);
1907 * Get Elementary's list of available profiles.
1909 * @return The profiles list. List node data are the profile name
1913 * @note One must free this list, after usage, with the function
1914 * elm_profile_list_free().
1916 EAPI Eina_List *elm_profile_list_get(void);
1919 * Free Elementary's list of available profiles.
1921 * @param l The profiles list, as returned by elm_profile_list_get().
1925 EAPI void elm_profile_list_free(Eina_List *l);
1928 * Set Elementary's profile.
1930 * This sets the global profile that is applied to Elementary
1931 * applications. Just the process the call comes from will be
1934 * @param profile The profile's name
1938 EAPI void elm_profile_set(const char *profile);
1941 * Set Elementary's profile.
1943 * This sets the global profile that is applied to all Elementary
1944 * applications. All running Elementary windows will be affected.
1946 * @param profile The profile's name
1950 EAPI void elm_profile_all_set(const char *profile);
1957 * @defgroup Engine Elementary Engine
1959 * These are functions setting and querying which rendering engine
1960 * Elementary will use for drawing its windows' pixels.
1962 * The following are the available engines:
1963 * @li "software_x11"
1966 * @li "software_16_x11"
1967 * @li "software_8_x11"
1970 * @li "software_gdi"
1971 * @li "software_16_wince_gdi"
1973 * @li "software_16_sdl"
1982 * @brief Get Elementary's rendering engine in use.
1984 * @return The rendering engine's name
1985 * @note there's no need to free the returned string, here.
1987 * This gets the global rendering engine that is applied to all Elementary
1990 * @see elm_engine_set()
1992 EAPI const char *elm_engine_current_get(void);
1995 * @brief Set Elementary's rendering engine for use.
1997 * @param engine The rendering engine's name
1999 * This sets global rendering engine that is applied to all Elementary
2000 * applications. Note that it will take effect only to Elementary windows
2001 * created after this is called.
2003 * @see elm_win_add()
2005 EAPI void elm_engine_set(const char *engine);
2012 * @defgroup Fonts Elementary Fonts
2014 * These are functions dealing with font rendering, selection and the
2015 * like for Elementary applications. One might fetch which system
2016 * fonts are there to use and set custom fonts for individual classes
2017 * of UI items containing text (text classes).
2022 typedef struct _Elm_Text_Class
2028 typedef struct _Elm_Font_Overlay
2030 const char *text_class;
2032 Evas_Font_Size size;
2035 typedef struct _Elm_Font_Properties
2039 } Elm_Font_Properties;
2042 * Get Elementary's list of supported text classes.
2044 * @return The text classes list, with @c Elm_Text_Class blobs as data.
2047 * Release the list with elm_text_classes_list_free().
2049 EAPI const Eina_List *elm_text_classes_list_get(void);
2052 * Free Elementary's list of supported text classes.
2056 * @see elm_text_classes_list_get().
2058 EAPI void elm_text_classes_list_free(const Eina_List *list);
2061 * Get Elementary's list of font overlays, set with
2062 * elm_font_overlay_set().
2064 * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2069 * For each text class, one can set a <b>font overlay</b> for it,
2070 * overriding the default font properties for that class coming from
2071 * the theme in use. There is no need to free this list.
2073 * @see elm_font_overlay_set() and elm_font_overlay_unset().
2075 EAPI const Eina_List *elm_font_overlay_list_get(void);
2078 * Set a font overlay for a given Elementary text class.
2080 * @param text_class Text class name
2081 * @param font Font name and style string
2082 * @param size Font size
2086 * @p font has to be in the format returned by
2087 * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2088 * and elm_font_overlay_unset().
2090 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2093 * Unset a font overlay for a given Elementary text class.
2095 * @param text_class Text class name
2099 * This will bring back text elements belonging to text class
2100 * @p text_class back to their default font settings.
2102 EAPI void elm_font_overlay_unset(const char *text_class);
2105 * Apply the changes made with elm_font_overlay_set() and
2106 * elm_font_overlay_unset() on the current Elementary window.
2110 * This applies all font overlays set to all objects in the UI.
2112 EAPI void elm_font_overlay_apply(void);
2115 * Apply the changes made with elm_font_overlay_set() and
2116 * elm_font_overlay_unset() on all Elementary application windows.
2120 * This applies all font overlays set to all objects in the UI.
2122 EAPI void elm_font_overlay_all_apply(void);
2125 * Translate a font (family) name string in fontconfig's font names
2126 * syntax into an @c Elm_Font_Properties struct.
2128 * @param font The font name and styles string
2129 * @return the font properties struct
2133 * @note The reverse translation can be achived with
2134 * elm_font_fontconfig_name_get(), for one style only (single font
2135 * instance, not family).
2137 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2140 * Free font properties return by elm_font_properties_get().
2142 * @param efp the font properties struct
2146 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2149 * Translate a font name, bound to a style, into fontconfig's font names
2152 * @param name The font (family) name
2153 * @param style The given style (may be @c NULL)
2155 * @return the font name and style string
2159 * @note The reverse translation can be achived with
2160 * elm_font_properties_get(), for one style only (single font
2161 * instance, not family).
2163 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2166 * Free the font string return by elm_font_fontconfig_name_get().
2168 * @param efp the font properties struct
2172 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2175 * Create a font hash table of available system fonts.
2177 * One must call it with @p list being the return value of
2178 * evas_font_available_list(). The hash will be indexed by font
2179 * (family) names, being its values @c Elm_Font_Properties blobs.
2181 * @param list The list of available system fonts, as returned by
2182 * evas_font_available_list().
2183 * @return the font hash.
2187 * @note The user is supposed to get it populated at least with 3
2188 * default font families (Sans, Serif, Monospace), which should be
2189 * present on most systems.
2191 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
2194 * Free the hash return by elm_font_available_hash_add().
2196 * @param hash the hash to be freed.
2200 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
2207 * @defgroup Fingers Fingers
2209 * Elementary is designed to be finger-friendly for touchscreens,
2210 * and so in addition to scaling for display resolution, it can
2211 * also scale based on finger "resolution" (or size). You can then
2212 * customize the granularity of the areas meant to receive clicks
2215 * Different profiles may have pre-set values for finger sizes.
2217 * @ref general_functions_example_page "This" example contemplates
2218 * some of these functions.
2224 * Get the configured "finger size"
2226 * @return The finger size
2228 * This gets the globally configured finger size, <b>in pixels</b>
2232 EAPI Evas_Coord elm_finger_size_get(void);
2235 * Set the configured finger size
2237 * This sets the globally configured finger size in pixels
2239 * @param size The finger size
2242 EAPI void elm_finger_size_set(Evas_Coord size);
2245 * Set the configured finger size for all applications on the display
2247 * This sets the globally configured finger size in pixels for all
2248 * applications on the display
2250 * @param size The finger size
2253 EAPI void elm_finger_size_all_set(Evas_Coord size);
2260 * @defgroup Focus Focus
2262 * An Elementary application has, at all times, one (and only one)
2263 * @b focused object. This is what determines where the input
2264 * events go to within the application's window. Also, focused
2265 * objects can be decorated differently, in order to signal to the
2266 * user where the input is, at a given moment.
2268 * Elementary applications also have the concept of <b>focus
2269 * chain</b>: one can cycle through all the windows' focusable
2270 * objects by input (tab key) or programmatically. The default
2271 * focus chain for an application is the one define by the order in
2272 * which the widgets where added in code. One will cycle through
2273 * top level widgets, and, for each one containg sub-objects, cycle
2274 * through them all, before returning to the level
2275 * above. Elementary also allows one to set @b custom focus chains
2276 * for their applications.
2278 * Besides the focused decoration a widget may exhibit, when it
2279 * gets focus, Elementary has a @b global focus highlight object
2280 * that can be enabled for a window. If one chooses to do so, this
2281 * extra highlight effect will surround the current focused object,
2284 * @note Some Elementary widgets are @b unfocusable, after
2285 * creation, by their very nature: they are not meant to be
2286 * interacted with input events, but are there just for visual
2289 * @ref general_functions_example_page "This" example contemplates
2290 * some of these functions.
2294 * Get the enable status of the focus highlight
2296 * This gets whether the highlight on focused objects is enabled or not
2299 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
2302 * Set the enable status of the focus highlight
2304 * Set whether to show or not the highlight on focused objects
2305 * @param enable Enable highlight if EINA_TRUE, disable otherwise
2308 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
2311 * Get the enable status of the highlight animation
2313 * Get whether the focus highlight, if enabled, will animate its switch from
2314 * one object to the next
2317 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
2320 * Set the enable status of the highlight animation
2322 * Set whether the focus highlight, if enabled, will animate its switch from
2323 * one object to the next
2324 * @param animate Enable animation if EINA_TRUE, disable otherwise
2327 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
2330 * Get the whether an Elementary object has the focus or not.
2332 * @param obj The Elementary object to get the information from
2333 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2334 * not (and on errors).
2336 * @see elm_object_focus_set()
2340 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2343 * Set/unset focus to a given Elementary object.
2345 * @param obj The Elementary object to operate on.
2346 * @param enable @c EINA_TRUE Set focus to a given object,
2347 * @c EINA_FALSE Unset focus to a given object.
2349 * @note When you set focus to this object, if it can handle focus, will
2350 * take the focus away from the one who had it previously and will, for
2351 * now on, be the one receiving input events. Unsetting focus will remove
2352 * the focus from @p obj, passing it back to the previous element in the
2355 * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2359 EAPI void elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2362 * Make a given Elementary object the focused one.
2364 * @param obj The Elementary object to make focused.
2366 * @note This object, if it can handle focus, will take the focus
2367 * away from the one who had it previously and will, for now on, be
2368 * the one receiving input events.
2370 * @see elm_object_focus_get()
2371 * @deprecated use elm_object_focus_set() instead.
2375 EINA_DEPRECATED EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2378 * Remove the focus from an Elementary object
2380 * @param obj The Elementary to take focus from
2382 * This removes the focus from @p obj, passing it back to the
2383 * previous element in the focus chain list.
2385 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2386 * @deprecated use elm_object_focus_set() instead.
2390 EINA_DEPRECATED EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2393 * Set the ability for an Element object to be focused
2395 * @param obj The Elementary object to operate on
2396 * @param enable @c EINA_TRUE if the object can be focused, @c
2397 * EINA_FALSE if not (and on errors)
2399 * This sets whether the object @p obj is able to take focus or
2400 * not. Unfocusable objects do nothing when programmatically
2401 * focused, being the nearest focusable parent object the one
2402 * really getting focus. Also, when they receive mouse input, they
2403 * will get the event, but not take away the focus from where it
2408 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2411 * Get whether an Elementary object is focusable or not
2413 * @param obj The Elementary object to operate on
2414 * @return @c EINA_TRUE if the object is allowed to be focused, @c
2415 * EINA_FALSE if not (and on errors)
2417 * @note Objects which are meant to be interacted with by input
2418 * events are created able to be focused, by default. All the
2423 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2426 * Set custom focus chain.
2428 * This function overwrites any previous custom focus chain within
2429 * the list of objects. The previous list will be deleted and this list
2430 * will be managed by elementary. After it is set, don't modify it.
2432 * @note On focus cycle, only will be evaluated children of this container.
2434 * @param obj The container object
2435 * @param objs Chain of objects to pass focus
2438 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2441 * Unset a custom focus chain on a given Elementary widget
2443 * @param obj The container object to remove focus chain from
2445 * Any focus chain previously set on @p obj (for its child objects)
2446 * is removed entirely after this call.
2450 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2453 * Get custom focus chain
2455 * @param obj The container object
2458 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2461 * Append object to custom focus chain.
2463 * @note If relative_child equal to NULL or not in custom chain, the object
2464 * will be added in end.
2466 * @note On focus cycle, only will be evaluated children of this container.
2468 * @param obj The container object
2469 * @param child The child to be added in custom chain
2470 * @param relative_child The relative object to position the child
2473 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2476 * Prepend object to custom focus chain.
2478 * @note If relative_child equal to NULL or not in custom chain, the object
2479 * will be added in begin.
2481 * @note On focus cycle, only will be evaluated children of this container.
2483 * @param obj The container object
2484 * @param child The child to be added in custom chain
2485 * @param relative_child The relative object to position the child
2488 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2491 * Give focus to next object in object tree.
2493 * Give focus to next object in focus chain of one object sub-tree.
2494 * If the last object of chain already have focus, the focus will go to the
2495 * first object of chain.
2497 * @param obj The object root of sub-tree
2498 * @param dir Direction to cycle the focus
2502 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2505 * Give focus to near object in one direction.
2507 * Give focus to near object in direction of one object.
2508 * If none focusable object in given direction, the focus will not change.
2510 * @param obj The reference object
2511 * @param x Horizontal component of direction to focus
2512 * @param y Vertical component of direction to focus
2516 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2519 * Make the elementary object and its children to be unfocusable
2522 * @param obj The Elementary object to operate on
2523 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2524 * @c EINA_FALSE for focusable.
2526 * This sets whether the object @p obj and its children objects
2527 * are able to take focus or not. If the tree is set as unfocusable,
2528 * newest focused object which is not in this tree will get focus.
2529 * This API can be helpful for an object to be deleted.
2530 * When an object will be deleted soon, it and its children may not
2531 * want to get focus (by focus reverting or by other focus controls).
2532 * Then, just use this API before deleting.
2534 * @see elm_object_tree_unfocusable_get()
2538 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2541 * Get whether an Elementary object and its children are unfocusable or not.
2543 * @param obj The Elementary object to get the information from
2544 * @return @c EINA_TRUE, if the tree is unfocussable,
2545 * @c EINA_FALSE if not (and on errors).
2547 * @see elm_object_tree_unfocusable_set()
2551 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2554 * @defgroup Scrolling Scrolling
2556 * These are functions setting how scrollable views in Elementary
2557 * widgets should behave on user interaction.
2563 * Get whether scrollers should bounce when they reach their
2564 * viewport's edge during a scroll.
2566 * @return the thumb scroll bouncing state
2568 * This is the default behavior for touch screens, in general.
2569 * @ingroup Scrolling
2571 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
2574 * Set whether scrollers should bounce when they reach their
2575 * viewport's edge during a scroll.
2577 * @param enabled the thumb scroll bouncing state
2579 * @see elm_thumbscroll_bounce_enabled_get()
2580 * @ingroup Scrolling
2582 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2585 * Set whether scrollers should bounce when they reach their
2586 * viewport's edge during a scroll, for all Elementary application
2589 * @param enabled the thumb scroll bouncing state
2591 * @see elm_thumbscroll_bounce_enabled_get()
2592 * @ingroup Scrolling
2594 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2597 * Get the amount of inertia a scroller will impose at bounce
2600 * @return the thumb scroll bounce friction
2602 * @ingroup Scrolling
2604 EAPI double elm_scroll_bounce_friction_get(void);
2607 * Set the amount of inertia a scroller will impose at bounce
2610 * @param friction the thumb scroll bounce friction
2612 * @see elm_thumbscroll_bounce_friction_get()
2613 * @ingroup Scrolling
2615 EAPI void elm_scroll_bounce_friction_set(double friction);
2618 * Set the amount of inertia a scroller will impose at bounce
2619 * animations, for all Elementary application windows.
2621 * @param friction the thumb scroll bounce friction
2623 * @see elm_thumbscroll_bounce_friction_get()
2624 * @ingroup Scrolling
2626 EAPI void elm_scroll_bounce_friction_all_set(double friction);
2629 * Get the amount of inertia a <b>paged</b> scroller will impose at
2630 * page fitting animations.
2632 * @return the page scroll friction
2634 * @ingroup Scrolling
2636 EAPI double elm_scroll_page_scroll_friction_get(void);
2639 * Set the amount of inertia a <b>paged</b> scroller will impose at
2640 * page fitting animations.
2642 * @param friction the page scroll friction
2644 * @see elm_thumbscroll_page_scroll_friction_get()
2645 * @ingroup Scrolling
2647 EAPI void elm_scroll_page_scroll_friction_set(double friction);
2650 * Set the amount of inertia a <b>paged</b> scroller will impose at
2651 * page fitting animations, for all Elementary application windows.
2653 * @param friction the page scroll friction
2655 * @see elm_thumbscroll_page_scroll_friction_get()
2656 * @ingroup Scrolling
2658 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
2661 * Get the amount of inertia a scroller will impose at region bring
2664 * @return the bring in scroll friction
2666 * @ingroup Scrolling
2668 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
2671 * Set the amount of inertia a scroller will impose at region bring
2674 * @param friction the bring in scroll friction
2676 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2677 * @ingroup Scrolling
2679 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
2682 * Set the amount of inertia a scroller will impose at region bring
2683 * animations, for all Elementary application windows.
2685 * @param friction the bring in scroll friction
2687 * @see elm_thumbscroll_bring_in_scroll_friction_get()
2688 * @ingroup Scrolling
2690 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
2693 * Get the amount of inertia scrollers will impose at animations
2694 * triggered by Elementary widgets' zooming API.
2696 * @return the zoom friction
2698 * @ingroup Scrolling
2700 EAPI double elm_scroll_zoom_friction_get(void);
2703 * Set the amount of inertia scrollers will impose at animations
2704 * triggered by Elementary widgets' zooming API.
2706 * @param friction the zoom friction
2708 * @see elm_thumbscroll_zoom_friction_get()
2709 * @ingroup Scrolling
2711 EAPI void elm_scroll_zoom_friction_set(double friction);
2714 * Set the amount of inertia scrollers will impose at animations
2715 * triggered by Elementary widgets' zooming API, for all Elementary
2716 * application windows.
2718 * @param friction the zoom friction
2720 * @see elm_thumbscroll_zoom_friction_get()
2721 * @ingroup Scrolling
2723 EAPI void elm_scroll_zoom_friction_all_set(double friction);
2726 * Get whether scrollers should be draggable from any point in their
2729 * @return the thumb scroll state
2731 * @note This is the default behavior for touch screens, in general.
2732 * @note All other functions namespaced with "thumbscroll" will only
2733 * have effect if this mode is enabled.
2735 * @ingroup Scrolling
2737 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
2740 * Set whether scrollers should be draggable from any point in their
2743 * @param enabled the thumb scroll state
2745 * @see elm_thumbscroll_enabled_get()
2746 * @ingroup Scrolling
2748 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2751 * Set whether scrollers should be draggable from any point in their
2752 * views, for all Elementary application windows.
2754 * @param enabled the thumb scroll state
2756 * @see elm_thumbscroll_enabled_get()
2757 * @ingroup Scrolling
2759 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2762 * Get the number of pixels one should travel while dragging a
2763 * scroller's view to actually trigger scrolling.
2765 * @return the thumb scroll threshould
2767 * One would use higher values for touch screens, in general, because
2768 * of their inherent imprecision.
2769 * @ingroup Scrolling
2771 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
2774 * Set the number of pixels one should travel while dragging a
2775 * scroller's view to actually trigger scrolling.
2777 * @param threshold the thumb scroll threshould
2779 * @see elm_thumbscroll_threshould_get()
2780 * @ingroup Scrolling
2782 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2785 * Set the number of pixels one should travel while dragging a
2786 * scroller's view to actually trigger scrolling, for all Elementary
2787 * application windows.
2789 * @param threshold the thumb scroll threshould
2791 * @see elm_thumbscroll_threshould_get()
2792 * @ingroup Scrolling
2794 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2797 * Get the minimum speed of mouse cursor movement which will trigger
2798 * list self scrolling animation after a mouse up event
2801 * @return the thumb scroll momentum threshould
2803 * @ingroup Scrolling
2805 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
2808 * Set the minimum speed of mouse cursor movement which will trigger
2809 * list self scrolling animation after a mouse up event
2812 * @param threshold the thumb scroll momentum threshould
2814 * @see elm_thumbscroll_momentum_threshould_get()
2815 * @ingroup Scrolling
2817 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2820 * Set the minimum speed of mouse cursor movement which will trigger
2821 * list self scrolling animation after a mouse up event
2822 * (pixels/second), for all Elementary application windows.
2824 * @param threshold the thumb scroll momentum threshould
2826 * @see elm_thumbscroll_momentum_threshould_get()
2827 * @ingroup Scrolling
2829 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2832 * Get the amount of inertia a scroller will impose at self scrolling
2835 * @return the thumb scroll friction
2837 * @ingroup Scrolling
2839 EAPI double elm_scroll_thumbscroll_friction_get(void);
2842 * Set the amount of inertia a scroller will impose at self scrolling
2845 * @param friction the thumb scroll friction
2847 * @see elm_thumbscroll_friction_get()
2848 * @ingroup Scrolling
2850 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
2853 * Set the amount of inertia a scroller will impose at self scrolling
2854 * animations, for all Elementary application windows.
2856 * @param friction the thumb scroll friction
2858 * @see elm_thumbscroll_friction_get()
2859 * @ingroup Scrolling
2861 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
2864 * Get the amount of lag between your actual mouse cursor dragging
2865 * movement and a scroller's view movement itself, while pushing it
2866 * into bounce state manually.
2868 * @return the thumb scroll border friction
2870 * @ingroup Scrolling
2872 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2875 * Set the amount of lag between your actual mouse cursor dragging
2876 * movement and a scroller's view movement itself, while pushing it
2877 * into bounce state manually.
2879 * @param friction the thumb scroll border friction. @c 0.0 for
2880 * perfect synchrony between two movements, @c 1.0 for maximum
2883 * @see elm_thumbscroll_border_friction_get()
2884 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2886 * @ingroup Scrolling
2888 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
2891 * Set the amount of lag between your actual mouse cursor dragging
2892 * movement and a scroller's view movement itself, while pushing it
2893 * into bounce state manually, for all Elementary application windows.
2895 * @param friction the thumb scroll border friction. @c 0.0 for
2896 * perfect synchrony between two movements, @c 1.0 for maximum
2899 * @see elm_thumbscroll_border_friction_get()
2900 * @note parameter value will get bound to 0.0 - 1.0 interval, always
2902 * @ingroup Scrolling
2904 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
2907 * Get the sensitivity amount which is be multiplied by the length of
2910 * @return the thumb scroll sensitivity friction
2912 * @ingroup Scrolling
2914 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
2917 * Set the sensitivity amount which is be multiplied by the length of
2920 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2921 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2924 * @see elm_thumbscroll_sensitivity_friction_get()
2925 * @note parameter value will get bound to 0.1 - 1.0 interval, always
2927 * @ingroup Scrolling
2929 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
2932 * Set the sensitivity amount which is be multiplied by the length of
2933 * mouse dragging, for all Elementary application windows.
2935 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2936 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2939 * @see elm_thumbscroll_sensitivity_friction_get()
2940 * @note parameter value will get bound to 0.1 - 1.0 interval, always
2942 * @ingroup Scrolling
2944 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
2951 * @defgroup Scrollhints Scrollhints
2953 * Objects when inside a scroller can scroll, but this may not always be
2954 * desirable in certain situations. This allows an object to hint to itself
2955 * and parents to "not scroll" in one of 2 ways. If any child object of a
2956 * scroller has pushed a scroll freeze or hold then it affects all parent
2957 * scrollers until all children have released them.
2959 * 1. To hold on scrolling. This means just flicking and dragging may no
2960 * longer scroll, but pressing/dragging near an edge of the scroller will
2961 * still scroll. This is automatically used by the entry object when
2964 * 2. To totally freeze scrolling. This means it stops. until
2971 * Push the scroll hold by 1
2973 * This increments the scroll hold count by one. If it is more than 0 it will
2974 * take effect on the parents of the indicated object.
2976 * @param obj The object
2977 * @ingroup Scrollhints
2979 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2982 * Pop the scroll hold by 1
2984 * This decrements the scroll hold count by one. If it is more than 0 it will
2985 * take effect on the parents of the indicated object.
2987 * @param obj The object
2988 * @ingroup Scrollhints
2990 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2993 * Push the scroll freeze by 1
2995 * This increments the scroll freeze count by one. If it is more
2996 * than 0 it will take effect on the parents of the indicated
2999 * @param obj The object
3000 * @ingroup Scrollhints
3002 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3005 * Pop the scroll freeze by 1
3007 * This decrements the scroll freeze count by one. If it is more
3008 * than 0 it will take effect on the parents of the indicated
3011 * @param obj The object
3012 * @ingroup Scrollhints
3014 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3017 * Lock the scrolling of the given widget (and thus all parents)
3019 * This locks the given object from scrolling in the X axis (and implicitly
3020 * also locks all parent scrollers too from doing the same).
3022 * @param obj The object
3023 * @param lock The lock state (1 == locked, 0 == unlocked)
3024 * @ingroup Scrollhints
3026 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3029 * Lock the scrolling of the given widget (and thus all parents)
3031 * This locks the given object from scrolling in the Y axis (and implicitly
3032 * also locks all parent scrollers too from doing the same).
3034 * @param obj The object
3035 * @param lock The lock state (1 == locked, 0 == unlocked)
3036 * @ingroup Scrollhints
3038 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3041 * Get the scrolling lock of the given widget
3043 * This gets the lock for X axis scrolling.
3045 * @param obj The object
3046 * @ingroup Scrollhints
3048 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3051 * Get the scrolling lock of the given widget
3053 * This gets the lock for X axis scrolling.
3055 * @param obj The object
3056 * @ingroup Scrollhints
3058 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3065 * Send a signal to the widget edje object.
3067 * This function sends a signal to the edje object of the obj. An
3068 * edje program can respond to a signal by specifying matching
3069 * 'signal' and 'source' fields.
3071 * @param obj The object
3072 * @param emission The signal's name.
3073 * @param source The signal's source.
3076 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3079 * Add a callback for a signal emitted by widget edje object.
3081 * This function connects a callback function to a signal emitted by the
3082 * edje object of the obj.
3083 * Globs can occur in either the emission or source name.
3085 * @param obj The object
3086 * @param emission The signal's name.
3087 * @param source The signal's source.
3088 * @param func The callback function to be executed when the signal is
3090 * @param data A pointer to data to pass in to the callback function.
3093 EAPI void elm_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func, void *data) EINA_ARG_NONNULL(1, 4);
3096 * Remove a signal-triggered callback from a widget edje object.
3098 * This function removes a callback, previoulsy attached to a
3099 * signal emitted by the edje object of the obj. The parameters
3100 * emission, source and func must match exactly those passed to a
3101 * previous call to elm_object_signal_callback_add(). The data
3102 * pointer that was passed to this call will be returned.
3104 * @param obj The object
3105 * @param emission The signal's name.
3106 * @param source The signal's source.
3107 * @param func The callback function to be executed when the signal is
3109 * @return The data pointer
3112 EAPI void *elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func) EINA_ARG_NONNULL(1, 4);
3115 * Add a callback for input events (key up, key down, mouse wheel)
3116 * on a given Elementary widget
3118 * @param obj The widget to add an event callback on
3119 * @param func The callback function to be executed when the event
3121 * @param data Data to pass in to @p func
3123 * Every widget in an Elementary interface set to receive focus,
3124 * with elm_object_focus_allow_set(), will propagate @b all of its
3125 * key up, key down and mouse wheel input events up to its parent
3126 * object, and so on. All of the focusable ones in this chain which
3127 * had an event callback set, with this call, will be able to treat
3128 * those events. There are two ways of making the propagation of
3129 * these event upwards in the tree of widgets to @b cease:
3130 * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3131 * the event was @b not processed, so the propagation will go on.
3132 * - The @c event_info pointer passed to @p func will contain the
3133 * event's structure and, if you OR its @c event_flags inner
3134 * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3135 * one has already handled it, thus killing the event's
3138 * @note Your event callback will be issued on those events taking
3139 * place only if no other child widget of @obj has consumed the
3142 * @note Not to be confused with @c
3143 * evas_object_event_callback_add(), which will add event callbacks
3144 * per type on general Evas objects (no event propagation
3145 * infrastructure taken in account).
3147 * @note Not to be confused with @c
3148 * elm_object_signal_callback_add(), which will add callbacks to @b
3149 * signals coming from a widget's theme, not input events.
3151 * @note Not to be confused with @c
3152 * edje_object_signal_callback_add(), which does the same as
3153 * elm_object_signal_callback_add(), but directly on an Edje
3156 * @note Not to be confused with @c
3157 * evas_object_smart_callback_add(), which adds callbacks to smart
3158 * objects' <b>smart events</b>, and not input events.
3160 * @see elm_object_event_callback_del()
3164 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3167 * Remove an event callback from a widget.
3169 * This function removes a callback, previoulsy attached to event emission
3171 * The parameters func and data must match exactly those passed to
3172 * a previous call to elm_object_event_callback_add(). The data pointer that
3173 * was passed to this call will be returned.
3175 * @param obj The object
3176 * @param func The callback function to be executed when the event is
3178 * @param data Data to pass in to the callback function.
3179 * @return The data pointer
3182 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3185 * Adjust size of an element for finger usage.
3187 * @param times_w How many fingers should fit horizontally
3188 * @param w Pointer to the width size to adjust
3189 * @param times_h How many fingers should fit vertically
3190 * @param h Pointer to the height size to adjust
3192 * This takes width and height sizes (in pixels) as input and a
3193 * size multiple (which is how many fingers you want to place
3194 * within the area, being "finger" the size set by
3195 * elm_finger_size_set()), and adjusts the size to be large enough
3196 * to accommodate the resulting size -- if it doesn't already
3197 * accommodate it. On return the @p w and @p h sizes pointed to by
3198 * these parameters will be modified, on those conditions.
3200 * @note This is kind of a low level Elementary call, most useful
3201 * on size evaluation times for widgets. An external user wouldn't
3202 * be calling, most of the time.
3206 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3209 * Get the duration for occuring long press event.
3211 * @return Timeout for long press event
3212 * @ingroup Longpress
3214 EAPI double elm_longpress_timeout_get(void);
3217 * Set the duration for occuring long press event.
3219 * @param lonpress_timeout Timeout for long press event
3220 * @ingroup Longpress
3222 EAPI void elm_longpress_timeout_set(double longpress_timeout);
3225 * @defgroup Debug Debug
3226 * don't use it unless you are sure
3232 * Print Tree object hierarchy in stdout
3234 * @param obj The root object
3237 EAPI void elm_object_tree_dump(const Evas_Object *top);
3240 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3242 * @param obj The root object
3243 * @param file The path of output file
3246 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3253 * @defgroup Theme Theme
3255 * Elementary uses Edje to theme its widgets, naturally. But for the most
3256 * part this is hidden behind a simpler interface that lets the user set
3257 * extensions and choose the style of widgets in a much easier way.
3259 * Instead of thinking in terms of paths to Edje files and their groups
3260 * each time you want to change the appearance of a widget, Elementary
3261 * works so you can add any theme file with extensions or replace the
3262 * main theme at one point in the application, and then just set the style
3263 * of widgets with elm_object_style_set() and related functions. Elementary
3264 * will then look in its list of themes for a matching group and apply it,
3265 * and when the theme changes midway through the application, all widgets
3266 * will be updated accordingly.
3268 * There are three concepts you need to know to understand how Elementary
3269 * theming works: default theme, extensions and overlays.
3271 * Default theme, obviously enough, is the one that provides the default
3272 * look of all widgets. End users can change the theme used by Elementary
3273 * by setting the @c ELM_THEME environment variable before running an
3274 * application, or globally for all programs using the @c elementary_config
3275 * utility. Applications can change the default theme using elm_theme_set(),
3276 * but this can go against the user wishes, so it's not an adviced practice.
3278 * Ideally, applications should find everything they need in the already
3279 * provided theme, but there may be occasions when that's not enough and
3280 * custom styles are required to correctly express the idea. For this
3281 * cases, Elementary has extensions.
3283 * Extensions allow the application developer to write styles of its own
3284 * to apply to some widgets. This requires knowledge of how each widget
3285 * is themed, as extensions will always replace the entire group used by
3286 * the widget, so important signals and parts need to be there for the
3287 * object to behave properly (see documentation of Edje for details).
3288 * Once the theme for the extension is done, the application needs to add
3289 * it to the list of themes Elementary will look into, using
3290 * elm_theme_extension_add(), and set the style of the desired widgets as
3291 * he would normally with elm_object_style_set().
3293 * Overlays, on the other hand, can replace the look of all widgets by
3294 * overriding the default style. Like extensions, it's up to the application
3295 * developer to write the theme for the widgets it wants, the difference
3296 * being that when looking for the theme, Elementary will check first the
3297 * list of overlays, then the set theme and lastly the list of extensions,
3298 * so with overlays it's possible to replace the default view and every
3299 * widget will be affected. This is very much alike to setting the whole
3300 * theme for the application and will probably clash with the end user
3301 * options, not to mention the risk of ending up with not matching styles
3302 * across the program. Unless there's a very special reason to use them,
3303 * overlays should be avoided for the resons exposed before.
3305 * All these theme lists are handled by ::Elm_Theme instances. Elementary
3306 * keeps one default internally and every function that receives one of
3307 * these can be called with NULL to refer to this default (except for
3308 * elm_theme_free()). It's possible to create a new instance of a
3309 * ::Elm_Theme to set other theme for a specific widget (and all of its
3310 * children), but this is as discouraged, if not even more so, than using
3311 * overlays. Don't use this unless you really know what you are doing.
3313 * But to be less negative about things, you can look at the following
3315 * @li @ref theme_example_01 "Using extensions"
3316 * @li @ref theme_example_02 "Using overlays"
3321 * @typedef Elm_Theme
3323 * Opaque handler for the list of themes Elementary looks for when
3324 * rendering widgets.
3326 * Stay out of this unless you really know what you are doing. For most
3327 * cases, sticking to the default is all a developer needs.
3329 typedef struct _Elm_Theme Elm_Theme;
3332 * Create a new specific theme
3334 * This creates an empty specific theme that only uses the default theme. A
3335 * specific theme has its own private set of extensions and overlays too
3336 * (which are empty by default). Specific themes do not fall back to themes
3337 * of parent objects. They are not intended for this use. Use styles, overlays
3338 * and extensions when needed, but avoid specific themes unless there is no
3339 * other way (example: you want to have a preview of a new theme you are
3340 * selecting in a "theme selector" window. The preview is inside a scroller
3341 * and should display what the theme you selected will look like, but not
3342 * actually apply it yet. The child of the scroller will have a specific
3343 * theme set to show this preview before the user decides to apply it to all
3346 EAPI Elm_Theme *elm_theme_new(void);
3348 * Free a specific theme
3350 * @param th The theme to free
3352 * This frees a theme created with elm_theme_new().
3354 EAPI void elm_theme_free(Elm_Theme *th);
3356 * Copy the theme fom the source to the destination theme
3358 * @param th The source theme to copy from
3359 * @param thdst The destination theme to copy data to
3361 * This makes a one-time static copy of all the theme config, extensions
3362 * and overlays from @p th to @p thdst. If @p th references a theme, then
3363 * @p thdst is also set to reference it, with all the theme settings,
3364 * overlays and extensions that @p th had.
3366 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3368 * Tell the source theme to reference the ref theme
3370 * @param th The theme that will do the referencing
3371 * @param thref The theme that is the reference source
3373 * This clears @p th to be empty and then sets it to refer to @p thref
3374 * so @p th acts as an override to @p thref, but where its overrides
3375 * don't apply, it will fall through to @p thref for configuration.
3377 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3379 * Return the theme referred to
3381 * @param th The theme to get the reference from
3382 * @return The referenced theme handle
3384 * This gets the theme set as the reference theme by elm_theme_ref_set().
3385 * If no theme is set as a reference, NULL is returned.
3387 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
3389 * Return the default theme
3391 * @return The default theme handle
3393 * This returns the internal default theme setup handle that all widgets
3394 * use implicitly unless a specific theme is set. This is also often use
3395 * as a shorthand of NULL.
3397 EAPI Elm_Theme *elm_theme_default_get(void);
3399 * Prepends a theme overlay to the list of overlays
3401 * @param th The theme to add to, or if NULL, the default theme
3402 * @param item The Edje file path to be used
3404 * Use this if your application needs to provide some custom overlay theme
3405 * (An Edje file that replaces some default styles of widgets) where adding
3406 * new styles, or changing system theme configuration is not possible. Do
3407 * NOT use this instead of a proper system theme configuration. Use proper
3408 * configuration files, profiles, environment variables etc. to set a theme
3409 * so that the theme can be altered by simple confiugration by a user. Using
3410 * this call to achieve that effect is abusing the API and will create lots
3413 * @see elm_theme_extension_add()
3415 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
3417 * Delete a theme overlay from the list of overlays
3419 * @param th The theme to delete from, or if NULL, the default theme
3420 * @param item The name of the theme overlay
3422 * @see elm_theme_overlay_add()
3424 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
3426 * Appends a theme extension to the list of extensions.
3428 * @param th The theme to add to, or if NULL, the default theme
3429 * @param item The Edje file path to be used
3431 * This is intended when an application needs more styles of widgets or new
3432 * widget themes that the default does not provide (or may not provide). The
3433 * application has "extended" usage by coming up with new custom style names
3434 * for widgets for specific uses, but as these are not "standard", they are
3435 * not guaranteed to be provided by a default theme. This means the
3436 * application is required to provide these extra elements itself in specific
3437 * Edje files. This call adds one of those Edje files to the theme search
3438 * path to be search after the default theme. The use of this call is
3439 * encouraged when default styles do not meet the needs of the application.
3440 * Use this call instead of elm_theme_overlay_add() for almost all cases.
3442 * @see elm_object_style_set()
3444 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
3446 * Deletes a theme extension from the list of extensions.
3448 * @param th The theme to delete from, or if NULL, the default theme
3449 * @param item The name of the theme extension
3451 * @see elm_theme_extension_add()
3453 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
3455 * Set the theme search order for the given theme
3457 * @param th The theme to set the search order, or if NULL, the default theme
3458 * @param theme Theme search string
3460 * This sets the search string for the theme in path-notation from first
3461 * theme to search, to last, delimited by the : character. Example:
3463 * "shiny:/path/to/file.edj:default"
3465 * See the ELM_THEME environment variable for more information.
3467 * @see elm_theme_get()
3468 * @see elm_theme_list_get()
3470 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
3472 * Return the theme search order
3474 * @param th The theme to get the search order, or if NULL, the default theme
3475 * @return The internal search order path
3477 * This function returns a colon separated string of theme elements as
3478 * returned by elm_theme_list_get().
3480 * @see elm_theme_set()
3481 * @see elm_theme_list_get()
3483 EAPI const char *elm_theme_get(Elm_Theme *th);
3485 * Return a list of theme elements to be used in a theme.
3487 * @param th Theme to get the list of theme elements from.
3488 * @return The internal list of theme elements
3490 * This returns the internal list of theme elements (will only be valid as
3491 * long as the theme is not modified by elm_theme_set() or theme is not
3492 * freed by elm_theme_free(). This is a list of strings which must not be
3493 * altered as they are also internal. If @p th is NULL, then the default
3494 * theme element list is returned.
3496 * A theme element can consist of a full or relative path to a .edj file,
3497 * or a name, without extension, for a theme to be searched in the known
3498 * theme paths for Elemementary.
3500 * @see elm_theme_set()
3501 * @see elm_theme_get()
3503 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3505 * Return the full patrh for a theme element
3507 * @param f The theme element name
3508 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3509 * @return The full path to the file found.
3511 * This returns a string you should free with free() on success, NULL on
3512 * failure. This will search for the given theme element, and if it is a
3513 * full or relative path element or a simple searchable name. The returned
3514 * path is the full path to the file, if searched, and the file exists, or it
3515 * is simply the full path given in the element or a resolved path if
3516 * relative to home. The @p in_search_path boolean pointed to is set to
3517 * EINA_TRUE if the file was a searchable file andis in the search path,
3518 * and EINA_FALSE otherwise.
3520 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3522 * Flush the current theme.
3524 * @param th Theme to flush
3526 * This flushes caches that let elementary know where to find theme elements
3527 * in the given theme. If @p th is NULL, then the default theme is flushed.
3528 * Call this function if source theme data has changed in such a way as to
3529 * make any caches Elementary kept invalid.
3531 EAPI void elm_theme_flush(Elm_Theme *th);
3533 * This flushes all themes (default and specific ones).
3535 * This will flush all themes in the current application context, by calling
3536 * elm_theme_flush() on each of them.
3538 EAPI void elm_theme_full_flush(void);
3540 * Set the theme for all elementary using applications on the current display
3542 * @param theme The name of the theme to use. Format same as the ELM_THEME
3543 * environment variable.
3545 EAPI void elm_theme_all_set(const char *theme);
3547 * Return a list of theme elements in the theme search path
3549 * @return A list of strings that are the theme element names.
3551 * This lists all available theme files in the standard Elementary search path
3552 * for theme elements, and returns them in alphabetical order as theme
3553 * element names in a list of strings. Free this with
3554 * elm_theme_name_available_list_free() when you are done with the list.
3556 EAPI Eina_List *elm_theme_name_available_list_new(void);
3558 * Free the list returned by elm_theme_name_available_list_new()
3560 * This frees the list of themes returned by
3561 * elm_theme_name_available_list_new(). Once freed the list should no longer
3562 * be used. a new list mys be created.
3564 EAPI void elm_theme_name_available_list_free(Eina_List *list);
3566 * Set a specific theme to be used for this object and its children
3568 * @param obj The object to set the theme on
3569 * @param th The theme to set
3571 * This sets a specific theme that will be used for the given object and any
3572 * child objects it has. If @p th is NULL then the theme to be used is
3573 * cleared and the object will inherit its theme from its parent (which
3574 * ultimately will use the default theme if no specific themes are set).
3576 * Use special themes with great care as this will annoy users and make
3577 * configuration difficult. Avoid any custom themes at all if it can be
3580 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3582 * Get the specific theme to be used
3584 * @param obj The object to get the specific theme from
3585 * @return The specifc theme set.
3587 * This will return a specific theme set, or NULL if no specific theme is
3588 * set on that object. It will not return inherited themes from parents, only
3589 * the specific theme set for that specific object. See elm_object_theme_set()
3590 * for more information.
3592 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3595 * Get a data item from a theme
3597 * @param th The theme, or NULL for default theme
3598 * @param key The data key to search with
3599 * @return The data value, or NULL on failure
3601 * This function is used to return data items from edc in @p th, an overlay, or an extension.
3602 * It works the same way as edje_file_data_get() except that the return is stringshared.
3604 EAPI const char *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3610 /** @defgroup Win Win
3612 * @image html img/widget/win/preview-00.png
3613 * @image latex img/widget/win/preview-00.eps
3615 * The window class of Elementary. Contains functions to manipulate
3616 * windows. The Evas engine used to render the window contents is specified
3617 * in the system or user elementary config files (whichever is found last),
3618 * and can be overridden with the ELM_ENGINE environment variable for
3619 * testing. Engines that may be supported (depending on Evas and Ecore-Evas
3620 * compilation setup and modules actually installed at runtime) are (listed
3621 * in order of best supported and most likely to be complete and work to
3624 * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3625 * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3627 * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3629 * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3631 * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3633 * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3634 * rendering using SDL as the buffer)
3635 * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3636 * GDI with software)
3637 * @li "dfb", "directfb" (Rendering to a DirectFB window)
3638 * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3639 * grayscale using dedicated 8bit software engine in X11)
3640 * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3641 * X11 using 16bit software engine)
3642 * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3643 * (Windows CE rendering via GDI with 16bit software renderer)
3644 * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3645 * buffer with 16bit software renderer)
3646 * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3648 * All engines use a simple string to select the engine to render, EXCEPT
3649 * the "shot" engine. This actually encodes the output of the virtual
3650 * screenshot and how long to delay in the engine string. The engine string
3651 * is encoded in the following way:
3653 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3655 * Where options are separated by a ":" char if more than one option is
3656 * given, with delay, if provided being the first option and file the last
3657 * (order is important). The delay specifies how long to wait after the
3658 * window is shown before doing the virtual "in memory" rendering and then
3659 * save the output to the file specified by the file option (and then exit).
3660 * If no delay is given, the default is 0.5 seconds. If no file is given the
3661 * default output file is "out.png". Repeat option is for continous
3662 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3663 * fixed to "out001.png" Some examples of using the shot engine:
3665 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3666 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3667 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3668 * ELM_ENGINE="shot:delay=2.0" elementary_test
3669 * ELM_ENGINE="shot:" elementary_test
3671 * Signals that you can add callbacks for are:
3673 * @li "delete,request": the user requested to close the window. See
3674 * elm_win_autodel_set().
3675 * @li "focus,in": window got focus
3676 * @li "focus,out": window lost focus
3677 * @li "moved": window that holds the canvas was moved
3680 * @li @ref win_example_01
3685 * Defines the types of window that can be created
3687 * These are hints set on the window so that a running Window Manager knows
3688 * how the window should be handled and/or what kind of decorations it
3691 * Currently, only the X11 backed engines use them.
3693 typedef enum _Elm_Win_Type
3695 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3696 window. Almost every window will be created with this
3698 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3699 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3700 window holding desktop icons. */
3701 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3702 be kept on top of any other window by the Window
3704 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3706 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3707 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3709 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3710 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3711 entry in a menubar is clicked. Typically used
3712 with elm_win_override_set(). This hint exists
3713 for completion only, as the EFL way of
3714 implementing a menu would not normally use a
3715 separate window for its contents. */
3716 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3717 triggered by right-clicking an object. */
3718 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3719 explanatory text that typically appear after the
3720 mouse cursor hovers over an object for a while.
3721 Typically used with elm_win_override_set() and also
3722 not very commonly used in the EFL. */
3723 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3724 battery life or a new E-Mail received. */
3725 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3726 usually used in the EFL. */
3727 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3728 object being dragged across different windows, or even
3729 applications. Typically used with
3730 elm_win_override_set(). */
3731 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3732 buffer. No actual window is created for this
3733 type, instead the window and all of its
3734 contents will be rendered to an image buffer.
3735 This allows to have children window inside a
3736 parent one just like any other object would
3737 be, and do other things like applying @c
3738 Evas_Map effects to it. This is the only type
3739 of window that requires the @c parent
3740 parameter of elm_win_add() to be a valid @c
3745 * The differents layouts that can be requested for the virtual keyboard.
3747 * When the application window is being managed by Illume, it may request
3748 * any of the following layouts for the virtual keyboard.
3750 typedef enum _Elm_Win_Keyboard_Mode
3752 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3753 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3754 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3755 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3756 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3757 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3758 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3759 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3760 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3761 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3762 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3763 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3764 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3765 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3766 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3767 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3768 } Elm_Win_Keyboard_Mode;
3771 * Available commands that can be sent to the Illume manager.
3773 * When running under an Illume session, a window may send commands to the
3774 * Illume manager to perform different actions.
3776 typedef enum _Elm_Illume_Command
3778 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3780 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3782 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3784 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3785 } Elm_Illume_Command;
3788 * Adds a window object. If this is the first window created, pass NULL as
3791 * @param parent Parent object to add the window to, or NULL
3792 * @param name The name of the window
3793 * @param type The window type, one of #Elm_Win_Type.
3795 * The @p parent paramter can be @c NULL for every window @p type except
3796 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3797 * which the image object will be created.
3799 * @return The created object, or NULL on failure
3801 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3803 * Adds a window object with standard setup
3805 * @param name The name of the window
3806 * @param title The title for the window
3808 * This creates a window like elm_win_add() but also puts in a standard
3809 * background with elm_bg_add(), as well as setting the window title to
3810 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
3811 * as the parent widget.
3813 * @return The created object, or NULL on failure
3815 * @see elm_win_add()
3817 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
3819 * Add @p subobj as a resize object of window @p obj.
3822 * Setting an object as a resize object of the window means that the
3823 * @p subobj child's size and position will be controlled by the window
3824 * directly. That is, the object will be resized to match the window size
3825 * and should never be moved or resized manually by the developer.
3827 * In addition, resize objects of the window control what the minimum size
3828 * of it will be, as well as whether it can or not be resized by the user.
3830 * For the end user to be able to resize a window by dragging the handles
3831 * or borders provided by the Window Manager, or using any other similar
3832 * mechanism, all of the resize objects in the window should have their
3833 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3835 * @param obj The window object
3836 * @param subobj The resize object to add
3838 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3840 * Delete @p subobj as a resize object of window @p obj.
3842 * This function removes the object @p subobj from the resize objects of
3843 * the window @p obj. It will not delete the object itself, which will be
3844 * left unmanaged and should be deleted by the developer, manually handled
3845 * or set as child of some other container.
3847 * @param obj The window object
3848 * @param subobj The resize object to add
3850 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3852 * Set the title of the window
3854 * @param obj The window object
3855 * @param title The title to set
3857 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3859 * Get the title of the window
3861 * The returned string is an internal one and should not be freed or
3862 * modified. It will also be rendered invalid if a new title is set or if
3863 * the window is destroyed.
3865 * @param obj The window object
3868 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3870 * Set the window's autodel state.
3872 * When closing the window in any way outside of the program control, like
3873 * pressing the X button in the titlebar or using a command from the
3874 * Window Manager, a "delete,request" signal is emitted to indicate that
3875 * this event occurred and the developer can take any action, which may
3876 * include, or not, destroying the window object.
3878 * When the @p autodel parameter is set, the window will be automatically
3879 * destroyed when this event occurs, after the signal is emitted.
3880 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3881 * and is up to the program to do so when it's required.
3883 * @param obj The window object
3884 * @param autodel If true, the window will automatically delete itself when
3887 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3889 * Get the window's autodel state.
3891 * @param obj The window object
3892 * @return If the window will automatically delete itself when closed
3894 * @see elm_win_autodel_set()
3896 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3898 * Activate a window object.
3900 * This function sends a request to the Window Manager to activate the
3901 * window pointed by @p obj. If honored by the WM, the window will receive
3902 * the keyboard focus.
3904 * @note This is just a request that a Window Manager may ignore, so calling
3905 * this function does not ensure in any way that the window will be the
3906 * active one after it.
3908 * @param obj The window object
3910 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3912 * Lower a window object.
3914 * Places the window pointed by @p obj at the bottom of the stack, so that
3915 * no other window is covered by it.
3917 * If elm_win_override_set() is not set, the Window Manager may ignore this
3920 * @param obj The window object
3922 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3924 * Raise a window object.
3926 * Places the window pointed by @p obj at the top of the stack, so that it's
3927 * not covered by any other window.
3929 * If elm_win_override_set() is not set, the Window Manager may ignore this
3932 * @param obj The window object
3934 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3936 * Set the borderless state of a window.
3938 * This function requests the Window Manager to not draw any decoration
3939 * around the window.
3941 * @param obj The window object
3942 * @param borderless If true, the window is borderless
3944 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3946 * Get the borderless state of a window.
3948 * @param obj The window object
3949 * @return If true, the window is borderless
3951 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3953 * Set the shaped state of a window.
3955 * Shaped windows, when supported, will render the parts of the window that
3956 * has no content, transparent.
3958 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3959 * background object or cover the entire window in any other way, or the
3960 * parts of the canvas that have no data will show framebuffer artifacts.
3962 * @param obj The window object
3963 * @param shaped If true, the window is shaped
3965 * @see elm_win_alpha_set()
3967 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3969 * Get the shaped state of a window.
3971 * @param obj The window object
3972 * @return If true, the window is shaped
3974 * @see elm_win_shaped_set()
3976 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3978 * Set the alpha channel state of a window.
3980 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3981 * possibly making parts of the window completely or partially transparent.
3982 * This is also subject to the underlying system supporting it, like for
3983 * example, running under a compositing manager. If no compositing is
3984 * available, enabling this option will instead fallback to using shaped
3985 * windows, with elm_win_shaped_set().
3987 * @param obj The window object
3988 * @param alpha If true, the window has an alpha channel
3990 * @see elm_win_alpha_set()
3992 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3994 * Get the transparency state of a window.
3996 * @param obj The window object
3997 * @return If true, the window is transparent
3999 * @see elm_win_transparent_set()
4001 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4003 * Set the transparency state of a window.
4005 * Use elm_win_alpha_set() instead.
4007 * @param obj The window object
4008 * @param transparent If true, the window is transparent
4010 * @see elm_win_alpha_set()
4012 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4014 * Get the alpha channel state of a window.
4016 * @param obj The window object
4017 * @return If true, the window has an alpha channel
4019 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4021 * Set the override state of a window.
4023 * A window with @p override set to EINA_TRUE will not be managed by the
4024 * Window Manager. This means that no decorations of any kind will be shown
4025 * for it, moving and resizing must be handled by the application, as well
4026 * as the window visibility.
4028 * This should not be used for normal windows, and even for not so normal
4029 * ones, it should only be used when there's a good reason and with a lot
4030 * of care. Mishandling override windows may result situations that
4031 * disrupt the normal workflow of the end user.
4033 * @param obj The window object
4034 * @param override If true, the window is overridden
4036 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4038 * Get the override state of a window.
4040 * @param obj The window object
4041 * @return If true, the window is overridden
4043 * @see elm_win_override_set()
4045 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4047 * Set the fullscreen state of a window.
4049 * @param obj The window object
4050 * @param fullscreen If true, the window is fullscreen
4052 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4054 * Get the fullscreen state of a window.
4056 * @param obj The window object
4057 * @return If true, the window is fullscreen
4059 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4061 * Set the maximized state of a window.
4063 * @param obj The window object
4064 * @param maximized If true, the window is maximized
4066 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4068 * Get the maximized state of a window.
4070 * @param obj The window object
4071 * @return If true, the window is maximized
4073 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4075 * Set the iconified state of a window.
4077 * @param obj The window object
4078 * @param iconified If true, the window is iconified
4080 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4082 * Get the iconified state of a window.
4084 * @param obj The window object
4085 * @return If true, the window is iconified
4087 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4089 * Set the layer of the window.
4091 * What this means exactly will depend on the underlying engine used.
4093 * In the case of X11 backed engines, the value in @p layer has the
4094 * following meanings:
4095 * @li < 3: The window will be placed below all others.
4096 * @li > 5: The window will be placed above all others.
4097 * @li other: The window will be placed in the default layer.
4099 * @param obj The window object
4100 * @param layer The layer of the window
4102 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4104 * Get the layer of the window.
4106 * @param obj The window object
4107 * @return The layer of the window
4109 * @see elm_win_layer_set()
4111 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4113 * Set the rotation of the window.
4115 * Most engines only work with multiples of 90.
4117 * This function is used to set the orientation of the window @p obj to
4118 * match that of the screen. The window itself will be resized to adjust
4119 * to the new geometry of its contents. If you want to keep the window size,
4120 * see elm_win_rotation_with_resize_set().
4122 * @param obj The window object
4123 * @param rotation The rotation of the window, in degrees (0-360),
4124 * counter-clockwise.
4126 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4128 * Rotates the window and resizes it.
4130 * Like elm_win_rotation_set(), but it also resizes the window's contents so
4131 * that they fit inside the current window geometry.
4133 * @param obj The window object
4134 * @param layer The rotation of the window in degrees (0-360),
4135 * counter-clockwise.
4137 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4139 * Get the rotation of the window.
4141 * @param obj The window object
4142 * @return The rotation of the window in degrees (0-360)
4144 * @see elm_win_rotation_set()
4145 * @see elm_win_rotation_with_resize_set()
4147 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4149 * Set the sticky state of the window.
4151 * Hints the Window Manager that the window in @p obj should be left fixed
4152 * at its position even when the virtual desktop it's on moves or changes.
4154 * @param obj The window object
4155 * @param sticky If true, the window's sticky state is enabled
4157 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4159 * Get the sticky state of the window.
4161 * @param obj The window object
4162 * @return If true, the window's sticky state is enabled
4164 * @see elm_win_sticky_set()
4166 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4168 * Set if this window is an illume conformant window
4170 * @param obj The window object
4171 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4173 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4175 * Get if this window is an illume conformant window
4177 * @param obj The window object
4178 * @return A boolean if this window is illume conformant or not
4180 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4182 * Set a window to be an illume quickpanel window
4184 * By default window objects are not quickpanel windows.
4186 * @param obj The window object
4187 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4189 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4191 * Get if this window is a quickpanel or not
4193 * @param obj The window object
4194 * @return A boolean if this window is a quickpanel or not
4196 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4198 * Set the major priority of a quickpanel window
4200 * @param obj The window object
4201 * @param priority The major priority for this quickpanel
4203 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4205 * Get the major priority of a quickpanel window
4207 * @param obj The window object
4208 * @return The major priority of this quickpanel
4210 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4212 * Set the minor priority of a quickpanel window
4214 * @param obj The window object
4215 * @param priority The minor priority for this quickpanel
4217 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4219 * Get the minor priority of a quickpanel window
4221 * @param obj The window object
4222 * @return The minor priority of this quickpanel
4224 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4226 * Set which zone this quickpanel should appear in
4228 * @param obj The window object
4229 * @param zone The requested zone for this quickpanel
4231 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4233 * Get which zone this quickpanel should appear in
4235 * @param obj The window object
4236 * @return The requested zone for this quickpanel
4238 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4240 * Set the window to be skipped by keyboard focus
4242 * This sets the window to be skipped by normal keyboard input. This means
4243 * a window manager will be asked to not focus this window as well as omit
4244 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4246 * Call this and enable it on a window BEFORE you show it for the first time,
4247 * otherwise it may have no effect.
4249 * Use this for windows that have only output information or might only be
4250 * interacted with by the mouse or fingers, and never for typing input.
4251 * Be careful that this may have side-effects like making the window
4252 * non-accessible in some cases unless the window is specially handled. Use
4255 * @param obj The window object
4256 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4258 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4260 * Send a command to the windowing environment
4262 * This is intended to work in touchscreen or small screen device
4263 * environments where there is a more simplistic window management policy in
4264 * place. This uses the window object indicated to select which part of the
4265 * environment to control (the part that this window lives in), and provides
4266 * a command and an optional parameter structure (use NULL for this if not
4269 * @param obj The window object that lives in the environment to control
4270 * @param command The command to send
4271 * @param params Optional parameters for the command
4273 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4275 * Get the inlined image object handle
4277 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4278 * then the window is in fact an evas image object inlined in the parent
4279 * canvas. You can get this object (be careful to not manipulate it as it
4280 * is under control of elementary), and use it to do things like get pixel
4281 * data, save the image to a file, etc.
4283 * @param obj The window object to get the inlined image from
4284 * @return The inlined image object, or NULL if none exists
4286 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4288 * Set the enabled status for the focus highlight in a window
4290 * This function will enable or disable the focus highlight only for the
4291 * given window, regardless of the global setting for it
4293 * @param obj The window where to enable the highlight
4294 * @param enabled The enabled value for the highlight
4296 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4298 * Get the enabled value of the focus highlight for this window
4300 * @param obj The window in which to check if the focus highlight is enabled
4302 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4304 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4306 * Set the style for the focus highlight on this window
4308 * Sets the style to use for theming the highlight of focused objects on
4309 * the given window. If @p style is NULL, the default will be used.
4311 * @param obj The window where to set the style
4312 * @param style The style to set
4314 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4316 * Get the style set for the focus highlight object
4318 * Gets the style set for this windows highilght object, or NULL if none
4321 * @param obj The window to retrieve the highlights style from
4323 * @return The style set or NULL if none was. Default is used in that case.
4325 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4327 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4328 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4329 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4330 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4331 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4332 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4333 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4335 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4336 * (blank mouse, private mouse obj, defaultmouse)
4340 * Sets the keyboard mode of the window.
4342 * @param obj The window object
4343 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4345 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4347 * Gets the keyboard mode of the window.
4349 * @param obj The window object
4350 * @return The mode, one of #Elm_Win_Keyboard_Mode
4352 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4354 * Sets whether the window is a keyboard.
4356 * @param obj The window object
4357 * @param is_keyboard If true, the window is a virtual keyboard
4359 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4361 * Gets whether the window is a keyboard.
4363 * @param obj The window object
4364 * @return If the window is a virtual keyboard
4366 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4369 * Get the screen position of a window.
4371 * @param obj The window object
4372 * @param x The int to store the x coordinate to
4373 * @param y The int to store the y coordinate to
4375 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4381 * @defgroup Inwin Inwin
4383 * @image html img/widget/inwin/preview-00.png
4384 * @image latex img/widget/inwin/preview-00.eps
4385 * @image html img/widget/inwin/preview-01.png
4386 * @image latex img/widget/inwin/preview-01.eps
4387 * @image html img/widget/inwin/preview-02.png
4388 * @image latex img/widget/inwin/preview-02.eps
4390 * An inwin is a window inside a window that is useful for a quick popup.
4391 * It does not hover.
4393 * It works by creating an object that will occupy the entire window, so it
4394 * must be created using an @ref Win "elm_win" as parent only. The inwin
4395 * object can be hidden or restacked below every other object if it's
4396 * needed to show what's behind it without destroying it. If this is done,
4397 * the elm_win_inwin_activate() function can be used to bring it back to
4398 * full visibility again.
4400 * There are three styles available in the default theme. These are:
4401 * @li default: The inwin is sized to take over most of the window it's
4403 * @li minimal: The size of the inwin will be the minimum necessary to show
4405 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4406 * possible, but it's sized vertically the most it needs to fit its\
4409 * Some examples of Inwin can be found in the following:
4410 * @li @ref inwin_example_01
4415 * Adds an inwin to the current window
4417 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4418 * Never call this function with anything other than the top-most window
4419 * as its parameter, unless you are fond of undefined behavior.
4421 * After creating the object, the widget will set itself as resize object
4422 * for the window with elm_win_resize_object_add(), so when shown it will
4423 * appear to cover almost the entire window (how much of it depends on its
4424 * content and the style used). It must not be added into other container
4425 * objects and it needs not be moved or resized manually.
4427 * @param parent The parent object
4428 * @return The new object or NULL if it cannot be created
4430 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4432 * Activates an inwin object, ensuring its visibility
4434 * This function will make sure that the inwin @p obj is completely visible
4435 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4436 * to the front. It also sets the keyboard focus to it, which will be passed
4439 * The object's theme will also receive the signal "elm,action,show" with
4442 * @param obj The inwin to activate
4444 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4446 * Set the content of an inwin object.
4448 * Once the content object is set, a previously set one will be deleted.
4449 * If you want to keep that old content object, use the
4450 * elm_win_inwin_content_unset() function.
4452 * @param obj The inwin object
4453 * @param content The object to set as content
4455 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4457 * Get the content of an inwin object.
4459 * Return the content object which is set for this widget.
4461 * The returned object is valid as long as the inwin is still alive and no
4462 * other content is set on it. Deleting the object will notify the inwin
4463 * about it and this one will be left empty.
4465 * If you need to remove an inwin's content to be reused somewhere else,
4466 * see elm_win_inwin_content_unset().
4468 * @param obj The inwin object
4469 * @return The content that is being used
4471 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4473 * Unset the content of an inwin object.
4475 * Unparent and return the content object which was set for this widget.
4477 * @param obj The inwin object
4478 * @return The content that was being used
4480 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4484 /* X specific calls - won't work on non-x engines (return 0) */
4487 * Get the Ecore_X_Window of an Evas_Object
4489 * @param obj The object
4491 * @return The Ecore_X_Window of @p obj
4495 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4497 /* smart callbacks called:
4498 * "delete,request" - the user requested to delete the window
4499 * "focus,in" - window got focus
4500 * "focus,out" - window lost focus
4501 * "moved" - window that holds the canvas was moved
4507 * @image html img/widget/bg/preview-00.png
4508 * @image latex img/widget/bg/preview-00.eps
4510 * @brief Background object, used for setting a solid color, image or Edje
4511 * group as background to a window or any container object.
4513 * The bg object is used for setting a solid background to a window or
4514 * packing into any container object. It works just like an image, but has
4515 * some properties useful to a background, like setting it to tiled,
4516 * centered, scaled or stretched.
4518 * Default contents parts of the bg widget that you can use for are:
4519 * @li "elm.swallow.content" - overlay of the bg
4521 * Here is some sample code using it:
4522 * @li @ref bg_01_example_page
4523 * @li @ref bg_02_example_page
4524 * @li @ref bg_03_example_page
4528 typedef enum _Elm_Bg_Option
4530 ELM_BG_OPTION_CENTER, /**< center the background */
4531 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4532 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4533 ELM_BG_OPTION_TILE /**< tile background at its original size */
4537 * Add a new background to the parent
4539 * @param parent The parent object
4540 * @return The new object or NULL if it cannot be created
4544 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4547 * Set the file (image or edje) used for the background
4549 * @param obj The bg object
4550 * @param file The file path
4551 * @param group Optional key (group in Edje) within the file
4553 * This sets the image file used in the background object. The image (or edje)
4554 * will be stretched (retaining aspect if its an image file) to completely fill
4555 * the bg object. This may mean some parts are not visible.
4557 * @note Once the image of @p obj is set, a previously set one will be deleted,
4558 * even if @p file is NULL.
4562 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4565 * Get the file (image or edje) used for the background
4567 * @param obj The bg object
4568 * @param file The file path
4569 * @param group Optional key (group in Edje) within the file
4573 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4576 * Set the option used for the background image
4578 * @param obj The bg object
4579 * @param option The desired background option (TILE, SCALE)
4581 * This sets the option used for manipulating the display of the background
4582 * image. The image can be tiled or scaled.
4586 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4589 * Get the option used for the background image
4591 * @param obj The bg object
4592 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4596 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4598 * Set the option used for the background color
4600 * @param obj The bg object
4605 * This sets the color used for the background rectangle. Its range goes
4610 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4612 * Get the option used for the background color
4614 * @param obj The bg object
4621 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4624 * Set the overlay object used for the background object.
4626 * @param obj The bg object
4627 * @param overlay The overlay object
4629 * This provides a way for elm_bg to have an 'overlay' that will be on top
4630 * of the bg. Once the over object is set, a previously set one will be
4631 * deleted, even if you set the new one to NULL. If you want to keep that
4632 * old content object, use the elm_bg_overlay_unset() function.
4637 EINA_DEPRECATED EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4640 * Get the overlay object used for the background object.
4642 * @param obj The bg object
4643 * @return The content that is being used
4645 * Return the content object which is set for this widget
4649 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4652 * Get the overlay object used for the background object.
4654 * @param obj The bg object
4655 * @return The content that was being used
4657 * Unparent and return the overlay object which was set for this widget
4661 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4664 * Set the size of the pixmap representation of the image.
4666 * This option just makes sense if an image is going to be set in the bg.
4668 * @param obj The bg object
4669 * @param w The new width of the image pixmap representation.
4670 * @param h The new height of the image pixmap representation.
4672 * This function sets a new size for pixmap representation of the given bg
4673 * image. It allows the image to be loaded already in the specified size,
4674 * reducing the memory usage and load time when loading a big image with load
4675 * size set to a smaller size.
4677 * NOTE: this is just a hint, the real size of the pixmap may differ
4678 * depending on the type of image being loaded, being bigger than requested.
4682 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4683 /* smart callbacks called:
4687 * @defgroup Icon Icon
4689 * @image html img/widget/icon/preview-00.png
4690 * @image latex img/widget/icon/preview-00.eps
4692 * An object that provides standard icon images (delete, edit, arrows, etc.)
4693 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4695 * The icon image requested can be in the elementary theme, or in the
4696 * freedesktop.org paths. It's possible to set the order of preference from
4697 * where the image will be used.
4699 * This API is very similar to @ref Image, but with ready to use images.
4701 * Default images provided by the theme are described below.
4703 * The first list contains icons that were first intended to be used in
4704 * toolbars, but can be used in many other places too:
4720 * Now some icons that were designed to be used in menus (but again, you can
4721 * use them anywhere else):
4726 * @li menu/arrow_down
4727 * @li menu/arrow_left
4728 * @li menu/arrow_right
4737 * And here we have some media player specific icons:
4738 * @li media_player/forward
4739 * @li media_player/info
4740 * @li media_player/next
4741 * @li media_player/pause
4742 * @li media_player/play
4743 * @li media_player/prev
4744 * @li media_player/rewind
4745 * @li media_player/stop
4747 * Signals that you can add callbacks for are:
4749 * "clicked" - This is called when a user has clicked the icon
4751 * An example of usage for this API follows:
4752 * @li @ref tutorial_icon
4760 typedef enum _Elm_Icon_Type
4767 * @enum _Elm_Icon_Lookup_Order
4768 * @typedef Elm_Icon_Lookup_Order
4770 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4771 * theme, FDO paths, or both?
4775 typedef enum _Elm_Icon_Lookup_Order
4777 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4778 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4779 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4780 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4781 } Elm_Icon_Lookup_Order;
4784 * Add a new icon object to the parent.
4786 * @param parent The parent object
4787 * @return The new object or NULL if it cannot be created
4789 * @see elm_icon_file_set()
4793 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4795 * Set the file that will be used as icon.
4797 * @param obj The icon object
4798 * @param file The path to file that will be used as icon image
4799 * @param group The group that the icon belongs to an edje file
4801 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4803 * @note The icon image set by this function can be changed by
4804 * elm_icon_standard_set().
4806 * @see elm_icon_file_get()
4810 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4812 * Set a location in memory to be used as an icon
4814 * @param obj The icon object
4815 * @param img The binary data that will be used as an image
4816 * @param size The size of binary data @p img
4817 * @param format Optional format of @p img to pass to the image loader
4818 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4820 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4822 * @note The icon image set by this function can be changed by
4823 * elm_icon_standard_set().
4827 EAPI Eina_Bool elm_icon_memfile_set(Evas_Object *obj, const void *img, size_t size, const char *format, const char *key); EINA_ARG_NONNULL(1, 2);
4829 * Get the file that will be used as icon.
4831 * @param obj The icon object
4832 * @param file The path to file that will be used as the icon image
4833 * @param group The group that the icon belongs to, in edje file
4835 * @see elm_icon_file_set()
4839 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4840 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4842 * Set the icon by icon standards names.
4844 * @param obj The icon object
4845 * @param name The icon name
4847 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4849 * For example, freedesktop.org defines standard icon names such as "home",
4850 * "network", etc. There can be different icon sets to match those icon
4851 * keys. The @p name given as parameter is one of these "keys", and will be
4852 * used to look in the freedesktop.org paths and elementary theme. One can
4853 * change the lookup order with elm_icon_order_lookup_set().
4855 * If name is not found in any of the expected locations and it is the
4856 * absolute path of an image file, this image will be used.
4858 * @note The icon image set by this function can be changed by
4859 * elm_icon_file_set().
4861 * @see elm_icon_standard_get()
4862 * @see elm_icon_file_set()
4866 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4868 * Get the icon name set by icon standard names.
4870 * @param obj The icon object
4871 * @return The icon name
4873 * If the icon image was set using elm_icon_file_set() instead of
4874 * elm_icon_standard_set(), then this function will return @c NULL.
4876 * @see elm_icon_standard_set()
4880 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4882 * Set the smooth scaling for an icon object.
4884 * @param obj The icon object
4885 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4886 * otherwise. Default is @c EINA_TRUE.
4888 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4889 * scaling provides a better resulting image, but is slower.
4891 * The smooth scaling should be disabled when making animations that change
4892 * the icon size, since they will be faster. Animations that don't require
4893 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4894 * is already scaled, since the scaled icon image will be cached).
4896 * @see elm_icon_smooth_get()
4900 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4902 * Get whether smooth scaling is enabled for an icon object.
4904 * @param obj The icon object
4905 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4907 * @see elm_icon_smooth_set()
4911 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4913 * Disable scaling of this object.
4915 * @param obj The icon object.
4916 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4917 * otherwise. Default is @c EINA_FALSE.
4919 * This function disables scaling of the icon object through the function
4920 * elm_object_scale_set(). However, this does not affect the object
4921 * size/resize in any way. For that effect, take a look at
4922 * elm_icon_scale_set().
4924 * @see elm_icon_no_scale_get()
4925 * @see elm_icon_scale_set()
4926 * @see elm_object_scale_set()
4930 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4932 * Get whether scaling is disabled on the object.
4934 * @param obj The icon object
4935 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4937 * @see elm_icon_no_scale_set()
4941 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4943 * Set if the object is (up/down) resizable.
4945 * @param obj The icon object
4946 * @param scale_up A bool to set if the object is resizable up. Default is
4948 * @param scale_down A bool to set if the object is resizable down. Default
4951 * This function limits the icon object resize ability. If @p scale_up is set to
4952 * @c EINA_FALSE, the object can't have its height or width resized to a value
4953 * higher than the original icon size. Same is valid for @p scale_down.
4955 * @see elm_icon_scale_get()
4959 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4961 * Get if the object is (up/down) resizable.
4963 * @param obj The icon object
4964 * @param scale_up A bool to set if the object is resizable up
4965 * @param scale_down A bool to set if the object is resizable down
4967 * @see elm_icon_scale_set()
4971 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4973 * Get the object's image size
4975 * @param obj The icon object
4976 * @param w A pointer to store the width in
4977 * @param h A pointer to store the height in
4981 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4983 * Set if the icon fill the entire object area.
4985 * @param obj The icon object
4986 * @param fill_outside @c EINA_TRUE if the object is filled outside,
4987 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4989 * When the icon object is resized to a different aspect ratio from the
4990 * original icon image, the icon image will still keep its aspect. This flag
4991 * tells how the image should fill the object's area. They are: keep the
4992 * entire icon inside the limits of height and width of the object (@p
4993 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4994 * of the object, and the icon will fill the entire object (@p fill_outside
4997 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4998 * retain property to false. Thus, the icon image will always keep its
4999 * original aspect ratio.
5001 * @see elm_icon_fill_outside_get()
5002 * @see elm_image_fill_outside_set()
5006 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5008 * Get if the object is filled outside.
5010 * @param obj The icon object
5011 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5013 * @see elm_icon_fill_outside_set()
5017 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5019 * Set the prescale size for the icon.
5021 * @param obj The icon object
5022 * @param size The prescale size. This value is used for both width and
5025 * This function sets a new size for pixmap representation of the given
5026 * icon. It allows the icon to be loaded already in the specified size,
5027 * reducing the memory usage and load time when loading a big icon with load
5028 * size set to a smaller size.
5030 * It's equivalent to the elm_bg_load_size_set() function for bg.
5032 * @note this is just a hint, the real size of the pixmap may differ
5033 * depending on the type of icon being loaded, being bigger than requested.
5035 * @see elm_icon_prescale_get()
5036 * @see elm_bg_load_size_set()
5040 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5042 * Get the prescale size for the icon.
5044 * @param obj The icon object
5045 * @return The prescale size
5047 * @see elm_icon_prescale_set()
5051 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5053 * Sets the icon lookup order used by elm_icon_standard_set().
5055 * @param obj The icon object
5056 * @param order The icon lookup order (can be one of
5057 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5058 * or ELM_ICON_LOOKUP_THEME)
5060 * @see elm_icon_order_lookup_get()
5061 * @see Elm_Icon_Lookup_Order
5065 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5067 * Gets the icon lookup order.
5069 * @param obj The icon object
5070 * @return The icon lookup order
5072 * @see elm_icon_order_lookup_set()
5073 * @see Elm_Icon_Lookup_Order
5077 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5079 * Get if the icon supports animation or not.
5081 * @param obj The icon object
5082 * @return @c EINA_TRUE if the icon supports animation,
5083 * @c EINA_FALSE otherwise.
5085 * Return if this elm icon's image can be animated. Currently Evas only
5086 * supports gif animation. If the return value is EINA_FALSE, other
5087 * elm_icon_animated_XXX APIs won't work.
5090 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5092 * Set animation mode of the icon.
5094 * @param obj The icon object
5095 * @param anim @c EINA_TRUE if the object do animation job,
5096 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5098 * Since the default animation mode is set to EINA_FALSE,
5099 * the icon is shown without animation.
5100 * This might be desirable when the application developer wants to show
5101 * a snapshot of the animated icon.
5102 * Set it to EINA_TRUE when the icon needs to be animated.
5105 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5107 * Get animation mode of the icon.
5109 * @param obj The icon object
5110 * @return The animation mode of the icon object
5111 * @see elm_icon_animated_set
5114 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5116 * Set animation play mode of the icon.
5118 * @param obj The icon object
5119 * @param play @c EINA_TRUE the object play animation images,
5120 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5122 * To play elm icon's animation, set play to EINA_TURE.
5123 * For example, you make gif player using this set/get API and click event.
5125 * 1. Click event occurs
5126 * 2. Check play flag using elm_icon_animaged_play_get
5127 * 3. If elm icon was playing, set play to EINA_FALSE.
5128 * Then animation will be stopped and vice versa
5131 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5133 * Get animation play mode of the icon.
5135 * @param obj The icon object
5136 * @return The play mode of the icon object
5138 * @see elm_icon_animated_play_get
5141 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5148 * @defgroup Image Image
5150 * @image html img/widget/image/preview-00.png
5151 * @image latex img/widget/image/preview-00.eps
5154 * An object that allows one to load an image file to it. It can be used
5155 * anywhere like any other elementary widget.
5157 * This widget provides most of the functionality provided from @ref Bg or @ref
5158 * Icon, but with a slightly different API (use the one that fits better your
5161 * The features not provided by those two other image widgets are:
5162 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5163 * @li change the object orientation with elm_image_orient_set();
5164 * @li and turning the image editable with elm_image_editable_set().
5166 * Signals that you can add callbacks for are:
5168 * @li @c "clicked" - This is called when a user has clicked the image
5170 * An example of usage for this API follows:
5171 * @li @ref tutorial_image
5180 * @enum _Elm_Image_Orient
5181 * @typedef Elm_Image_Orient
5183 * Possible orientation options for elm_image_orient_set().
5185 * @image html elm_image_orient_set.png
5186 * @image latex elm_image_orient_set.eps width=\textwidth
5190 typedef enum _Elm_Image_Orient
5192 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5193 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5194 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5195 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5196 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5197 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5198 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5199 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5203 * Add a new image to the parent.
5205 * @param parent The parent object
5206 * @return The new object or NULL if it cannot be created
5208 * @see elm_image_file_set()
5212 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5214 * Set the file that will be used as image.
5216 * @param obj The image object
5217 * @param file The path to file that will be used as image
5218 * @param group The group that the image belongs in edje file (if it's an
5221 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5223 * @see elm_image_file_get()
5227 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5229 * Get the file that will be used as image.
5231 * @param obj The image object
5232 * @param file The path to file
5233 * @param group The group that the image belongs in edje file
5235 * @see elm_image_file_set()
5239 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5241 * Set the smooth effect for an image.
5243 * @param obj The image object
5244 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5245 * otherwise. Default is @c EINA_TRUE.
5247 * Set the scaling algorithm to be used when scaling the image. Smooth
5248 * scaling provides a better resulting image, but is slower.
5250 * The smooth scaling should be disabled when making animations that change
5251 * the image size, since it will be faster. Animations that don't require
5252 * resizing of the image can keep the smooth scaling enabled (even if the
5253 * image is already scaled, since the scaled image will be cached).
5255 * @see elm_image_smooth_get()
5259 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5261 * Get the smooth effect for an image.
5263 * @param obj The image object
5264 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5266 * @see elm_image_smooth_get()
5270 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5273 * Gets the current size of the image.
5275 * @param obj The image object.
5276 * @param w Pointer to store width, or NULL.
5277 * @param h Pointer to store height, or NULL.
5279 * This is the real size of the image, not the size of the object.
5281 * On error, neither w or h will be written.
5285 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5287 * Disable scaling of this object.
5289 * @param obj The image object.
5290 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5291 * otherwise. Default is @c EINA_FALSE.
5293 * This function disables scaling of the elm_image widget through the
5294 * function elm_object_scale_set(). However, this does not affect the widget
5295 * size/resize in any way. For that effect, take a look at
5296 * elm_image_scale_set().
5298 * @see elm_image_no_scale_get()
5299 * @see elm_image_scale_set()
5300 * @see elm_object_scale_set()
5304 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5306 * Get whether scaling is disabled on the object.
5308 * @param obj The image object
5309 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5311 * @see elm_image_no_scale_set()
5315 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5317 * Set if the object is (up/down) resizable.
5319 * @param obj The image object
5320 * @param scale_up A bool to set if the object is resizable up. Default is
5322 * @param scale_down A bool to set if the object is resizable down. Default
5325 * This function limits the image resize ability. If @p scale_up is set to
5326 * @c EINA_FALSE, the object can't have its height or width resized to a value
5327 * higher than the original image size. Same is valid for @p scale_down.
5329 * @see elm_image_scale_get()
5333 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5335 * Get if the object is (up/down) resizable.
5337 * @param obj The image object
5338 * @param scale_up A bool to set if the object is resizable up
5339 * @param scale_down A bool to set if the object is resizable down
5341 * @see elm_image_scale_set()
5345 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5347 * Set if the image fills the entire object area, when keeping the aspect ratio.
5349 * @param obj The image object
5350 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5351 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5353 * When the image should keep its aspect ratio even if resized to another
5354 * aspect ratio, there are two possibilities to resize it: keep the entire
5355 * image inside the limits of height and width of the object (@p fill_outside
5356 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5357 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5359 * @note This option will have no effect if
5360 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5362 * @see elm_image_fill_outside_get()
5363 * @see elm_image_aspect_ratio_retained_set()
5367 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5369 * Get if the object is filled outside
5371 * @param obj The image object
5372 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5374 * @see elm_image_fill_outside_set()
5378 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5380 * Set the prescale size for the image
5382 * @param obj The image object
5383 * @param size The prescale size. This value is used for both width and
5386 * This function sets a new size for pixmap representation of the given
5387 * image. It allows the image to be loaded already in the specified size,
5388 * reducing the memory usage and load time when loading a big image with load
5389 * size set to a smaller size.
5391 * It's equivalent to the elm_bg_load_size_set() function for bg.
5393 * @note this is just a hint, the real size of the pixmap may differ
5394 * depending on the type of image being loaded, being bigger than requested.
5396 * @see elm_image_prescale_get()
5397 * @see elm_bg_load_size_set()
5401 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5403 * Get the prescale size for the image
5405 * @param obj The image object
5406 * @return The prescale size
5408 * @see elm_image_prescale_set()
5412 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5414 * Set the image orientation.
5416 * @param obj The image object
5417 * @param orient The image orientation @ref Elm_Image_Orient
5418 * Default is #ELM_IMAGE_ORIENT_NONE.
5420 * This function allows to rotate or flip the given image.
5422 * @see elm_image_orient_get()
5423 * @see @ref Elm_Image_Orient
5427 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5429 * Get the image orientation.
5431 * @param obj The image object
5432 * @return The image orientation @ref Elm_Image_Orient
5434 * @see elm_image_orient_set()
5435 * @see @ref Elm_Image_Orient
5439 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5441 * Make the image 'editable'.
5443 * @param obj Image object.
5444 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5446 * This means the image is a valid drag target for drag and drop, and can be
5447 * cut or pasted too.
5451 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5453 * Check if the image 'editable'.
5455 * @param obj Image object.
5456 * @return Editability.
5458 * A return value of EINA_TRUE means the image is a valid drag target
5459 * for drag and drop, and can be cut or pasted too.
5463 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5465 * Get the basic Evas_Image object from this object (widget).
5467 * @param obj The image object to get the inlined image from
5468 * @return The inlined image object, or NULL if none exists
5470 * This function allows one to get the underlying @c Evas_Object of type
5471 * Image from this elementary widget. It can be useful to do things like get
5472 * the pixel data, save the image to a file, etc.
5474 * @note Be careful to not manipulate it, as it is under control of
5479 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5481 * Set whether the original aspect ratio of the image should be kept on resize.
5483 * @param obj The image object.
5484 * @param retained @c EINA_TRUE if the image should retain the aspect,
5485 * @c EINA_FALSE otherwise.
5487 * The original aspect ratio (width / height) of the image is usually
5488 * distorted to match the object's size. Enabling this option will retain
5489 * this original aspect, and the way that the image is fit into the object's
5490 * area depends on the option set by elm_image_fill_outside_set().
5492 * @see elm_image_aspect_ratio_retained_get()
5493 * @see elm_image_fill_outside_set()
5497 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5499 * Get if the object retains the original aspect ratio.
5501 * @param obj The image object.
5502 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5507 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5514 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5516 typedef enum _Elm_GLView_Mode
5518 ELM_GLVIEW_ALPHA = 1,
5519 ELM_GLVIEW_DEPTH = 2,
5520 ELM_GLVIEW_STENCIL = 4
5524 * Defines a policy for the glview resizing.
5526 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5528 typedef enum _Elm_GLView_Resize_Policy
5530 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5531 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5532 } Elm_GLView_Resize_Policy;
5534 typedef enum _Elm_GLView_Render_Policy
5536 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5537 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5538 } Elm_GLView_Render_Policy;
5543 * A simple GLView widget that allows GL rendering.
5545 * Signals that you can add callbacks for are:
5551 * Add a new glview to the parent
5553 * @param parent The parent object
5554 * @return The new object or NULL if it cannot be created
5558 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5561 * Sets the size of the glview
5563 * @param obj The glview object
5564 * @param width width of the glview object
5565 * @param height height of the glview object
5569 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5572 * Gets the size of the glview.
5574 * @param obj The glview object
5575 * @param width width of the glview object
5576 * @param height height of the glview object
5578 * Note that this function returns the actual image size of the
5579 * glview. This means that when the scale policy is set to
5580 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5585 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5588 * Gets the gl api struct for gl rendering
5590 * @param obj The glview object
5591 * @return The api object or NULL if it cannot be created
5595 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5598 * Set the mode of the GLView. Supports Three simple modes.
5600 * @param obj The glview object
5601 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5602 * @return True if set properly.
5606 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5609 * Set the resize policy for the glview object.
5611 * @param obj The glview object.
5612 * @param policy The scaling policy.
5614 * By default, the resize policy is set to
5615 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5616 * destroys the previous surface and recreates the newly specified
5617 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5618 * however, glview only scales the image object and not the underlying
5623 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5626 * Set the render policy for the glview object.
5628 * @param obj The glview object.
5629 * @param policy The render policy.
5631 * By default, the render policy is set to
5632 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5633 * that during the render loop, glview is only redrawn if it needs
5634 * to be redrawn. (i.e. When it is visible) If the policy is set to
5635 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5636 * whether it is visible/need redrawing or not.
5640 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5643 * Set the init function that runs once in the main loop.
5645 * @param obj The glview object.
5646 * @param func The init function to be registered.
5648 * The registered init function gets called once during the render loop.
5652 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5655 * Set the render function that runs in the main loop.
5657 * @param obj The glview object.
5658 * @param func The delete function to be registered.
5660 * The registered del function gets called when GLView object is deleted.
5664 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5667 * Set the resize function that gets called when resize happens.
5669 * @param obj The glview object.
5670 * @param func The resize function to be registered.
5674 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5677 * Set the render function that runs in the main loop.
5679 * @param obj The glview object.
5680 * @param func The render function to be registered.
5684 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5687 * Notifies that there has been changes in the GLView.
5689 * @param obj The glview object.
5693 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5703 * @image html img/widget/box/preview-00.png
5704 * @image latex img/widget/box/preview-00.eps width=\textwidth
5706 * @image html img/box.png
5707 * @image latex img/box.eps width=\textwidth
5709 * A box arranges objects in a linear fashion, governed by a layout function
5710 * that defines the details of this arrangement.
5712 * By default, the box will use an internal function to set the layout to
5713 * a single row, either vertical or horizontal. This layout is affected
5714 * by a number of parameters, such as the homogeneous flag set by
5715 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5716 * elm_box_align_set() and the hints set to each object in the box.
5718 * For this default layout, it's possible to change the orientation with
5719 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5720 * placing its elements ordered from top to bottom. When horizontal is set,
5721 * the order will go from left to right. If the box is set to be
5722 * homogeneous, every object in it will be assigned the same space, that
5723 * of the largest object. Padding can be used to set some spacing between
5724 * the cell given to each object. The alignment of the box, set with
5725 * elm_box_align_set(), determines how the bounding box of all the elements
5726 * will be placed within the space given to the box widget itself.
5728 * The size hints of each object also affect how they are placed and sized
5729 * within the box. evas_object_size_hint_min_set() will give the minimum
5730 * size the object can have, and the box will use it as the basis for all
5731 * latter calculations. Elementary widgets set their own minimum size as
5732 * needed, so there's rarely any need to use it manually.
5734 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5735 * used to tell whether the object will be allocated the minimum size it
5736 * needs or if the space given to it should be expanded. It's important
5737 * to realize that expanding the size given to the object is not the same
5738 * thing as resizing the object. It could very well end being a small
5739 * widget floating in a much larger empty space. If not set, the weight
5740 * for objects will normally be 0.0 for both axis, meaning the widget will
5741 * not be expanded. To take as much space possible, set the weight to
5742 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5744 * Besides how much space each object is allocated, it's possible to control
5745 * how the widget will be placed within that space using
5746 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5747 * for both axis, meaning the object will be centered, but any value from
5748 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5749 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5750 * is -1.0, means the object will be resized to fill the entire space it
5753 * In addition, customized functions to define the layout can be set, which
5754 * allow the application developer to organize the objects within the box
5755 * in any number of ways.
5757 * The special elm_box_layout_transition() function can be used
5758 * to switch from one layout to another, animating the motion of the
5759 * children of the box.
5761 * @note Objects should not be added to box objects using _add() calls.
5763 * Some examples on how to use boxes follow:
5764 * @li @ref box_example_01
5765 * @li @ref box_example_02
5770 * @typedef Elm_Box_Transition
5772 * Opaque handler containing the parameters to perform an animated
5773 * transition of the layout the box uses.
5775 * @see elm_box_transition_new()
5776 * @see elm_box_layout_set()
5777 * @see elm_box_layout_transition()
5779 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5782 * Add a new box to the parent
5784 * By default, the box will be in vertical mode and non-homogeneous.
5786 * @param parent The parent object
5787 * @return The new object or NULL if it cannot be created
5789 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5791 * Set the horizontal orientation
5793 * By default, box object arranges their contents vertically from top to
5795 * By calling this function with @p horizontal as EINA_TRUE, the box will
5796 * become horizontal, arranging contents from left to right.
5798 * @note This flag is ignored if a custom layout function is set.
5800 * @param obj The box object
5801 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5802 * EINA_FALSE = vertical)
5804 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5806 * Get the horizontal orientation
5808 * @param obj The box object
5809 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5811 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5813 * Set the box to arrange its children homogeneously
5815 * If enabled, homogeneous layout makes all items the same size, according
5816 * to the size of the largest of its children.
5818 * @note This flag is ignored if a custom layout function is set.
5820 * @param obj The box object
5821 * @param homogeneous The homogeneous flag
5823 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5825 * Get whether the box is using homogeneous mode or not
5827 * @param obj The box object
5828 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5830 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5831 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5832 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5834 * Add an object to the beginning of the pack list
5836 * Pack @p subobj into the box @p obj, placing it first in the list of
5837 * children objects. The actual position the object will get on screen
5838 * depends on the layout used. If no custom layout is set, it will be at
5839 * the top or left, depending if the box is vertical or horizontal,
5842 * @param obj The box object
5843 * @param subobj The object to add to the box
5845 * @see elm_box_pack_end()
5846 * @see elm_box_pack_before()
5847 * @see elm_box_pack_after()
5848 * @see elm_box_unpack()
5849 * @see elm_box_unpack_all()
5850 * @see elm_box_clear()
5852 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5854 * Add an object at the end of the pack list
5856 * Pack @p subobj into the box @p obj, placing it last in the list of
5857 * children objects. The actual position the object will get on screen
5858 * depends on the layout used. If no custom layout is set, it will be at
5859 * the bottom or right, depending if the box is vertical or horizontal,
5862 * @param obj The box object
5863 * @param subobj The object to add to the box
5865 * @see elm_box_pack_start()
5866 * @see elm_box_pack_before()
5867 * @see elm_box_pack_after()
5868 * @see elm_box_unpack()
5869 * @see elm_box_unpack_all()
5870 * @see elm_box_clear()
5872 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5874 * Adds an object to the box before the indicated object
5876 * This will add the @p subobj to the box indicated before the object
5877 * indicated with @p before. If @p before is not already in the box, results
5878 * are undefined. Before means either to the left of the indicated object or
5879 * above it depending on orientation.
5881 * @param obj The box object
5882 * @param subobj The object to add to the box
5883 * @param before The object before which to add it
5885 * @see elm_box_pack_start()
5886 * @see elm_box_pack_end()
5887 * @see elm_box_pack_after()
5888 * @see elm_box_unpack()
5889 * @see elm_box_unpack_all()
5890 * @see elm_box_clear()
5892 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5894 * Adds an object to the box after the indicated object
5896 * This will add the @p subobj to the box indicated after the object
5897 * indicated with @p after. If @p after is not already in the box, results
5898 * are undefined. After means either to the right of the indicated object or
5899 * below it depending on orientation.
5901 * @param obj The box object
5902 * @param subobj The object to add to the box
5903 * @param after The object after which to add it
5905 * @see elm_box_pack_start()
5906 * @see elm_box_pack_end()
5907 * @see elm_box_pack_before()
5908 * @see elm_box_unpack()
5909 * @see elm_box_unpack_all()
5910 * @see elm_box_clear()
5912 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5914 * Clear the box of all children
5916 * Remove all the elements contained by the box, deleting the respective
5919 * @param obj The box object
5921 * @see elm_box_unpack()
5922 * @see elm_box_unpack_all()
5924 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5928 * Remove the object given by @p subobj from the box @p obj without
5931 * @param obj The box object
5933 * @see elm_box_unpack_all()
5934 * @see elm_box_clear()
5936 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5938 * Remove all items from the box, without deleting them
5940 * Clear the box from all children, but don't delete the respective objects.
5941 * If no other references of the box children exist, the objects will never
5942 * be deleted, and thus the application will leak the memory. Make sure
5943 * when using this function that you hold a reference to all the objects
5944 * in the box @p obj.
5946 * @param obj The box object
5948 * @see elm_box_clear()
5949 * @see elm_box_unpack()
5951 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5953 * Retrieve a list of the objects packed into the box
5955 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5956 * The order of the list corresponds to the packing order the box uses.
5958 * You must free this list with eina_list_free() once you are done with it.
5960 * @param obj The box object
5962 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5964 * Set the space (padding) between the box's elements.
5966 * Extra space in pixels that will be added between a box child and its
5967 * neighbors after its containing cell has been calculated. This padding
5968 * is set for all elements in the box, besides any possible padding that
5969 * individual elements may have through their size hints.
5971 * @param obj The box object
5972 * @param horizontal The horizontal space between elements
5973 * @param vertical The vertical space between elements
5975 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5977 * Get the space (padding) between the box's elements.
5979 * @param obj The box object
5980 * @param horizontal The horizontal space between elements
5981 * @param vertical The vertical space between elements
5983 * @see elm_box_padding_set()
5985 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5987 * Set the alignment of the whole bouding box of contents.
5989 * Sets how the bounding box containing all the elements of the box, after
5990 * their sizes and position has been calculated, will be aligned within
5991 * the space given for the whole box widget.
5993 * @param obj The box object
5994 * @param horizontal The horizontal alignment of elements
5995 * @param vertical The vertical alignment of elements
5997 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5999 * Get the alignment of the whole bouding box of contents.
6001 * @param obj The box object
6002 * @param horizontal The horizontal alignment of elements
6003 * @param vertical The vertical alignment of elements
6005 * @see elm_box_align_set()
6007 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6010 * Force the box to recalculate its children packing.
6012 * If any children was added or removed, box will not calculate the
6013 * values immediately rather leaving it to the next main loop
6014 * iteration. While this is great as it would save lots of
6015 * recalculation, whenever you need to get the position of a just
6016 * added item you must force recalculate before doing so.
6018 * @param obj The box object.
6020 EAPI void elm_box_recalculate(Evas_Object *obj);
6023 * Set the layout defining function to be used by the box
6025 * Whenever anything changes that requires the box in @p obj to recalculate
6026 * the size and position of its elements, the function @p cb will be called
6027 * to determine what the layout of the children will be.
6029 * Once a custom function is set, everything about the children layout
6030 * is defined by it. The flags set by elm_box_horizontal_set() and
6031 * elm_box_homogeneous_set() no longer have any meaning, and the values
6032 * given by elm_box_padding_set() and elm_box_align_set() are up to this
6033 * layout function to decide if they are used and how. These last two
6034 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6035 * passed to @p cb. The @c Evas_Object the function receives is not the
6036 * Elementary widget, but the internal Evas Box it uses, so none of the
6037 * functions described here can be used on it.
6039 * Any of the layout functions in @c Evas can be used here, as well as the
6040 * special elm_box_layout_transition().
6042 * The final @p data argument received by @p cb is the same @p data passed
6043 * here, and the @p free_data function will be called to free it
6044 * whenever the box is destroyed or another layout function is set.
6046 * Setting @p cb to NULL will revert back to the default layout function.
6048 * @param obj The box object
6049 * @param cb The callback function used for layout
6050 * @param data Data that will be passed to layout function
6051 * @param free_data Function called to free @p data
6053 * @see elm_box_layout_transition()
6055 EAPI void elm_box_layout_set(Evas_Object *obj, Evas_Object_Box_Layout cb, const void *data, void (*free_data)(void *data)) EINA_ARG_NONNULL(1);
6057 * Special layout function that animates the transition from one layout to another
6059 * Normally, when switching the layout function for a box, this will be
6060 * reflected immediately on screen on the next render, but it's also
6061 * possible to do this through an animated transition.
6063 * This is done by creating an ::Elm_Box_Transition and setting the box
6064 * layout to this function.
6068 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6069 * evas_object_box_layout_vertical, // start
6070 * NULL, // data for initial layout
6071 * NULL, // free function for initial data
6072 * evas_object_box_layout_horizontal, // end
6073 * NULL, // data for final layout
6074 * NULL, // free function for final data
6075 * anim_end, // will be called when animation ends
6076 * NULL); // data for anim_end function\
6077 * elm_box_layout_set(box, elm_box_layout_transition, t,
6078 * elm_box_transition_free);
6081 * @note This function can only be used with elm_box_layout_set(). Calling
6082 * it directly will not have the expected results.
6084 * @see elm_box_transition_new
6085 * @see elm_box_transition_free
6086 * @see elm_box_layout_set
6088 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6090 * Create a new ::Elm_Box_Transition to animate the switch of layouts
6092 * If you want to animate the change from one layout to another, you need
6093 * to set the layout function of the box to elm_box_layout_transition(),
6094 * passing as user data to it an instance of ::Elm_Box_Transition with the
6095 * necessary information to perform this animation. The free function to
6096 * set for the layout is elm_box_transition_free().
6098 * The parameters to create an ::Elm_Box_Transition sum up to how long
6099 * will it be, in seconds, a layout function to describe the initial point,
6100 * another for the final position of the children and one function to be
6101 * called when the whole animation ends. This last function is useful to
6102 * set the definitive layout for the box, usually the same as the end
6103 * layout for the animation, but could be used to start another transition.
6105 * @param start_layout The layout function that will be used to start the animation
6106 * @param start_layout_data The data to be passed the @p start_layout function
6107 * @param start_layout_free_data Function to free @p start_layout_data
6108 * @param end_layout The layout function that will be used to end the animation
6109 * @param end_layout_free_data The data to be passed the @p end_layout function
6110 * @param end_layout_free_data Function to free @p end_layout_data
6111 * @param transition_end_cb Callback function called when animation ends
6112 * @param transition_end_data Data to be passed to @p transition_end_cb
6113 * @return An instance of ::Elm_Box_Transition
6115 * @see elm_box_transition_new
6116 * @see elm_box_layout_transition
6118 EAPI Elm_Box_Transition *elm_box_transition_new(const double duration, Evas_Object_Box_Layout start_layout, void *start_layout_data, void(*start_layout_free_data)(void *data), Evas_Object_Box_Layout end_layout, void *end_layout_data, void(*end_layout_free_data)(void *data), void(*transition_end_cb)(void *data), void *transition_end_data) EINA_ARG_NONNULL(2, 5);
6120 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6122 * This function is mostly useful as the @c free_data parameter in
6123 * elm_box_layout_set() when elm_box_layout_transition().
6125 * @param data The Elm_Box_Transition instance to be freed.
6127 * @see elm_box_transition_new
6128 * @see elm_box_layout_transition
6130 EAPI void elm_box_transition_free(void *data);
6137 * @defgroup Button Button
6139 * @image html img/widget/button/preview-00.png
6140 * @image latex img/widget/button/preview-00.eps
6141 * @image html img/widget/button/preview-01.png
6142 * @image latex img/widget/button/preview-01.eps
6143 * @image html img/widget/button/preview-02.png
6144 * @image latex img/widget/button/preview-02.eps
6146 * This is a push-button. Press it and run some function. It can contain
6147 * a simple label and icon object and it also has an autorepeat feature.
6149 * This widgets emits the following signals:
6150 * @li "clicked": the user clicked the button (press/release).
6151 * @li "repeated": the user pressed the button without releasing it.
6152 * @li "pressed": button was pressed.
6153 * @li "unpressed": button was released after being pressed.
6154 * In all three cases, the @c event parameter of the callback will be
6157 * Also, defined in the default theme, the button has the following styles
6159 * @li default: a normal button.
6160 * @li anchor: Like default, but the button fades away when the mouse is not
6161 * over it, leaving only the text or icon.
6162 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6163 * continuous look across its options.
6164 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6166 * Default contents parts of the button widget that you can use for are:
6167 * @li "elm.swallow.content" - A icon of the button
6169 * Default text parts of the button widget that you can use for are:
6170 * @li "elm.text" - Label of the button
6172 * Follow through a complete example @ref button_example_01 "here".
6176 * Add a new button to the parent's canvas
6178 * @param parent The parent object
6179 * @return The new object or NULL if it cannot be created
6181 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6183 * Set the label used in the button
6185 * The passed @p label can be NULL to clean any existing text in it and
6186 * leave the button as an icon only object.
6188 * @param obj The button object
6189 * @param label The text will be written on the button
6190 * @deprecated use elm_object_text_set() instead.
6192 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6194 * Get the label set for the button
6196 * The string returned is an internal pointer and should not be freed or
6197 * altered. It will also become invalid when the button is destroyed.
6198 * The string returned, if not NULL, is a stringshare, so if you need to
6199 * keep it around even after the button is destroyed, you can use
6200 * eina_stringshare_ref().
6202 * @param obj The button object
6203 * @return The text set to the label, or NULL if nothing is set
6204 * @deprecated use elm_object_text_set() instead.
6206 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6208 * Set the icon used for the button
6210 * Setting a new icon will delete any other that was previously set, making
6211 * any reference to them invalid. If you need to maintain the previous
6212 * object alive, unset it first with elm_button_icon_unset().
6214 * @param obj The button object
6215 * @param icon The icon object for the button
6217 EINA_DEPRECATED EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6219 * Get the icon used for the button
6221 * Return the icon object which is set for this widget. If the button is
6222 * destroyed or another icon is set, the returned object will be deleted
6223 * and any reference to it will be invalid.
6225 * @param obj The button object
6226 * @return The icon object that is being used
6228 * @see elm_button_icon_unset()
6230 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6232 * Remove the icon set without deleting it and return the object
6234 * This function drops the reference the button holds of the icon object
6235 * and returns this last object. It is used in case you want to remove any
6236 * icon, or set another one, without deleting the actual object. The button
6237 * will be left without an icon set.
6239 * @param obj The button object
6240 * @return The icon object that was being used
6242 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6244 * Turn on/off the autorepeat event generated when the button is kept pressed
6246 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6247 * signal when they are clicked.
6249 * When on, keeping a button pressed will continuously emit a @c repeated
6250 * signal until the button is released. The time it takes until it starts
6251 * emitting the signal is given by
6252 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6253 * new emission by elm_button_autorepeat_gap_timeout_set().
6255 * @param obj The button object
6256 * @param on A bool to turn on/off the event
6258 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6260 * Get whether the autorepeat feature is enabled
6262 * @param obj The button object
6263 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6265 * @see elm_button_autorepeat_set()
6267 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6269 * Set the initial timeout before the autorepeat event is generated
6271 * Sets the timeout, in seconds, since the button is pressed until the
6272 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6273 * won't be any delay and the even will be fired the moment the button is
6276 * @param obj The button object
6277 * @param t Timeout in seconds
6279 * @see elm_button_autorepeat_set()
6280 * @see elm_button_autorepeat_gap_timeout_set()
6282 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6284 * Get the initial timeout before the autorepeat event is generated
6286 * @param obj The button object
6287 * @return Timeout in seconds
6289 * @see elm_button_autorepeat_initial_timeout_set()
6291 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6293 * Set the interval between each generated autorepeat event
6295 * After the first @c repeated event is fired, all subsequent ones will
6296 * follow after a delay of @p t seconds for each.
6298 * @param obj The button object
6299 * @param t Interval in seconds
6301 * @see elm_button_autorepeat_initial_timeout_set()
6303 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6305 * Get the interval between each generated autorepeat event
6307 * @param obj The button object
6308 * @return Interval in seconds
6310 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6316 * @defgroup File_Selector_Button File Selector Button
6318 * @image html img/widget/fileselector_button/preview-00.png
6319 * @image latex img/widget/fileselector_button/preview-00.eps
6320 * @image html img/widget/fileselector_button/preview-01.png
6321 * @image latex img/widget/fileselector_button/preview-01.eps
6322 * @image html img/widget/fileselector_button/preview-02.png
6323 * @image latex img/widget/fileselector_button/preview-02.eps
6325 * This is a button that, when clicked, creates an Elementary
6326 * window (or inner window) <b> with a @ref Fileselector "file
6327 * selector widget" within</b>. When a file is chosen, the (inner)
6328 * window is closed and the button emits a signal having the
6329 * selected file as it's @c event_info.
6331 * This widget encapsulates operations on its internal file
6332 * selector on its own API. There is less control over its file
6333 * selector than that one would have instatiating one directly.
6335 * The following styles are available for this button:
6338 * @li @c "hoversel_vertical"
6339 * @li @c "hoversel_vertical_entry"
6341 * Smart callbacks one can register to:
6342 * - @c "file,chosen" - the user has selected a path, whose string
6343 * pointer comes as the @c event_info data (a stringshared
6346 * Here is an example on its usage:
6347 * @li @ref fileselector_button_example
6349 * @see @ref File_Selector_Entry for a similar widget.
6354 * Add a new file selector button widget to the given parent
6355 * Elementary (container) object
6357 * @param parent The parent object
6358 * @return a new file selector button widget handle or @c NULL, on
6361 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6364 * Set the label for a given file selector button widget
6366 * @param obj The file selector button widget
6367 * @param label The text label to be displayed on @p obj
6369 * @deprecated use elm_object_text_set() instead.
6371 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6374 * Get the label set for a given file selector button widget
6376 * @param obj The file selector button widget
6377 * @return The button label
6379 * @deprecated use elm_object_text_set() instead.
6381 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6384 * Set the icon on a given file selector button widget
6386 * @param obj The file selector button widget
6387 * @param icon The icon object for the button
6389 * Once the icon object is set, a previously set one will be
6390 * deleted. If you want to keep the latter, use the
6391 * elm_fileselector_button_icon_unset() function.
6393 * @see elm_fileselector_button_icon_get()
6395 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6398 * Get the icon set for a given file selector button widget
6400 * @param obj The file selector button widget
6401 * @return The icon object currently set on @p obj or @c NULL, if
6404 * @see elm_fileselector_button_icon_set()
6406 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6409 * Unset the icon used in a given file selector button widget
6411 * @param obj The file selector button widget
6412 * @return The icon object that was being used on @p obj or @c
6415 * Unparent and return the icon object which was set for this
6418 * @see elm_fileselector_button_icon_set()
6420 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6423 * Set the title for a given file selector button widget's window
6425 * @param obj The file selector button widget
6426 * @param title The title string
6428 * This will change the window's title, when the file selector pops
6429 * out after a click on the button. Those windows have the default
6430 * (unlocalized) value of @c "Select a file" as titles.
6432 * @note It will only take any effect if the file selector
6433 * button widget is @b not under "inwin mode".
6435 * @see elm_fileselector_button_window_title_get()
6437 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6440 * Get the title set for a given file selector button widget's
6443 * @param obj The file selector button widget
6444 * @return Title of the file selector button's window
6446 * @see elm_fileselector_button_window_title_get() for more details
6448 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6451 * Set the size of a given file selector button widget's window,
6452 * holding the file selector itself.
6454 * @param obj The file selector button widget
6455 * @param width The window's width
6456 * @param height The window's height
6458 * @note it will only take any effect if the file selector button
6459 * widget is @b not under "inwin mode". The default size for the
6460 * window (when applicable) is 400x400 pixels.
6462 * @see elm_fileselector_button_window_size_get()
6464 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6467 * Get the size of a given file selector button widget's window,
6468 * holding the file selector itself.
6470 * @param obj The file selector button widget
6471 * @param width Pointer into which to store the width value
6472 * @param height Pointer into which to store the height value
6474 * @note Use @c NULL pointers on the size values you're not
6475 * interested in: they'll be ignored by the function.
6477 * @see elm_fileselector_button_window_size_set(), for more details
6479 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6482 * Set the initial file system path for a given file selector
6485 * @param obj The file selector button widget
6486 * @param path The path string
6488 * It must be a <b>directory</b> path, which will have the contents
6489 * displayed initially in the file selector's view, when invoked
6490 * from @p obj. The default initial path is the @c "HOME"
6491 * environment variable's value.
6493 * @see elm_fileselector_button_path_get()
6495 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6498 * Get the initial file system path set for a given file selector
6501 * @param obj The file selector button widget
6502 * @return path The path string
6504 * @see elm_fileselector_button_path_set() for more details
6506 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6509 * Enable/disable a tree view in the given file selector button
6510 * widget's internal file selector
6512 * @param obj The file selector button widget
6513 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6516 * This has the same effect as elm_fileselector_expandable_set(),
6517 * but now applied to a file selector button's internal file
6520 * @note There's no way to put a file selector button's internal
6521 * file selector in "grid mode", as one may do with "pure" file
6524 * @see elm_fileselector_expandable_get()
6526 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6529 * Get whether tree view is enabled for the given file selector
6530 * button widget's internal file selector
6532 * @param obj The file selector button widget
6533 * @return @c EINA_TRUE if @p obj widget's internal file selector
6534 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6536 * @see elm_fileselector_expandable_set() for more details
6538 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6541 * Set whether a given file selector button widget's internal file
6542 * selector is to display folders only or the directory contents,
6545 * @param obj The file selector button widget
6546 * @param only @c EINA_TRUE to make @p obj widget's internal file
6547 * selector only display directories, @c EINA_FALSE to make files
6548 * to be displayed in it too
6550 * This has the same effect as elm_fileselector_folder_only_set(),
6551 * but now applied to a file selector button's internal file
6554 * @see elm_fileselector_folder_only_get()
6556 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6559 * Get whether a given file selector button widget's internal file
6560 * selector is displaying folders only or the directory contents,
6563 * @param obj The file selector button widget
6564 * @return @c EINA_TRUE if @p obj widget's internal file
6565 * selector is only displaying directories, @c EINA_FALSE if files
6566 * are being displayed in it too (and on errors)
6568 * @see elm_fileselector_button_folder_only_set() for more details
6570 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6573 * Enable/disable the file name entry box where the user can type
6574 * in a name for a file, in a given file selector button widget's
6575 * internal file selector.
6577 * @param obj The file selector button widget
6578 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6579 * file selector a "saving dialog", @c EINA_FALSE otherwise
6581 * This has the same effect as elm_fileselector_is_save_set(),
6582 * but now applied to a file selector button's internal file
6585 * @see elm_fileselector_is_save_get()
6587 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6590 * Get whether the given file selector button widget's internal
6591 * file selector is in "saving dialog" mode
6593 * @param obj The file selector button widget
6594 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6595 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6598 * @see elm_fileselector_button_is_save_set() for more details
6600 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6603 * Set whether a given file selector button widget's internal file
6604 * selector will raise an Elementary "inner window", instead of a
6605 * dedicated Elementary window. By default, it won't.
6607 * @param obj The file selector button widget
6608 * @param value @c EINA_TRUE to make it use an inner window, @c
6609 * EINA_TRUE to make it use a dedicated window
6611 * @see elm_win_inwin_add() for more information on inner windows
6612 * @see elm_fileselector_button_inwin_mode_get()
6614 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6617 * Get whether a given file selector button widget's internal file
6618 * selector will raise an Elementary "inner window", instead of a
6619 * dedicated Elementary window.
6621 * @param obj The file selector button widget
6622 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6623 * if it will use a dedicated window
6625 * @see elm_fileselector_button_inwin_mode_set() for more details
6627 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6634 * @defgroup File_Selector_Entry File Selector Entry
6636 * @image html img/widget/fileselector_entry/preview-00.png
6637 * @image latex img/widget/fileselector_entry/preview-00.eps
6639 * This is an entry made to be filled with or display a <b>file
6640 * system path string</b>. Besides the entry itself, the widget has
6641 * a @ref File_Selector_Button "file selector button" on its side,
6642 * which will raise an internal @ref Fileselector "file selector widget",
6643 * when clicked, for path selection aided by file system
6646 * This file selector may appear in an Elementary window or in an
6647 * inner window. When a file is chosen from it, the (inner) window
6648 * is closed and the selected file's path string is exposed both as
6649 * an smart event and as the new text on the entry.
6651 * This widget encapsulates operations on its internal file
6652 * selector on its own API. There is less control over its file
6653 * selector than that one would have instatiating one directly.
6655 * Smart callbacks one can register to:
6656 * - @c "changed" - The text within the entry was changed
6657 * - @c "activated" - The entry has had editing finished and
6658 * changes are to be "committed"
6659 * - @c "press" - The entry has been clicked
6660 * - @c "longpressed" - The entry has been clicked (and held) for a
6662 * - @c "clicked" - The entry has been clicked
6663 * - @c "clicked,double" - The entry has been double clicked
6664 * - @c "focused" - The entry has received focus
6665 * - @c "unfocused" - The entry has lost focus
6666 * - @c "selection,paste" - A paste action has occurred on the
6668 * - @c "selection,copy" - A copy action has occurred on the entry
6669 * - @c "selection,cut" - A cut action has occurred on the entry
6670 * - @c "unpressed" - The file selector entry's button was released
6671 * after being pressed.
6672 * - @c "file,chosen" - The user has selected a path via the file
6673 * selector entry's internal file selector, whose string pointer
6674 * comes as the @c event_info data (a stringshared string)
6676 * Here is an example on its usage:
6677 * @li @ref fileselector_entry_example
6679 * @see @ref File_Selector_Button for a similar widget.
6684 * Add a new file selector entry widget to the given parent
6685 * Elementary (container) object
6687 * @param parent The parent object
6688 * @return a new file selector entry widget handle or @c NULL, on
6691 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6694 * Set the label for a given file selector entry widget's button
6696 * @param obj The file selector entry widget
6697 * @param label The text label to be displayed on @p obj widget's
6700 * @deprecated use elm_object_text_set() instead.
6702 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6705 * Get the label set for a given file selector entry widget's button
6707 * @param obj The file selector entry widget
6708 * @return The widget button's label
6710 * @deprecated use elm_object_text_set() instead.
6712 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6715 * Set the icon on a given file selector entry widget's button
6717 * @param obj The file selector entry widget
6718 * @param icon The icon object for the entry's button
6720 * Once the icon object is set, a previously set one will be
6721 * deleted. If you want to keep the latter, use the
6722 * elm_fileselector_entry_button_icon_unset() function.
6724 * @see elm_fileselector_entry_button_icon_get()
6726 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6729 * Get the icon set for a given file selector entry widget's button
6731 * @param obj The file selector entry widget
6732 * @return The icon object currently set on @p obj widget's button
6733 * or @c NULL, if none is
6735 * @see elm_fileselector_entry_button_icon_set()
6737 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6740 * Unset the icon used in a given file selector entry widget's
6743 * @param obj The file selector entry widget
6744 * @return The icon object that was being used on @p obj widget's
6745 * button or @c NULL, on errors
6747 * Unparent and return the icon object which was set for this
6750 * @see elm_fileselector_entry_button_icon_set()
6752 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6755 * Set the title for a given file selector entry widget's window
6757 * @param obj The file selector entry widget
6758 * @param title The title string
6760 * This will change the window's title, when the file selector pops
6761 * out after a click on the entry's button. Those windows have the
6762 * default (unlocalized) value of @c "Select a file" as titles.
6764 * @note It will only take any effect if the file selector
6765 * entry widget is @b not under "inwin mode".
6767 * @see elm_fileselector_entry_window_title_get()
6769 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6772 * Get the title set for a given file selector entry widget's
6775 * @param obj The file selector entry widget
6776 * @return Title of the file selector entry's window
6778 * @see elm_fileselector_entry_window_title_get() for more details
6780 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6783 * Set the size of a given file selector entry widget's window,
6784 * holding the file selector itself.
6786 * @param obj The file selector entry widget
6787 * @param width The window's width
6788 * @param height The window's height
6790 * @note it will only take any effect if the file selector entry
6791 * widget is @b not under "inwin mode". The default size for the
6792 * window (when applicable) is 400x400 pixels.
6794 * @see elm_fileselector_entry_window_size_get()
6796 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6799 * Get the size of a given file selector entry widget's window,
6800 * holding the file selector itself.
6802 * @param obj The file selector entry widget
6803 * @param width Pointer into which to store the width value
6804 * @param height Pointer into which to store the height value
6806 * @note Use @c NULL pointers on the size values you're not
6807 * interested in: they'll be ignored by the function.
6809 * @see elm_fileselector_entry_window_size_set(), for more details
6811 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6814 * Set the initial file system path and the entry's path string for
6815 * a given file selector entry widget
6817 * @param obj The file selector entry widget
6818 * @param path The path string
6820 * It must be a <b>directory</b> path, which will have the contents
6821 * displayed initially in the file selector's view, when invoked
6822 * from @p obj. The default initial path is the @c "HOME"
6823 * environment variable's value.
6825 * @see elm_fileselector_entry_path_get()
6827 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6830 * Get the entry's path string for a given file selector entry
6833 * @param obj The file selector entry widget
6834 * @return path The path string
6836 * @see elm_fileselector_entry_path_set() for more details
6838 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6841 * Enable/disable a tree view in the given file selector entry
6842 * widget's internal file selector
6844 * @param obj The file selector entry widget
6845 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6848 * This has the same effect as elm_fileselector_expandable_set(),
6849 * but now applied to a file selector entry's internal file
6852 * @note There's no way to put a file selector entry's internal
6853 * file selector in "grid mode", as one may do with "pure" file
6856 * @see elm_fileselector_expandable_get()
6858 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6861 * Get whether tree view is enabled for the given file selector
6862 * entry widget's internal file selector
6864 * @param obj The file selector entry widget
6865 * @return @c EINA_TRUE if @p obj widget's internal file selector
6866 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6868 * @see elm_fileselector_expandable_set() for more details
6870 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6873 * Set whether a given file selector entry widget's internal file
6874 * selector is to display folders only or the directory contents,
6877 * @param obj The file selector entry widget
6878 * @param only @c EINA_TRUE to make @p obj widget's internal file
6879 * selector only display directories, @c EINA_FALSE to make files
6880 * to be displayed in it too
6882 * This has the same effect as elm_fileselector_folder_only_set(),
6883 * but now applied to a file selector entry's internal file
6886 * @see elm_fileselector_folder_only_get()
6888 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6891 * Get whether a given file selector entry widget's internal file
6892 * selector is displaying folders only or the directory contents,
6895 * @param obj The file selector entry widget
6896 * @return @c EINA_TRUE if @p obj widget's internal file
6897 * selector is only displaying directories, @c EINA_FALSE if files
6898 * are being displayed in it too (and on errors)
6900 * @see elm_fileselector_entry_folder_only_set() for more details
6902 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6905 * Enable/disable the file name entry box where the user can type
6906 * in a name for a file, in a given file selector entry widget's
6907 * internal file selector.
6909 * @param obj The file selector entry widget
6910 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6911 * file selector a "saving dialog", @c EINA_FALSE otherwise
6913 * This has the same effect as elm_fileselector_is_save_set(),
6914 * but now applied to a file selector entry's internal file
6917 * @see elm_fileselector_is_save_get()
6919 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6922 * Get whether the given file selector entry widget's internal
6923 * file selector is in "saving dialog" mode
6925 * @param obj The file selector entry widget
6926 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6927 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6930 * @see elm_fileselector_entry_is_save_set() for more details
6932 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6935 * Set whether a given file selector entry widget's internal file
6936 * selector will raise an Elementary "inner window", instead of a
6937 * dedicated Elementary window. By default, it won't.
6939 * @param obj The file selector entry widget
6940 * @param value @c EINA_TRUE to make it use an inner window, @c
6941 * EINA_TRUE to make it use a dedicated window
6943 * @see elm_win_inwin_add() for more information on inner windows
6944 * @see elm_fileselector_entry_inwin_mode_get()
6946 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6949 * Get whether a given file selector entry widget's internal file
6950 * selector will raise an Elementary "inner window", instead of a
6951 * dedicated Elementary window.
6953 * @param obj The file selector entry widget
6954 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6955 * if it will use a dedicated window
6957 * @see elm_fileselector_entry_inwin_mode_set() for more details
6959 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6962 * Set the initial file system path for a given file selector entry
6965 * @param obj The file selector entry widget
6966 * @param path The path string
6968 * It must be a <b>directory</b> path, which will have the contents
6969 * displayed initially in the file selector's view, when invoked
6970 * from @p obj. The default initial path is the @c "HOME"
6971 * environment variable's value.
6973 * @see elm_fileselector_entry_path_get()
6975 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6978 * Get the parent directory's path to the latest file selection on
6979 * a given filer selector entry widget
6981 * @param obj The file selector object
6982 * @return The (full) path of the directory of the last selection
6983 * on @p obj widget, a @b stringshared string
6985 * @see elm_fileselector_entry_path_set()
6987 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6994 * @defgroup Scroller Scroller
6996 * A scroller holds a single object and "scrolls it around". This means that
6997 * it allows the user to use a scrollbar (or a finger) to drag the viewable
6998 * region around, allowing to move through a much larger object that is
6999 * contained in the scroller. The scroller will always have a small minimum
7000 * size by default as it won't be limited by the contents of the scroller.
7002 * Signals that you can add callbacks for are:
7003 * @li "edge,left" - the left edge of the content has been reached
7004 * @li "edge,right" - the right edge of the content has been reached
7005 * @li "edge,top" - the top edge of the content has been reached
7006 * @li "edge,bottom" - the bottom edge of the content has been reached
7007 * @li "scroll" - the content has been scrolled (moved)
7008 * @li "scroll,anim,start" - scrolling animation has started
7009 * @li "scroll,anim,stop" - scrolling animation has stopped
7010 * @li "scroll,drag,start" - dragging the contents around has started
7011 * @li "scroll,drag,stop" - dragging the contents around has stopped
7012 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7015 * @note When Elemementary is in embedded mode the scrollbars will not be
7016 * dragable, they appear merely as indicators of how much has been scrolled.
7017 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7018 * fingerscroll) won't work.
7020 * Default contents parts of the scroller widget that you can use for are:
7021 * @li "elm.swallow.content" - A content of the scroller
7023 * In @ref tutorial_scroller you'll find an example of how to use most of
7028 * @brief Type that controls when scrollbars should appear.
7030 * @see elm_scroller_policy_set()
7032 typedef enum _Elm_Scroller_Policy
7034 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7035 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7036 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7037 ELM_SCROLLER_POLICY_LAST
7038 } Elm_Scroller_Policy;
7040 * @brief Add a new scroller to the parent
7042 * @param parent The parent object
7043 * @return The new object or NULL if it cannot be created
7045 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7047 * @brief Set the content of the scroller widget (the object to be scrolled around).
7049 * @param obj The scroller object
7050 * @param content The new content object
7052 * Once the content object is set, a previously set one will be deleted.
7053 * If you want to keep that old content object, use the
7054 * elm_scroller_content_unset() function.
7056 EINA_DEPRECATED EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7058 * @brief Get the content of the scroller widget
7060 * @param obj The slider object
7061 * @return The content that is being used
7063 * Return the content object which is set for this widget
7065 * @see elm_scroller_content_set()
7067 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7069 * @brief Unset the content of the scroller widget
7071 * @param obj The slider object
7072 * @return The content that was being used
7074 * Unparent and return the content object which was set for this widget
7076 * @see elm_scroller_content_set()
7078 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7080 * @brief Set custom theme elements for the scroller
7082 * @param obj The scroller object
7083 * @param widget The widget name to use (default is "scroller")
7084 * @param base The base name to use (default is "base")
7086 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7088 * @brief Make the scroller minimum size limited to the minimum size of the content
7090 * @param obj The scroller object
7091 * @param w Enable limiting minimum size horizontally
7092 * @param h Enable limiting minimum size vertically
7094 * By default the scroller will be as small as its design allows,
7095 * irrespective of its content. This will make the scroller minimum size the
7096 * right size horizontally and/or vertically to perfectly fit its content in
7099 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7101 * @brief Show a specific virtual region within the scroller content object
7103 * @param obj The scroller object
7104 * @param x X coordinate of the region
7105 * @param y Y coordinate of the region
7106 * @param w Width of the region
7107 * @param h Height of the region
7109 * This will ensure all (or part if it does not fit) of the designated
7110 * region in the virtual content object (0, 0 starting at the top-left of the
7111 * virtual content object) is shown within the scroller.
7113 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);
7115 * @brief Set the scrollbar visibility policy
7117 * @param obj The scroller object
7118 * @param policy_h Horizontal scrollbar policy
7119 * @param policy_v Vertical scrollbar policy
7121 * This sets the scrollbar visibility policy for the given scroller.
7122 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7123 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7124 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7125 * respectively for the horizontal and vertical scrollbars.
7127 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7129 * @brief Gets scrollbar visibility policy
7131 * @param obj The scroller object
7132 * @param policy_h Horizontal scrollbar policy
7133 * @param policy_v Vertical scrollbar policy
7135 * @see elm_scroller_policy_set()
7137 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7139 * @brief Get the currently visible content region
7141 * @param obj The scroller object
7142 * @param x X coordinate of the region
7143 * @param y Y coordinate of the region
7144 * @param w Width of the region
7145 * @param h Height of the region
7147 * This gets the current region in the content object that is visible through
7148 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7149 * w, @p h values pointed to.
7151 * @note All coordinates are relative to the content.
7153 * @see elm_scroller_region_show()
7155 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);
7157 * @brief Get the size of the content object
7159 * @param obj The scroller object
7160 * @param w Width of the content object.
7161 * @param h Height of the content object.
7163 * This gets the size of the content object of the scroller.
7165 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7167 * @brief Set bouncing behavior
7169 * @param obj The scroller object
7170 * @param h_bounce Allow bounce horizontally
7171 * @param v_bounce Allow bounce vertically
7173 * When scrolling, the scroller may "bounce" when reaching an edge of the
7174 * content object. This is a visual way to indicate the end has been reached.
7175 * This is enabled by default for both axis. This API will set if it is enabled
7176 * for the given axis with the boolean parameters for each axis.
7178 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7180 * @brief Get the bounce behaviour
7182 * @param obj The Scroller object
7183 * @param h_bounce Will the scroller bounce horizontally or not
7184 * @param v_bounce Will the scroller bounce vertically or not
7186 * @see elm_scroller_bounce_set()
7188 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7190 * @brief Set scroll page size relative to viewport size.
7192 * @param obj The scroller object
7193 * @param h_pagerel The horizontal page relative size
7194 * @param v_pagerel The vertical page relative size
7196 * The scroller is capable of limiting scrolling by the user to "pages". That
7197 * is to jump by and only show a "whole page" at a time as if the continuous
7198 * area of the scroller content is split into page sized pieces. This sets
7199 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7200 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7201 * axis. This is mutually exclusive with page size
7202 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7203 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7204 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7207 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7209 * @brief Set scroll page size.
7211 * @param obj The scroller object
7212 * @param h_pagesize The horizontal page size
7213 * @param v_pagesize The vertical page size
7215 * This sets the page size to an absolute fixed value, with 0 turning it off
7218 * @see elm_scroller_page_relative_set()
7220 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7222 * @brief Get scroll current page number.
7224 * @param obj The scroller object
7225 * @param h_pagenumber The horizontal page number
7226 * @param v_pagenumber The vertical page number
7228 * The page number starts from 0. 0 is the first page.
7229 * Current page means the page which meets the top-left of the viewport.
7230 * If there are two or more pages in the viewport, it returns the number of the page
7231 * which meets the top-left of the viewport.
7233 * @see elm_scroller_last_page_get()
7234 * @see elm_scroller_page_show()
7235 * @see elm_scroller_page_brint_in()
7237 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7239 * @brief Get scroll last page number.
7241 * @param obj The scroller object
7242 * @param h_pagenumber The horizontal page number
7243 * @param v_pagenumber The vertical page number
7245 * The page number starts from 0. 0 is the first page.
7246 * This returns the last page number among the pages.
7248 * @see elm_scroller_current_page_get()
7249 * @see elm_scroller_page_show()
7250 * @see elm_scroller_page_brint_in()
7252 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7254 * Show a specific virtual region within the scroller content object by page number.
7256 * @param obj The scroller object
7257 * @param h_pagenumber The horizontal page number
7258 * @param v_pagenumber The vertical page number
7260 * 0, 0 of the indicated page is located at the top-left of the viewport.
7261 * This will jump to the page directly without animation.
7266 * sc = elm_scroller_add(win);
7267 * elm_scroller_content_set(sc, content);
7268 * elm_scroller_page_relative_set(sc, 1, 0);
7269 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7270 * elm_scroller_page_show(sc, h_page + 1, v_page);
7273 * @see elm_scroller_page_bring_in()
7275 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7277 * Show a specific virtual region within the scroller content object by page number.
7279 * @param obj The scroller object
7280 * @param h_pagenumber The horizontal page number
7281 * @param v_pagenumber The vertical page number
7283 * 0, 0 of the indicated page is located at the top-left of the viewport.
7284 * This will slide to the page with animation.
7289 * sc = elm_scroller_add(win);
7290 * elm_scroller_content_set(sc, content);
7291 * elm_scroller_page_relative_set(sc, 1, 0);
7292 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7293 * elm_scroller_page_bring_in(sc, h_page, v_page);
7296 * @see elm_scroller_page_show()
7298 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7300 * @brief Show a specific virtual region within the scroller content object.
7302 * @param obj The scroller object
7303 * @param x X coordinate of the region
7304 * @param y Y coordinate of the region
7305 * @param w Width of the region
7306 * @param h Height of the region
7308 * This will ensure all (or part if it does not fit) of the designated
7309 * region in the virtual content object (0, 0 starting at the top-left of the
7310 * virtual content object) is shown within the scroller. Unlike
7311 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7312 * to this location (if configuration in general calls for transitions). It
7313 * may not jump immediately to the new location and make take a while and
7314 * show other content along the way.
7316 * @see elm_scroller_region_show()
7318 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);
7320 * @brief Set event propagation on a scroller
7322 * @param obj The scroller object
7323 * @param propagation If propagation is enabled or not
7325 * This enables or disabled event propagation from the scroller content to
7326 * the scroller and its parent. By default event propagation is disabled.
7328 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7330 * @brief Get event propagation for a scroller
7332 * @param obj The scroller object
7333 * @return The propagation state
7335 * This gets the event propagation for a scroller.
7337 * @see elm_scroller_propagate_events_set()
7339 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7341 * @brief Set scrolling gravity on a scroller
7343 * @param obj The scroller object
7344 * @param x The scrolling horizontal gravity
7345 * @param y The scrolling vertical gravity
7347 * The gravity, defines how the scroller will adjust its view
7348 * when the size of the scroller contents increase.
7350 * The scroller will adjust the view to glue itself as follows.
7352 * x=0.0, for showing the left most region of the content.
7353 * x=1.0, for showing the right most region of the content.
7354 * y=0.0, for showing the bottom most region of the content.
7355 * y=1.0, for showing the top most region of the content.
7357 * Default values for x and y are 0.0
7359 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7361 * @brief Get scrolling gravity values for a scroller
7363 * @param obj The scroller object
7364 * @param x The scrolling horizontal gravity
7365 * @param y The scrolling vertical gravity
7367 * This gets gravity values for a scroller.
7369 * @see elm_scroller_gravity_set()
7372 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7378 * @defgroup Label Label
7380 * @image html img/widget/label/preview-00.png
7381 * @image latex img/widget/label/preview-00.eps
7383 * @brief Widget to display text, with simple html-like markup.
7385 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7386 * text doesn't fit the geometry of the label it will be ellipsized or be
7387 * cut. Elementary provides several themes for this widget:
7388 * @li default - No animation
7389 * @li marker - Centers the text in the label and make it bold by default
7390 * @li slide_long - The entire text appears from the right of the screen and
7391 * slides until it disappears in the left of the screen(reappering on the
7393 * @li slide_short - The text appears in the left of the label and slides to
7394 * the right to show the overflow. When all of the text has been shown the
7395 * position is reset.
7396 * @li slide_bounce - The text appears in the left of the label and slides to
7397 * the right to show the overflow. When all of the text has been shown the
7398 * animation reverses, moving the text to the left.
7400 * Custom themes can of course invent new markup tags and style them any way
7403 * The following signals may be emitted by the label widget:
7404 * @li "language,changed": The program's language changed.
7406 * See @ref tutorial_label for a demonstration of how to use a label widget.
7410 * @brief Add a new label to the parent
7412 * @param parent The parent object
7413 * @return The new object or NULL if it cannot be created
7415 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7417 * @brief Set the label on the label object
7419 * @param obj The label object
7420 * @param label The label will be used on the label object
7421 * @deprecated See elm_object_text_set()
7423 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 */
7425 * @brief Get the label used on the label object
7427 * @param obj The label object
7428 * @return The string inside the label
7429 * @deprecated See elm_object_text_get()
7431 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7433 * @brief Set the wrapping behavior of the label
7435 * @param obj The label object
7436 * @param wrap To wrap text or not
7438 * By default no wrapping is done. Possible values for @p wrap are:
7439 * @li ELM_WRAP_NONE - No wrapping
7440 * @li ELM_WRAP_CHAR - wrap between characters
7441 * @li ELM_WRAP_WORD - wrap between words
7442 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7444 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7446 * @brief Get the wrapping behavior of the label
7448 * @param obj The label object
7451 * @see elm_label_line_wrap_set()
7453 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7455 * @brief Set wrap width of the label
7457 * @param obj The label object
7458 * @param w The wrap width in pixels at a minimum where words need to wrap
7460 * This function sets the maximum width size hint of the label.
7462 * @warning This is only relevant if the label is inside a container.
7464 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7466 * @brief Get wrap width of the label
7468 * @param obj The label object
7469 * @return The wrap width in pixels at a minimum where words need to wrap
7471 * @see elm_label_wrap_width_set()
7473 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7475 * @brief Set wrap height of the label
7477 * @param obj The label object
7478 * @param h The wrap height in pixels at a minimum where words need to wrap
7480 * This function sets the maximum height size hint of the label.
7482 * @warning This is only relevant if the label is inside a container.
7484 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7486 * @brief get wrap width of the label
7488 * @param obj The label object
7489 * @return The wrap height in pixels at a minimum where words need to wrap
7491 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7493 * @brief Set the font size on the label object.
7495 * @param obj The label object
7496 * @param size font size
7498 * @warning NEVER use this. It is for hyper-special cases only. use styles
7499 * instead. e.g. "big", "medium", "small" - or better name them by use:
7500 * "title", "footnote", "quote" etc.
7502 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7504 * @brief Set the text color on the label object
7506 * @param obj The label object
7507 * @param r Red property background color of The label object
7508 * @param g Green property background color of The label object
7509 * @param b Blue property background color of The label object
7510 * @param a Alpha property background color of The label object
7512 * @warning NEVER use this. It is for hyper-special cases only. use styles
7513 * instead. e.g. "big", "medium", "small" - or better name them by use:
7514 * "title", "footnote", "quote" etc.
7516 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);
7518 * @brief Set the text align on the label object
7520 * @param obj The label object
7521 * @param align align mode ("left", "center", "right")
7523 * @warning NEVER use this. It is for hyper-special cases only. use styles
7524 * instead. e.g. "big", "medium", "small" - or better name them by use:
7525 * "title", "footnote", "quote" etc.
7527 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7529 * @brief Set background color of the label
7531 * @param obj The label object
7532 * @param r Red property background color of The label object
7533 * @param g Green property background color of The label object
7534 * @param b Blue property background color of The label object
7535 * @param a Alpha property background alpha of The label object
7537 * @warning NEVER use this. It is for hyper-special cases only. use styles
7538 * instead. e.g. "big", "medium", "small" - or better name them by use:
7539 * "title", "footnote", "quote" etc.
7541 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);
7543 * @brief Set the ellipsis behavior of the label
7545 * @param obj The label object
7546 * @param ellipsis To ellipsis text or not
7548 * If set to true and the text doesn't fit in the label an ellipsis("...")
7549 * will be shown at the end of the widget.
7551 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7552 * choosen wrap method was ELM_WRAP_WORD.
7554 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7556 * @brief Set the text slide of the label
7558 * @param obj The label object
7559 * @param slide To start slide or stop
7561 * If set to true, the text of the label will slide/scroll through the length of
7564 * @warning This only works with the themes "slide_short", "slide_long" and
7567 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7569 * @brief Get the text slide mode of the label
7571 * @param obj The label object
7572 * @return slide slide mode value
7574 * @see elm_label_slide_set()
7576 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7578 * @brief Set the slide duration(speed) of the label
7580 * @param obj The label object
7581 * @return The duration in seconds in moving text from slide begin position
7582 * to slide end position
7584 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7586 * @brief Get the slide duration(speed) of the label
7588 * @param obj The label object
7589 * @return The duration time in moving text from slide begin position to slide end position
7591 * @see elm_label_slide_duration_set()
7593 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7599 * @defgroup Toggle Toggle
7601 * @image html img/widget/toggle/preview-00.png
7602 * @image latex img/widget/toggle/preview-00.eps
7604 * @brief A toggle is a slider which can be used to toggle between
7605 * two values. It has two states: on and off.
7607 * This widget is deprecated. Please use elm_check_add() instead using the
7608 * toggle style like:
7611 * obj = elm_check_add(parent);
7612 * elm_object_style_set(obj, "toggle");
7613 * elm_object_text_part_set(obj, "on", "ON");
7614 * elm_object_text_part_set(obj, "off", "OFF");
7617 * Signals that you can add callbacks for are:
7618 * @li "changed" - Whenever the toggle value has been changed. Is not called
7619 * until the toggle is released by the cursor (assuming it
7620 * has been triggered by the cursor in the first place).
7622 * @ref tutorial_toggle show how to use a toggle.
7626 * @brief Add a toggle to @p parent.
7628 * @param parent The parent object
7630 * @return The toggle object
7632 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7634 * @brief Sets the label to be displayed with the toggle.
7636 * @param obj The toggle object
7637 * @param label The label to be displayed
7639 * @deprecated use elm_object_text_set() instead.
7641 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7643 * @brief Gets the label of the toggle
7645 * @param obj toggle object
7646 * @return The label of the toggle
7648 * @deprecated use elm_object_text_get() instead.
7650 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7652 * @brief Set the icon used for the toggle
7654 * @param obj The toggle object
7655 * @param icon The icon object for the button
7657 * Once the icon object is set, a previously set one will be deleted
7658 * If you want to keep that old content object, use the
7659 * elm_toggle_icon_unset() function.
7661 * @deprecated use elm_object_content_set() instead.
7663 EINA_DEPRECATED EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7665 * @brief Get the icon used for the toggle
7667 * @param obj The toggle object
7668 * @return The icon object that is being used
7670 * Return the icon object which is set for this widget.
7672 * @see elm_toggle_icon_set()
7674 * @deprecated use elm_object_content_get() instead.
7676 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7678 * @brief Unset the icon used for the toggle
7680 * @param obj The toggle object
7681 * @return The icon object that was being used
7683 * Unparent and return the icon object which was set for this widget.
7685 * @see elm_toggle_icon_set()
7687 * @deprecated use elm_object_content_unset() instead.
7689 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7691 * @brief Sets the labels to be associated with the on and off states of the toggle.
7693 * @param obj The toggle object
7694 * @param onlabel The label displayed when the toggle is in the "on" state
7695 * @param offlabel The label displayed when the toggle is in the "off" state
7697 * @deprecated use elm_object_text_part_set() for "on" and "off" parts
7700 EINA_DEPRECATED EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7702 * @brief Gets the labels associated with the on and off states of the
7705 * @param obj The toggle object
7706 * @param onlabel A char** to place the onlabel of @p obj into
7707 * @param offlabel A char** to place the offlabel of @p obj into
7709 * @deprecated use elm_object_text_part_get() for "on" and "off" parts
7712 EINA_DEPRECATED EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7714 * @brief Sets the state of the toggle to @p state.
7716 * @param obj The toggle object
7717 * @param state The state of @p obj
7719 * @deprecated use elm_check_state_set() instead.
7721 EINA_DEPRECATED EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7723 * @brief Gets the state of the toggle to @p state.
7725 * @param obj The toggle object
7726 * @return The state of @p obj
7728 * @deprecated use elm_check_state_get() instead.
7730 EINA_DEPRECATED EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7732 * @brief Sets the state pointer of the toggle to @p statep.
7734 * @param obj The toggle object
7735 * @param statep The state pointer of @p obj
7737 * @deprecated use elm_check_state_pointer_set() instead.
7739 EINA_DEPRECATED EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7745 * @defgroup Frame Frame
7747 * @image html img/widget/frame/preview-00.png
7748 * @image latex img/widget/frame/preview-00.eps
7750 * @brief Frame is a widget that holds some content and has a title.
7752 * The default look is a frame with a title, but Frame supports multple
7760 * @li outdent_bottom
7762 * Of all this styles only default shows the title. Frame emits no signals.
7764 * Default contents parts of the frame widget that you can use for are:
7765 * @li "elm.swallow.content" - A content of the frame
7767 * Default text parts of the frame widget that you can use for are:
7768 * @li "elm.text" - Label of the frame
7770 * For a detailed example see the @ref tutorial_frame.
7775 * @brief Add a new frame to the parent
7777 * @param parent The parent object
7778 * @return The new object or NULL if it cannot be created
7780 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7782 * @brief Set the frame label
7784 * @param obj The frame object
7785 * @param label The label of this frame object
7787 * @deprecated use elm_object_text_set() instead.
7789 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7791 * @brief Get the frame label
7793 * @param obj The frame object
7795 * @return The label of this frame objet or NULL if unable to get frame
7797 * @deprecated use elm_object_text_get() instead.
7799 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7801 * @brief Set the content of the frame widget
7803 * Once the content object is set, a previously set one will be deleted.
7804 * If you want to keep that old content object, use the
7805 * elm_frame_content_unset() function.
7807 * @param obj The frame object
7808 * @param content The content will be filled in this frame object
7810 EINA_DEPRECATED EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7812 * @brief Get the content of the frame widget
7814 * Return the content object which is set for this widget
7816 * @param obj The frame object
7817 * @return The content that is being used
7819 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7821 * @brief Unset the content of the frame widget
7823 * Unparent and return the content object which was set for this widget
7825 * @param obj The frame object
7826 * @return The content that was being used
7828 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7834 * @defgroup Table Table
7836 * A container widget to arrange other widgets in a table where items can
7837 * also span multiple columns or rows - even overlap (and then be raised or
7838 * lowered accordingly to adjust stacking if they do overlap).
7840 * The followin are examples of how to use a table:
7841 * @li @ref tutorial_table_01
7842 * @li @ref tutorial_table_02
7847 * @brief Add a new table to the parent
7849 * @param parent The parent object
7850 * @return The new object or NULL if it cannot be created
7852 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7854 * @brief Set the homogeneous layout in the table
7856 * @param obj The layout object
7857 * @param homogeneous A boolean to set if the layout is homogeneous in the
7858 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7860 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7862 * @brief Get the current table homogeneous mode.
7864 * @param obj The table object
7865 * @return A boolean to indicating if the layout is homogeneous in the table
7866 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7868 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7870 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7872 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7874 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7876 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7878 * @brief Set padding between cells.
7880 * @param obj The layout object.
7881 * @param horizontal set the horizontal padding.
7882 * @param vertical set the vertical padding.
7884 * Default value is 0.
7886 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7888 * @brief Get padding between cells.
7890 * @param obj The layout object.
7891 * @param horizontal set the horizontal padding.
7892 * @param vertical set the vertical padding.
7894 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7896 * @brief Add a subobject on the table with the coordinates passed
7898 * @param obj The table object
7899 * @param subobj The subobject to be added to the table
7900 * @param x Row number
7901 * @param y Column number
7905 * @note All positioning inside the table is relative to rows and columns, so
7906 * a value of 0 for x and y, means the top left cell of the table, and a
7907 * value of 1 for w and h means @p subobj only takes that 1 cell.
7909 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7911 * @brief Remove child from table.
7913 * @param obj The table object
7914 * @param subobj The subobject
7916 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7918 * @brief Faster way to remove all child objects from a table object.
7920 * @param obj The table object
7921 * @param clear If true, will delete children, else just remove from table.
7923 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7925 * @brief Set the packing location of an existing child of the table
7927 * @param subobj The subobject to be modified in the table
7928 * @param x Row number
7929 * @param y Column number
7933 * Modifies the position of an object already in the table.
7935 * @note All positioning inside the table is relative to rows and columns, so
7936 * a value of 0 for x and y, means the top left cell of the table, and a
7937 * value of 1 for w and h means @p subobj only takes that 1 cell.
7939 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7941 * @brief Get the packing location of an existing child of the table
7943 * @param subobj The subobject to be modified in the table
7944 * @param x Row number
7945 * @param y Column number
7949 * @see elm_table_pack_set()
7951 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7956 /* TEMPORARY: DOCS WILL BE FILLED IN WITH CNP/SED */
7957 typedef struct Elm_Gen_Item Elm_Gen_Item;
7958 typedef struct _Elm_Gen_Item_Class Elm_Gen_Item_Class;
7959 typedef struct _Elm_Gen_Item_Class_Func Elm_Gen_Item_Class_Func; /**< Class functions for gen item classes. */
7960 typedef char *(*Elm_Gen_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gen item classes. */
7961 typedef Evas_Object *(*Elm_Gen_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Content(swallowed object) fetching class function for gen item classes. */
7962 typedef Eina_Bool (*Elm_Gen_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gen item classes. */
7963 typedef void (*Elm_Gen_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gen item classes. */
7964 struct _Elm_Gen_Item_Class
7966 const char *item_style;
7967 struct _Elm_Gen_Item_Class_Func
7969 Elm_Gen_Item_Label_Get_Cb label_get;
7970 Elm_Gen_Item_Content_Get_Cb content_get;
7971 Elm_Gen_Item_State_Get_Cb state_get;
7972 Elm_Gen_Item_Del_Cb del;
7975 EAPI void elm_gen_clear(Evas_Object *obj);
7976 EAPI void elm_gen_item_selected_set(Elm_Gen_Item *it, Eina_Bool selected);
7977 EAPI Eina_Bool elm_gen_item_selected_get(const Elm_Gen_Item *it);
7978 EAPI void elm_gen_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
7979 EAPI Eina_Bool elm_gen_always_select_mode_get(const Evas_Object *obj);
7980 EAPI void elm_gen_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
7981 EAPI Eina_Bool elm_gen_no_select_mode_get(const Evas_Object *obj);
7982 EAPI void elm_gen_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
7983 EAPI void elm_gen_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
7984 EAPI void elm_gen_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
7985 EAPI void elm_gen_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
7986 EAPI void elm_gen_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
7987 EAPI void elm_gen_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
7988 EAPI void elm_gen_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
7989 EAPI void elm_gen_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
7990 EAPI void elm_gen_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
7991 EAPI Elm_Gen_Item *elm_gen_first_item_get(const Evas_Object *obj);
7992 EAPI Elm_Gen_Item *elm_gen_last_item_get(const Evas_Object *obj);
7993 EAPI Elm_Gen_Item *elm_gen_item_next_get(const Elm_Gen_Item *it);
7994 EAPI Elm_Gen_Item *elm_gen_item_prev_get(const Elm_Gen_Item *it);
7995 EAPI Evas_Object *elm_gen_item_widget_get(const Elm_Gen_Item *it);
7998 * @defgroup Gengrid Gengrid (Generic grid)
8000 * This widget aims to position objects in a grid layout while
8001 * actually creating and rendering only the visible ones, using the
8002 * same idea as the @ref Genlist "genlist": the user defines a @b
8003 * class for each item, specifying functions that will be called at
8004 * object creation, deletion, etc. When those items are selected by
8005 * the user, a callback function is issued. Users may interact with
8006 * a gengrid via the mouse (by clicking on items to select them and
8007 * clicking on the grid's viewport and swiping to pan the whole
8008 * view) or via the keyboard, navigating through item with the
8011 * @section Gengrid_Layouts Gengrid layouts
8013 * Gengrids may layout its items in one of two possible layouts:
8017 * When in "horizontal mode", items will be placed in @b columns,
8018 * from top to bottom and, when the space for a column is filled,
8019 * another one is started on the right, thus expanding the grid
8020 * horizontally, making for horizontal scrolling. When in "vertical
8021 * mode" , though, items will be placed in @b rows, from left to
8022 * right and, when the space for a row is filled, another one is
8023 * started below, thus expanding the grid vertically (and making
8024 * for vertical scrolling).
8026 * @section Gengrid_Items Gengrid items
8028 * An item in a gengrid can have 0 or more text labels (they can be
8029 * regular text or textblock Evas objects - that's up to the style
8030 * to determine), 0 or more icons (which are simply objects
8031 * swallowed into the gengrid item's theming Edje object) and 0 or
8032 * more <b>boolean states</b>, which have the behavior left to the
8033 * user to define. The Edje part names for each of these properties
8034 * will be looked up, in the theme file for the gengrid, under the
8035 * Edje (string) data items named @c "labels", @c "icons" and @c
8036 * "states", respectively. For each of those properties, if more
8037 * than one part is provided, they must have names listed separated
8038 * by spaces in the data fields. For the default gengrid item
8039 * theme, we have @b one label part (@c "elm.text"), @b two icon
8040 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8043 * A gengrid item may be at one of several styles. Elementary
8044 * provides one by default - "default", but this can be extended by
8045 * system or application custom themes/overlays/extensions (see
8046 * @ref Theme "themes" for more details).
8048 * @section Gengrid_Item_Class Gengrid item classes
8050 * In order to have the ability to add and delete items on the fly,
8051 * gengrid implements a class (callback) system where the
8052 * application provides a structure with information about that
8053 * type of item (gengrid may contain multiple different items with
8054 * different classes, states and styles). Gengrid will call the
8055 * functions in this struct (methods) when an item is "realized"
8056 * (i.e., created dynamically, while the user is scrolling the
8057 * grid). All objects will simply be deleted when no longer needed
8058 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8059 * contains the following members:
8060 * - @c item_style - This is a constant string and simply defines
8061 * the name of the item style. It @b must be specified and the
8062 * default should be @c "default".
8063 * - @c func.label_get - This function is called when an item
8064 * object is actually created. The @c data parameter will point to
8065 * the same data passed to elm_gengrid_item_append() and related
8066 * item creation functions. The @c obj parameter is the gengrid
8067 * object itself, while the @c part one is the name string of one
8068 * of the existing text parts in the Edje group implementing the
8069 * item's theme. This function @b must return a strdup'()ed string,
8070 * as the caller will free() it when done. See
8071 * #Elm_Gengrid_Item_Label_Get_Cb.
8072 * - @c func.content_get - This function is called when an item object
8073 * is actually created. The @c data parameter will point to the
8074 * same data passed to elm_gengrid_item_append() and related item
8075 * creation functions. The @c obj parameter is the gengrid object
8076 * itself, while the @c part one is the name string of one of the
8077 * existing (content) swallow parts in the Edje group implementing the
8078 * item's theme. It must return @c NULL, when no content is desired,
8079 * or a valid object handle, otherwise. The object will be deleted
8080 * by the gengrid on its deletion or when the item is "unrealized".
8081 * See #Elm_Gengrid_Item_Content_Get_Cb.
8082 * - @c func.state_get - This function is called when an item
8083 * object is actually created. The @c data parameter will point to
8084 * the same data passed to elm_gengrid_item_append() and related
8085 * item creation functions. The @c obj parameter is the gengrid
8086 * object itself, while the @c part one is the name string of one
8087 * of the state parts in the Edje group implementing the item's
8088 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8089 * true/on. Gengrids will emit a signal to its theming Edje object
8090 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8091 * "source" arguments, respectively, when the state is true (the
8092 * default is false), where @c XXX is the name of the (state) part.
8093 * See #Elm_Gengrid_Item_State_Get_Cb.
8094 * - @c func.del - This is called when elm_gengrid_item_del() is
8095 * called on an item or elm_gengrid_clear() is called on the
8096 * gengrid. This is intended for use when gengrid items are
8097 * deleted, so any data attached to the item (e.g. its data
8098 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8100 * @section Gengrid_Usage_Hints Usage hints
8102 * If the user wants to have multiple items selected at the same
8103 * time, elm_gengrid_multi_select_set() will permit it. If the
8104 * gengrid is single-selection only (the default), then
8105 * elm_gengrid_select_item_get() will return the selected item or
8106 * @c NULL, if none is selected. If the gengrid is under
8107 * multi-selection, then elm_gengrid_selected_items_get() will
8108 * return a list (that is only valid as long as no items are
8109 * modified (added, deleted, selected or unselected) of child items
8112 * If an item changes (internal (boolean) state, label or content
8113 * changes), then use elm_gengrid_item_update() to have gengrid
8114 * update the item with the new state. A gengrid will re-"realize"
8115 * the item, thus calling the functions in the
8116 * #Elm_Gengrid_Item_Class set for that item.
8118 * To programmatically (un)select an item, use
8119 * elm_gengrid_item_selected_set(). To get its selected state use
8120 * elm_gengrid_item_selected_get(). To make an item disabled
8121 * (unable to be selected and appear differently) use
8122 * elm_gengrid_item_disabled_set() to set this and
8123 * elm_gengrid_item_disabled_get() to get the disabled state.
8125 * Grid cells will only have their selection smart callbacks called
8126 * when firstly getting selected. Any further clicks will do
8127 * nothing, unless you enable the "always select mode", with
8128 * elm_gengrid_always_select_mode_set(), thus making every click to
8129 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8130 * turn off the ability to select items entirely in the widget and
8131 * they will neither appear selected nor call the selection smart
8134 * Remember that you can create new styles and add your own theme
8135 * augmentation per application with elm_theme_extension_add(). If
8136 * you absolutely must have a specific style that overrides any
8137 * theme the user or system sets up you can use
8138 * elm_theme_overlay_add() to add such a file.
8140 * @section Gengrid_Smart_Events Gengrid smart events
8142 * Smart events that you can add callbacks for are:
8143 * - @c "activated" - The user has double-clicked or pressed
8144 * (enter|return|spacebar) on an item. The @c event_info parameter
8145 * is the gengrid item that was activated.
8146 * - @c "clicked,double" - The user has double-clicked an item.
8147 * The @c event_info parameter is the gengrid item that was double-clicked.
8148 * - @c "longpressed" - This is called when the item is pressed for a certain
8149 * amount of time. By default it's 1 second.
8150 * - @c "selected" - The user has made an item selected. The
8151 * @c event_info parameter is the gengrid item that was selected.
8152 * - @c "unselected" - The user has made an item unselected. The
8153 * @c event_info parameter is the gengrid item that was unselected.
8154 * - @c "realized" - This is called when the item in the gengrid
8155 * has its implementing Evas object instantiated, de facto. @c
8156 * event_info is the gengrid item that was created. The object
8157 * may be deleted at any time, so it is highly advised to the
8158 * caller @b not to use the object pointer returned from
8159 * elm_gengrid_item_object_get(), because it may point to freed
8161 * - @c "unrealized" - This is called when the implementing Evas
8162 * object for this item is deleted. @c event_info is the gengrid
8163 * item that was deleted.
8164 * - @c "changed" - Called when an item is added, removed, resized
8165 * or moved and when the gengrid is resized or gets "horizontal"
8167 * - @c "scroll,anim,start" - This is called when scrolling animation has
8169 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8171 * - @c "drag,start,up" - Called when the item in the gengrid has
8172 * been dragged (not scrolled) up.
8173 * - @c "drag,start,down" - Called when the item in the gengrid has
8174 * been dragged (not scrolled) down.
8175 * - @c "drag,start,left" - Called when the item in the gengrid has
8176 * been dragged (not scrolled) left.
8177 * - @c "drag,start,right" - Called when the item in the gengrid has
8178 * been dragged (not scrolled) right.
8179 * - @c "drag,stop" - Called when the item in the gengrid has
8180 * stopped being dragged.
8181 * - @c "drag" - Called when the item in the gengrid is being
8183 * - @c "scroll" - called when the content has been scrolled
8185 * - @c "scroll,drag,start" - called when dragging the content has
8187 * - @c "scroll,drag,stop" - called when dragging the content has
8189 * - @c "edge,top" - This is called when the gengrid is scrolled until
8191 * - @c "edge,bottom" - This is called when the gengrid is scrolled
8192 * until the bottom edge.
8193 * - @c "edge,left" - This is called when the gengrid is scrolled
8194 * until the left edge.
8195 * - @c "edge,right" - This is called when the gengrid is scrolled
8196 * until the right edge.
8198 * List of gengrid examples:
8199 * @li @ref gengrid_example
8203 * @addtogroup Gengrid
8207 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8208 #define Elm_Gengrid_Item_Class Elm_Gen_Item_Class
8209 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8210 #define Elm_Gengrid_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
8211 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8212 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
8213 typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Content (swallowed object) fetching class function for gengrid item classes. */
8214 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. */
8215 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
8218 * @struct _Elm_Gengrid_Item_Class
8220 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8223 struct _Elm_Gengrid_Item_Class
8225 const char *item_style;
8226 struct _Elm_Gengrid_Item_Class_Func
8228 Elm_Gengrid_Item_Label_Get_Cb label_get;
8229 Elm_Gengrid_Item_Content_Get_Cb content_get;
8230 Elm_Gengrid_Item_State_Get_Cb state_get;
8231 Elm_Gengrid_Item_Del_Cb del;
8233 }; /**< #Elm_Gengrid_Item_Class member definitions */
8234 #define Elm_Gengrid_Item_Class_Func Elm_Gen_Item_Class_Func
8236 * Add a new gengrid widget to the given parent Elementary
8237 * (container) object
8239 * @param parent The parent object
8240 * @return a new gengrid widget handle or @c NULL, on errors
8242 * This function inserts a new gengrid widget on the canvas.
8244 * @see elm_gengrid_item_size_set()
8245 * @see elm_gengrid_group_item_size_set()
8246 * @see elm_gengrid_horizontal_set()
8247 * @see elm_gengrid_item_append()
8248 * @see elm_gengrid_item_del()
8249 * @see elm_gengrid_clear()
8253 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8256 * Set the size for the items of a given gengrid widget
8258 * @param obj The gengrid object.
8259 * @param w The items' width.
8260 * @param h The items' height;
8262 * A gengrid, after creation, has still no information on the size
8263 * to give to each of its cells. So, you most probably will end up
8264 * with squares one @ref Fingers "finger" wide, the default
8265 * size. Use this function to force a custom size for you items,
8266 * making them as big as you wish.
8268 * @see elm_gengrid_item_size_get()
8272 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8275 * Get the size set for the items of a given gengrid widget
8277 * @param obj The gengrid object.
8278 * @param w Pointer to a variable where to store the items' width.
8279 * @param h Pointer to a variable where to store the items' height.
8281 * @note Use @c NULL pointers on the size values you're not
8282 * interested in: they'll be ignored by the function.
8284 * @see elm_gengrid_item_size_get() for more details
8288 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8291 * Set the size for the group items of a given gengrid widget
8293 * @param obj The gengrid object.
8294 * @param w The group items' width.
8295 * @param h The group items' height;
8297 * A gengrid, after creation, has still no information on the size
8298 * to give to each of its cells. So, you most probably will end up
8299 * with squares one @ref Fingers "finger" wide, the default
8300 * size. Use this function to force a custom size for you group items,
8301 * making them as big as you wish.
8303 * @see elm_gengrid_group_item_size_get()
8307 EAPI void elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8310 * Get the size set for the group items of a given gengrid widget
8312 * @param obj The gengrid object.
8313 * @param w Pointer to a variable where to store the group items' width.
8314 * @param h Pointer to a variable where to store the group items' height.
8316 * @note Use @c NULL pointers on the size values you're not
8317 * interested in: they'll be ignored by the function.
8319 * @see elm_gengrid_group_item_size_get() for more details
8323 EAPI void elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8326 * Set the items grid's alignment within a given gengrid widget
8328 * @param obj The gengrid object.
8329 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8330 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8332 * This sets the alignment of the whole grid of items of a gengrid
8333 * within its given viewport. By default, those values are both
8334 * 0.5, meaning that the gengrid will have its items grid placed
8335 * exactly in the middle of its viewport.
8337 * @note If given alignment values are out of the cited ranges,
8338 * they'll be changed to the nearest boundary values on the valid
8341 * @see elm_gengrid_align_get()
8345 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8348 * Get the items grid's alignment values within a given gengrid
8351 * @param obj The gengrid object.
8352 * @param align_x Pointer to a variable where to store the
8353 * horizontal alignment.
8354 * @param align_y Pointer to a variable where to store the vertical
8357 * @note Use @c NULL pointers on the alignment values you're not
8358 * interested in: they'll be ignored by the function.
8360 * @see elm_gengrid_align_set() for more details
8364 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8367 * Set whether a given gengrid widget is or not able have items
8370 * @param obj The gengrid object
8371 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8372 * @c EINA_FALSE to turn it off
8374 * If a gengrid is set to allow reordering, a click held for more
8375 * than 0.5 over a given item will highlight it specially,
8376 * signalling the gengrid has entered the reordering state. From
8377 * that time on, the user will be able to, while still holding the
8378 * mouse button down, move the item freely in the gengrid's
8379 * viewport, replacing to said item to the locations it goes to.
8380 * The replacements will be animated and, whenever the user
8381 * releases the mouse button, the item being replaced gets a new
8382 * definitive place in the grid.
8384 * @see elm_gengrid_reorder_mode_get()
8388 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8391 * Get whether a given gengrid widget is or not able have items
8394 * @param obj The gengrid object
8395 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8398 * @see elm_gengrid_reorder_mode_set() for more details
8402 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8405 * Append a new item in a given gengrid widget.
8407 * @param obj The gengrid object.
8408 * @param gic The item class for the item.
8409 * @param data The item data.
8410 * @param func Convenience function called when the item is
8412 * @param func_data Data to be passed to @p func.
8413 * @return A handle to the item added or @c NULL, on errors.
8415 * This adds an item to the beginning of the gengrid.
8417 * @see elm_gengrid_item_prepend()
8418 * @see elm_gengrid_item_insert_before()
8419 * @see elm_gengrid_item_insert_after()
8420 * @see elm_gengrid_item_del()
8424 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);
8427 * Prepend a new item in a given gengrid widget.
8429 * @param obj The gengrid object.
8430 * @param gic The item class for the item.
8431 * @param data The item data.
8432 * @param func Convenience function called when the item is
8434 * @param func_data Data to be passed to @p func.
8435 * @return A handle to the item added or @c NULL, on errors.
8437 * This adds an item to the end of the gengrid.
8439 * @see elm_gengrid_item_append()
8440 * @see elm_gengrid_item_insert_before()
8441 * @see elm_gengrid_item_insert_after()
8442 * @see elm_gengrid_item_del()
8446 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);
8449 * Insert an item before another in a gengrid widget
8451 * @param obj The gengrid object.
8452 * @param gic The item class for the item.
8453 * @param data The item data.
8454 * @param relative The item to place this new one before.
8455 * @param func Convenience function called when the item is
8457 * @param func_data Data to be passed to @p func.
8458 * @return A handle to the item added or @c NULL, on errors.
8460 * This inserts an item before another in the gengrid.
8462 * @see elm_gengrid_item_append()
8463 * @see elm_gengrid_item_prepend()
8464 * @see elm_gengrid_item_insert_after()
8465 * @see elm_gengrid_item_del()
8469 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);
8472 * Insert an item after another in a gengrid widget
8474 * @param obj The gengrid object.
8475 * @param gic The item class for the item.
8476 * @param data The item data.
8477 * @param relative The item to place this new one after.
8478 * @param func Convenience function called when the item is
8480 * @param func_data Data to be passed to @p func.
8481 * @return A handle to the item added or @c NULL, on errors.
8483 * This inserts an item after another in the gengrid.
8485 * @see elm_gengrid_item_append()
8486 * @see elm_gengrid_item_prepend()
8487 * @see elm_gengrid_item_insert_after()
8488 * @see elm_gengrid_item_del()
8492 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);
8494 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);
8496 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);
8499 * Set whether items on a given gengrid widget are to get their
8500 * selection callbacks issued for @b every subsequent selection
8501 * click on them or just for the first click.
8503 * @param obj The gengrid object
8504 * @param always_select @c EINA_TRUE to make items "always
8505 * selected", @c EINA_FALSE, otherwise
8507 * By default, grid items will only call their selection callback
8508 * function when firstly getting selected, any subsequent further
8509 * clicks will do nothing. With this call, you make those
8510 * subsequent clicks also to issue the selection callbacks.
8512 * @note <b>Double clicks</b> will @b always be reported on items.
8514 * @see elm_gengrid_always_select_mode_get()
8518 EINA_DEPRECATED EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8521 * Get whether items on a given gengrid widget have their selection
8522 * callbacks issued for @b every subsequent selection click on them
8523 * or just for the first click.
8525 * @param obj The gengrid object.
8526 * @return @c EINA_TRUE if the gengrid items are "always selected",
8527 * @c EINA_FALSE, otherwise
8529 * @see elm_gengrid_always_select_mode_set() for more details
8533 EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8536 * Set whether items on a given gengrid widget can be selected or not.
8538 * @param obj The gengrid object
8539 * @param no_select @c EINA_TRUE to make items selectable,
8540 * @c EINA_FALSE otherwise
8542 * This will make items in @p obj selectable or not. In the latter
8543 * case, any user interaction on the gengrid items will neither make
8544 * them appear selected nor them call their selection callback
8547 * @see elm_gengrid_no_select_mode_get()
8551 EINA_DEPRECATED EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8554 * Get whether items on a given gengrid widget can be selected or
8557 * @param obj The gengrid object
8558 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8561 * @see elm_gengrid_no_select_mode_set() for more details
8565 EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8568 * Enable or disable multi-selection in a given gengrid widget
8570 * @param obj The gengrid object.
8571 * @param multi @c EINA_TRUE, to enable multi-selection,
8572 * @c EINA_FALSE to disable it.
8574 * Multi-selection is the ability for one to have @b more than one
8575 * item selected, on a given gengrid, simultaneously. When it is
8576 * enabled, a sequence of clicks on different items will make them
8577 * all selected, progressively. A click on an already selected item
8578 * will unselect it. If interecting via the keyboard,
8579 * multi-selection is enabled while holding the "Shift" key.
8581 * @note By default, multi-selection is @b disabled on gengrids
8583 * @see elm_gengrid_multi_select_get()
8587 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8590 * Get whether multi-selection is enabled or disabled for a given
8593 * @param obj The gengrid object.
8594 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8595 * EINA_FALSE otherwise
8597 * @see elm_gengrid_multi_select_set() for more details
8601 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8604 * Enable or disable bouncing effect for a given gengrid widget
8606 * @param obj The gengrid object
8607 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8608 * @c EINA_FALSE to disable it
8609 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8610 * @c EINA_FALSE to disable it
8612 * The bouncing effect occurs whenever one reaches the gengrid's
8613 * edge's while panning it -- it will scroll past its limits a
8614 * little bit and return to the edge again, in a animated for,
8617 * @note By default, gengrids have bouncing enabled on both axis
8619 * @see elm_gengrid_bounce_get()
8623 EINA_DEPRECATED EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8626 * Get whether bouncing effects are enabled or disabled, for a
8627 * given gengrid widget, on each axis
8629 * @param obj The gengrid object
8630 * @param h_bounce Pointer to a variable where to store the
8631 * horizontal bouncing flag.
8632 * @param v_bounce Pointer to a variable where to store the
8633 * vertical bouncing flag.
8635 * @see elm_gengrid_bounce_set() for more details
8639 EINA_DEPRECATED EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8642 * Set a given gengrid widget's scrolling page size, relative to
8643 * its viewport size.
8645 * @param obj The gengrid object
8646 * @param h_pagerel The horizontal page (relative) size
8647 * @param v_pagerel The vertical page (relative) size
8649 * The gengrid's scroller is capable of binding scrolling by the
8650 * user to "pages". It means that, while scrolling and, specially
8651 * after releasing the mouse button, the grid will @b snap to the
8652 * nearest displaying page's area. When page sizes are set, the
8653 * grid's continuous content area is split into (equal) page sized
8656 * This function sets the size of a page <b>relatively to the
8657 * viewport dimensions</b> of the gengrid, for each axis. A value
8658 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8659 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8660 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8661 * 1.0. Values beyond those will make it behave behave
8662 * inconsistently. If you only want one axis to snap to pages, use
8663 * the value @c 0.0 for the other one.
8665 * There is a function setting page size values in @b absolute
8666 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8667 * is mutually exclusive to this one.
8669 * @see elm_gengrid_page_relative_get()
8673 EINA_DEPRECATED EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8676 * Get a given gengrid widget's scrolling page size, relative to
8677 * its viewport size.
8679 * @param obj The gengrid object
8680 * @param h_pagerel Pointer to a variable where to store the
8681 * horizontal page (relative) size
8682 * @param v_pagerel Pointer to a variable where to store the
8683 * vertical page (relative) size
8685 * @see elm_gengrid_page_relative_set() for more details
8689 EINA_DEPRECATED EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8692 * Set a given gengrid widget's scrolling page size
8694 * @param obj The gengrid object
8695 * @param h_pagerel The horizontal page size, in pixels
8696 * @param v_pagerel The vertical page size, in pixels
8698 * The gengrid's scroller is capable of binding scrolling by the
8699 * user to "pages". It means that, while scrolling and, specially
8700 * after releasing the mouse button, the grid will @b snap to the
8701 * nearest displaying page's area. When page sizes are set, the
8702 * grid's continuous content area is split into (equal) page sized
8705 * This function sets the size of a page of the gengrid, in pixels,
8706 * for each axis. Sane usable values are, between @c 0 and the
8707 * dimensions of @p obj, for each axis. Values beyond those will
8708 * make it behave behave inconsistently. If you only want one axis
8709 * to snap to pages, use the value @c 0 for the other one.
8711 * There is a function setting page size values in @b relative
8712 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8713 * use is mutually exclusive to this one.
8717 EINA_DEPRECATED EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8720 * @brief Get gengrid current page number.
8722 * @param obj The gengrid object
8723 * @param h_pagenumber The horizontal page number
8724 * @param v_pagenumber The vertical page number
8726 * The page number starts from 0. 0 is the first page.
8727 * Current page means the page which meet the top-left of the viewport.
8728 * If there are two or more pages in the viewport, it returns the number of page
8729 * which meet the top-left of the viewport.
8731 * @see elm_gengrid_last_page_get()
8732 * @see elm_gengrid_page_show()
8733 * @see elm_gengrid_page_brint_in()
8735 EINA_DEPRECATED EAPI void elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8738 * @brief Get scroll last page number.
8740 * @param obj The gengrid object
8741 * @param h_pagenumber The horizontal page number
8742 * @param v_pagenumber The vertical page number
8744 * The page number starts from 0. 0 is the first page.
8745 * This returns the last page number among the pages.
8747 * @see elm_gengrid_current_page_get()
8748 * @see elm_gengrid_page_show()
8749 * @see elm_gengrid_page_brint_in()
8751 EINA_DEPRECATED EAPI void elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8754 * Show a specific virtual region within the gengrid content object by page number.
8756 * @param obj The gengrid object
8757 * @param h_pagenumber The horizontal page number
8758 * @param v_pagenumber The vertical page number
8760 * 0, 0 of the indicated page is located at the top-left of the viewport.
8761 * This will jump to the page directly without animation.
8766 * sc = elm_gengrid_add(win);
8767 * elm_gengrid_content_set(sc, content);
8768 * elm_gengrid_page_relative_set(sc, 1, 0);
8769 * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8770 * elm_gengrid_page_show(sc, h_page + 1, v_page);
8773 * @see elm_gengrid_page_bring_in()
8775 EINA_DEPRECATED EAPI void elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8778 * Show a specific virtual region within the gengrid content object by page number.
8780 * @param obj The gengrid object
8781 * @param h_pagenumber The horizontal page number
8782 * @param v_pagenumber The vertical page number
8784 * 0, 0 of the indicated page is located at the top-left of the viewport.
8785 * This will slide to the page with animation.
8790 * sc = elm_gengrid_add(win);
8791 * elm_gengrid_content_set(sc, content);
8792 * elm_gengrid_page_relative_set(sc, 1, 0);
8793 * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8794 * elm_gengrid_page_bring_in(sc, h_page, v_page);
8797 * @see elm_gengrid_page_show()
8799 EINA_DEPRECATED EAPI void elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8802 * Set for what direction a given gengrid widget will expand while
8803 * placing its items.
8805 * @param obj The gengrid object.
8806 * @param setting @c EINA_TRUE to make the gengrid expand
8807 * horizontally, @c EINA_FALSE to expand vertically.
8809 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8810 * in @b columns, from top to bottom and, when the space for a
8811 * column is filled, another one is started on the right, thus
8812 * expanding the grid horizontally. When in "vertical mode"
8813 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8814 * to right and, when the space for a row is filled, another one is
8815 * started below, thus expanding the grid vertically.
8817 * @see elm_gengrid_horizontal_get()
8821 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8824 * Get for what direction a given gengrid widget will expand while
8825 * placing its items.
8827 * @param obj The gengrid object.
8828 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8829 * @c EINA_FALSE if it's set to expand vertically.
8831 * @see elm_gengrid_horizontal_set() for more detais
8835 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8838 * Get the first item in a given gengrid widget
8840 * @param obj The gengrid object
8841 * @return The first item's handle or @c NULL, if there are no
8842 * items in @p obj (and on errors)
8844 * This returns the first item in the @p obj's internal list of
8847 * @see elm_gengrid_last_item_get()
8851 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8854 * Get the last item in a given gengrid widget
8856 * @param obj The gengrid object
8857 * @return The last item's handle or @c NULL, if there are no
8858 * items in @p obj (and on errors)
8860 * This returns the last item in the @p obj's internal list of
8863 * @see elm_gengrid_first_item_get()
8867 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8870 * Get the @b next item in a gengrid widget's internal list of items,
8871 * given a handle to one of those items.
8873 * @param item The gengrid item to fetch next from
8874 * @return The item after @p item, or @c NULL if there's none (and
8877 * This returns the item placed after the @p item, on the container
8880 * @see elm_gengrid_item_prev_get()
8884 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8887 * Get the @b previous item in a gengrid widget's internal list of items,
8888 * given a handle to one of those items.
8890 * @param item The gengrid item to fetch previous from
8891 * @return The item before @p item, or @c NULL if there's none (and
8894 * This returns the item placed before the @p item, on the container
8897 * @see elm_gengrid_item_next_get()
8901 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8904 * Get the gengrid object's handle which contains a given gengrid
8907 * @param item The item to fetch the container from
8908 * @return The gengrid (parent) object
8910 * This returns the gengrid object itself that an item belongs to.
8914 EINA_DEPRECATED EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8917 * Remove a gengrid item from the its parent, deleting it.
8919 * @param item The item to be removed.
8920 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8922 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8927 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8930 * Update the contents of a given gengrid item
8932 * @param item The gengrid item
8934 * This updates an item by calling all the item class functions
8935 * again to get the contents, labels and states. Use this when the
8936 * original item data has changed and you want thta changes to be
8941 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8942 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8943 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8946 * Return the data associated to a given gengrid item
8948 * @param item The gengrid item.
8949 * @return the data associated to this item.
8951 * This returns the @c data value passed on the
8952 * elm_gengrid_item_append() and related item addition calls.
8954 * @see elm_gengrid_item_append()
8955 * @see elm_gengrid_item_data_set()
8959 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8962 * Set the data associated to a given gengrid item
8964 * @param item The gengrid item
8965 * @param data The new data pointer to set on it
8967 * This @b overrides the @c data value passed on the
8968 * elm_gengrid_item_append() and related item addition calls. This
8969 * function @b won't call elm_gengrid_item_update() automatically,
8970 * so you'd issue it afterwards if you want to hove the item
8971 * updated to reflect the that new data.
8973 * @see elm_gengrid_item_data_get()
8977 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8980 * Get a given gengrid item's position, relative to the whole
8981 * gengrid's grid area.
8983 * @param item The Gengrid item.
8984 * @param x Pointer to variable where to store the item's <b>row
8986 * @param y Pointer to variable where to store the item's <b>column
8989 * This returns the "logical" position of the item whithin the
8990 * gengrid. For example, @c (0, 1) would stand for first row,
8995 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8998 * Set whether a given gengrid item is selected or not
9000 * @param item The gengrid item
9001 * @param selected Use @c EINA_TRUE, to make it selected, @c
9002 * EINA_FALSE to make it unselected
9004 * This sets the selected state of an item. If multi selection is
9005 * not enabled on the containing gengrid and @p selected is @c
9006 * EINA_TRUE, any other previously selected items will get
9007 * unselected in favor of this new one.
9009 * @see elm_gengrid_item_selected_get()
9013 EINA_DEPRECATED EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9016 * Get whether a given gengrid item is selected or not
9018 * @param item The gengrid item
9019 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9021 * @see elm_gengrid_item_selected_set() for more details
9025 EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9028 * Get the real Evas object created to implement the view of a
9029 * given gengrid item
9031 * @param item The gengrid item.
9032 * @return the Evas object implementing this item's view.
9034 * This returns the actual Evas object used to implement the
9035 * specified gengrid item's view. This may be @c NULL, as it may
9036 * not have been created or may have been deleted, at any time, by
9037 * the gengrid. <b>Do not modify this object</b> (move, resize,
9038 * show, hide, etc.), as the gengrid is controlling it. This
9039 * function is for querying, emitting custom signals or hooking
9040 * lower level callbacks for events on that object. Do not delete
9041 * this object under any circumstances.
9043 * @see elm_gengrid_item_data_get()
9047 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9050 * Show the portion of a gengrid's internal grid containing a given
9051 * item, @b immediately.
9053 * @param item The item to display
9055 * This causes gengrid to @b redraw its viewport's contents to the
9056 * region contining the given @p item item, if it is not fully
9059 * @see elm_gengrid_item_bring_in()
9063 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9066 * Animatedly bring in, to the visible are of a gengrid, a given
9069 * @param item The gengrid item to display
9071 * This causes gengrig to jump to the given @p item item and show
9072 * it (by scrolling), if it is not fully visible. This will use
9073 * animation to do so and take a period of time to complete.
9075 * @see elm_gengrid_item_show()
9079 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9082 * Set whether a given gengrid item is disabled or not.
9084 * @param item The gengrid item
9085 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9086 * to enable it back.
9088 * A disabled item cannot be selected or unselected. It will also
9089 * change its appearance, to signal the user it's disabled.
9091 * @see elm_gengrid_item_disabled_get()
9095 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9098 * Get whether a given gengrid item is disabled or not.
9100 * @param item The gengrid item
9101 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9104 * @see elm_gengrid_item_disabled_set() for more details
9108 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9111 * Set the text to be shown in a given gengrid item's tooltips.
9113 * @param item The gengrid item
9114 * @param text The text to set in the content
9116 * This call will setup the text to be used as tooltip to that item
9117 * (analogous to elm_object_tooltip_text_set(), but being item
9118 * tooltips with higher precedence than object tooltips). It can
9119 * have only one tooltip at a time, so any previous tooltip data
9124 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9127 * Set the content to be shown in a given gengrid item's tooltips
9129 * @param item The gengrid item.
9130 * @param func The function returning the tooltip contents.
9131 * @param data What to provide to @a func as callback data/context.
9132 * @param del_cb Called when data is not needed anymore, either when
9133 * another callback replaces @p func, the tooltip is unset with
9134 * elm_gengrid_item_tooltip_unset() or the owner @p item
9135 * dies. This callback receives as its first parameter the
9136 * given @p data, being @c event_info the item handle.
9138 * This call will setup the tooltip's contents to @p item
9139 * (analogous to elm_object_tooltip_content_cb_set(), but being
9140 * item tooltips with higher precedence than object tooltips). It
9141 * can have only one tooltip at a time, so any previous tooltip
9142 * content will get removed. @p func (with @p data) will be called
9143 * every time Elementary needs to show the tooltip and it should
9144 * return a valid Evas object, which will be fully managed by the
9145 * tooltip system, getting deleted when the tooltip is gone.
9149 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);
9152 * Unset a tooltip from a given gengrid item
9154 * @param item gengrid item to remove a previously set tooltip from.
9156 * This call removes any tooltip set on @p item. The callback
9157 * provided as @c del_cb to
9158 * elm_gengrid_item_tooltip_content_cb_set() will be called to
9159 * notify it is not used anymore (and have resources cleaned, if
9162 * @see elm_gengrid_item_tooltip_content_cb_set()
9166 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9169 * Set a different @b style for a given gengrid item's tooltip.
9171 * @param item gengrid item with tooltip set
9172 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9173 * "default", @c "transparent", etc)
9175 * Tooltips can have <b>alternate styles</b> to be displayed on,
9176 * which are defined by the theme set on Elementary. This function
9177 * works analogously as elm_object_tooltip_style_set(), but here
9178 * applied only to gengrid item objects. The default style for
9179 * tooltips is @c "default".
9181 * @note before you set a style you should define a tooltip with
9182 * elm_gengrid_item_tooltip_content_cb_set() or
9183 * elm_gengrid_item_tooltip_text_set()
9185 * @see elm_gengrid_item_tooltip_style_get()
9189 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9192 * Get the style set a given gengrid item's tooltip.
9194 * @param item gengrid item with tooltip already set on.
9195 * @return style the theme style in use, which defaults to
9196 * "default". If the object does not have a tooltip set,
9197 * then @c NULL is returned.
9199 * @see elm_gengrid_item_tooltip_style_set() for more details
9203 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9205 * @brief Disable size restrictions on an object's tooltip
9206 * @param item The tooltip's anchor object
9207 * @param disable If EINA_TRUE, size restrictions are disabled
9208 * @return EINA_FALSE on failure, EINA_TRUE on success
9210 * This function allows a tooltip to expand beyond its parant window's canvas.
9211 * It will instead be limited only by the size of the display.
9213 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9215 * @brief Retrieve size restriction state of an object's tooltip
9216 * @param item The tooltip's anchor object
9217 * @return If EINA_TRUE, size restrictions are disabled
9219 * This function returns whether a tooltip is allowed to expand beyond
9220 * its parant window's canvas.
9221 * It will instead be limited only by the size of the display.
9223 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9225 * Set the type of mouse pointer/cursor decoration to be shown,
9226 * when the mouse pointer is over the given gengrid widget item
9228 * @param item gengrid item to customize cursor on
9229 * @param cursor the cursor type's name
9231 * This function works analogously as elm_object_cursor_set(), but
9232 * here the cursor's changing area is restricted to the item's
9233 * area, and not the whole widget's. Note that that item cursors
9234 * have precedence over widget cursors, so that a mouse over @p
9235 * item will always show cursor @p type.
9237 * If this function is called twice for an object, a previously set
9238 * cursor will be unset on the second call.
9240 * @see elm_object_cursor_set()
9241 * @see elm_gengrid_item_cursor_get()
9242 * @see elm_gengrid_item_cursor_unset()
9246 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9249 * Get the type of mouse pointer/cursor decoration set to be shown,
9250 * when the mouse pointer is over the given gengrid widget item
9252 * @param item gengrid item with custom cursor set
9253 * @return the cursor type's name or @c NULL, if no custom cursors
9254 * were set to @p item (and on errors)
9256 * @see elm_object_cursor_get()
9257 * @see elm_gengrid_item_cursor_set() for more details
9258 * @see elm_gengrid_item_cursor_unset()
9262 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9265 * Unset any custom mouse pointer/cursor decoration set to be
9266 * shown, when the mouse pointer is over the given gengrid widget
9267 * item, thus making it show the @b default cursor again.
9269 * @param item a gengrid item
9271 * Use this call to undo any custom settings on this item's cursor
9272 * decoration, bringing it back to defaults (no custom style set).
9274 * @see elm_object_cursor_unset()
9275 * @see elm_gengrid_item_cursor_set() for more details
9279 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9282 * Set a different @b style for a given custom cursor set for a
9285 * @param item gengrid item with custom cursor set
9286 * @param style the <b>theme style</b> to use (e.g. @c "default",
9287 * @c "transparent", etc)
9289 * This function only makes sense when one is using custom mouse
9290 * cursor decorations <b>defined in a theme file</b> , which can
9291 * have, given a cursor name/type, <b>alternate styles</b> on
9292 * it. It works analogously as elm_object_cursor_style_set(), but
9293 * here applied only to gengrid item objects.
9295 * @warning Before you set a cursor style you should have defined a
9296 * custom cursor previously on the item, with
9297 * elm_gengrid_item_cursor_set()
9299 * @see elm_gengrid_item_cursor_engine_only_set()
9300 * @see elm_gengrid_item_cursor_style_get()
9304 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9307 * Get the current @b style set for a given gengrid item's custom
9310 * @param item gengrid item with custom cursor set.
9311 * @return style the cursor style in use. If the object does not
9312 * have a cursor set, then @c NULL is returned.
9314 * @see elm_gengrid_item_cursor_style_set() for more details
9318 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9321 * Set if the (custom) cursor for a given gengrid item should be
9322 * searched in its theme, also, or should only rely on the
9325 * @param item item with custom (custom) cursor already set on
9326 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9327 * only on those provided by the rendering engine, @c EINA_FALSE to
9328 * have them searched on the widget's theme, as well.
9330 * @note This call is of use only if you've set a custom cursor
9331 * for gengrid items, with elm_gengrid_item_cursor_set().
9333 * @note By default, cursors will only be looked for between those
9334 * provided by the rendering engine.
9338 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9341 * Get if the (custom) cursor for a given gengrid item is being
9342 * searched in its theme, also, or is only relying on the rendering
9345 * @param item a gengrid item
9346 * @return @c EINA_TRUE, if cursors are being looked for only on
9347 * those provided by the rendering engine, @c EINA_FALSE if they
9348 * are being searched on the widget's theme, as well.
9350 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9354 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9357 * Remove all items from a given gengrid widget
9359 * @param obj The gengrid object.
9361 * This removes (and deletes) all items in @p obj, leaving it
9364 * @see elm_gengrid_item_del(), to remove just one item.
9368 EINA_DEPRECATED EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9371 * Get the selected item in a given gengrid widget
9373 * @param obj The gengrid object.
9374 * @return The selected item's handleor @c NULL, if none is
9375 * selected at the moment (and on errors)
9377 * This returns the selected item in @p obj. If multi selection is
9378 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9379 * the first item in the list is selected, which might not be very
9380 * useful. For that case, see elm_gengrid_selected_items_get().
9384 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9387 * Get <b>a list</b> of selected items in a given gengrid
9389 * @param obj The gengrid object.
9390 * @return The list of selected items or @c NULL, if none is
9391 * selected at the moment (and on errors)
9393 * This returns a list of the selected items, in the order that
9394 * they appear in the grid. This list is only valid as long as no
9395 * more items are selected or unselected (or unselected implictly
9396 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9399 * @see elm_gengrid_selected_item_get()
9403 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9410 * @defgroup Clock Clock
9412 * @image html img/widget/clock/preview-00.png
9413 * @image latex img/widget/clock/preview-00.eps
9415 * This is a @b digital clock widget. In its default theme, it has a
9416 * vintage "flipping numbers clock" appearance, which will animate
9417 * sheets of individual algarisms individually as time goes by.
9419 * A newly created clock will fetch system's time (already
9420 * considering local time adjustments) to start with, and will tick
9421 * accondingly. It may or may not show seconds.
9423 * Clocks have an @b edition mode. When in it, the sheets will
9424 * display extra arrow indications on the top and bottom and the
9425 * user may click on them to raise or lower the time values. After
9426 * it's told to exit edition mode, it will keep ticking with that
9427 * new time set (it keeps the difference from local time).
9429 * Also, when under edition mode, user clicks on the cited arrows
9430 * which are @b held for some time will make the clock to flip the
9431 * sheet, thus editing the time, continuosly and automatically for
9432 * the user. The interval between sheet flips will keep growing in
9433 * time, so that it helps the user to reach a time which is distant
9436 * The time display is, by default, in military mode (24h), but an
9437 * am/pm indicator may be optionally shown, too, when it will
9440 * Smart callbacks one can register to:
9441 * - "changed" - the clock's user changed the time
9443 * Here is an example on its usage:
9444 * @li @ref clock_example
9453 * Identifiers for which clock digits should be editable, when a
9454 * clock widget is in edition mode. Values may be ORed together to
9455 * make a mask, naturally.
9457 * @see elm_clock_edit_set()
9458 * @see elm_clock_digit_edit_set()
9460 typedef enum _Elm_Clock_Digedit
9462 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9463 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9464 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9465 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9466 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9467 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9468 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9469 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9470 } Elm_Clock_Digedit;
9473 * Add a new clock widget to the given parent Elementary
9474 * (container) object
9476 * @param parent The parent object
9477 * @return a new clock widget handle or @c NULL, on errors
9479 * This function inserts a new clock widget on the canvas.
9483 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9486 * Set a clock widget's time, programmatically
9488 * @param obj The clock widget object
9489 * @param hrs The hours to set
9490 * @param min The minutes to set
9491 * @param sec The secondes to set
9493 * This function updates the time that is showed by the clock
9496 * Values @b must be set within the following ranges:
9497 * - 0 - 23, for hours
9498 * - 0 - 59, for minutes
9499 * - 0 - 59, for seconds,
9501 * even if the clock is not in "military" mode.
9503 * @warning The behavior for values set out of those ranges is @b
9508 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9511 * Get a clock widget's time values
9513 * @param obj The clock object
9514 * @param[out] hrs Pointer to the variable to get the hours value
9515 * @param[out] min Pointer to the variable to get the minutes value
9516 * @param[out] sec Pointer to the variable to get the seconds value
9518 * This function gets the time set for @p obj, returning
9519 * it on the variables passed as the arguments to function
9521 * @note Use @c NULL pointers on the time values you're not
9522 * interested in: they'll be ignored by the function.
9526 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9529 * Set whether a given clock widget is under <b>edition mode</b> or
9530 * under (default) displaying-only mode.
9532 * @param obj The clock object
9533 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9534 * put it back to "displaying only" mode
9536 * This function makes a clock's time to be editable or not <b>by
9537 * user interaction</b>. When in edition mode, clocks @b stop
9538 * ticking, until one brings them back to canonical mode. The
9539 * elm_clock_digit_edit_set() function will influence which digits
9540 * of the clock will be editable. By default, all of them will be
9541 * (#ELM_CLOCK_NONE).
9543 * @note am/pm sheets, if being shown, will @b always be editable
9544 * under edition mode.
9546 * @see elm_clock_edit_get()
9550 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9553 * Retrieve whether a given clock widget is under <b>edition
9554 * mode</b> or under (default) displaying-only mode.
9556 * @param obj The clock object
9557 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9560 * This function retrieves whether the clock's time can be edited
9561 * or not by user interaction.
9563 * @see elm_clock_edit_set() for more details
9567 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9570 * Set what digits of the given clock widget should be editable
9571 * when in edition mode.
9573 * @param obj The clock object
9574 * @param digedit Bit mask indicating the digits to be editable
9575 * (values in #Elm_Clock_Digedit).
9577 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9578 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9581 * @see elm_clock_digit_edit_get()
9585 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9588 * Retrieve what digits of the given clock widget should be
9589 * editable when in edition mode.
9591 * @param obj The clock object
9592 * @return Bit mask indicating the digits to be editable
9593 * (values in #Elm_Clock_Digedit).
9595 * @see elm_clock_digit_edit_set() for more details
9599 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9602 * Set if the given clock widget must show hours in military or
9605 * @param obj The clock object
9606 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9609 * This function sets if the clock must show hours in military or
9610 * am/pm mode. In some countries like Brazil the military mode
9611 * (00-24h-format) is used, in opposition to the USA, where the
9612 * am/pm mode is more commonly used.
9614 * @see elm_clock_show_am_pm_get()
9618 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9621 * Get if the given clock widget shows hours in military or am/pm
9624 * @param obj The clock object
9625 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9628 * This function gets if the clock shows hours in military or am/pm
9631 * @see elm_clock_show_am_pm_set() for more details
9635 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9638 * Set if the given clock widget must show time with seconds or not
9640 * @param obj The clock object
9641 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9643 * This function sets if the given clock must show or not elapsed
9644 * seconds. By default, they are @b not shown.
9646 * @see elm_clock_show_seconds_get()
9650 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9653 * Get whether the given clock widget is showing time with seconds
9656 * @param obj The clock object
9657 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9659 * This function gets whether @p obj is showing or not the elapsed
9662 * @see elm_clock_show_seconds_set()
9666 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9669 * Set the interval on time updates for an user mouse button hold
9670 * on clock widgets' time edition.
9672 * @param obj The clock object
9673 * @param interval The (first) interval value in seconds
9675 * This interval value is @b decreased while the user holds the
9676 * mouse pointer either incrementing or decrementing a given the
9677 * clock digit's value.
9679 * This helps the user to get to a given time distant from the
9680 * current one easier/faster, as it will start to flip quicker and
9681 * quicker on mouse button holds.
9683 * The calculation for the next flip interval value, starting from
9684 * the one set with this call, is the previous interval divided by
9685 * 1.05, so it decreases a little bit.
9687 * The default starting interval value for automatic flips is
9690 * @see elm_clock_interval_get()
9694 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9697 * Get the interval on time updates for an user mouse button hold
9698 * on clock widgets' time edition.
9700 * @param obj The clock object
9701 * @return The (first) interval value, in seconds, set on it
9703 * @see elm_clock_interval_set() for more details
9707 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9714 * @defgroup Layout Layout
9716 * @image html img/widget/layout/preview-00.png
9717 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9719 * @image html img/layout-predefined.png
9720 * @image latex img/layout-predefined.eps width=\textwidth
9722 * This is a container widget that takes a standard Edje design file and
9723 * wraps it very thinly in a widget.
9725 * An Edje design (theme) file has a very wide range of possibilities to
9726 * describe the behavior of elements added to the Layout. Check out the Edje
9727 * documentation and the EDC reference to get more information about what can
9728 * be done with Edje.
9730 * Just like @ref List, @ref Box, and other container widgets, any
9731 * object added to the Layout will become its child, meaning that it will be
9732 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9734 * The Layout widget can contain as many Contents, Boxes or Tables as
9735 * described in its theme file. For instance, objects can be added to
9736 * different Tables by specifying the respective Table part names. The same
9737 * is valid for Content and Box.
9739 * The objects added as child of the Layout will behave as described in the
9740 * part description where they were added. There are 3 possible types of
9741 * parts where a child can be added:
9743 * @section secContent Content (SWALLOW part)
9745 * Only one object can be added to the @c SWALLOW part (but you still can
9746 * have many @c SWALLOW parts and one object on each of them). Use the @c
9747 * elm_object_content_set/get/unset functions to set, retrieve and unset
9748 * objects as content of the @c SWALLOW. After being set to this part, the
9749 * object size, position, visibility, clipping and other description
9750 * properties will be totally controled by the description of the given part
9751 * (inside the Edje theme file).
9753 * One can use @c evas_object_size_hint_* functions on the child to have some
9754 * kind of control over its behavior, but the resulting behavior will still
9755 * depend heavily on the @c SWALLOW part description.
9757 * The Edje theme also can change the part description, based on signals or
9758 * scripts running inside the theme. This change can also be animated. All of
9759 * this will affect the child object set as content accordingly. The object
9760 * size will be changed if the part size is changed, it will animate move if
9761 * the part is moving, and so on.
9763 * The following picture demonstrates a Layout widget with a child object
9764 * added to its @c SWALLOW:
9766 * @image html layout_swallow.png
9767 * @image latex layout_swallow.eps width=\textwidth
9769 * @section secBox Box (BOX part)
9771 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9772 * allows one to add objects to the box and have them distributed along its
9773 * area, accordingly to the specified @a layout property (now by @a layout we
9774 * mean the chosen layouting design of the Box, not the Layout widget
9777 * A similar effect for having a box with its position, size and other things
9778 * controled by the Layout theme would be to create an Elementary @ref Box
9779 * widget and add it as a Content in the @c SWALLOW part.
9781 * The main difference of using the Layout Box is that its behavior, the box
9782 * properties like layouting format, padding, align, etc. will be all
9783 * controled by the theme. This means, for example, that a signal could be
9784 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9785 * handled the signal by changing the box padding, or align, or both. Using
9786 * the Elementary @ref Box widget is not necessarily harder or easier, it
9787 * just depends on the circunstances and requirements.
9789 * The Layout Box can be used through the @c elm_layout_box_* set of
9792 * The following picture demonstrates a Layout widget with many child objects
9793 * added to its @c BOX part:
9795 * @image html layout_box.png
9796 * @image latex layout_box.eps width=\textwidth
9798 * @section secTable Table (TABLE part)
9800 * Just like the @ref secBox, the Layout Table is very similar to the
9801 * Elementary @ref Table widget. It allows one to add objects to the Table
9802 * specifying the row and column where the object should be added, and any
9803 * column or row span if necessary.
9805 * Again, we could have this design by adding a @ref Table widget to the @c
9806 * SWALLOW part using elm_object_content_part_set(). The same difference happens
9807 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9808 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9810 * The Layout Table can be used through the @c elm_layout_table_* set of
9813 * The following picture demonstrates a Layout widget with many child objects
9814 * added to its @c TABLE part:
9816 * @image html layout_table.png
9817 * @image latex layout_table.eps width=\textwidth
9819 * @section secPredef Predefined Layouts
9821 * Another interesting thing about the Layout widget is that it offers some
9822 * predefined themes that come with the default Elementary theme. These
9823 * themes can be set by the call elm_layout_theme_set(), and provide some
9824 * basic functionality depending on the theme used.
9826 * Most of them already send some signals, some already provide a toolbar or
9827 * back and next buttons.
9829 * These are available predefined theme layouts. All of them have class = @c
9830 * layout, group = @c application, and style = one of the following options:
9832 * @li @c toolbar-content - application with toolbar and main content area
9833 * @li @c toolbar-content-back - application with toolbar and main content
9834 * area with a back button and title area
9835 * @li @c toolbar-content-back-next - application with toolbar and main
9836 * content area with a back and next buttons and title area
9837 * @li @c content-back - application with a main content area with a back
9838 * button and title area
9839 * @li @c content-back-next - application with a main content area with a
9840 * back and next buttons and title area
9841 * @li @c toolbar-vbox - application with toolbar and main content area as a
9843 * @li @c toolbar-table - application with toolbar and main content area as a
9846 * @section secExamples Examples
9848 * Some examples of the Layout widget can be found here:
9849 * @li @ref layout_example_01
9850 * @li @ref layout_example_02
9851 * @li @ref layout_example_03
9852 * @li @ref layout_example_edc
9857 * Add a new layout to the parent
9859 * @param parent The parent object
9860 * @return The new object or NULL if it cannot be created
9862 * @see elm_layout_file_set()
9863 * @see elm_layout_theme_set()
9867 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9869 * Set the file that will be used as layout
9871 * @param obj The layout object
9872 * @param file The path to file (edj) that will be used as layout
9873 * @param group The group that the layout belongs in edje file
9875 * @return (1 = success, 0 = error)
9879 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9881 * Set the edje group from the elementary theme that will be used as layout
9883 * @param obj The layout object
9884 * @param clas the clas of the group
9885 * @param group the group
9886 * @param style the style to used
9888 * @return (1 = success, 0 = error)
9892 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9894 * Set the layout content.
9896 * @param obj The layout object
9897 * @param swallow The swallow part name in the edje file
9898 * @param content The child that will be added in this layout object
9900 * Once the content object is set, a previously set one will be deleted.
9901 * If you want to keep that old content object, use the
9902 * elm_object_content_part_unset() function.
9904 * @note In an Edje theme, the part used as a content container is called @c
9905 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9906 * expected to be a part name just like the second parameter of
9907 * elm_layout_box_append().
9909 * @see elm_layout_box_append()
9910 * @see elm_object_content_part_get()
9911 * @see elm_object_content_part_unset()
9916 EINA_DEPRECATED EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9918 * Get the child object in the given content part.
9920 * @param obj The layout object
9921 * @param swallow The SWALLOW part to get its content
9923 * @return The swallowed object or NULL if none or an error occurred
9925 * @see elm_object_content_part_set()
9929 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9931 * Unset the layout content.
9933 * @param obj The layout object
9934 * @param swallow The swallow part name in the edje file
9935 * @return The content that was being used
9937 * Unparent and return the content object which was set for this part.
9939 * @see elm_object_content_part_set()
9943 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9945 * Set the text of the given part
9947 * @param obj The layout object
9948 * @param part The TEXT part where to set the text
9949 * @param text The text to set
9952 * @deprecated use elm_object_text_* instead.
9954 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9956 * Get the text set in the given part
9958 * @param obj The layout object
9959 * @param part The TEXT part to retrieve the text off
9961 * @return The text set in @p part
9964 * @deprecated use elm_object_text_* instead.
9966 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9968 * Append child to layout box part.
9970 * @param obj the layout object
9971 * @param part the box part to which the object will be appended.
9972 * @param child the child object to append to box.
9974 * Once the object is appended, it will become child of the layout. Its
9975 * lifetime will be bound to the layout, whenever the layout dies the child
9976 * will be deleted automatically. One should use elm_layout_box_remove() to
9977 * make this layout forget about the object.
9979 * @see elm_layout_box_prepend()
9980 * @see elm_layout_box_insert_before()
9981 * @see elm_layout_box_insert_at()
9982 * @see elm_layout_box_remove()
9986 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9988 * Prepend child to layout box part.
9990 * @param obj the layout object
9991 * @param part the box part to prepend.
9992 * @param child the child object to prepend to box.
9994 * Once the object is prepended, it will become child of the layout. Its
9995 * lifetime will be bound to the layout, whenever the layout dies the child
9996 * will be deleted automatically. One should use elm_layout_box_remove() to
9997 * make this layout forget about the object.
9999 * @see elm_layout_box_append()
10000 * @see elm_layout_box_insert_before()
10001 * @see elm_layout_box_insert_at()
10002 * @see elm_layout_box_remove()
10006 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10008 * Insert child to layout box part before a reference object.
10010 * @param obj the layout object
10011 * @param part the box part to insert.
10012 * @param child the child object to insert into box.
10013 * @param reference another reference object to insert before in box.
10015 * Once the object is inserted, it will become child of the layout. Its
10016 * lifetime will be bound to the layout, whenever the layout dies the child
10017 * will be deleted automatically. One should use elm_layout_box_remove() to
10018 * make this layout forget about the object.
10020 * @see elm_layout_box_append()
10021 * @see elm_layout_box_prepend()
10022 * @see elm_layout_box_insert_before()
10023 * @see elm_layout_box_remove()
10027 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10029 * Insert child to layout box part at a given position.
10031 * @param obj the layout object
10032 * @param part the box part to insert.
10033 * @param child the child object to insert into box.
10034 * @param pos the numeric position >=0 to insert the child.
10036 * Once the object is inserted, it will become child of the layout. Its
10037 * lifetime will be bound to the layout, whenever the layout dies the child
10038 * will be deleted automatically. One should use elm_layout_box_remove() to
10039 * make this layout forget about the object.
10041 * @see elm_layout_box_append()
10042 * @see elm_layout_box_prepend()
10043 * @see elm_layout_box_insert_before()
10044 * @see elm_layout_box_remove()
10048 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10050 * Remove a child of the given part box.
10052 * @param obj The layout object
10053 * @param part The box part name to remove child.
10054 * @param child The object to remove from box.
10055 * @return The object that was being used, or NULL if not found.
10057 * The object will be removed from the box part and its lifetime will
10058 * not be handled by the layout anymore. This is equivalent to
10059 * elm_object_content_part_unset() for box.
10061 * @see elm_layout_box_append()
10062 * @see elm_layout_box_remove_all()
10066 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10068 * Remove all child of the given part box.
10070 * @param obj The layout object
10071 * @param part The box part name to remove child.
10072 * @param clear If EINA_TRUE, then all objects will be deleted as
10073 * well, otherwise they will just be removed and will be
10074 * dangling on the canvas.
10076 * The objects will be removed from the box part and their lifetime will
10077 * not be handled by the layout anymore. This is equivalent to
10078 * elm_layout_box_remove() for all box children.
10080 * @see elm_layout_box_append()
10081 * @see elm_layout_box_remove()
10085 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10087 * Insert child to layout table part.
10089 * @param obj the layout object
10090 * @param part the box part to pack child.
10091 * @param child_obj the child object to pack into table.
10092 * @param col the column to which the child should be added. (>= 0)
10093 * @param row the row to which the child should be added. (>= 0)
10094 * @param colspan how many columns should be used to store this object. (>=
10096 * @param rowspan how many rows should be used to store this object. (>= 1)
10098 * Once the object is inserted, it will become child of the table. Its
10099 * lifetime will be bound to the layout, and whenever the layout dies the
10100 * child will be deleted automatically. One should use
10101 * elm_layout_table_remove() to make this layout forget about the object.
10103 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10104 * more space than a single cell. For instance, the following code:
10106 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10109 * Would result in an object being added like the following picture:
10111 * @image html layout_colspan.png
10112 * @image latex layout_colspan.eps width=\textwidth
10114 * @see elm_layout_table_unpack()
10115 * @see elm_layout_table_clear()
10119 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);
10121 * Unpack (remove) a child of the given part table.
10123 * @param obj The layout object
10124 * @param part The table part name to remove child.
10125 * @param child_obj The object to remove from table.
10126 * @return The object that was being used, or NULL if not found.
10128 * The object will be unpacked from the table part and its lifetime
10129 * will not be handled by the layout anymore. This is equivalent to
10130 * elm_object_content_part_unset() for table.
10132 * @see elm_layout_table_pack()
10133 * @see elm_layout_table_clear()
10137 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10139 * Remove all child of the given part table.
10141 * @param obj The layout object
10142 * @param part The table part name to remove child.
10143 * @param clear If EINA_TRUE, then all objects will be deleted as
10144 * well, otherwise they will just be removed and will be
10145 * dangling on the canvas.
10147 * The objects will be removed from the table part and their lifetime will
10148 * not be handled by the layout anymore. This is equivalent to
10149 * elm_layout_table_unpack() for all table children.
10151 * @see elm_layout_table_pack()
10152 * @see elm_layout_table_unpack()
10156 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10158 * Get the edje layout
10160 * @param obj The layout object
10162 * @return A Evas_Object with the edje layout settings loaded
10163 * with function elm_layout_file_set
10165 * This returns the edje object. It is not expected to be used to then
10166 * swallow objects via edje_object_part_swallow() for example. Use
10167 * elm_object_content_part_set() instead so child object handling and sizing is
10170 * @note This function should only be used if you really need to call some
10171 * low level Edje function on this edje object. All the common stuff (setting
10172 * text, emitting signals, hooking callbacks to signals, etc.) can be done
10173 * with proper elementary functions.
10175 * @see elm_object_signal_callback_add()
10176 * @see elm_object_signal_emit()
10177 * @see elm_object_text_part_set()
10178 * @see elm_object_content_part_set()
10179 * @see elm_layout_box_append()
10180 * @see elm_layout_table_pack()
10181 * @see elm_layout_data_get()
10185 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10187 * Get the edje data from the given layout
10189 * @param obj The layout object
10190 * @param key The data key
10192 * @return The edje data string
10194 * This function fetches data specified inside the edje theme of this layout.
10195 * This function return NULL if data is not found.
10197 * In EDC this comes from a data block within the group block that @p
10198 * obj was loaded from. E.g.
10205 * item: "key1" "value1";
10206 * item: "key2" "value2";
10214 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10218 * @param obj The layout object
10220 * Manually forces a sizing re-evaluation. This is useful when the minimum
10221 * size required by the edje theme of this layout has changed. The change on
10222 * the minimum size required by the edje theme is not immediately reported to
10223 * the elementary layout, so one needs to call this function in order to tell
10224 * the widget (layout) that it needs to reevaluate its own size.
10226 * The minimum size of the theme is calculated based on minimum size of
10227 * parts, the size of elements inside containers like box and table, etc. All
10228 * of this can change due to state changes, and that's when this function
10229 * should be called.
10231 * Also note that a standard signal of "size,eval" "elm" emitted from the
10232 * edje object will cause this to happen too.
10236 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10239 * Sets a specific cursor for an edje part.
10241 * @param obj The layout object.
10242 * @param part_name a part from loaded edje group.
10243 * @param cursor cursor name to use, see Elementary_Cursor.h
10245 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10246 * part not exists or it has "mouse_events: 0".
10250 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10253 * Get the cursor to be shown when mouse is over an edje part
10255 * @param obj The layout object.
10256 * @param part_name a part from loaded edje group.
10257 * @return the cursor name.
10261 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10264 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10266 * @param obj The layout object.
10267 * @param part_name a part from loaded edje group, that had a cursor set
10268 * with elm_layout_part_cursor_set().
10272 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10275 * Sets a specific cursor style for an edje part.
10277 * @param obj The layout object.
10278 * @param part_name a part from loaded edje group.
10279 * @param style the theme style to use (default, transparent, ...)
10281 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10282 * part not exists or it did not had a cursor set.
10286 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10289 * Gets a specific cursor style for an edje part.
10291 * @param obj The layout object.
10292 * @param part_name a part from loaded edje group.
10294 * @return the theme style in use, defaults to "default". If the
10295 * object does not have a cursor set, then NULL is returned.
10299 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10302 * Sets if the cursor set should be searched on the theme or should use
10303 * the provided by the engine, only.
10305 * @note before you set if should look on theme you should define a
10306 * cursor with elm_layout_part_cursor_set(). By default it will only
10307 * look for cursors provided by the engine.
10309 * @param obj The layout object.
10310 * @param part_name a part from loaded edje group.
10311 * @param engine_only if cursors should be just provided by the engine
10312 * or should also search on widget's theme as well
10314 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10315 * part not exists or it did not had a cursor set.
10319 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);
10322 * Gets a specific cursor engine_only for an edje part.
10324 * @param obj The layout object.
10325 * @param part_name a part from loaded edje group.
10327 * @return whenever the cursor is just provided by engine or also from theme.
10331 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10334 * @def elm_layout_icon_set
10335 * Convienience macro to set the icon object in a layout that follows the
10336 * Elementary naming convention for its parts.
10340 #define elm_layout_icon_set(_ly, _obj) \
10343 elm_object_content_part_set((_ly), "elm.swallow.icon", (_obj)); \
10344 if ((_obj)) sig = "elm,state,icon,visible"; \
10345 else sig = "elm,state,icon,hidden"; \
10346 elm_object_signal_emit((_ly), sig, "elm"); \
10350 * @def elm_layout_icon_get
10351 * Convienience macro to get the icon object from a layout that follows the
10352 * Elementary naming convention for its parts.
10356 #define elm_layout_icon_get(_ly) \
10357 elm_object_content_part_get((_ly), "elm.swallow.icon")
10360 * @def elm_layout_end_set
10361 * Convienience macro to set the end object in a layout that follows the
10362 * Elementary naming convention for its parts.
10366 #define elm_layout_end_set(_ly, _obj) \
10369 elm_object_content_part_set((_ly), "elm.swallow.end", (_obj)); \
10370 if ((_obj)) sig = "elm,state,end,visible"; \
10371 else sig = "elm,state,end,hidden"; \
10372 elm_object_signal_emit((_ly), sig, "elm"); \
10376 * @def elm_layout_end_get
10377 * Convienience macro to get the end object in a layout that follows the
10378 * Elementary naming convention for its parts.
10382 #define elm_layout_end_get(_ly) \
10383 elm_object_content_part_get((_ly), "elm.swallow.end")
10386 * @def elm_layout_label_set
10387 * Convienience macro to set the label in a layout that follows the
10388 * Elementary naming convention for its parts.
10391 * @deprecated use elm_object_text_* instead.
10393 #define elm_layout_label_set(_ly, _txt) \
10394 elm_layout_text_set((_ly), "elm.text", (_txt))
10397 * @def elm_layout_label_get
10398 * Convienience macro to get the label in a layout that follows the
10399 * Elementary naming convention for its parts.
10402 * @deprecated use elm_object_text_* instead.
10404 #define elm_layout_label_get(_ly) \
10405 elm_layout_text_get((_ly), "elm.text")
10407 /* smart callbacks called:
10408 * "theme,changed" - when elm theme is changed.
10412 * @defgroup Notify Notify
10414 * @image html img/widget/notify/preview-00.png
10415 * @image latex img/widget/notify/preview-00.eps
10417 * Display a container in a particular region of the parent(top, bottom,
10418 * etc. A timeout can be set to automatically hide the notify. This is so
10419 * that, after an evas_object_show() on a notify object, if a timeout was set
10420 * on it, it will @b automatically get hidden after that time.
10422 * Signals that you can add callbacks for are:
10423 * @li "timeout" - when timeout happens on notify and it's hidden
10424 * @li "block,clicked" - when a click outside of the notify happens
10426 * Default contents parts of the notify widget that you can use for are:
10427 * @li "elm.swallow.content" - A content of the notify
10429 * @ref tutorial_notify show usage of the API.
10434 * @brief Possible orient values for notify.
10436 * This values should be used in conjunction to elm_notify_orient_set() to
10437 * set the position in which the notify should appear(relative to its parent)
10438 * and in conjunction with elm_notify_orient_get() to know where the notify
10441 typedef enum _Elm_Notify_Orient
10443 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10444 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10445 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10446 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10447 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10448 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10449 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10450 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10451 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10452 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10453 } Elm_Notify_Orient;
10455 * @brief Add a new notify to the parent
10457 * @param parent The parent object
10458 * @return The new object or NULL if it cannot be created
10460 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10462 * @brief Set the content of the notify widget
10464 * @param obj The notify object
10465 * @param content The content will be filled in this notify object
10467 * Once the content object is set, a previously set one will be deleted. If
10468 * you want to keep that old content object, use the
10469 * elm_notify_content_unset() function.
10471 EINA_DEPRECATED EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10473 * @brief Unset the content of the notify widget
10475 * @param obj The notify object
10476 * @return The content that was being used
10478 * Unparent and return the content object which was set for this widget
10480 * @see elm_notify_content_set()
10482 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10484 * @brief Return the content of the notify widget
10486 * @param obj The notify object
10487 * @return The content that is being used
10489 * @see elm_notify_content_set()
10491 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10493 * @brief Set the notify parent
10495 * @param obj The notify object
10496 * @param content The new parent
10498 * Once the parent object is set, a previously set one will be disconnected
10501 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10503 * @brief Get the notify parent
10505 * @param obj The notify object
10506 * @return The parent
10508 * @see elm_notify_parent_set()
10510 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10512 * @brief Set the orientation
10514 * @param obj The notify object
10515 * @param orient The new orientation
10517 * Sets the position in which the notify will appear in its parent.
10519 * @see @ref Elm_Notify_Orient for possible values.
10521 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10523 * @brief Return the orientation
10524 * @param obj The notify object
10525 * @return The orientation of the notification
10527 * @see elm_notify_orient_set()
10528 * @see Elm_Notify_Orient
10530 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10532 * @brief Set the time interval after which the notify window is going to be
10535 * @param obj The notify object
10536 * @param time The timeout in seconds
10538 * This function sets a timeout and starts the timer controlling when the
10539 * notify is hidden. Since calling evas_object_show() on a notify restarts
10540 * the timer controlling when the notify is hidden, setting this before the
10541 * notify is shown will in effect mean starting the timer when the notify is
10544 * @note Set a value <= 0.0 to disable a running timer.
10546 * @note If the value > 0.0 and the notify is previously visible, the
10547 * timer will be started with this value, canceling any running timer.
10549 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10551 * @brief Return the timeout value (in seconds)
10552 * @param obj the notify object
10554 * @see elm_notify_timeout_set()
10556 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10558 * @brief Sets whether events should be passed to by a click outside
10561 * @param obj The notify object
10562 * @param repeats EINA_TRUE Events are repeats, else no
10564 * When true if the user clicks outside the window the events will be caught
10565 * by the others widgets, else the events are blocked.
10567 * @note The default value is EINA_TRUE.
10569 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10571 * @brief Return true if events are repeat below the notify object
10572 * @param obj the notify object
10574 * @see elm_notify_repeat_events_set()
10576 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10582 * @defgroup Hover Hover
10584 * @image html img/widget/hover/preview-00.png
10585 * @image latex img/widget/hover/preview-00.eps
10587 * A Hover object will hover over its @p parent object at the @p target
10588 * location. Anything in the background will be given a darker coloring to
10589 * indicate that the hover object is on top (at the default theme). When the
10590 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10591 * clicked that @b doesn't cause the hover to be dismissed.
10593 * A Hover object has two parents. One parent that owns it during creation
10594 * and the other parent being the one over which the hover object spans.
10597 * @note The hover object will take up the entire space of @p target
10600 * Elementary has the following styles for the hover widget:
10604 * @li hoversel_vertical
10606 * The following are the available position for content:
10618 * Signals that you can add callbacks for are:
10619 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10620 * @li "smart,changed" - a content object placed under the "smart"
10621 * policy was replaced to a new slot direction.
10623 * See @ref tutorial_hover for more information.
10627 typedef enum _Elm_Hover_Axis
10629 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10630 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10631 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10632 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10635 * @brief Adds a hover object to @p parent
10637 * @param parent The parent object
10638 * @return The hover object or NULL if one could not be created
10640 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10642 * @brief Sets the target object for the hover.
10644 * @param obj The hover object
10645 * @param target The object to center the hover onto. The hover
10647 * This function will cause the hover to be centered on the target object.
10649 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10651 * @brief Gets the target object for the hover.
10653 * @param obj The hover object
10654 * @param parent The object to locate the hover over.
10656 * @see elm_hover_target_set()
10658 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10660 * @brief Sets the parent object for the hover.
10662 * @param obj The hover object
10663 * @param parent The object to locate the hover over.
10665 * This function will cause the hover to take up the entire space that the
10666 * parent object fills.
10668 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10670 * @brief Gets the parent object for the hover.
10672 * @param obj The hover object
10673 * @return The parent object to locate the hover over.
10675 * @see elm_hover_parent_set()
10677 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10679 * @brief Sets the content of the hover object and the direction in which it
10682 * @param obj The hover object
10683 * @param swallow The direction that the object will be displayed
10684 * at. Accepted values are "left", "top-left", "top", "top-right",
10685 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10687 * @param content The content to place at @p swallow
10689 * Once the content object is set for a given direction, a previously
10690 * set one (on the same direction) will be deleted. If you want to
10691 * keep that old content object, use the elm_hover_content_unset()
10694 * All directions may have contents at the same time, except for
10695 * "smart". This is a special placement hint and its use case
10696 * independs of the calculations coming from
10697 * elm_hover_best_content_location_get(). Its use is for cases when
10698 * one desires only one hover content, but with a dinamic special
10699 * placement within the hover area. The content's geometry, whenever
10700 * it changes, will be used to decide on a best location not
10701 * extrapolating the hover's parent object view to show it in (still
10702 * being the hover's target determinant of its medium part -- move and
10703 * resize it to simulate finger sizes, for example). If one of the
10704 * directions other than "smart" are used, a previously content set
10705 * using it will be deleted, and vice-versa.
10707 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10709 * @brief Get the content of the hover object, in a given direction.
10711 * Return the content object which was set for this widget in the
10712 * @p swallow direction.
10714 * @param obj The hover object
10715 * @param swallow The direction that the object was display at.
10716 * @return The content that was being used
10718 * @see elm_hover_content_set()
10720 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10722 * @brief Unset the content of the hover object, in a given direction.
10724 * Unparent and return the content object set at @p swallow direction.
10726 * @param obj The hover object
10727 * @param swallow The direction that the object was display at.
10728 * @return The content that was being used.
10730 * @see elm_hover_content_set()
10732 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10734 * @brief Returns the best swallow location for content in the hover.
10736 * @param obj The hover object
10737 * @param pref_axis The preferred orientation axis for the hover object to use
10738 * @return The edje location to place content into the hover or @c
10741 * Best is defined here as the location at which there is the most available
10744 * @p pref_axis may be one of
10745 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10746 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10747 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10748 * - @c ELM_HOVER_AXIS_BOTH -- both
10750 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10751 * nescessarily be along the horizontal axis("left" or "right"). If
10752 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10753 * be along the vertical axis("top" or "bottom"). Chossing
10754 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10755 * returned position may be in either axis.
10757 * @see elm_hover_content_set()
10759 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10766 * @defgroup Entry Entry
10768 * @image html img/widget/entry/preview-00.png
10769 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10770 * @image html img/widget/entry/preview-01.png
10771 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10772 * @image html img/widget/entry/preview-02.png
10773 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10774 * @image html img/widget/entry/preview-03.png
10775 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10777 * An entry is a convenience widget which shows a box that the user can
10778 * enter text into. Entries by default don't scroll, so they grow to
10779 * accomodate the entire text, resizing the parent window as needed. This
10780 * can be changed with the elm_entry_scrollable_set() function.
10782 * They can also be single line or multi line (the default) and when set
10783 * to multi line mode they support text wrapping in any of the modes
10784 * indicated by #Elm_Wrap_Type.
10786 * Other features include password mode, filtering of inserted text with
10787 * elm_entry_text_filter_append() and related functions, inline "items" and
10788 * formatted markup text.
10790 * @section entry-markup Formatted text
10792 * The markup tags supported by the Entry are defined by the theme, but
10793 * even when writing new themes or extensions it's a good idea to stick to
10794 * a sane default, to maintain coherency and avoid application breakages.
10795 * Currently defined by the default theme are the following tags:
10796 * @li \<br\>: Inserts a line break.
10797 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10799 * @li \<tab\>: Inserts a tab.
10800 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10802 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10803 * @li \<link\>...\</link\>: Underlines the enclosed text.
10804 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10806 * @section entry-special Special markups
10808 * Besides those used to format text, entries support two special markup
10809 * tags used to insert clickable portions of text or items inlined within
10812 * @subsection entry-anchors Anchors
10814 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10815 * \</a\> tags and an event will be generated when this text is clicked,
10819 * This text is outside <a href=anc-01>but this one is an anchor</a>
10822 * The @c href attribute in the opening tag gives the name that will be
10823 * used to identify the anchor and it can be any valid utf8 string.
10825 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10826 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10827 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10828 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10831 * @subsection entry-items Items
10833 * Inlined in the text, any other @c Evas_Object can be inserted by using
10834 * \<item\> tags this way:
10837 * <item size=16x16 vsize=full href=emoticon/haha></item>
10840 * Just like with anchors, the @c href identifies each item, but these need,
10841 * in addition, to indicate their size, which is done using any one of
10842 * @c size, @c absize or @c relsize attributes. These attributes take their
10843 * value in the WxH format, where W is the width and H the height of the
10846 * @li absize: Absolute pixel size for the item. Whatever value is set will
10847 * be the item's size regardless of any scale value the object may have
10848 * been set to. The final line height will be adjusted to fit larger items.
10849 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10851 * @li relsize: Size is adjusted for the item to fit within the current
10854 * Besides their size, items are specificed a @c vsize value that affects
10855 * how their final size and position are calculated. The possible values
10857 * @li ascent: Item will be placed within the line's baseline and its
10858 * ascent. That is, the height between the line where all characters are
10859 * positioned and the highest point in the line. For @c size and @c absize
10860 * items, the descent value will be added to the total line height to make
10861 * them fit. @c relsize items will be adjusted to fit within this space.
10862 * @li full: Items will be placed between the descent and ascent, or the
10863 * lowest point in the line and its highest.
10865 * The next image shows different configurations of items and how they
10866 * are the previously mentioned options affect their sizes. In all cases,
10867 * the green line indicates the ascent, blue for the baseline and red for
10870 * @image html entry_item.png
10871 * @image latex entry_item.eps width=\textwidth
10873 * And another one to show how size differs from absize. In the first one,
10874 * the scale value is set to 1.0, while the second one is using one of 2.0.
10876 * @image html entry_item_scale.png
10877 * @image latex entry_item_scale.eps width=\textwidth
10879 * After the size for an item is calculated, the entry will request an
10880 * object to place in its space. For this, the functions set with
10881 * elm_entry_item_provider_append() and related functions will be called
10882 * in order until one of them returns a @c non-NULL value. If no providers
10883 * are available, or all of them return @c NULL, then the entry falls back
10884 * to one of the internal defaults, provided the name matches with one of
10887 * All of the following are currently supported:
10890 * - emoticon/angry-shout
10891 * - emoticon/crazy-laugh
10892 * - emoticon/evil-laugh
10894 * - emoticon/goggle-smile
10895 * - emoticon/grumpy
10896 * - emoticon/grumpy-smile
10897 * - emoticon/guilty
10898 * - emoticon/guilty-smile
10900 * - emoticon/half-smile
10901 * - emoticon/happy-panting
10903 * - emoticon/indifferent
10905 * - emoticon/knowing-grin
10907 * - emoticon/little-bit-sorry
10908 * - emoticon/love-lots
10910 * - emoticon/minimal-smile
10911 * - emoticon/not-happy
10912 * - emoticon/not-impressed
10914 * - emoticon/opensmile
10917 * - emoticon/squint-laugh
10918 * - emoticon/surprised
10919 * - emoticon/suspicious
10920 * - emoticon/tongue-dangling
10921 * - emoticon/tongue-poke
10923 * - emoticon/unhappy
10924 * - emoticon/very-sorry
10927 * - emoticon/worried
10930 * Alternatively, an item may reference an image by its path, using
10931 * the URI form @c file:///path/to/an/image.png and the entry will then
10932 * use that image for the item.
10934 * @section entry-files Loading and saving files
10936 * Entries have convinience functions to load text from a file and save
10937 * changes back to it after a short delay. The automatic saving is enabled
10938 * by default, but can be disabled with elm_entry_autosave_set() and files
10939 * can be loaded directly as plain text or have any markup in them
10940 * recognized. See elm_entry_file_set() for more details.
10942 * @section entry-signals Emitted signals
10944 * This widget emits the following signals:
10946 * @li "changed": The text within the entry was changed.
10947 * @li "changed,user": The text within the entry was changed because of user interaction.
10948 * @li "activated": The enter key was pressed on a single line entry.
10949 * @li "press": A mouse button has been pressed on the entry.
10950 * @li "longpressed": A mouse button has been pressed and held for a couple
10952 * @li "clicked": The entry has been clicked (mouse press and release).
10953 * @li "clicked,double": The entry has been double clicked.
10954 * @li "clicked,triple": The entry has been triple clicked.
10955 * @li "focused": The entry has received focus.
10956 * @li "unfocused": The entry has lost focus.
10957 * @li "selection,paste": A paste of the clipboard contents was requested.
10958 * @li "selection,copy": A copy of the selected text into the clipboard was
10960 * @li "selection,cut": A cut of the selected text into the clipboard was
10962 * @li "selection,start": A selection has begun and no previous selection
10964 * @li "selection,changed": The current selection has changed.
10965 * @li "selection,cleared": The current selection has been cleared.
10966 * @li "cursor,changed": The cursor has changed position.
10967 * @li "anchor,clicked": An anchor has been clicked. The event_info
10968 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10969 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10970 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10971 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10972 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10973 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10974 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10975 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10976 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10977 * @li "preedit,changed": The preedit string has changed.
10978 * @li "language,changed": Program language changed.
10980 * @section entry-examples
10982 * An overview of the Entry API can be seen in @ref entry_example_01
10987 * @typedef Elm_Entry_Anchor_Info
10989 * The info sent in the callback for the "anchor,clicked" signals emitted
10992 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10994 * @struct _Elm_Entry_Anchor_Info
10996 * The info sent in the callback for the "anchor,clicked" signals emitted
10999 struct _Elm_Entry_Anchor_Info
11001 const char *name; /**< The name of the anchor, as stated in its href */
11002 int button; /**< The mouse button used to click on it */
11003 Evas_Coord x, /**< Anchor geometry, relative to canvas */
11004 y, /**< Anchor geometry, relative to canvas */
11005 w, /**< Anchor geometry, relative to canvas */
11006 h; /**< Anchor geometry, relative to canvas */
11009 * @typedef Elm_Entry_Filter_Cb
11010 * This callback type is used by entry filters to modify text.
11011 * @param data The data specified as the last param when adding the filter
11012 * @param entry The entry object
11013 * @param text A pointer to the location of the text being filtered. This data can be modified,
11014 * but any additional allocations must be managed by the user.
11015 * @see elm_entry_text_filter_append
11016 * @see elm_entry_text_filter_prepend
11018 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11021 * This adds an entry to @p parent object.
11023 * By default, entries are:
11027 * @li autosave is enabled
11029 * @param parent The parent object
11030 * @return The new object or NULL if it cannot be created
11032 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11034 * Sets the entry to single line mode.
11036 * In single line mode, entries don't ever wrap when the text reaches the
11037 * edge, and instead they keep growing horizontally. Pressing the @c Enter
11038 * key will generate an @c "activate" event instead of adding a new line.
11040 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11041 * and pressing enter will break the text into a different line
11042 * without generating any events.
11044 * @param obj The entry object
11045 * @param single_line If true, the text in the entry
11046 * will be on a single line.
11048 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11050 * Gets whether the entry is set to be single line.
11052 * @param obj The entry object
11053 * @return single_line If true, the text in the entry is set to display
11054 * on a single line.
11056 * @see elm_entry_single_line_set()
11058 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11060 * Sets the entry to password mode.
11062 * In password mode, entries are implicitly single line and the display of
11063 * any text in them is replaced with asterisks (*).
11065 * @param obj The entry object
11066 * @param password If true, password mode is enabled.
11068 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11070 * Gets whether the entry is set to password mode.
11072 * @param obj The entry object
11073 * @return If true, the entry is set to display all characters
11074 * as asterisks (*).
11076 * @see elm_entry_password_set()
11078 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11080 * This sets the text displayed within the entry to @p entry.
11082 * @param obj The entry object
11083 * @param entry The text to be displayed
11085 * @deprecated Use elm_object_text_set() instead.
11086 * @note Using this function bypasses text filters
11088 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11090 * This returns the text currently shown in object @p entry.
11091 * See also elm_entry_entry_set().
11093 * @param obj The entry object
11094 * @return The currently displayed text or NULL on failure
11096 * @deprecated Use elm_object_text_get() instead.
11098 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11100 * Appends @p entry to the text of the entry.
11102 * Adds the text in @p entry to the end of any text already present in the
11105 * The appended text is subject to any filters set for the widget.
11107 * @param obj The entry object
11108 * @param entry The text to be displayed
11110 * @see elm_entry_text_filter_append()
11112 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11114 * Gets whether the entry is empty.
11116 * Empty means no text at all. If there are any markup tags, like an item
11117 * tag for which no provider finds anything, and no text is displayed, this
11118 * function still returns EINA_FALSE.
11120 * @param obj The entry object
11121 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11123 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11125 * Gets any selected text within the entry.
11127 * If there's any selected text in the entry, this function returns it as
11128 * a string in markup format. NULL is returned if no selection exists or
11129 * if an error occurred.
11131 * The returned value points to an internal string and should not be freed
11132 * or modified in any way. If the @p entry object is deleted or its
11133 * contents are changed, the returned pointer should be considered invalid.
11135 * @param obj The entry object
11136 * @return The selected text within the entry or NULL on failure
11138 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11140 * Inserts the given text into the entry at the current cursor position.
11142 * This inserts text at the cursor position as if it was typed
11143 * by the user (note that this also allows markup which a user
11144 * can't just "type" as it would be converted to escaped text, so this
11145 * call can be used to insert things like emoticon items or bold push/pop
11146 * tags, other font and color change tags etc.)
11148 * If any selection exists, it will be replaced by the inserted text.
11150 * The inserted text is subject to any filters set for the widget.
11152 * @param obj The entry object
11153 * @param entry The text to insert
11155 * @see elm_entry_text_filter_append()
11157 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11159 * Set the line wrap type to use on multi-line entries.
11161 * Sets the wrap type used by the entry to any of the specified in
11162 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11163 * line (without inserting a line break or paragraph separator) when it
11164 * reaches the far edge of the widget.
11166 * Note that this only makes sense for multi-line entries. A widget set
11167 * to be single line will never wrap.
11169 * @param obj The entry object
11170 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11172 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11174 * Gets the wrap mode the entry was set to use.
11176 * @param obj The entry object
11177 * @return Wrap type
11179 * @see also elm_entry_line_wrap_set()
11181 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11183 * Sets if the entry is to be editable or not.
11185 * By default, entries are editable and when focused, any text input by the
11186 * user will be inserted at the current cursor position. But calling this
11187 * function with @p editable as EINA_FALSE will prevent the user from
11188 * inputting text into the entry.
11190 * The only way to change the text of a non-editable entry is to use
11191 * elm_object_text_set(), elm_entry_entry_insert() and other related
11194 * @param obj The entry object
11195 * @param editable If EINA_TRUE, user input will be inserted in the entry,
11196 * if not, the entry is read-only and no user input is allowed.
11198 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11200 * Gets whether the entry is editable or not.
11202 * @param obj The entry object
11203 * @return If true, the entry is editable by the user.
11204 * If false, it is not editable by the user
11206 * @see elm_entry_editable_set()
11208 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11210 * This drops any existing text selection within the entry.
11212 * @param obj The entry object
11214 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11216 * This selects all text within the entry.
11218 * @param obj The entry object
11220 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11222 * This moves the cursor one place to the right within the entry.
11224 * @param obj The entry object
11225 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11227 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11229 * This moves the cursor one place to the left within the entry.
11231 * @param obj The entry object
11232 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11234 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11236 * This moves the cursor one line up within the entry.
11238 * @param obj The entry object
11239 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11241 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11243 * This moves the cursor one line down within the entry.
11245 * @param obj The entry object
11246 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11248 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11250 * This moves the cursor to the beginning of the entry.
11252 * @param obj The entry object
11254 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11256 * This moves the cursor to the end of the entry.
11258 * @param obj The entry object
11260 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11262 * This moves the cursor to the beginning of the current line.
11264 * @param obj The entry object
11266 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11268 * This moves the cursor to the end of the current line.
11270 * @param obj The entry object
11272 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11274 * This begins a selection within the entry as though
11275 * the user were holding down the mouse button to make a selection.
11277 * @param obj The entry object
11279 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11281 * This ends a selection within the entry as though
11282 * the user had just released the mouse button while making a selection.
11284 * @param obj The entry object
11286 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11288 * Gets whether a format node exists at the current cursor position.
11290 * A format node is anything that defines how the text is rendered. It can
11291 * be a visible format node, such as a line break or a paragraph separator,
11292 * or an invisible one, such as bold begin or end tag.
11293 * This function returns whether any format node exists at the current
11296 * @param obj The entry object
11297 * @return EINA_TRUE if the current cursor position contains a format node,
11298 * EINA_FALSE otherwise.
11300 * @see elm_entry_cursor_is_visible_format_get()
11302 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11304 * Gets if the current cursor position holds a visible format node.
11306 * @param obj The entry object
11307 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11308 * if it's an invisible one or no format exists.
11310 * @see elm_entry_cursor_is_format_get()
11312 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11314 * Gets the character pointed by the cursor at its current position.
11316 * This function returns a string with the utf8 character stored at the
11317 * current cursor position.
11318 * Only the text is returned, any format that may exist will not be part
11319 * of the return value.
11321 * @param obj The entry object
11322 * @return The text pointed by the cursors.
11324 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11326 * This function returns the geometry of the cursor.
11328 * It's useful if you want to draw something on the cursor (or where it is),
11329 * or for example in the case of scrolled entry where you want to show the
11332 * @param obj The entry object
11333 * @param x returned geometry
11334 * @param y returned geometry
11335 * @param w returned geometry
11336 * @param h returned geometry
11337 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11339 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);
11341 * Sets the cursor position in the entry to the given value
11343 * The value in @p pos is the index of the character position within the
11344 * contents of the string as returned by elm_entry_cursor_pos_get().
11346 * @param obj The entry object
11347 * @param pos The position of the cursor
11349 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11351 * Retrieves the current position of the cursor in the entry
11353 * @param obj The entry object
11354 * @return The cursor position
11356 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11358 * This executes a "cut" action on the selected text in the entry.
11360 * @param obj The entry object
11362 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11364 * This executes a "copy" action on the selected text in the entry.
11366 * @param obj The entry object
11368 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11370 * This executes a "paste" action in the entry.
11372 * @param obj The entry object
11374 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11376 * This clears and frees the items in a entry's contextual (longpress)
11379 * @param obj The entry object
11381 * @see elm_entry_context_menu_item_add()
11383 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11385 * This adds an item to the entry's contextual menu.
11387 * A longpress on an entry will make the contextual menu show up, if this
11388 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11389 * By default, this menu provides a few options like enabling selection mode,
11390 * which is useful on embedded devices that need to be explicit about it,
11391 * and when a selection exists it also shows the copy and cut actions.
11393 * With this function, developers can add other options to this menu to
11394 * perform any action they deem necessary.
11396 * @param obj The entry object
11397 * @param label The item's text label
11398 * @param icon_file The item's icon file
11399 * @param icon_type The item's icon type
11400 * @param func The callback to execute when the item is clicked
11401 * @param data The data to associate with the item for related functions
11403 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);
11405 * This disables the entry's contextual (longpress) menu.
11407 * @param obj The entry object
11408 * @param disabled If true, the menu is disabled
11410 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11412 * This returns whether the entry's contextual (longpress) menu is
11415 * @param obj The entry object
11416 * @return If true, the menu is disabled
11418 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11420 * This appends a custom item provider to the list for that entry
11422 * This appends the given callback. The list is walked from beginning to end
11423 * with each function called given the item href string in the text. If the
11424 * function returns an object handle other than NULL (it should create an
11425 * object to do this), then this object is used to replace that item. If
11426 * not the next provider is called until one provides an item object, or the
11427 * default provider in entry does.
11429 * @param obj The entry object
11430 * @param func The function called to provide the item object
11431 * @param data The data passed to @p func
11433 * @see @ref entry-items
11435 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);
11437 * This prepends a custom item provider to the list for that entry
11439 * This prepends the given callback. See elm_entry_item_provider_append() for
11442 * @param obj The entry object
11443 * @param func The function called to provide the item object
11444 * @param data The data passed to @p func
11446 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);
11448 * This removes a custom item provider to the list for that entry
11450 * This removes the given callback. See elm_entry_item_provider_append() for
11453 * @param obj The entry object
11454 * @param func The function called to provide the item object
11455 * @param data The data passed to @p func
11457 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);
11459 * Append a filter function for text inserted in the entry
11461 * Append the given callback to the list. This functions will be called
11462 * whenever any text is inserted into the entry, with the text to be inserted
11463 * as a parameter. The callback function is free to alter the text in any way
11464 * it wants, but it must remember to free the given pointer and update it.
11465 * If the new text is to be discarded, the function can free it and set its
11466 * text parameter to NULL. This will also prevent any following filters from
11469 * @param obj The entry object
11470 * @param func The function to use as text filter
11471 * @param data User data to pass to @p func
11473 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11475 * Prepend a filter function for text insdrted in the entry
11477 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11478 * for more information
11480 * @param obj The entry object
11481 * @param func The function to use as text filter
11482 * @param data User data to pass to @p func
11484 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11486 * Remove a filter from the list
11488 * Removes the given callback from the filter list. See
11489 * elm_entry_text_filter_append() for more information.
11491 * @param obj The entry object
11492 * @param func The filter function to remove
11493 * @param data The user data passed when adding the function
11495 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11497 * This converts a markup (HTML-like) string into UTF-8.
11499 * The returned string is a malloc'ed buffer and it should be freed when
11500 * not needed anymore.
11502 * @param s The string (in markup) to be converted
11503 * @return The converted string (in UTF-8). It should be freed.
11505 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11507 * This converts a UTF-8 string into markup (HTML-like).
11509 * The returned string is a malloc'ed buffer and it should be freed when
11510 * not needed anymore.
11512 * @param s The string (in UTF-8) to be converted
11513 * @return The converted string (in markup). It should be freed.
11515 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11517 * This sets the file (and implicitly loads it) for the text to display and
11518 * then edit. All changes are written back to the file after a short delay if
11519 * the entry object is set to autosave (which is the default).
11521 * If the entry had any other file set previously, any changes made to it
11522 * will be saved if the autosave feature is enabled, otherwise, the file
11523 * will be silently discarded and any non-saved changes will be lost.
11525 * @param obj The entry object
11526 * @param file The path to the file to load and save
11527 * @param format The file format
11529 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11531 * Gets the file being edited by the entry.
11533 * This function can be used to retrieve any file set on the entry for
11534 * edition, along with the format used to load and save it.
11536 * @param obj The entry object
11537 * @param file The path to the file to load and save
11538 * @param format The file format
11540 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11542 * This function writes any changes made to the file set with
11543 * elm_entry_file_set()
11545 * @param obj The entry object
11547 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11549 * This sets the entry object to 'autosave' the loaded text file or not.
11551 * @param obj The entry object
11552 * @param autosave Autosave the loaded file or not
11554 * @see elm_entry_file_set()
11556 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11558 * This gets the entry object's 'autosave' status.
11560 * @param obj The entry object
11561 * @return Autosave the loaded file or not
11563 * @see elm_entry_file_set()
11565 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11567 * Control pasting of text and images for the widget.
11569 * Normally the entry allows both text and images to be pasted. By setting
11570 * textonly to be true, this prevents images from being pasted.
11572 * Note this only changes the behaviour of text.
11574 * @param obj The entry object
11575 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11576 * text+image+other.
11578 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11580 * Getting elm_entry text paste/drop mode.
11582 * In textonly mode, only text may be pasted or dropped into the widget.
11584 * @param obj The entry object
11585 * @return If the widget only accepts text from pastes.
11587 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11589 * Enable or disable scrolling in entry
11591 * Normally the entry is not scrollable unless you enable it with this call.
11593 * @param obj The entry object
11594 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11596 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11598 * Get the scrollable state of the entry
11600 * Normally the entry is not scrollable. This gets the scrollable state
11601 * of the entry. See elm_entry_scrollable_set() for more information.
11603 * @param obj The entry object
11604 * @return The scrollable state
11606 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11608 * This sets a widget to be displayed to the left of a scrolled entry.
11610 * @param obj The scrolled entry object
11611 * @param icon The widget to display on the left side of the scrolled
11614 * @note A previously set widget will be destroyed.
11615 * @note If the object being set does not have minimum size hints set,
11616 * it won't get properly displayed.
11618 * @see elm_entry_end_set()
11620 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11622 * Gets the leftmost widget of the scrolled entry. This object is
11623 * owned by the scrolled entry and should not be modified.
11625 * @param obj The scrolled entry object
11626 * @return the left widget inside the scroller
11628 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11630 * Unset the leftmost widget of the scrolled entry, unparenting and
11633 * @param obj The scrolled entry object
11634 * @return the previously set icon sub-object of this entry, on
11637 * @see elm_entry_icon_set()
11639 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11641 * Sets the visibility of the left-side widget of the scrolled entry,
11642 * set by elm_entry_icon_set().
11644 * @param obj The scrolled entry object
11645 * @param setting EINA_TRUE if the object should be displayed,
11646 * EINA_FALSE if not.
11648 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11650 * This sets a widget to be displayed to the end of a scrolled entry.
11652 * @param obj The scrolled entry object
11653 * @param end The widget to display on the right side of the scrolled
11656 * @note A previously set widget will be destroyed.
11657 * @note If the object being set does not have minimum size hints set,
11658 * it won't get properly displayed.
11660 * @see elm_entry_icon_set
11662 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11664 * Gets the endmost widget of the scrolled entry. This object is owned
11665 * by the scrolled entry and should not be modified.
11667 * @param obj The scrolled entry object
11668 * @return the right widget inside the scroller
11670 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11672 * Unset the endmost widget of the scrolled entry, unparenting and
11675 * @param obj The scrolled entry object
11676 * @return the previously set icon sub-object of this entry, on
11679 * @see elm_entry_icon_set()
11681 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11683 * Sets the visibility of the end widget of the scrolled entry, set by
11684 * elm_entry_end_set().
11686 * @param obj The scrolled entry object
11687 * @param setting EINA_TRUE if the object should be displayed,
11688 * EINA_FALSE if not.
11690 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11692 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11695 * Setting an entry to single-line mode with elm_entry_single_line_set()
11696 * will automatically disable the display of scrollbars when the entry
11697 * moves inside its scroller.
11699 * @param obj The scrolled entry object
11700 * @param h The horizontal scrollbar policy to apply
11701 * @param v The vertical scrollbar policy to apply
11703 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11705 * This enables/disables bouncing within the entry.
11707 * This function sets whether the entry will bounce when scrolling reaches
11708 * the end of the contained entry.
11710 * @param obj The scrolled entry object
11711 * @param h The horizontal bounce state
11712 * @param v The vertical bounce state
11714 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11716 * Get the bounce mode
11718 * @param obj The Entry object
11719 * @param h_bounce Allow bounce horizontally
11720 * @param v_bounce Allow bounce vertically
11722 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11724 /* pre-made filters for entries */
11726 * @typedef Elm_Entry_Filter_Limit_Size
11728 * Data for the elm_entry_filter_limit_size() entry filter.
11730 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11732 * @struct _Elm_Entry_Filter_Limit_Size
11734 * Data for the elm_entry_filter_limit_size() entry filter.
11736 struct _Elm_Entry_Filter_Limit_Size
11738 int max_char_count; /**< The maximum number of characters allowed. */
11739 int max_byte_count; /**< The maximum number of bytes allowed*/
11742 * Filter inserted text based on user defined character and byte limits
11744 * Add this filter to an entry to limit the characters that it will accept
11745 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11746 * The funtion works on the UTF-8 representation of the string, converting
11747 * it from the set markup, thus not accounting for any format in it.
11749 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11750 * it as data when setting the filter. In it, it's possible to set limits
11751 * by character count or bytes (any of them is disabled if 0), and both can
11752 * be set at the same time. In that case, it first checks for characters,
11755 * The function will cut the inserted text in order to allow only the first
11756 * number of characters that are still allowed. The cut is made in
11757 * characters, even when limiting by bytes, in order to always contain
11758 * valid ones and avoid half unicode characters making it in.
11760 * This filter, like any others, does not apply when setting the entry text
11761 * directly with elm_object_text_set() (or the deprecated
11762 * elm_entry_entry_set()).
11764 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11766 * @typedef Elm_Entry_Filter_Accept_Set
11768 * Data for the elm_entry_filter_accept_set() entry filter.
11770 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11772 * @struct _Elm_Entry_Filter_Accept_Set
11774 * Data for the elm_entry_filter_accept_set() entry filter.
11776 struct _Elm_Entry_Filter_Accept_Set
11778 const char *accepted; /**< Set of characters accepted in the entry. */
11779 const char *rejected; /**< Set of characters rejected from the entry. */
11782 * Filter inserted text based on accepted or rejected sets of characters
11784 * Add this filter to an entry to restrict the set of accepted characters
11785 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11786 * This structure contains both accepted and rejected sets, but they are
11787 * mutually exclusive.
11789 * The @c accepted set takes preference, so if it is set, the filter will
11790 * only work based on the accepted characters, ignoring anything in the
11791 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11793 * In both cases, the function filters by matching utf8 characters to the
11794 * raw markup text, so it can be used to remove formatting tags.
11796 * This filter, like any others, does not apply when setting the entry text
11797 * directly with elm_object_text_set() (or the deprecated
11798 * elm_entry_entry_set()).
11800 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11802 * Set the input panel layout of the entry
11804 * @param obj The entry object
11805 * @param layout layout type
11807 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11809 * Get the input panel layout of the entry
11811 * @param obj The entry object
11812 * @return layout type
11814 * @see elm_entry_input_panel_layout_set
11816 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11818 * Set the autocapitalization type on the immodule.
11820 * @param obj The entry object
11821 * @param autocapital_type The type of autocapitalization
11823 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11825 * Retrieve the autocapitalization type on the immodule.
11827 * @param obj The entry object
11828 * @return autocapitalization type
11830 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11832 * Sets the attribute to show the input panel automatically.
11834 * @param obj The entry object
11835 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
11837 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
11839 * Retrieve the attribute to show the input panel automatically.
11841 * @param obj The entry object
11842 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
11844 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11850 /* composite widgets - these basically put together basic widgets above
11851 * in convenient packages that do more than basic stuff */
11855 * @defgroup Anchorview Anchorview
11857 * @image html img/widget/anchorview/preview-00.png
11858 * @image latex img/widget/anchorview/preview-00.eps
11860 * Anchorview is for displaying text that contains markup with anchors
11861 * like <c>\<a href=1234\>something\</\></c> in it.
11863 * Besides being styled differently, the anchorview widget provides the
11864 * necessary functionality so that clicking on these anchors brings up a
11865 * popup with user defined content such as "call", "add to contacts" or
11866 * "open web page". This popup is provided using the @ref Hover widget.
11868 * This widget is very similar to @ref Anchorblock, so refer to that
11869 * widget for an example. The only difference Anchorview has is that the
11870 * widget is already provided with scrolling functionality, so if the
11871 * text set to it is too large to fit in the given space, it will scroll,
11872 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11873 * text can be displayed.
11875 * This widget emits the following signals:
11876 * @li "anchor,clicked": will be called when an anchor is clicked. The
11877 * @p event_info parameter on the callback will be a pointer of type
11878 * ::Elm_Entry_Anchorview_Info.
11880 * See @ref Anchorblock for an example on how to use both of them.
11889 * @typedef Elm_Entry_Anchorview_Info
11891 * The info sent in the callback for "anchor,clicked" signals emitted by
11892 * the Anchorview widget.
11894 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11896 * @struct _Elm_Entry_Anchorview_Info
11898 * The info sent in the callback for "anchor,clicked" signals emitted by
11899 * the Anchorview widget.
11901 struct _Elm_Entry_Anchorview_Info
11903 const char *name; /**< Name of the anchor, as indicated in its href
11905 int button; /**< The mouse button used to click on it */
11906 Evas_Object *hover; /**< The hover object to use for the popup */
11908 Evas_Coord x, y, w, h;
11909 } anchor, /**< Geometry selection of text used as anchor */
11910 hover_parent; /**< Geometry of the object used as parent by the
11912 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11913 for content on the left side of
11914 the hover. Before calling the
11915 callback, the widget will make the
11916 necessary calculations to check
11917 which sides are fit to be set with
11918 content, based on the position the
11919 hover is activated and its distance
11920 to the edges of its parent object
11922 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
11923 the right side of the hover.
11924 See @ref hover_left */
11925 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
11926 of the hover. See @ref hover_left */
11927 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
11928 below the hover. See @ref
11932 * Add a new Anchorview object
11934 * @param parent The parent object
11935 * @return The new object or NULL if it cannot be created
11937 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11939 * Set the text to show in the anchorview
11941 * Sets the text of the anchorview to @p text. This text can include markup
11942 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11943 * text that will be specially styled and react to click events, ended with
11944 * either of \</a\> or \</\>. When clicked, the anchor will emit an
11945 * "anchor,clicked" signal that you can attach a callback to with
11946 * evas_object_smart_callback_add(). The name of the anchor given in the
11947 * event info struct will be the one set in the href attribute, in this
11948 * case, anchorname.
11950 * Other markup can be used to style the text in different ways, but it's
11951 * up to the style defined in the theme which tags do what.
11952 * @deprecated use elm_object_text_set() instead.
11954 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11956 * Get the markup text set for the anchorview
11958 * Retrieves the text set on the anchorview, with markup tags included.
11960 * @param obj The anchorview object
11961 * @return The markup text set or @c NULL if nothing was set or an error
11963 * @deprecated use elm_object_text_set() instead.
11965 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11967 * Set the parent of the hover popup
11969 * Sets the parent object to use by the hover created by the anchorview
11970 * when an anchor is clicked. See @ref Hover for more details on this.
11971 * If no parent is set, the same anchorview object will be used.
11973 * @param obj The anchorview object
11974 * @param parent The object to use as parent for the hover
11976 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11978 * Get the parent of the hover popup
11980 * Get the object used as parent for the hover created by the anchorview
11981 * widget. See @ref Hover for more details on this.
11983 * @param obj The anchorview object
11984 * @return The object used as parent for the hover, NULL if none is set.
11986 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11988 * Set the style that the hover should use
11990 * When creating the popup hover, anchorview will request that it's
11991 * themed according to @p style.
11993 * @param obj The anchorview object
11994 * @param style The style to use for the underlying hover
11996 * @see elm_object_style_set()
11998 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12000 * Get the style that the hover should use
12002 * Get the style the hover created by anchorview will use.
12004 * @param obj The anchorview object
12005 * @return The style to use by the hover. NULL means the default is used.
12007 * @see elm_object_style_set()
12009 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12011 * Ends the hover popup in the anchorview
12013 * When an anchor is clicked, the anchorview widget will create a hover
12014 * object to use as a popup with user provided content. This function
12015 * terminates this popup, returning the anchorview to its normal state.
12017 * @param obj The anchorview object
12019 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12021 * Set bouncing behaviour when the scrolled content reaches an edge
12023 * Tell the internal scroller object whether it should bounce or not
12024 * when it reaches the respective edges for each axis.
12026 * @param obj The anchorview object
12027 * @param h_bounce Whether to bounce or not in the horizontal axis
12028 * @param v_bounce Whether to bounce or not in the vertical axis
12030 * @see elm_scroller_bounce_set()
12032 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12034 * Get the set bouncing behaviour of the internal scroller
12036 * Get whether the internal scroller should bounce when the edge of each
12037 * axis is reached scrolling.
12039 * @param obj The anchorview object
12040 * @param h_bounce Pointer where to store the bounce state of the horizontal
12042 * @param v_bounce Pointer where to store the bounce state of the vertical
12045 * @see elm_scroller_bounce_get()
12047 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12049 * Appends a custom item provider to the given anchorview
12051 * Appends the given function to the list of items providers. This list is
12052 * called, one function at a time, with the given @p data pointer, the
12053 * anchorview object and, in the @p item parameter, the item name as
12054 * referenced in its href string. Following functions in the list will be
12055 * called in order until one of them returns something different to NULL,
12056 * which should be an Evas_Object which will be used in place of the item
12059 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12060 * href=item/name\>\</item\>
12062 * @param obj The anchorview object
12063 * @param func The function to add to the list of providers
12064 * @param data User data that will be passed to the callback function
12066 * @see elm_entry_item_provider_append()
12068 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);
12070 * Prepend a custom item provider to the given anchorview
12072 * Like elm_anchorview_item_provider_append(), but it adds the function
12073 * @p func to the beginning of the list, instead of the end.
12075 * @param obj The anchorview object
12076 * @param func The function to add to the list of providers
12077 * @param data User data that will be passed to the callback function
12079 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);
12081 * Remove a custom item provider from the list of the given anchorview
12083 * Removes the function and data pairing that matches @p func and @p data.
12084 * That is, unless the same function and same user data are given, the
12085 * function will not be removed from the list. This allows us to add the
12086 * same callback several times, with different @p data pointers and be
12087 * able to remove them later without conflicts.
12089 * @param obj The anchorview object
12090 * @param func The function to remove from the list
12091 * @param data The data matching the function to remove from the list
12093 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);
12100 * @defgroup Anchorblock Anchorblock
12102 * @image html img/widget/anchorblock/preview-00.png
12103 * @image latex img/widget/anchorblock/preview-00.eps
12105 * Anchorblock is for displaying text that contains markup with anchors
12106 * like <c>\<a href=1234\>something\</\></c> in it.
12108 * Besides being styled differently, the anchorblock widget provides the
12109 * necessary functionality so that clicking on these anchors brings up a
12110 * popup with user defined content such as "call", "add to contacts" or
12111 * "open web page". This popup is provided using the @ref Hover widget.
12113 * This widget emits the following signals:
12114 * @li "anchor,clicked": will be called when an anchor is clicked. The
12115 * @p event_info parameter on the callback will be a pointer of type
12116 * ::Elm_Entry_Anchorblock_Info.
12122 * Since examples are usually better than plain words, we might as well
12123 * try @ref tutorial_anchorblock_example "one".
12126 * @addtogroup Anchorblock
12130 * @typedef Elm_Entry_Anchorblock_Info
12132 * The info sent in the callback for "anchor,clicked" signals emitted by
12133 * the Anchorblock widget.
12135 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12137 * @struct _Elm_Entry_Anchorblock_Info
12139 * The info sent in the callback for "anchor,clicked" signals emitted by
12140 * the Anchorblock widget.
12142 struct _Elm_Entry_Anchorblock_Info
12144 const char *name; /**< Name of the anchor, as indicated in its href
12146 int button; /**< The mouse button used to click on it */
12147 Evas_Object *hover; /**< The hover object to use for the popup */
12149 Evas_Coord x, y, w, h;
12150 } anchor, /**< Geometry selection of text used as anchor */
12151 hover_parent; /**< Geometry of the object used as parent by the
12153 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12154 for content on the left side of
12155 the hover. Before calling the
12156 callback, the widget will make the
12157 necessary calculations to check
12158 which sides are fit to be set with
12159 content, based on the position the
12160 hover is activated and its distance
12161 to the edges of its parent object
12163 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12164 the right side of the hover.
12165 See @ref hover_left */
12166 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12167 of the hover. See @ref hover_left */
12168 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12169 below the hover. See @ref
12173 * Add a new Anchorblock object
12175 * @param parent The parent object
12176 * @return The new object or NULL if it cannot be created
12178 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12180 * Set the text to show in the anchorblock
12182 * Sets the text of the anchorblock to @p text. This text can include markup
12183 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12184 * of text that will be specially styled and react to click events, ended
12185 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12186 * "anchor,clicked" signal that you can attach a callback to with
12187 * evas_object_smart_callback_add(). The name of the anchor given in the
12188 * event info struct will be the one set in the href attribute, in this
12189 * case, anchorname.
12191 * Other markup can be used to style the text in different ways, but it's
12192 * up to the style defined in the theme which tags do what.
12193 * @deprecated use elm_object_text_set() instead.
12195 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12197 * Get the markup text set for the anchorblock
12199 * Retrieves the text set on the anchorblock, with markup tags included.
12201 * @param obj The anchorblock object
12202 * @return The markup text set or @c NULL if nothing was set or an error
12204 * @deprecated use elm_object_text_set() instead.
12206 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12208 * Set the parent of the hover popup
12210 * Sets the parent object to use by the hover created by the anchorblock
12211 * when an anchor is clicked. See @ref Hover for more details on this.
12213 * @param obj The anchorblock object
12214 * @param parent The object to use as parent for the hover
12216 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12218 * Get the parent of the hover popup
12220 * Get the object used as parent for the hover created by the anchorblock
12221 * widget. See @ref Hover for more details on this.
12222 * If no parent is set, the same anchorblock object will be used.
12224 * @param obj The anchorblock object
12225 * @return The object used as parent for the hover, NULL if none is set.
12227 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12229 * Set the style that the hover should use
12231 * When creating the popup hover, anchorblock will request that it's
12232 * themed according to @p style.
12234 * @param obj The anchorblock object
12235 * @param style The style to use for the underlying hover
12237 * @see elm_object_style_set()
12239 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12241 * Get the style that the hover should use
12243 * Get the style, the hover created by anchorblock will use.
12245 * @param obj The anchorblock object
12246 * @return The style to use by the hover. NULL means the default is used.
12248 * @see elm_object_style_set()
12250 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12252 * Ends the hover popup in the anchorblock
12254 * When an anchor is clicked, the anchorblock widget will create a hover
12255 * object to use as a popup with user provided content. This function
12256 * terminates this popup, returning the anchorblock to its normal state.
12258 * @param obj The anchorblock object
12260 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12262 * Appends a custom item provider to the given anchorblock
12264 * Appends the given function to the list of items providers. This list is
12265 * called, one function at a time, with the given @p data pointer, the
12266 * anchorblock object and, in the @p item parameter, the item name as
12267 * referenced in its href string. Following functions in the list will be
12268 * called in order until one of them returns something different to NULL,
12269 * which should be an Evas_Object which will be used in place of the item
12272 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12273 * href=item/name\>\</item\>
12275 * @param obj The anchorblock object
12276 * @param func The function to add to the list of providers
12277 * @param data User data that will be passed to the callback function
12279 * @see elm_entry_item_provider_append()
12281 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);
12283 * Prepend a custom item provider to the given anchorblock
12285 * Like elm_anchorblock_item_provider_append(), but it adds the function
12286 * @p func to the beginning of the list, instead of the end.
12288 * @param obj The anchorblock object
12289 * @param func The function to add to the list of providers
12290 * @param data User data that will be passed to the callback function
12292 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);
12294 * Remove a custom item provider from the list of the given anchorblock
12296 * Removes the function and data pairing that matches @p func and @p data.
12297 * That is, unless the same function and same user data are given, the
12298 * function will not be removed from the list. This allows us to add the
12299 * same callback several times, with different @p data pointers and be
12300 * able to remove them later without conflicts.
12302 * @param obj The anchorblock object
12303 * @param func The function to remove from the list
12304 * @param data The data matching the function to remove from the list
12306 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);
12312 * @defgroup Bubble Bubble
12314 * @image html img/widget/bubble/preview-00.png
12315 * @image latex img/widget/bubble/preview-00.eps
12316 * @image html img/widget/bubble/preview-01.png
12317 * @image latex img/widget/bubble/preview-01.eps
12318 * @image html img/widget/bubble/preview-02.png
12319 * @image latex img/widget/bubble/preview-02.eps
12321 * @brief The Bubble is a widget to show text similar to how speech is
12322 * represented in comics.
12324 * The bubble widget contains 5 important visual elements:
12325 * @li The frame is a rectangle with rounded edjes and an "arrow".
12326 * @li The @p icon is an image to which the frame's arrow points to.
12327 * @li The @p label is a text which appears to the right of the icon if the
12328 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12330 * @li The @p info is a text which appears to the right of the label. Info's
12331 * font is of a ligther color than label.
12332 * @li The @p content is an evas object that is shown inside the frame.
12334 * The position of the arrow, icon, label and info depends on which corner is
12335 * selected. The four available corners are:
12336 * @li "top_left" - Default
12338 * @li "bottom_left"
12339 * @li "bottom_right"
12341 * Signals that you can add callbacks for are:
12342 * @li "clicked" - This is called when a user has clicked the bubble.
12344 * For an example of using a buble see @ref bubble_01_example_page "this".
12349 * Add a new bubble to the parent
12351 * @param parent The parent object
12352 * @return The new object or NULL if it cannot be created
12354 * This function adds a text bubble to the given parent evas object.
12356 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12358 * Set the label of the bubble
12360 * @param obj The bubble object
12361 * @param label The string to set in the label
12363 * This function sets the title of the bubble. Where this appears depends on
12364 * the selected corner.
12365 * @deprecated use elm_object_text_set() instead.
12367 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12369 * Get the label of the bubble
12371 * @param obj The bubble object
12372 * @return The string of set in the label
12374 * This function gets the title of the bubble.
12375 * @deprecated use elm_object_text_get() instead.
12377 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12379 * Set the info of the bubble
12381 * @param obj The bubble object
12382 * @param info The given info about the bubble
12384 * This function sets the info of the bubble. Where this appears depends on
12385 * the selected corner.
12386 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12388 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12390 * Get the info of the bubble
12392 * @param obj The bubble object
12394 * @return The "info" string of the bubble
12396 * This function gets the info text.
12397 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12399 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12401 * Set the content to be shown in the bubble
12403 * Once the content object is set, a previously set one will be deleted.
12404 * If you want to keep the old content object, use the
12405 * elm_bubble_content_unset() function.
12407 * @param obj The bubble object
12408 * @param content The given content of the bubble
12410 * This function sets the content shown on the middle of the bubble.
12412 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12414 * Get the content shown in the bubble
12416 * Return the content object which is set for this widget.
12418 * @param obj The bubble object
12419 * @return The content that is being used
12421 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12423 * Unset the content shown in the bubble
12425 * Unparent and return the content object which was set for this widget.
12427 * @param obj The bubble object
12428 * @return The content that was being used
12430 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12432 * Set the icon of the bubble
12434 * Once the icon object is set, a previously set one will be deleted.
12435 * If you want to keep the old content object, use the
12436 * elm_icon_content_unset() function.
12438 * @param obj The bubble object
12439 * @param icon The given icon for the bubble
12441 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12443 * Get the icon of the bubble
12445 * @param obj The bubble object
12446 * @return The icon for the bubble
12448 * This function gets the icon shown on the top left of bubble.
12450 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12452 * Unset the icon of the bubble
12454 * Unparent and return the icon object which was set for this widget.
12456 * @param obj The bubble object
12457 * @return The icon that was being used
12459 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12461 * Set the corner of the bubble
12463 * @param obj The bubble object.
12464 * @param corner The given corner for the bubble.
12466 * This function sets the corner of the bubble. The corner will be used to
12467 * determine where the arrow in the frame points to and where label, icon and
12470 * Possible values for corner are:
12471 * @li "top_left" - Default
12473 * @li "bottom_left"
12474 * @li "bottom_right"
12476 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12478 * Get the corner of the bubble
12480 * @param obj The bubble object.
12481 * @return The given corner for the bubble.
12483 * This function gets the selected corner of the bubble.
12485 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12491 * @defgroup Photo Photo
12493 * For displaying the photo of a person (contact). Simple, yet
12494 * with a very specific purpose.
12496 * Signals that you can add callbacks for are:
12498 * "clicked" - This is called when a user has clicked the photo
12499 * "drag,start" - Someone started dragging the image out of the object
12500 * "drag,end" - Dragged item was dropped (somewhere)
12506 * Add a new photo to the parent
12508 * @param parent The parent object
12509 * @return The new object or NULL if it cannot be created
12513 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12516 * Set the file that will be used as photo
12518 * @param obj The photo object
12519 * @param file The path to file that will be used as photo
12521 * @return (1 = success, 0 = error)
12525 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12528 * Set the file that will be used as thumbnail in the photo.
12530 * @param obj The photo object.
12531 * @param file The path to file that will be used as thumb.
12532 * @param group The key used in case of an EET file.
12536 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12539 * Set the size that will be used on the photo
12541 * @param obj The photo object
12542 * @param size The size that the photo will be
12546 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12549 * Set if the photo should be completely visible or not.
12551 * @param obj The photo object
12552 * @param fill if true the photo will be completely visible
12556 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12559 * Set editability of the photo.
12561 * An editable photo can be dragged to or from, and can be cut or
12562 * pasted too. Note that pasting an image or dropping an item on
12563 * the image will delete the existing content.
12565 * @param obj The photo object.
12566 * @param set To set of clear editablity.
12568 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12574 /* gesture layer */
12576 * @defgroup Elm_Gesture_Layer Gesture Layer
12577 * Gesture Layer Usage:
12579 * Use Gesture Layer to detect gestures.
12580 * The advantage is that you don't have to implement
12581 * gesture detection, just set callbacks of gesture state.
12582 * By using gesture layer we make standard interface.
12584 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12585 * with a parent object parameter.
12586 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12587 * call. Usually with same object as target (2nd parameter).
12589 * Now you need to tell gesture layer what gestures you follow.
12590 * This is done with @ref elm_gesture_layer_cb_set call.
12591 * By setting the callback you actually saying to gesture layer:
12592 * I would like to know when the gesture @ref Elm_Gesture_Types
12593 * switches to state @ref Elm_Gesture_State.
12595 * Next, you need to implement the actual action that follows the input
12596 * in your callback.
12598 * Note that if you like to stop being reported about a gesture, just set
12599 * all callbacks referring this gesture to NULL.
12600 * (again with @ref elm_gesture_layer_cb_set)
12602 * The information reported by gesture layer to your callback is depending
12603 * on @ref Elm_Gesture_Types:
12604 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12605 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12606 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12608 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12609 * @ref ELM_GESTURE_MOMENTUM.
12611 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12612 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12613 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12614 * Note that we consider a flick as a line-gesture that should be completed
12615 * in flick-time-limit as defined in @ref Config.
12617 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12619 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12622 * Gesture Layer Tweaks:
12624 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12625 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12627 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12628 * so gesture starts when user touches (a *DOWN event) touch-surface
12629 * and ends when no fingers touches surface (a *UP event).
12633 * @enum _Elm_Gesture_Types
12634 * Enum of supported gesture types.
12635 * @ingroup Elm_Gesture_Layer
12637 enum _Elm_Gesture_Types
12639 ELM_GESTURE_FIRST = 0,
12641 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12642 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12643 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12644 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12646 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12648 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12649 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12651 ELM_GESTURE_ZOOM, /**< Zoom */
12652 ELM_GESTURE_ROTATE, /**< Rotate */
12658 * @typedef Elm_Gesture_Types
12659 * gesture types enum
12660 * @ingroup Elm_Gesture_Layer
12662 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12665 * @enum _Elm_Gesture_State
12666 * Enum of gesture states.
12667 * @ingroup Elm_Gesture_Layer
12669 enum _Elm_Gesture_State
12671 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12672 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12673 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12674 ELM_GESTURE_STATE_END, /**< Gesture completed */
12675 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12679 * @typedef Elm_Gesture_State
12680 * gesture states enum
12681 * @ingroup Elm_Gesture_Layer
12683 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12686 * @struct _Elm_Gesture_Taps_Info
12687 * Struct holds taps info for user
12688 * @ingroup Elm_Gesture_Layer
12690 struct _Elm_Gesture_Taps_Info
12692 Evas_Coord x, y; /**< Holds center point between fingers */
12693 unsigned int n; /**< Number of fingers tapped */
12694 unsigned int timestamp; /**< event timestamp */
12698 * @typedef Elm_Gesture_Taps_Info
12699 * holds taps info for user
12700 * @ingroup Elm_Gesture_Layer
12702 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12705 * @struct _Elm_Gesture_Momentum_Info
12706 * Struct holds momentum info for user
12707 * x1 and y1 are not necessarily in sync
12708 * x1 holds x value of x direction starting point
12709 * and same holds for y1.
12710 * This is noticeable when doing V-shape movement
12711 * @ingroup Elm_Gesture_Layer
12713 struct _Elm_Gesture_Momentum_Info
12714 { /* Report line ends, timestamps, and momentum computed */
12715 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12716 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12717 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12718 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12720 unsigned int tx; /**< Timestamp of start of final x-swipe */
12721 unsigned int ty; /**< Timestamp of start of final y-swipe */
12723 Evas_Coord mx; /**< Momentum on X */
12724 Evas_Coord my; /**< Momentum on Y */
12726 unsigned int n; /**< Number of fingers */
12730 * @typedef Elm_Gesture_Momentum_Info
12731 * holds momentum info for user
12732 * @ingroup Elm_Gesture_Layer
12734 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12737 * @struct _Elm_Gesture_Line_Info
12738 * Struct holds line info for user
12739 * @ingroup Elm_Gesture_Layer
12741 struct _Elm_Gesture_Line_Info
12742 { /* Report line ends, timestamps, and momentum computed */
12743 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12744 /* FIXME should be radians, bot degrees */
12745 double angle; /**< Angle (direction) of lines */
12749 * @typedef Elm_Gesture_Line_Info
12750 * Holds line info for user
12751 * @ingroup Elm_Gesture_Layer
12753 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12756 * @struct _Elm_Gesture_Zoom_Info
12757 * Struct holds zoom info for user
12758 * @ingroup Elm_Gesture_Layer
12760 struct _Elm_Gesture_Zoom_Info
12762 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12763 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12764 double zoom; /**< Zoom value: 1.0 means no zoom */
12765 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12769 * @typedef Elm_Gesture_Zoom_Info
12770 * Holds zoom info for user
12771 * @ingroup Elm_Gesture_Layer
12773 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12776 * @struct _Elm_Gesture_Rotate_Info
12777 * Struct holds rotation info for user
12778 * @ingroup Elm_Gesture_Layer
12780 struct _Elm_Gesture_Rotate_Info
12782 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12783 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12784 double base_angle; /**< Holds start-angle */
12785 double angle; /**< Rotation value: 0.0 means no rotation */
12786 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12790 * @typedef Elm_Gesture_Rotate_Info
12791 * Holds rotation info for user
12792 * @ingroup Elm_Gesture_Layer
12794 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12797 * @typedef Elm_Gesture_Event_Cb
12798 * User callback used to stream gesture info from gesture layer
12799 * @param data user data
12800 * @param event_info gesture report info
12801 * Returns a flag field to be applied on the causing event.
12802 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12803 * upon the event, in an irreversible way.
12805 * @ingroup Elm_Gesture_Layer
12807 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12810 * Use function to set callbacks to be notified about
12811 * change of state of gesture.
12812 * When a user registers a callback with this function
12813 * this means this gesture has to be tested.
12815 * When ALL callbacks for a gesture are set to NULL
12816 * it means user isn't interested in gesture-state
12817 * and it will not be tested.
12819 * @param obj Pointer to gesture-layer.
12820 * @param idx The gesture you would like to track its state.
12821 * @param cb callback function pointer.
12822 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12823 * @param data user info to be sent to callback (usually, Smart Data)
12825 * @ingroup Elm_Gesture_Layer
12827 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);
12830 * Call this function to get repeat-events settings.
12832 * @param obj Pointer to gesture-layer.
12834 * @return repeat events settings.
12835 * @see elm_gesture_layer_hold_events_set()
12836 * @ingroup Elm_Gesture_Layer
12838 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12841 * This function called in order to make gesture-layer repeat events.
12842 * Set this of you like to get the raw events only if gestures were not detected.
12843 * Clear this if you like gesture layer to fwd events as testing gestures.
12845 * @param obj Pointer to gesture-layer.
12846 * @param r Repeat: TRUE/FALSE
12848 * @ingroup Elm_Gesture_Layer
12850 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12853 * This function sets step-value for zoom action.
12854 * Set step to any positive value.
12855 * Cancel step setting by setting to 0.0
12857 * @param obj Pointer to gesture-layer.
12858 * @param s new zoom step value.
12860 * @ingroup Elm_Gesture_Layer
12862 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12865 * This function sets step-value for rotate action.
12866 * Set step to any positive value.
12867 * Cancel step setting by setting to 0.0
12869 * @param obj Pointer to gesture-layer.
12870 * @param s new roatate step value.
12872 * @ingroup Elm_Gesture_Layer
12874 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12877 * This function called to attach gesture-layer to an Evas_Object.
12878 * @param obj Pointer to gesture-layer.
12879 * @param t Pointer to underlying object (AKA Target)
12881 * @return TRUE, FALSE on success, failure.
12883 * @ingroup Elm_Gesture_Layer
12885 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12888 * Call this function to construct a new gesture-layer object.
12889 * This does not activate the gesture layer. You have to
12890 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12892 * @param parent the parent object.
12894 * @return Pointer to new gesture-layer object.
12896 * @ingroup Elm_Gesture_Layer
12898 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12901 * @defgroup Thumb Thumb
12903 * @image html img/widget/thumb/preview-00.png
12904 * @image latex img/widget/thumb/preview-00.eps
12906 * A thumb object is used for displaying the thumbnail of an image or video.
12907 * You must have compiled Elementary with Ethumb_Client support and the DBus
12908 * service must be present and auto-activated in order to have thumbnails to
12911 * Once the thumbnail object becomes visible, it will check if there is a
12912 * previously generated thumbnail image for the file set on it. If not, it
12913 * will start generating this thumbnail.
12915 * Different config settings will cause different thumbnails to be generated
12916 * even on the same file.
12918 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12919 * Ethumb documentation to change this path, and to see other configuration
12922 * Signals that you can add callbacks for are:
12924 * - "clicked" - This is called when a user has clicked the thumb without dragging
12926 * - "clicked,double" - This is called when a user has double-clicked the thumb.
12927 * - "press" - This is called when a user has pressed down the thumb.
12928 * - "generate,start" - The thumbnail generation started.
12929 * - "generate,stop" - The generation process stopped.
12930 * - "generate,error" - The generation failed.
12931 * - "load,error" - The thumbnail image loading failed.
12933 * available styles:
12937 * An example of use of thumbnail:
12939 * - @ref thumb_example_01
12943 * @addtogroup Thumb
12948 * @enum _Elm_Thumb_Animation_Setting
12949 * @typedef Elm_Thumb_Animation_Setting
12951 * Used to set if a video thumbnail is animating or not.
12955 typedef enum _Elm_Thumb_Animation_Setting
12957 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12958 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
12959 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
12960 ELM_THUMB_ANIMATION_LAST
12961 } Elm_Thumb_Animation_Setting;
12964 * Add a new thumb object to the parent.
12966 * @param parent The parent object.
12967 * @return The new object or NULL if it cannot be created.
12969 * @see elm_thumb_file_set()
12970 * @see elm_thumb_ethumb_client_get()
12974 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12976 * Reload thumbnail if it was generated before.
12978 * @param obj The thumb object to reload
12980 * This is useful if the ethumb client configuration changed, like its
12981 * size, aspect or any other property one set in the handle returned
12982 * by elm_thumb_ethumb_client_get().
12984 * If the options didn't change, the thumbnail won't be generated again, but
12985 * the old one will still be used.
12987 * @see elm_thumb_file_set()
12991 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12993 * Set the file that will be used as thumbnail.
12995 * @param obj The thumb object.
12996 * @param file The path to file that will be used as thumb.
12997 * @param key The key used in case of an EET file.
12999 * The file can be an image or a video (in that case, acceptable extensions are:
13000 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13001 * function elm_thumb_animate().
13003 * @see elm_thumb_file_get()
13004 * @see elm_thumb_reload()
13005 * @see elm_thumb_animate()
13009 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13011 * Get the image or video path and key used to generate the thumbnail.
13013 * @param obj The thumb object.
13014 * @param file Pointer to filename.
13015 * @param key Pointer to key.
13017 * @see elm_thumb_file_set()
13018 * @see elm_thumb_path_get()
13022 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13024 * Get the path and key to the image or video generated by ethumb.
13026 * One just need to make sure that the thumbnail was generated before getting
13027 * its path; otherwise, the path will be NULL. One way to do that is by asking
13028 * for the path when/after the "generate,stop" smart callback is called.
13030 * @param obj The thumb object.
13031 * @param file Pointer to thumb path.
13032 * @param key Pointer to thumb key.
13034 * @see elm_thumb_file_get()
13038 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13040 * Set the animation state for the thumb object. If its content is an animated
13041 * video, you may start/stop the animation or tell it to play continuously and
13044 * @param obj The thumb object.
13045 * @param setting The animation setting.
13047 * @see elm_thumb_file_set()
13051 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13053 * Get the animation state for the thumb object.
13055 * @param obj The thumb object.
13056 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13059 * @see elm_thumb_animate_set()
13063 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13065 * Get the ethumb_client handle so custom configuration can be made.
13067 * @return Ethumb_Client instance or NULL.
13069 * This must be called before the objects are created to be sure no object is
13070 * visible and no generation started.
13072 * Example of usage:
13075 * #include <Elementary.h>
13076 * #ifndef ELM_LIB_QUICKLAUNCH
13078 * elm_main(int argc, char **argv)
13080 * Ethumb_Client *client;
13082 * elm_need_ethumb();
13086 * client = elm_thumb_ethumb_client_get();
13089 * ERR("could not get ethumb_client");
13092 * ethumb_client_size_set(client, 100, 100);
13093 * ethumb_client_crop_align_set(client, 0.5, 0.5);
13096 * // Create elm_thumb objects here
13106 * @note There's only one client handle for Ethumb, so once a configuration
13107 * change is done to it, any other request for thumbnails (for any thumbnail
13108 * object) will use that configuration. Thus, this configuration is global.
13112 EAPI void *elm_thumb_ethumb_client_get(void);
13114 * Get the ethumb_client connection state.
13116 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13119 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
13121 * Make the thumbnail 'editable'.
13123 * @param obj Thumb object.
13124 * @param set Turn on or off editability. Default is @c EINA_FALSE.
13126 * This means the thumbnail is a valid drag target for drag and drop, and can be
13127 * cut or pasted too.
13129 * @see elm_thumb_editable_get()
13133 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13135 * Make the thumbnail 'editable'.
13137 * @param obj Thumb object.
13138 * @return Editability.
13140 * This means the thumbnail is a valid drag target for drag and drop, and can be
13141 * cut or pasted too.
13143 * @see elm_thumb_editable_set()
13147 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13154 * @defgroup Web Web
13156 * @image html img/widget/web/preview-00.png
13157 * @image latex img/widget/web/preview-00.eps
13159 * A web object is used for displaying web pages (HTML/CSS/JS)
13160 * using WebKit-EFL. You must have compiled Elementary with
13163 * Signals that you can add callbacks for are:
13164 * @li "download,request": A file download has been requested. Event info is
13165 * a pointer to a Elm_Web_Download
13166 * @li "editorclient,contents,changed": Editor client's contents changed
13167 * @li "editorclient,selection,changed": Editor client's selection changed
13168 * @li "frame,created": A new frame was created. Event info is an
13169 * Evas_Object which can be handled with WebKit's ewk_frame API
13170 * @li "icon,received": An icon was received by the main frame
13171 * @li "inputmethod,changed": Input method changed. Event info is an
13172 * Eina_Bool indicating whether it's enabled or not
13173 * @li "js,windowobject,clear": JS window object has been cleared
13174 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13175 * is a char *link[2], where the first string contains the URL the link
13176 * points to, and the second one the title of the link
13177 * @li "link,hover,out": Mouse cursor left the link
13178 * @li "load,document,finished": Loading of a document finished. Event info
13179 * is the frame that finished loading
13180 * @li "load,error": Load failed. Event info is a pointer to
13181 * Elm_Web_Frame_Load_Error
13182 * @li "load,finished": Load finished. Event info is NULL on success, on
13183 * error it's a pointer to Elm_Web_Frame_Load_Error
13184 * @li "load,newwindow,show": A new window was created and is ready to be
13186 * @li "load,progress": Overall load progress. Event info is a pointer to
13187 * a double containing a value between 0.0 and 1.0
13188 * @li "load,provisional": Started provisional load
13189 * @li "load,started": Loading of a document started
13190 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13191 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13192 * the menubar is visible, or EINA_FALSE in case it's not
13193 * @li "menubar,visible,set": Informs menubar visibility. Event info is
13194 * an Eina_Bool indicating the visibility
13195 * @li "popup,created": A dropdown widget was activated, requesting its
13196 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13197 * @li "popup,willdelete": The web object is ready to destroy the popup
13198 * object created. Event info is a pointer to Elm_Web_Menu
13199 * @li "ready": Page is fully loaded
13200 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13201 * info is a pointer to Eina_Bool where the visibility state should be set
13202 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13203 * is an Eina_Bool with the visibility state set
13204 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13205 * a string with the new text
13206 * @li "statusbar,visible,get": Queries visibility of the status bar.
13207 * Event info is a pointer to Eina_Bool where the visibility state should be
13209 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13210 * an Eina_Bool with the visibility value
13211 * @li "title,changed": Title of the main frame changed. Event info is a
13212 * string with the new title
13213 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13214 * is a pointer to Eina_Bool where the visibility state should be set
13215 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13216 * info is an Eina_Bool with the visibility state
13217 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13218 * a string with the text to show
13219 * @li "uri,changed": URI of the main frame changed. Event info is a string
13221 * @li "view,resized": The web object internal's view changed sized
13222 * @li "windows,close,request": A JavaScript request to close the current
13223 * window was requested
13224 * @li "zoom,animated,end": Animated zoom finished
13226 * available styles:
13229 * An example of use of web:
13231 * - @ref web_example_01 TBD
13240 * Structure used to report load errors.
13242 * Load errors are reported as signal by elm_web. All the strings are
13243 * temporary references and should @b not be used after the signal
13244 * callback returns. If it's required, make copies with strdup() or
13245 * eina_stringshare_add() (they are not even guaranteed to be
13246 * stringshared, so must use eina_stringshare_add() and not
13247 * eina_stringshare_ref()).
13249 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13251 * Structure used to report load errors.
13253 * Load errors are reported as signal by elm_web. All the strings are
13254 * temporary references and should @b not be used after the signal
13255 * callback returns. If it's required, make copies with strdup() or
13256 * eina_stringshare_add() (they are not even guaranteed to be
13257 * stringshared, so must use eina_stringshare_add() and not
13258 * eina_stringshare_ref()).
13260 struct _Elm_Web_Frame_Load_Error
13262 int code; /**< Numeric error code */
13263 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13264 const char *domain; /**< Error domain name */
13265 const char *description; /**< Error description (already localized) */
13266 const char *failing_url; /**< The URL that failed to load */
13267 Evas_Object *frame; /**< Frame object that produced the error */
13271 * The possibles types that the items in a menu can be
13273 typedef enum _Elm_Web_Menu_Item_Type
13275 ELM_WEB_MENU_SEPARATOR,
13276 ELM_WEB_MENU_GROUP,
13277 ELM_WEB_MENU_OPTION
13278 } Elm_Web_Menu_Item_Type;
13281 * Structure describing the items in a menu
13283 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13285 * Structure describing the items in a menu
13287 struct _Elm_Web_Menu_Item
13289 const char *text; /**< The text for the item */
13290 Elm_Web_Menu_Item_Type type; /**< The type of the item */
13294 * Structure describing the menu of a popup
13296 * This structure will be passed as the @c event_info for the "popup,create"
13297 * signal, which is emitted when a dropdown menu is opened. Users wanting
13298 * to handle these popups by themselves should listen to this signal and
13299 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13300 * property as @c EINA_FALSE means that the user will not handle the popup
13301 * and the default implementation will be used.
13303 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13304 * will be emitted to notify the user that it can destroy any objects and
13305 * free all data related to it.
13307 * @see elm_web_popup_selected_set()
13308 * @see elm_web_popup_destroy()
13310 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13312 * Structure describing the menu of a popup
13314 * This structure will be passed as the @c event_info for the "popup,create"
13315 * signal, which is emitted when a dropdown menu is opened. Users wanting
13316 * to handle these popups by themselves should listen to this signal and
13317 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13318 * property as @c EINA_FALSE means that the user will not handle the popup
13319 * and the default implementation will be used.
13321 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13322 * will be emitted to notify the user that it can destroy any objects and
13323 * free all data related to it.
13325 * @see elm_web_popup_selected_set()
13326 * @see elm_web_popup_destroy()
13328 struct _Elm_Web_Menu
13330 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13331 int x; /**< The X position of the popup, relative to the elm_web object */
13332 int y; /**< The Y position of the popup, relative to the elm_web object */
13333 int width; /**< Width of the popup menu */
13334 int height; /**< Height of the popup menu */
13336 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. */
13339 typedef struct _Elm_Web_Download Elm_Web_Download;
13340 struct _Elm_Web_Download
13346 * Types of zoom available.
13348 typedef enum _Elm_Web_Zoom_Mode
13350 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13351 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13352 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13353 ELM_WEB_ZOOM_MODE_LAST
13354 } Elm_Web_Zoom_Mode;
13356 * Opaque handler containing the features (such as statusbar, menubar, etc)
13357 * that are to be set on a newly requested window.
13359 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13361 * Callback type for the create_window hook.
13363 * The function parameters are:
13364 * @li @p data User data pointer set when setting the hook function
13365 * @li @p obj The elm_web object requesting the new window
13366 * @li @p js Set to @c EINA_TRUE if the request was originated from
13367 * JavaScript. @c EINA_FALSE otherwise.
13368 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13369 * the features requested for the new window.
13371 * The returned value of the function should be the @c elm_web widget where
13372 * the request will be loaded. That is, if a new window or tab is created,
13373 * the elm_web widget in it should be returned, and @b NOT the window
13375 * Returning @c NULL should cancel the request.
13377 * @see elm_web_window_create_hook_set()
13379 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13381 * Callback type for the JS alert hook.
13383 * The function parameters are:
13384 * @li @p data User data pointer set when setting the hook function
13385 * @li @p obj The elm_web object requesting the new window
13386 * @li @p message The message to show in the alert dialog
13388 * The function should return the object representing the alert dialog.
13389 * Elm_Web will run a second main loop to handle the dialog and normal
13390 * flow of the application will be restored when the object is deleted, so
13391 * the user should handle the popup properly in order to delete the object
13392 * when the action is finished.
13393 * If the function returns @c NULL the popup will be ignored.
13395 * @see elm_web_dialog_alert_hook_set()
13397 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13399 * Callback type for the JS confirm hook.
13401 * The function parameters are:
13402 * @li @p data User data pointer set when setting the hook function
13403 * @li @p obj The elm_web object requesting the new window
13404 * @li @p message The message to show in the confirm dialog
13405 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13406 * the user selected @c Ok, @c EINA_FALSE otherwise.
13408 * The function should return the object representing the confirm dialog.
13409 * Elm_Web will run a second main loop to handle the dialog and normal
13410 * flow of the application will be restored when the object is deleted, so
13411 * the user should handle the popup properly in order to delete the object
13412 * when the action is finished.
13413 * If the function returns @c NULL the popup will be ignored.
13415 * @see elm_web_dialog_confirm_hook_set()
13417 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13419 * Callback type for the JS prompt hook.
13421 * The function parameters are:
13422 * @li @p data User data pointer set when setting the hook function
13423 * @li @p obj The elm_web object requesting the new window
13424 * @li @p message The message to show in the prompt dialog
13425 * @li @p def_value The default value to present the user in the entry
13426 * @li @p value Pointer where to store the value given by the user. Must
13427 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13428 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13429 * the user selected @c Ok, @c EINA_FALSE otherwise.
13431 * The function should return the object representing the prompt dialog.
13432 * Elm_Web will run a second main loop to handle the dialog and normal
13433 * flow of the application will be restored when the object is deleted, so
13434 * the user should handle the popup properly in order to delete the object
13435 * when the action is finished.
13436 * If the function returns @c NULL the popup will be ignored.
13438 * @see elm_web_dialog_prompt_hook_set()
13440 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13442 * Callback type for the JS file selector hook.
13444 * The function parameters are:
13445 * @li @p data User data pointer set when setting the hook function
13446 * @li @p obj The elm_web object requesting the new window
13447 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13448 * @li @p accept_types Mime types accepted
13449 * @li @p selected Pointer where to store the list of malloc'ed strings
13450 * containing the path to each file selected. Must be @c NULL if the file
13451 * dialog is cancelled
13452 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13453 * the user selected @c Ok, @c EINA_FALSE otherwise.
13455 * The function should return the object representing the file selector
13457 * Elm_Web will run a second main loop to handle the dialog and normal
13458 * flow of the application will be restored when the object is deleted, so
13459 * the user should handle the popup properly in order to delete the object
13460 * when the action is finished.
13461 * If the function returns @c NULL the popup will be ignored.
13463 * @see elm_web_dialog_file selector_hook_set()
13465 typedef Evas_Object *(*Elm_Web_Dialog_File_Selector)(void *data, Evas_Object *obj, Eina_Bool allows_multiple, Eina_List *accept_types, Eina_List **selected, Eina_Bool *ret);
13467 * Callback type for the JS console message hook.
13469 * When a console message is added from JavaScript, any set function to the
13470 * console message hook will be called for the user to handle. There is no
13471 * default implementation of this hook.
13473 * The function parameters are:
13474 * @li @p data User data pointer set when setting the hook function
13475 * @li @p obj The elm_web object that originated the message
13476 * @li @p message The message sent
13477 * @li @p line_number The line number
13478 * @li @p source_id Source id
13480 * @see elm_web_console_message_hook_set()
13482 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13484 * Add a new web object to the parent.
13486 * @param parent The parent object.
13487 * @return The new object or NULL if it cannot be created.
13489 * @see elm_web_uri_set()
13490 * @see elm_web_webkit_view_get()
13492 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13495 * Get internal ewk_view object from web object.
13497 * Elementary may not provide some low level features of EWebKit,
13498 * instead of cluttering the API with proxy methods we opted to
13499 * return the internal reference. Be careful using it as it may
13500 * interfere with elm_web behavior.
13502 * @param obj The web object.
13503 * @return The internal ewk_view object or NULL if it does not
13504 * exist. (Failure to create or Elementary compiled without
13507 * @see elm_web_add()
13509 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13512 * Sets the function to call when a new window is requested
13514 * This hook will be called when a request to create a new window is
13515 * issued from the web page loaded.
13516 * There is no default implementation for this feature, so leaving this
13517 * unset or passing @c NULL in @p func will prevent new windows from
13520 * @param obj The web object where to set the hook function
13521 * @param func The hook function to be called when a window is requested
13522 * @param data User data
13524 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13526 * Sets the function to call when an alert dialog
13528 * This hook will be called when a JavaScript alert dialog is requested.
13529 * If no function is set or @c NULL is passed in @p func, the default
13530 * implementation will take place.
13532 * @param obj The web object where to set the hook function
13533 * @param func The callback function to be used
13534 * @param data User data
13536 * @see elm_web_inwin_mode_set()
13538 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13540 * Sets the function to call when an confirm dialog
13542 * This hook will be called when a JavaScript confirm dialog is requested.
13543 * If no function is set or @c NULL is passed in @p func, the default
13544 * implementation will take place.
13546 * @param obj The web object where to set the hook function
13547 * @param func The callback function to be used
13548 * @param data User data
13550 * @see elm_web_inwin_mode_set()
13552 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13554 * Sets the function to call when an prompt dialog
13556 * This hook will be called when a JavaScript prompt dialog is requested.
13557 * If no function is set or @c NULL is passed in @p func, the default
13558 * implementation will take place.
13560 * @param obj The web object where to set the hook function
13561 * @param func The callback function to be used
13562 * @param data User data
13564 * @see elm_web_inwin_mode_set()
13566 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13568 * Sets the function to call when an file selector dialog
13570 * This hook will be called when a JavaScript file selector dialog is
13572 * If no function is set or @c NULL is passed in @p func, the default
13573 * implementation will take place.
13575 * @param obj The web object where to set the hook function
13576 * @param func The callback function to be used
13577 * @param data User data
13579 * @see elm_web_inwin_mode_set()
13581 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13583 * Sets the function to call when a console message is emitted from JS
13585 * This hook will be called when a console message is emitted from
13586 * JavaScript. There is no default implementation for this feature.
13588 * @param obj The web object where to set the hook function
13589 * @param func The callback function to be used
13590 * @param data User data
13592 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13594 * Gets the status of the tab propagation
13596 * @param obj The web object to query
13597 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13599 * @see elm_web_tab_propagate_set()
13601 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13603 * Sets whether to use tab propagation
13605 * If tab propagation is enabled, whenever the user presses the Tab key,
13606 * Elementary will handle it and switch focus to the next widget.
13607 * The default value is disabled, where WebKit will handle the Tab key to
13608 * cycle focus though its internal objects, jumping to the next widget
13609 * only when that cycle ends.
13611 * @param obj The web object
13612 * @param propagate Whether to propagate Tab keys to Elementary or not
13614 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13616 * Sets the URI for the web object
13618 * It must be a full URI, with resource included, in the form
13619 * http://www.enlightenment.org or file:///tmp/something.html
13621 * @param obj The web object
13622 * @param uri The URI to set
13623 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13625 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13627 * Gets the current URI for the object
13629 * The returned string must not be freed and is guaranteed to be
13632 * @param obj The web object
13633 * @return A stringshared internal string with the current URI, or NULL on
13636 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13638 * Gets the current title
13640 * The returned string must not be freed and is guaranteed to be
13643 * @param obj The web object
13644 * @return A stringshared internal string with the current title, or NULL on
13647 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13649 * Sets the background color to be used by the web object
13651 * This is the color that will be used by default when the loaded page
13652 * does not set it's own. Color values are pre-multiplied.
13654 * @param obj The web object
13655 * @param r Red component
13656 * @param g Green component
13657 * @param b Blue component
13658 * @param a Alpha component
13660 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13662 * Gets the background color to be used by the web object
13664 * This is the color that will be used by default when the loaded page
13665 * does not set it's own. Color values are pre-multiplied.
13667 * @param obj The web object
13668 * @param r Red component
13669 * @param g Green component
13670 * @param b Blue component
13671 * @param a Alpha component
13673 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13675 * Gets a copy of the currently selected text
13677 * The string returned must be freed by the user when it's done with it.
13679 * @param obj The web object
13680 * @return A newly allocated string, or NULL if nothing is selected or an
13683 EAPI char *elm_view_selection_get(const Evas_Object *obj);
13685 * Tells the web object which index in the currently open popup was selected
13687 * When the user handles the popup creation from the "popup,created" signal,
13688 * it needs to tell the web object which item was selected by calling this
13689 * function with the index corresponding to the item.
13691 * @param obj The web object
13692 * @param index The index selected
13694 * @see elm_web_popup_destroy()
13696 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
13698 * Dismisses an open dropdown popup
13700 * When the popup from a dropdown widget is to be dismissed, either after
13701 * selecting an option or to cancel it, this function must be called, which
13702 * will later emit an "popup,willdelete" signal to notify the user that
13703 * any memory and objects related to this popup can be freed.
13705 * @param obj The web object
13706 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13707 * if there was no menu to destroy
13709 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
13711 * Searches the given string in a document.
13713 * @param obj The web object where to search the text
13714 * @param string String to search
13715 * @param case_sensitive If search should be case sensitive or not
13716 * @param forward If search is from cursor and on or backwards
13717 * @param wrap If search should wrap at the end
13719 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13722 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13724 * Marks matches of the given string in a document.
13726 * @param obj The web object where to search text
13727 * @param string String to match
13728 * @param case_sensitive If match should be case sensitive or not
13729 * @param highlight If matches should be highlighted
13730 * @param limit Maximum amount of matches, or zero to unlimited
13732 * @return number of matched @a string
13734 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13736 * Clears all marked matches in the document
13738 * @param obj The web object
13740 * @return EINA_TRUE on success, EINA_FALSE otherwise
13742 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
13744 * Sets whether to highlight the matched marks
13746 * If enabled, marks set with elm_web_text_matches_mark() will be
13749 * @param obj The web object
13750 * @param highlight Whether to highlight the marks or not
13752 * @return EINA_TRUE on success, EINA_FALSE otherwise
13754 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13756 * Gets whether highlighting marks is enabled
13758 * @param The web object
13760 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13763 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
13765 * Gets the overall loading progress of the page
13767 * Returns the estimated loading progress of the page, with a value between
13768 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13769 * included in the page.
13771 * @param The web object
13773 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13776 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
13778 * Stops loading the current page
13780 * Cancels the loading of the current page in the web object. This will
13781 * cause a "load,error" signal to be emitted, with the is_cancellation
13782 * flag set to EINA_TRUE.
13784 * @param obj The web object
13786 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13788 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
13790 * Requests a reload of the current document in the object
13792 * @param obj The web object
13794 * @return EINA_TRUE on success, EINA_FALSE otherwise
13796 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
13798 * Requests a reload of the current document, avoiding any existing caches
13800 * @param obj The web object
13802 * @return EINA_TRUE on success, EINA_FALSE otherwise
13804 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
13806 * Goes back one step in the browsing history
13808 * This is equivalent to calling elm_web_object_navigate(obj, -1);
13810 * @param obj The web object
13812 * @return EINA_TRUE on success, EINA_FALSE otherwise
13814 * @see elm_web_history_enable_set()
13815 * @see elm_web_back_possible()
13816 * @see elm_web_forward()
13817 * @see elm_web_navigate()
13819 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
13821 * Goes forward one step in the browsing history
13823 * This is equivalent to calling elm_web_object_navigate(obj, 1);
13825 * @param obj The web object
13827 * @return EINA_TRUE on success, EINA_FALSE otherwise
13829 * @see elm_web_history_enable_set()
13830 * @see elm_web_forward_possible()
13831 * @see elm_web_back()
13832 * @see elm_web_navigate()
13834 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
13836 * Jumps the given number of steps in the browsing history
13838 * The @p steps value can be a negative integer to back in history, or a
13839 * positive to move forward.
13841 * @param obj The web object
13842 * @param steps The number of steps to jump
13844 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13845 * history exists to jump the given number of steps
13847 * @see elm_web_history_enable_set()
13848 * @see elm_web_navigate_possible()
13849 * @see elm_web_back()
13850 * @see elm_web_forward()
13852 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
13854 * Queries whether it's possible to go back in history
13856 * @param obj The web object
13858 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13861 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
13863 * Queries whether it's possible to go forward in history
13865 * @param obj The web object
13867 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13870 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
13872 * Queries whether it's possible to jump the given number of steps
13874 * The @p steps value can be a negative integer to back in history, or a
13875 * positive to move forward.
13877 * @param obj The web object
13878 * @param steps The number of steps to check for
13880 * @return EINA_TRUE if enough history exists to perform the given jump,
13881 * EINA_FALSE otherwise
13883 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
13885 * Gets whether browsing history is enabled for the given object
13887 * @param obj The web object
13889 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13891 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
13893 * Enables or disables the browsing history
13895 * @param obj The web object
13896 * @param enable Whether to enable or disable the browsing history
13898 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13900 * Sets the zoom level of the web object
13902 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
13903 * values meaning zoom in and lower meaning zoom out. This function will
13904 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
13905 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
13907 * @param obj The web object
13908 * @param zoom The zoom level to set
13910 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
13912 * Gets the current zoom level set on the web object
13914 * Note that this is the zoom level set on the web object and not that
13915 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
13916 * the two zoom levels should match, but for the other two modes the
13917 * Webkit zoom is calculated internally to match the chosen mode without
13918 * changing the zoom level set for the web object.
13920 * @param obj The web object
13922 * @return The zoom level set on the object
13924 EAPI double elm_web_zoom_get(const Evas_Object *obj);
13926 * Sets the zoom mode to use
13928 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
13929 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
13931 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
13932 * with the elm_web_zoom_set() function.
13933 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
13934 * make sure the entirety of the web object's contents are shown.
13935 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
13936 * fit the contents in the web object's size, without leaving any space
13939 * @param obj The web object
13940 * @param mode The mode to set
13942 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
13944 * Gets the currently set zoom mode
13946 * @param obj The web object
13948 * @return The current zoom mode set for the object, or
13949 * ::ELM_WEB_ZOOM_MODE_LAST on error
13951 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
13953 * Shows the given region in the web object
13955 * @param obj The web object
13956 * @param x The x coordinate of the region to show
13957 * @param y The y coordinate of the region to show
13958 * @param w The width of the region to show
13959 * @param h The height of the region to show
13961 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
13963 * Brings in the region to the visible area
13965 * Like elm_web_region_show(), but it animates the scrolling of the object
13968 * @param obj The web object
13969 * @param x The x coordinate of the region to show
13970 * @param y The y coordinate of the region to show
13971 * @param w The width of the region to show
13972 * @param h The height of the region to show
13974 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
13976 * Sets the default dialogs to use an Inwin instead of a normal window
13978 * If set, then the default implementation for the JavaScript dialogs and
13979 * file selector will be opened in an Inwin. Otherwise they will use a
13980 * normal separated window.
13982 * @param obj The web object
13983 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
13985 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
13987 * Gets whether Inwin mode is set for the current object
13989 * @param obj The web object
13991 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
13993 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
13995 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
13996 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
13997 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);
13998 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14005 * @defgroup Hoversel Hoversel
14007 * @image html img/widget/hoversel/preview-00.png
14008 * @image latex img/widget/hoversel/preview-00.eps
14010 * A hoversel is a button that pops up a list of items (automatically
14011 * choosing the direction to display) that have a label and, optionally, an
14012 * icon to select from. It is a convenience widget to avoid the need to do
14013 * all the piecing together yourself. It is intended for a small number of
14014 * items in the hoversel menu (no more than 8), though is capable of many
14017 * Signals that you can add callbacks for are:
14018 * "clicked" - the user clicked the hoversel button and popped up the sel
14019 * "selected" - an item in the hoversel list is selected. event_info is the item
14020 * "dismissed" - the hover is dismissed
14022 * See @ref tutorial_hoversel for an example.
14025 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14027 * @brief Add a new Hoversel object
14029 * @param parent The parent object
14030 * @return The new object or NULL if it cannot be created
14032 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14034 * @brief This sets the hoversel to expand horizontally.
14036 * @param obj The hoversel object
14037 * @param horizontal If true, the hover will expand horizontally to the
14040 * @note The initial button will display horizontally regardless of this
14043 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14045 * @brief This returns whether the hoversel is set to expand horizontally.
14047 * @param obj The hoversel object
14048 * @return If true, the hover will expand horizontally to the right.
14050 * @see elm_hoversel_horizontal_set()
14052 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14054 * @brief Set the Hover parent
14056 * @param obj The hoversel object
14057 * @param parent The parent to use
14059 * Sets the hover parent object, the area that will be darkened when the
14060 * hoversel is clicked. Should probably be the window that the hoversel is
14061 * in. See @ref Hover objects for more information.
14063 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14065 * @brief Get the Hover parent
14067 * @param obj The hoversel object
14068 * @return The used parent
14070 * Gets the hover parent object.
14072 * @see elm_hoversel_hover_parent_set()
14074 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14076 * @brief Set the hoversel button label
14078 * @param obj The hoversel object
14079 * @param label The label text.
14081 * This sets the label of the button that is always visible (before it is
14082 * clicked and expanded).
14084 * @deprecated elm_object_text_set()
14086 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14088 * @brief Get the hoversel button label
14090 * @param obj The hoversel object
14091 * @return The label text.
14093 * @deprecated elm_object_text_get()
14095 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14097 * @brief Set the icon of the hoversel button
14099 * @param obj The hoversel object
14100 * @param icon The icon object
14102 * Sets the icon of the button that is always visible (before it is clicked
14103 * and expanded). Once the icon object is set, a previously set one will be
14104 * deleted, if you want to keep that old content object, use the
14105 * elm_hoversel_icon_unset() function.
14107 * @see elm_object_content_set() for the button widget
14109 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14111 * @brief Get the icon of the hoversel button
14113 * @param obj The hoversel object
14114 * @return The icon object
14116 * Get the icon of the button that is always visible (before it is clicked
14117 * and expanded). Also see elm_object_content_get() for the button widget.
14119 * @see elm_hoversel_icon_set()
14121 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14123 * @brief Get and unparent the icon of the hoversel button
14125 * @param obj The hoversel object
14126 * @return The icon object that was being used
14128 * Unparent and return the icon of the button that is always visible
14129 * (before it is clicked and expanded).
14131 * @see elm_hoversel_icon_set()
14132 * @see elm_object_content_unset() for the button widget
14134 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14136 * @brief This triggers the hoversel popup from code, the same as if the user
14137 * had clicked the button.
14139 * @param obj The hoversel object
14141 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14143 * @brief This dismisses the hoversel popup as if the user had clicked
14144 * outside the hover.
14146 * @param obj The hoversel object
14148 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14150 * @brief Returns whether the hoversel is expanded.
14152 * @param obj The hoversel object
14153 * @return This will return EINA_TRUE if the hoversel is expanded or
14154 * EINA_FALSE if it is not expanded.
14156 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14158 * @brief This will remove all the children items from the hoversel.
14160 * @param obj The hoversel object
14162 * @warning Should @b not be called while the hoversel is active; use
14163 * elm_hoversel_expanded_get() to check first.
14165 * @see elm_hoversel_item_del_cb_set()
14166 * @see elm_hoversel_item_del()
14168 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14170 * @brief Get the list of items within the given hoversel.
14172 * @param obj The hoversel object
14173 * @return Returns a list of Elm_Hoversel_Item*
14175 * @see elm_hoversel_item_add()
14177 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14179 * @brief Add an item to the hoversel button
14181 * @param obj The hoversel object
14182 * @param label The text label to use for the item (NULL if not desired)
14183 * @param icon_file An image file path on disk to use for the icon or standard
14184 * icon name (NULL if not desired)
14185 * @param icon_type The icon type if relevant
14186 * @param func Convenience function to call when this item is selected
14187 * @param data Data to pass to item-related functions
14188 * @return A handle to the item added.
14190 * This adds an item to the hoversel to show when it is clicked. Note: if you
14191 * need to use an icon from an edje file then use
14192 * elm_hoversel_item_icon_set() right after the this function, and set
14193 * icon_file to NULL here.
14195 * For more information on what @p icon_file and @p icon_type are see the
14196 * @ref Icon "icon documentation".
14198 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);
14200 * @brief Delete an item from the hoversel
14202 * @param item The item to delete
14204 * This deletes the item from the hoversel (should not be called while the
14205 * hoversel is active; use elm_hoversel_expanded_get() to check first).
14207 * @see elm_hoversel_item_add()
14208 * @see elm_hoversel_item_del_cb_set()
14210 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14212 * @brief Set the function to be called when an item from the hoversel is
14215 * @param item The item to set the callback on
14216 * @param func The function called
14218 * That function will receive these parameters:
14219 * @li void *item_data
14220 * @li Evas_Object *the_item_object
14221 * @li Elm_Hoversel_Item *the_object_struct
14223 * @see elm_hoversel_item_add()
14225 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14227 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14228 * that will be passed to associated function callbacks.
14230 * @param item The item to get the data from
14231 * @return The data pointer set with elm_hoversel_item_add()
14233 * @see elm_hoversel_item_add()
14235 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14237 * @brief This returns the label text of the given hoversel item.
14239 * @param item The item to get the label
14240 * @return The label text of the hoversel item
14242 * @see elm_hoversel_item_add()
14244 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14246 * @brief This sets the icon for the given hoversel item.
14248 * @param item The item to set the icon
14249 * @param icon_file An image file path on disk to use for the icon or standard
14251 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14252 * to NULL if the icon is not an edje file
14253 * @param icon_type The icon type
14255 * The icon can be loaded from the standard set, from an image file, or from
14258 * @see elm_hoversel_item_add()
14260 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);
14262 * @brief Get the icon object of the hoversel item
14264 * @param item The item to get the icon from
14265 * @param icon_file The image file path on disk used for the icon or standard
14267 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14268 * if the icon is not an edje file
14269 * @param icon_type The icon type
14271 * @see elm_hoversel_item_icon_set()
14272 * @see elm_hoversel_item_add()
14274 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);
14280 * @defgroup Toolbar Toolbar
14281 * @ingroup Elementary
14283 * @image html img/widget/toolbar/preview-00.png
14284 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14286 * @image html img/toolbar.png
14287 * @image latex img/toolbar.eps width=\textwidth
14289 * A toolbar is a widget that displays a list of items inside
14290 * a box. It can be scrollable, show a menu with items that don't fit
14291 * to toolbar size or even crop them.
14293 * Only one item can be selected at a time.
14295 * Items can have multiple states, or show menus when selected by the user.
14297 * Smart callbacks one can listen to:
14298 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14299 * - "language,changed" - when the program language changes
14301 * Available styles for it:
14303 * - @c "transparent" - no background or shadow, just show the content
14305 * List of examples:
14306 * @li @ref toolbar_example_01
14307 * @li @ref toolbar_example_02
14308 * @li @ref toolbar_example_03
14312 * @addtogroup Toolbar
14317 * @enum _Elm_Toolbar_Shrink_Mode
14318 * @typedef Elm_Toolbar_Shrink_Mode
14320 * Set toolbar's items display behavior, it can be scrollabel,
14321 * show a menu with exceeding items, or simply hide them.
14323 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14326 * Values <b> don't </b> work as bitmask, only one can be choosen.
14328 * @see elm_toolbar_mode_shrink_set()
14329 * @see elm_toolbar_mode_shrink_get()
14333 typedef enum _Elm_Toolbar_Shrink_Mode
14335 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14336 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14337 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14338 ELM_TOOLBAR_SHRINK_MENU /**< Inserts a button to pop up a menu with exceeding items. */
14339 } Elm_Toolbar_Shrink_Mode;
14341 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(). */
14343 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(). */
14346 * Add a new toolbar widget to the given parent Elementary
14347 * (container) object.
14349 * @param parent The parent object.
14350 * @return a new toolbar widget handle or @c NULL, on errors.
14352 * This function inserts a new toolbar widget on the canvas.
14356 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14359 * Set the icon size, in pixels, to be used by toolbar items.
14361 * @param obj The toolbar object
14362 * @param icon_size The icon size in pixels
14364 * @note Default value is @c 32. It reads value from elm config.
14366 * @see elm_toolbar_icon_size_get()
14370 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14373 * Get the icon size, in pixels, to be used by toolbar items.
14375 * @param obj The toolbar object.
14376 * @return The icon size in pixels.
14378 * @see elm_toolbar_icon_size_set() for details.
14382 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14385 * Sets icon lookup order, for toolbar items' icons.
14387 * @param obj The toolbar object.
14388 * @param order The icon lookup order.
14390 * Icons added before calling this function will not be affected.
14391 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14393 * @see elm_toolbar_icon_order_lookup_get()
14397 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14400 * Gets the icon lookup order.
14402 * @param obj The toolbar object.
14403 * @return The icon lookup order.
14405 * @see elm_toolbar_icon_order_lookup_set() for details.
14409 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14412 * Set whether the toolbar should always have an item selected.
14414 * @param obj The toolbar object.
14415 * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14418 * This will cause the toolbar to always have an item selected, and clicking
14419 * the selected item will not cause a selected event to be emitted. Enabling this mode
14420 * will immediately select the first toolbar item.
14422 * Always-selected is disabled by default.
14424 * @see elm_toolbar_always_select_mode_get().
14428 EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14431 * Get whether the toolbar should always have an item selected.
14433 * @param obj The toolbar object.
14434 * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14435 * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14437 * @see elm_toolbar_always_select_mode_set() for details.
14441 EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14444 * Set whether the toolbar items' should be selected by the user or not.
14446 * @param obj The toolbar object.
14447 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14450 * This will turn off the ability to select items entirely and they will
14451 * neither appear selected nor emit selected signals. The clicked
14452 * callback function will still be called.
14454 * Selection is enabled by default.
14456 * @see elm_toolbar_no_select_mode_get().
14460 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14463 * Set whether the toolbar items' should be selected by the user or not.
14465 * @param obj The toolbar object.
14466 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14467 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14469 * @see elm_toolbar_no_select_mode_set() for details.
14473 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14476 * Append item to the toolbar.
14478 * @param obj The toolbar object.
14479 * @param icon A string with icon name or the absolute path of an image file.
14480 * @param label The label of the item.
14481 * @param func The function to call when the item is clicked.
14482 * @param data The data to associate with the item for related callbacks.
14483 * @return The created item or @c NULL upon failure.
14485 * A new item will be created and appended to the toolbar, i.e., will
14486 * be set as @b last item.
14488 * Items created with this method can be deleted with
14489 * elm_toolbar_item_del().
14491 * Associated @p data can be properly freed when item is deleted if a
14492 * callback function is set with elm_toolbar_item_del_cb_set().
14494 * If a function is passed as argument, it will be called everytime this item
14495 * is selected, i.e., the user clicks over an unselected item.
14496 * If such function isn't needed, just passing
14497 * @c NULL as @p func is enough. The same should be done for @p data.
14499 * Toolbar will load icon image from fdo or current theme.
14500 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14501 * If an absolute path is provided it will load it direct from a file.
14503 * @see elm_toolbar_item_icon_set()
14504 * @see elm_toolbar_item_del()
14505 * @see elm_toolbar_item_del_cb_set()
14509 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);
14512 * Prepend item to the toolbar.
14514 * @param obj The toolbar object.
14515 * @param icon A string with icon name or the absolute path of an image file.
14516 * @param label The label of the item.
14517 * @param func The function to call when the item is clicked.
14518 * @param data The data to associate with the item for related callbacks.
14519 * @return The created item or @c NULL upon failure.
14521 * A new item will be created and prepended to the toolbar, i.e., will
14522 * be set as @b first item.
14524 * Items created with this method can be deleted with
14525 * elm_toolbar_item_del().
14527 * Associated @p data can be properly freed when item is deleted if a
14528 * callback function is set with elm_toolbar_item_del_cb_set().
14530 * If a function is passed as argument, it will be called everytime this item
14531 * is selected, i.e., the user clicks over an unselected item.
14532 * If such function isn't needed, just passing
14533 * @c NULL as @p func is enough. The same should be done for @p data.
14535 * Toolbar will load icon image from fdo or current theme.
14536 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14537 * If an absolute path is provided it will load it direct from a file.
14539 * @see elm_toolbar_item_icon_set()
14540 * @see elm_toolbar_item_del()
14541 * @see elm_toolbar_item_del_cb_set()
14545 EAPI Elm_Toolbar_Item *elm_toolbar_item_prepend(Evas_Object *obj, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
14548 * Insert a new item into the toolbar object before item @p before.
14550 * @param obj The toolbar object.
14551 * @param before The toolbar item to insert before.
14552 * @param icon A string with icon name or the absolute path of an image file.
14553 * @param label The label of the item.
14554 * @param func The function to call when the item is clicked.
14555 * @param data The data to associate with the item for related callbacks.
14556 * @return The created item or @c NULL upon failure.
14558 * A new item will be created and added to the toolbar. Its position in
14559 * this toolbar will be just before item @p before.
14561 * Items created with this method can be deleted with
14562 * elm_toolbar_item_del().
14564 * Associated @p data can be properly freed when item is deleted if a
14565 * callback function is set with elm_toolbar_item_del_cb_set().
14567 * If a function is passed as argument, it will be called everytime this item
14568 * is selected, i.e., the user clicks over an unselected item.
14569 * If such function isn't needed, just passing
14570 * @c NULL as @p func is enough. The same should be done for @p data.
14572 * Toolbar will load icon image from fdo or current theme.
14573 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14574 * If an absolute path is provided it will load it direct from a file.
14576 * @see elm_toolbar_item_icon_set()
14577 * @see elm_toolbar_item_del()
14578 * @see elm_toolbar_item_del_cb_set()
14582 EAPI Elm_Toolbar_Item *elm_toolbar_item_insert_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);
14585 * Insert a new item into the toolbar object after item @p after.
14587 * @param obj The toolbar object.
14588 * @param before The toolbar item to insert before.
14589 * @param icon A string with icon name or the absolute path of an image file.
14590 * @param label The label of the item.
14591 * @param func The function to call when the item is clicked.
14592 * @param data The data to associate with the item for related callbacks.
14593 * @return The created item or @c NULL upon failure.
14595 * A new item will be created and added to the toolbar. Its position in
14596 * this toolbar will be just after item @p after.
14598 * Items created with this method can be deleted with
14599 * elm_toolbar_item_del().
14601 * Associated @p data can be properly freed when item is deleted if a
14602 * callback function is set with elm_toolbar_item_del_cb_set().
14604 * If a function is passed as argument, it will be called everytime this item
14605 * is selected, i.e., the user clicks over an unselected item.
14606 * If such function isn't needed, just passing
14607 * @c NULL as @p func is enough. The same should be done for @p data.
14609 * Toolbar will load icon image from fdo or current theme.
14610 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14611 * If an absolute path is provided it will load it direct from a file.
14613 * @see elm_toolbar_item_icon_set()
14614 * @see elm_toolbar_item_del()
14615 * @see elm_toolbar_item_del_cb_set()
14619 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);
14622 * Get the first item in the given toolbar widget's list of
14625 * @param obj The toolbar object
14626 * @return The first item or @c NULL, if it has no items (and on
14629 * @see elm_toolbar_item_append()
14630 * @see elm_toolbar_last_item_get()
14634 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14637 * Get the last item in the given toolbar widget's list of
14640 * @param obj The toolbar object
14641 * @return The last item or @c NULL, if it has no items (and on
14644 * @see elm_toolbar_item_prepend()
14645 * @see elm_toolbar_first_item_get()
14649 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14652 * Get the item after @p item in toolbar.
14654 * @param item The toolbar item.
14655 * @return The item after @p item, or @c NULL if none or on failure.
14657 * @note If it is the last item, @c NULL will be returned.
14659 * @see elm_toolbar_item_append()
14663 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14666 * Get the item before @p item in toolbar.
14668 * @param item The toolbar item.
14669 * @return The item before @p item, or @c NULL if none or on failure.
14671 * @note If it is the first item, @c NULL will be returned.
14673 * @see elm_toolbar_item_prepend()
14677 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14680 * Get the toolbar object from an item.
14682 * @param item The item.
14683 * @return The toolbar object.
14685 * This returns the toolbar object itself that an item belongs to.
14689 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14692 * Set the priority of a toolbar item.
14694 * @param item The toolbar item.
14695 * @param priority The item priority. The default is zero.
14697 * This is used only when the toolbar shrink mode is set to
14698 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14699 * When space is less than required, items with low priority
14700 * will be removed from the toolbar and added to a dynamically-created menu,
14701 * while items with higher priority will remain on the toolbar,
14702 * with the same order they were added.
14704 * @see elm_toolbar_item_priority_get()
14708 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14711 * Get the priority of a toolbar item.
14713 * @param item The toolbar item.
14714 * @return The @p item priority, or @c 0 on failure.
14716 * @see elm_toolbar_item_priority_set() for details.
14720 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14723 * Get the label of item.
14725 * @param item The item of toolbar.
14726 * @return The label of item.
14728 * The return value is a pointer to the label associated to @p item when
14729 * it was created, with function elm_toolbar_item_append() or similar,
14731 * with function elm_toolbar_item_label_set. If no label
14732 * was passed as argument, it will return @c NULL.
14734 * @see elm_toolbar_item_label_set() for more details.
14735 * @see elm_toolbar_item_append()
14739 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14742 * Set the label of item.
14744 * @param item The item of toolbar.
14745 * @param text The label of item.
14747 * The label to be displayed by the item.
14748 * Label will be placed at icons bottom (if set).
14750 * If a label was passed as argument on item creation, with function
14751 * elm_toolbar_item_append() or similar, it will be already
14752 * displayed by the item.
14754 * @see elm_toolbar_item_label_get()
14755 * @see elm_toolbar_item_append()
14759 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14762 * Return the data associated with a given toolbar widget item.
14764 * @param item The toolbar widget item handle.
14765 * @return The data associated with @p item.
14767 * @see elm_toolbar_item_data_set()
14771 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14774 * Set the data associated with a given toolbar widget item.
14776 * @param item The toolbar widget item handle.
14777 * @param data The new data pointer to set to @p item.
14779 * This sets new item data on @p item.
14781 * @warning The old data pointer won't be touched by this function, so
14782 * the user had better to free that old data himself/herself.
14786 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14789 * Returns a pointer to a toolbar item by its label.
14791 * @param obj The toolbar object.
14792 * @param label The label of the item to find.
14794 * @return The pointer to the toolbar item matching @p label or @c NULL
14799 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14802 * Get whether the @p item is selected or not.
14804 * @param item The toolbar item.
14805 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14806 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14808 * @see elm_toolbar_selected_item_set() for details.
14809 * @see elm_toolbar_item_selected_get()
14813 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14816 * Set the selected state of an item.
14818 * @param item The toolbar item
14819 * @param selected The selected state
14821 * This sets the selected state of the given item @p it.
14822 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14824 * If a new item is selected the previosly selected will be unselected.
14825 * Previoulsy selected item can be get with function
14826 * elm_toolbar_selected_item_get().
14828 * Selected items will be highlighted.
14830 * @see elm_toolbar_item_selected_get()
14831 * @see elm_toolbar_selected_item_get()
14835 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14838 * Get the selected item.
14840 * @param obj The toolbar object.
14841 * @return The selected toolbar item.
14843 * The selected item can be unselected with function
14844 * elm_toolbar_item_selected_set().
14846 * The selected item always will be highlighted on toolbar.
14848 * @see elm_toolbar_selected_items_get()
14852 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14855 * Set the icon associated with @p item.
14857 * @param obj The parent of this item.
14858 * @param item The toolbar item.
14859 * @param icon A string with icon name or the absolute path of an image file.
14861 * Toolbar will load icon image from fdo or current theme.
14862 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14863 * If an absolute path is provided it will load it direct from a file.
14865 * @see elm_toolbar_icon_order_lookup_set()
14866 * @see elm_toolbar_icon_order_lookup_get()
14870 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14873 * Get the string used to set the icon of @p item.
14875 * @param item The toolbar item.
14876 * @return The string associated with the icon object.
14878 * @see elm_toolbar_item_icon_set() for details.
14882 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14885 * Get the object of @p item.
14887 * @param item The toolbar item.
14888 * @return The object
14892 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14895 * Get the icon object of @p item.
14897 * @param item The toolbar item.
14898 * @return The icon object
14900 * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14904 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14907 * Set the icon associated with @p item to an image in a binary buffer.
14909 * @param item The toolbar item.
14910 * @param img The binary data that will be used as an image
14911 * @param size The size of binary data @p img
14912 * @param format Optional format of @p img to pass to the image loader
14913 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
14915 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
14917 * @note The icon image set by this function can be changed by
14918 * elm_toolbar_item_icon_set().
14922 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);
14925 * Delete them item from the toolbar.
14927 * @param item The item of toolbar to be deleted.
14929 * @see elm_toolbar_item_append()
14930 * @see elm_toolbar_item_del_cb_set()
14934 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14937 * Set the function called when a toolbar item is freed.
14939 * @param item The item to set the callback on.
14940 * @param func The function called.
14942 * If there is a @p func, then it will be called prior item's memory release.
14943 * That will be called with the following arguments:
14945 * @li item's Evas object;
14948 * This way, a data associated to a toolbar item could be properly freed.
14952 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14955 * Get a value whether toolbar item is disabled or not.
14957 * @param item The item.
14958 * @return The disabled state.
14960 * @see elm_toolbar_item_disabled_set() for more details.
14964 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14967 * Sets the disabled/enabled state of a toolbar item.
14969 * @param item The item.
14970 * @param disabled The disabled state.
14972 * A disabled item cannot be selected or unselected. It will also
14973 * change its appearance (generally greyed out). This sets the
14974 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
14979 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14982 * Set or unset item as a separator.
14984 * @param item The toolbar item.
14985 * @param setting @c EINA_TRUE to set item @p item as separator or
14986 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
14988 * Items aren't set as separator by default.
14990 * If set as separator it will display separator theme, so won't display
14993 * @see elm_toolbar_item_separator_get()
14997 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
15000 * Get a value whether item is a separator or not.
15002 * @param item The toolbar item.
15003 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15004 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15006 * @see elm_toolbar_item_separator_set() for details.
15010 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15013 * Set the shrink state of toolbar @p obj.
15015 * @param obj The toolbar object.
15016 * @param shrink_mode Toolbar's items display behavior.
15018 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15019 * but will enforce a minimun size so all the items will fit, won't scroll
15020 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15021 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15022 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15026 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15029 * Get the shrink mode of toolbar @p obj.
15031 * @param obj The toolbar object.
15032 * @return Toolbar's items display behavior.
15034 * @see elm_toolbar_mode_shrink_set() for details.
15038 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15041 * Enable/disable homogenous mode.
15043 * @param obj The toolbar object
15044 * @param homogeneous Assume the items within the toolbar are of the
15045 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15047 * This will enable the homogeneous mode where items are of the same size.
15048 * @see elm_toolbar_homogeneous_get()
15052 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15055 * Get whether the homogenous mode is enabled.
15057 * @param obj The toolbar object.
15058 * @return Assume the items within the toolbar are of the same height
15059 * and width (EINA_TRUE = on, EINA_FALSE = off).
15061 * @see elm_toolbar_homogeneous_set()
15065 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15068 * Enable/disable homogenous mode.
15070 * @param obj The toolbar object
15071 * @param homogeneous Assume the items within the toolbar are of the
15072 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15074 * This will enable the homogeneous mode where items are of the same size.
15075 * @see elm_toolbar_homogeneous_get()
15077 * @deprecated use elm_toolbar_homogeneous_set() instead.
15081 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
15084 * Get whether the homogenous mode is enabled.
15086 * @param obj The toolbar object.
15087 * @return Assume the items within the toolbar are of the same height
15088 * and width (EINA_TRUE = on, EINA_FALSE = off).
15090 * @see elm_toolbar_homogeneous_set()
15091 * @deprecated use elm_toolbar_homogeneous_get() instead.
15095 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15098 * Set the parent object of the toolbar items' menus.
15100 * @param obj The toolbar object.
15101 * @param parent The parent of the menu objects.
15103 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15105 * For more details about setting the parent for toolbar menus, see
15106 * elm_menu_parent_set().
15108 * @see elm_menu_parent_set() for details.
15109 * @see elm_toolbar_item_menu_set() for details.
15113 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15116 * Get the parent object of the toolbar items' menus.
15118 * @param obj The toolbar object.
15119 * @return The parent of the menu objects.
15121 * @see elm_toolbar_menu_parent_set() for details.
15125 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15128 * Set the alignment of the items.
15130 * @param obj The toolbar object.
15131 * @param align The new alignment, a float between <tt> 0.0 </tt>
15132 * and <tt> 1.0 </tt>.
15134 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15135 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15138 * Centered items by default.
15140 * @see elm_toolbar_align_get()
15144 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15147 * Get the alignment of the items.
15149 * @param obj The toolbar object.
15150 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15153 * @see elm_toolbar_align_set() for details.
15157 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15160 * Set whether the toolbar item opens a menu.
15162 * @param item The toolbar item.
15163 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15165 * A toolbar item can be set to be a menu, using this function.
15167 * Once it is set to be a menu, it can be manipulated through the
15168 * menu-like function elm_toolbar_menu_parent_set() and the other
15169 * elm_menu functions, using the Evas_Object @c menu returned by
15170 * elm_toolbar_item_menu_get().
15172 * So, items to be displayed in this item's menu should be added with
15173 * elm_menu_item_add().
15175 * The following code exemplifies the most basic usage:
15177 * tb = elm_toolbar_add(win)
15178 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15179 * elm_toolbar_item_menu_set(item, EINA_TRUE);
15180 * elm_toolbar_menu_parent_set(tb, win);
15181 * menu = elm_toolbar_item_menu_get(item);
15182 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15183 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15187 * @see elm_toolbar_item_menu_get()
15191 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15194 * Get toolbar item's menu.
15196 * @param item The toolbar item.
15197 * @return Item's menu object or @c NULL on failure.
15199 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15200 * this function will set it.
15202 * @see elm_toolbar_item_menu_set() for details.
15206 EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15209 * Add a new state to @p item.
15211 * @param item The item.
15212 * @param icon A string with icon name or the absolute path of an image file.
15213 * @param label The label of the new state.
15214 * @param func The function to call when the item is clicked when this
15215 * state is selected.
15216 * @param data The data to associate with the state.
15217 * @return The toolbar item state, or @c NULL upon failure.
15219 * Toolbar will load icon image from fdo or current theme.
15220 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15221 * If an absolute path is provided it will load it direct from a file.
15223 * States created with this function can be removed with
15224 * elm_toolbar_item_state_del().
15226 * @see elm_toolbar_item_state_del()
15227 * @see elm_toolbar_item_state_sel()
15228 * @see elm_toolbar_item_state_get()
15232 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);
15235 * Delete a previoulsy added state to @p item.
15237 * @param item The toolbar item.
15238 * @param state The state to be deleted.
15239 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15241 * @see elm_toolbar_item_state_add()
15243 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15246 * Set @p state as the current state of @p it.
15248 * @param it The item.
15249 * @param state The state to use.
15250 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15252 * If @p state is @c NULL, it won't select any state and the default item's
15253 * icon and label will be used. It's the same behaviour than
15254 * elm_toolbar_item_state_unser().
15256 * @see elm_toolbar_item_state_unset()
15260 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15263 * Unset the state of @p it.
15265 * @param it The item.
15267 * The default icon and label from this item will be displayed.
15269 * @see elm_toolbar_item_state_set() for more details.
15273 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15276 * Get the current state of @p it.
15278 * @param item The item.
15279 * @return The selected state or @c NULL if none is selected or on failure.
15281 * @see elm_toolbar_item_state_set() for details.
15282 * @see elm_toolbar_item_state_unset()
15283 * @see elm_toolbar_item_state_add()
15287 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15290 * Get the state after selected state in toolbar's @p item.
15292 * @param it The toolbar item to change state.
15293 * @return The state after current state, or @c NULL on failure.
15295 * If last state is selected, this function will return first state.
15297 * @see elm_toolbar_item_state_set()
15298 * @see elm_toolbar_item_state_add()
15302 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15305 * Get the state before selected state in toolbar's @p item.
15307 * @param it The toolbar item to change state.
15308 * @return The state before current state, or @c NULL on failure.
15310 * If first state is selected, this function will return last state.
15312 * @see elm_toolbar_item_state_set()
15313 * @see elm_toolbar_item_state_add()
15317 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15320 * Set the text to be shown in a given toolbar item's tooltips.
15322 * @param item Target item.
15323 * @param text The text to set in the content.
15325 * Setup the text as tooltip to object. The item can have only one tooltip,
15326 * so any previous tooltip data - set with this function or
15327 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15329 * @see elm_object_tooltip_text_set() for more details.
15333 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15336 * Set the content to be shown in the tooltip item.
15338 * Setup the tooltip to item. The item can have only one tooltip,
15339 * so any previous tooltip data is removed. @p func(with @p data) will
15340 * be called every time that need show the tooltip and it should
15341 * return a valid Evas_Object. This object is then managed fully by
15342 * tooltip system and is deleted when the tooltip is gone.
15344 * @param item the toolbar item being attached a tooltip.
15345 * @param func the function used to create the tooltip contents.
15346 * @param data what to provide to @a func as callback data/context.
15347 * @param del_cb called when data is not needed anymore, either when
15348 * another callback replaces @a func, the tooltip is unset with
15349 * elm_toolbar_item_tooltip_unset() or the owner @a item
15350 * dies. This callback receives as the first parameter the
15351 * given @a data, and @c event_info is the item.
15353 * @see elm_object_tooltip_content_cb_set() for more details.
15357 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);
15360 * Unset tooltip from item.
15362 * @param item toolbar item to remove previously set tooltip.
15364 * Remove tooltip from item. The callback provided as del_cb to
15365 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15366 * it is not used anymore.
15368 * @see elm_object_tooltip_unset() for more details.
15369 * @see elm_toolbar_item_tooltip_content_cb_set()
15373 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15376 * Sets a different style for this item tooltip.
15378 * @note before you set a style you should define a tooltip with
15379 * elm_toolbar_item_tooltip_content_cb_set() or
15380 * elm_toolbar_item_tooltip_text_set()
15382 * @param item toolbar item with tooltip already set.
15383 * @param style the theme style to use (default, transparent, ...)
15385 * @see elm_object_tooltip_style_set() for more details.
15389 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15392 * Get the style for this item tooltip.
15394 * @param item toolbar item with tooltip already set.
15395 * @return style the theme style in use, defaults to "default". If the
15396 * object does not have a tooltip set, then NULL is returned.
15398 * @see elm_object_tooltip_style_get() for more details.
15399 * @see elm_toolbar_item_tooltip_style_set()
15403 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15406 * Set the type of mouse pointer/cursor decoration to be shown,
15407 * when the mouse pointer is over the given toolbar widget item
15409 * @param item toolbar item to customize cursor on
15410 * @param cursor the cursor type's name
15412 * This function works analogously as elm_object_cursor_set(), but
15413 * here the cursor's changing area is restricted to the item's
15414 * area, and not the whole widget's. Note that that item cursors
15415 * have precedence over widget cursors, so that a mouse over an
15416 * item with custom cursor set will always show @b that cursor.
15418 * If this function is called twice for an object, a previously set
15419 * cursor will be unset on the second call.
15421 * @see elm_object_cursor_set()
15422 * @see elm_toolbar_item_cursor_get()
15423 * @see elm_toolbar_item_cursor_unset()
15427 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15430 * Get the type of mouse pointer/cursor decoration set to be shown,
15431 * when the mouse pointer is over the given toolbar widget item
15433 * @param item toolbar item with custom cursor set
15434 * @return the cursor type's name or @c NULL, if no custom cursors
15435 * were set to @p item (and on errors)
15437 * @see elm_object_cursor_get()
15438 * @see elm_toolbar_item_cursor_set()
15439 * @see elm_toolbar_item_cursor_unset()
15443 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15446 * Unset any custom mouse pointer/cursor decoration set to be
15447 * shown, when the mouse pointer is over the given toolbar widget
15448 * item, thus making it show the @b default cursor again.
15450 * @param item a toolbar item
15452 * Use this call to undo any custom settings on this item's cursor
15453 * decoration, bringing it back to defaults (no custom style set).
15455 * @see elm_object_cursor_unset()
15456 * @see elm_toolbar_item_cursor_set()
15460 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15463 * Set a different @b style for a given custom cursor set for a
15466 * @param item toolbar item with custom cursor set
15467 * @param style the <b>theme style</b> to use (e.g. @c "default",
15468 * @c "transparent", etc)
15470 * This function only makes sense when one is using custom mouse
15471 * cursor decorations <b>defined in a theme file</b>, which can have,
15472 * given a cursor name/type, <b>alternate styles</b> on it. It
15473 * works analogously as elm_object_cursor_style_set(), but here
15474 * applyed only to toolbar item objects.
15476 * @warning Before you set a cursor style you should have definen a
15477 * custom cursor previously on the item, with
15478 * elm_toolbar_item_cursor_set()
15480 * @see elm_toolbar_item_cursor_engine_only_set()
15481 * @see elm_toolbar_item_cursor_style_get()
15485 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15488 * Get the current @b style set for a given toolbar item's custom
15491 * @param item toolbar item with custom cursor set.
15492 * @return style the cursor style in use. If the object does not
15493 * have a cursor set, then @c NULL is returned.
15495 * @see elm_toolbar_item_cursor_style_set() for more details
15499 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15502 * Set if the (custom)cursor for a given toolbar item should be
15503 * searched in its theme, also, or should only rely on the
15504 * rendering engine.
15506 * @param item item with custom (custom) cursor already set on
15507 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15508 * only on those provided by the rendering engine, @c EINA_FALSE to
15509 * have them searched on the widget's theme, as well.
15511 * @note This call is of use only if you've set a custom cursor
15512 * for toolbar items, with elm_toolbar_item_cursor_set().
15514 * @note By default, cursors will only be looked for between those
15515 * provided by the rendering engine.
15519 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15522 * Get if the (custom) cursor for a given toolbar item is being
15523 * searched in its theme, also, or is only relying on the rendering
15526 * @param item a toolbar item
15527 * @return @c EINA_TRUE, if cursors are being looked for only on
15528 * those provided by the rendering engine, @c EINA_FALSE if they
15529 * are being searched on the widget's theme, as well.
15531 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15535 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15538 * Change a toolbar's orientation
15539 * @param obj The toolbar object
15540 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15541 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15544 EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15547 * Get a toolbar's orientation
15548 * @param obj The toolbar object
15549 * @return If @c EINA_TRUE, the toolbar is vertical
15550 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15553 EAPI Eina_Bool elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
15560 * @defgroup Tooltips Tooltips
15562 * The Tooltip is an (internal, for now) smart object used to show a
15563 * content in a frame on mouse hover of objects(or widgets), with
15564 * tips/information about them.
15569 EAPI double elm_tooltip_delay_get(void);
15570 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15571 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15572 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15573 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15574 EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15575 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15576 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);
15577 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15578 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15579 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15580 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
15581 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
15588 * @defgroup Cursors Cursors
15590 * The Elementary cursor is an internal smart object used to
15591 * customize the mouse cursor displayed over objects (or
15592 * widgets). In the most common scenario, the cursor decoration
15593 * comes from the graphical @b engine Elementary is running
15594 * on. Those engines may provide different decorations for cursors,
15595 * and Elementary provides functions to choose them (think of X11
15596 * cursors, as an example).
15598 * There's also the possibility of, besides using engine provided
15599 * cursors, also use ones coming from Edje theming files. Both
15600 * globally and per widget, Elementary makes it possible for one to
15601 * make the cursors lookup to be held on engines only or on
15602 * Elementary's theme file, too.
15608 * Set the cursor to be shown when mouse is over the object
15610 * Set the cursor that will be displayed when mouse is over the
15611 * object. The object can have only one cursor set to it, so if
15612 * this function is called twice for an object, the previous set
15614 * If using X cursors, a definition of all the valid cursor names
15615 * is listed on Elementary_Cursors.h. If an invalid name is set
15616 * the default cursor will be used.
15618 * @param obj the object being set a cursor.
15619 * @param cursor the cursor name to be used.
15623 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15626 * Get the cursor to be shown when mouse is over the object
15628 * @param obj an object with cursor already set.
15629 * @return the cursor name.
15633 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15636 * Unset cursor for object
15638 * Unset cursor for object, and set the cursor to default if the mouse
15639 * was over this object.
15641 * @param obj Target object
15642 * @see elm_object_cursor_set()
15646 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15649 * Sets a different style for this object cursor.
15651 * @note before you set a style you should define a cursor with
15652 * elm_object_cursor_set()
15654 * @param obj an object with cursor already set.
15655 * @param style the theme style to use (default, transparent, ...)
15659 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15662 * Get the style for this object cursor.
15664 * @param obj an object with cursor already set.
15665 * @return style the theme style in use, defaults to "default". If the
15666 * object does not have a cursor set, then NULL is returned.
15670 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15673 * Set if the cursor set should be searched on the theme or should use
15674 * the provided by the engine, only.
15676 * @note before you set if should look on theme you should define a cursor
15677 * with elm_object_cursor_set(). By default it will only look for cursors
15678 * provided by the engine.
15680 * @param obj an object with cursor already set.
15681 * @param engine_only boolean to define it cursors should be looked only
15682 * between the provided by the engine or searched on widget's theme as well.
15686 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15689 * Get the cursor engine only usage for this object cursor.
15691 * @param obj an object with cursor already set.
15692 * @return engine_only boolean to define it cursors should be
15693 * looked only between the provided by the engine or searched on
15694 * widget's theme as well. If the object does not have a cursor
15695 * set, then EINA_FALSE is returned.
15699 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15702 * Get the configured cursor engine only usage
15704 * This gets the globally configured exclusive usage of engine cursors.
15706 * @return 1 if only engine cursors should be used
15709 EAPI int elm_cursor_engine_only_get(void);
15712 * Set the configured cursor engine only usage
15714 * This sets the globally configured exclusive usage of engine cursors.
15715 * It won't affect cursors set before changing this value.
15717 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15718 * look for them on theme before.
15719 * @return EINA_TRUE if value is valid and setted (0 or 1)
15722 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
15729 * @defgroup Menu Menu
15731 * @image html img/widget/menu/preview-00.png
15732 * @image latex img/widget/menu/preview-00.eps
15734 * A menu is a list of items displayed above its parent. When the menu is
15735 * showing its parent is darkened. Each item can have a sub-menu. The menu
15736 * object can be used to display a menu on a right click event, in a toolbar,
15739 * Signals that you can add callbacks for are:
15740 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15741 * event_info is NULL.
15743 * @see @ref tutorial_menu
15746 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15748 * @brief Add a new menu to the parent
15750 * @param parent The parent object.
15751 * @return The new object or NULL if it cannot be created.
15753 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15755 * @brief Set the parent for the given menu widget
15757 * @param obj The menu object.
15758 * @param parent The new parent.
15760 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15762 * @brief Get the parent for the given menu widget
15764 * @param obj The menu object.
15765 * @return The parent.
15767 * @see elm_menu_parent_set()
15769 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15771 * @brief Move the menu to a new position
15773 * @param obj The menu object.
15774 * @param x The new position.
15775 * @param y The new position.
15777 * Sets the top-left position of the menu to (@p x,@p y).
15779 * @note @p x and @p y coordinates are relative to parent.
15781 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15783 * @brief Close a opened menu
15785 * @param obj the menu object
15788 * Hides the menu and all it's sub-menus.
15790 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15792 * @brief Returns a list of @p item's items.
15794 * @param obj The menu object
15795 * @return An Eina_List* of @p item's items
15797 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15799 * @brief Get the Evas_Object of an Elm_Menu_Item
15801 * @param item The menu item object.
15802 * @return The edje object containing the swallowed content
15804 * @warning Don't manipulate this object!
15806 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15808 * @brief Add an item at the end of the given menu widget
15810 * @param obj The menu object.
15811 * @param parent The parent menu item (optional)
15812 * @param icon A icon display on the item. The icon will be destryed by the menu.
15813 * @param label The label of the item.
15814 * @param func Function called when the user select the item.
15815 * @param data Data sent by the callback.
15816 * @return Returns the new item.
15818 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);
15820 * @brief Add an object swallowed in an item at the end of the given menu
15823 * @param obj The menu object.
15824 * @param parent The parent menu item (optional)
15825 * @param subobj The object to swallow
15826 * @param func Function called when the user select the item.
15827 * @param data Data sent by the callback.
15828 * @return Returns the new item.
15830 * Add an evas object as an item to the menu.
15832 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);
15834 * @brief Set the label of a menu item
15836 * @param item The menu item object.
15837 * @param label The label to set for @p item
15839 * @warning Don't use this funcion on items created with
15840 * elm_menu_item_add_object() or elm_menu_item_separator_add().
15842 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15844 * @brief Get the label of a menu item
15846 * @param item The menu item object.
15847 * @return The label of @p item
15849 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15851 * @brief Set the icon of a menu item to the standard icon with name @p icon
15853 * @param item The menu item object.
15854 * @param icon The icon object to set for the content of @p item
15856 * Once this icon is set, any previously set icon will be deleted.
15858 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15860 * @brief Get the string representation from the icon of a menu item
15862 * @param item The menu item object.
15863 * @return The string representation of @p item's icon or NULL
15865 * @see elm_menu_item_object_icon_name_set()
15867 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15869 * @brief Set the content object of a menu item
15871 * @param item The menu item object
15872 * @param The content object or NULL
15873 * @return EINA_TRUE on success, else EINA_FALSE
15875 * Use this function to change the object swallowed by a menu item, deleting
15876 * any previously swallowed object.
15878 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
15880 * @brief Get the content object of a menu item
15882 * @param item The menu item object
15883 * @return The content object or NULL
15884 * @note If @p item was added with elm_menu_item_add_object, this
15885 * function will return the object passed, else it will return the
15888 * @see elm_menu_item_object_content_set()
15890 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15892 * @brief Set the selected state of @p item.
15894 * @param item The menu item object.
15895 * @param selected The selected/unselected state of the item
15897 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15899 * @brief Get the selected state of @p item.
15901 * @param item The menu item object.
15902 * @return The selected/unselected state of the item
15904 * @see elm_menu_item_selected_set()
15906 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15908 * @brief Set the disabled state of @p item.
15910 * @param item The menu item object.
15911 * @param disabled The enabled/disabled state of the item
15913 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15915 * @brief Get the disabled state of @p item.
15917 * @param item The menu item object.
15918 * @return The enabled/disabled state of the item
15920 * @see elm_menu_item_disabled_set()
15922 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15924 * @brief Add a separator item to menu @p obj under @p parent.
15926 * @param obj The menu object
15927 * @param parent The item to add the separator under
15928 * @return The created item or NULL on failure
15930 * This is item is a @ref Separator.
15932 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
15934 * @brief Returns whether @p item is a separator.
15936 * @param item The item to check
15937 * @return If true, @p item is a separator
15939 * @see elm_menu_item_separator_add()
15941 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15943 * @brief Deletes an item from the menu.
15945 * @param item The item to delete.
15947 * @see elm_menu_item_add()
15949 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15951 * @brief Set the function called when a menu item is deleted.
15953 * @param item The item to set the callback on
15954 * @param func The function called
15956 * @see elm_menu_item_add()
15957 * @see elm_menu_item_del()
15959 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15961 * @brief Returns the data associated with menu item @p item.
15963 * @param item The item
15964 * @return The data associated with @p item or NULL if none was set.
15966 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
15968 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15970 * @brief Sets the data to be associated with menu item @p item.
15972 * @param item The item
15973 * @param data The data to be associated with @p item
15975 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
15977 * @brief Returns a list of @p item's subitems.
15979 * @param item The item
15980 * @return An Eina_List* of @p item's subitems
15982 * @see elm_menu_add()
15984 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15986 * @brief Get the position of a menu item
15988 * @param item The menu item
15989 * @return The item's index
15991 * This function returns the index position of a menu item in a menu.
15992 * For a sub-menu, this number is relative to the first item in the sub-menu.
15994 * @note Index values begin with 0
15996 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
15998 * @brief @brief Return a menu item's owner menu
16000 * @param item The menu item
16001 * @return The menu object owning @p item, or NULL on failure
16003 * Use this function to get the menu object owning an item.
16005 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16007 * @brief Get the selected item in the menu
16009 * @param obj The menu object
16010 * @return The selected item, or NULL if none
16012 * @see elm_menu_item_selected_get()
16013 * @see elm_menu_item_selected_set()
16015 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16017 * @brief Get the last item in the menu
16019 * @param obj The menu object
16020 * @return The last item, or NULL if none
16022 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16024 * @brief Get the first item in the menu
16026 * @param obj The menu object
16027 * @return The first item, or NULL if none
16029 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16031 * @brief Get the next item in the menu.
16033 * @param item The menu item object.
16034 * @return The item after it, or NULL if none
16036 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16038 * @brief Get the previous item in the menu.
16040 * @param item The menu item object.
16041 * @return The item before it, or NULL if none
16043 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16049 * @defgroup List List
16050 * @ingroup Elementary
16052 * @image html img/widget/list/preview-00.png
16053 * @image latex img/widget/list/preview-00.eps width=\textwidth
16055 * @image html img/list.png
16056 * @image latex img/list.eps width=\textwidth
16058 * A list widget is a container whose children are displayed vertically or
16059 * horizontally, in order, and can be selected.
16060 * The list can accept only one or multiple items selection. Also has many
16061 * modes of items displaying.
16063 * A list is a very simple type of list widget. For more robust
16064 * lists, @ref Genlist should probably be used.
16066 * Smart callbacks one can listen to:
16067 * - @c "activated" - The user has double-clicked or pressed
16068 * (enter|return|spacebar) on an item. The @c event_info parameter
16069 * is the item that was activated.
16070 * - @c "clicked,double" - The user has double-clicked an item.
16071 * The @c event_info parameter is the item that was double-clicked.
16072 * - "selected" - when the user selected an item
16073 * - "unselected" - when the user unselected an item
16074 * - "longpressed" - an item in the list is long-pressed
16075 * - "edge,top" - the list is scrolled until the top edge
16076 * - "edge,bottom" - the list is scrolled until the bottom edge
16077 * - "edge,left" - the list is scrolled until the left edge
16078 * - "edge,right" - the list is scrolled until the right edge
16079 * - "language,changed" - the program's language changed
16081 * Available styles for it:
16084 * List of examples:
16085 * @li @ref list_example_01
16086 * @li @ref list_example_02
16087 * @li @ref list_example_03
16096 * @enum _Elm_List_Mode
16097 * @typedef Elm_List_Mode
16099 * Set list's resize behavior, transverse axis scroll and
16100 * items cropping. See each mode's description for more details.
16102 * @note Default value is #ELM_LIST_SCROLL.
16104 * Values <b> don't </b> work as bitmask, only one can be choosen.
16106 * @see elm_list_mode_set()
16107 * @see elm_list_mode_get()
16111 typedef enum _Elm_List_Mode
16113 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. */
16114 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). */
16115 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. */
16116 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. */
16117 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16120 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(). */
16123 * Add a new list widget to the given parent Elementary
16124 * (container) object.
16126 * @param parent The parent object.
16127 * @return a new list widget handle or @c NULL, on errors.
16129 * This function inserts a new list widget on the canvas.
16133 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16138 * @param obj The list object
16140 * @note Call before running show() on the list object.
16141 * @warning If not called, it won't display the list properly.
16144 * li = elm_list_add(win);
16145 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16146 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16148 * evas_object_show(li);
16153 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16156 * Enable or disable multiple items selection on the list object.
16158 * @param obj The list object
16159 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16162 * Disabled by default. If disabled, the user can select a single item of
16163 * the list each time. Selected items are highlighted on list.
16164 * If enabled, many items can be selected.
16166 * If a selected item is selected again, it will be unselected.
16168 * @see elm_list_multi_select_get()
16172 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16175 * Get a value whether multiple items selection is enabled or not.
16177 * @see elm_list_multi_select_set() for details.
16179 * @param obj The list object.
16180 * @return @c EINA_TRUE means multiple items selection is enabled.
16181 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16182 * @c EINA_FALSE is returned.
16186 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16189 * Set which mode to use for the list object.
16191 * @param obj The list object
16192 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16193 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16195 * Set list's resize behavior, transverse axis scroll and
16196 * items cropping. See each mode's description for more details.
16198 * @note Default value is #ELM_LIST_SCROLL.
16200 * Only one can be set, if a previous one was set, it will be changed
16201 * by the new mode set. Bitmask won't work as well.
16203 * @see elm_list_mode_get()
16207 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16210 * Get the mode the list is at.
16212 * @param obj The list object
16213 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16214 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16216 * @note see elm_list_mode_set() for more information.
16220 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16223 * Enable or disable horizontal mode on the list object.
16225 * @param obj The list object.
16226 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16227 * disable it, i.e., to enable vertical mode.
16229 * @note Vertical mode is set by default.
16231 * On horizontal mode items are displayed on list from left to right,
16232 * instead of from top to bottom. Also, the list will scroll horizontally.
16233 * Each item will presents left icon on top and right icon, or end, at
16236 * @see elm_list_horizontal_get()
16240 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16243 * Get a value whether horizontal mode is enabled or not.
16245 * @param obj The list object.
16246 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16247 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16248 * @c EINA_FALSE is returned.
16250 * @see elm_list_horizontal_set() for details.
16254 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16257 * Enable or disable always select mode on the list object.
16259 * @param obj The list object
16260 * @param always_select @c EINA_TRUE to enable always select mode or
16261 * @c EINA_FALSE to disable it.
16263 * @note Always select mode is disabled by default.
16265 * Default behavior of list items is to only call its callback function
16266 * the first time it's pressed, i.e., when it is selected. If a selected
16267 * item is pressed again, and multi-select is disabled, it won't call
16268 * this function (if multi-select is enabled it will unselect the item).
16270 * If always select is enabled, it will call the callback function
16271 * everytime a item is pressed, so it will call when the item is selected,
16272 * and again when a selected item is pressed.
16274 * @see elm_list_always_select_mode_get()
16275 * @see elm_list_multi_select_set()
16279 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16282 * Get a value whether always select mode is enabled or not, meaning that
16283 * an item will always call its callback function, even if already selected.
16285 * @param obj The list object
16286 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16287 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16288 * @c EINA_FALSE is returned.
16290 * @see elm_list_always_select_mode_set() for details.
16294 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16297 * Set bouncing behaviour when the scrolled content reaches an edge.
16299 * Tell the internal scroller object whether it should bounce or not
16300 * when it reaches the respective edges for each axis.
16302 * @param obj The list object
16303 * @param h_bounce Whether to bounce or not in the horizontal axis.
16304 * @param v_bounce Whether to bounce or not in the vertical axis.
16306 * @see elm_scroller_bounce_set()
16310 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16313 * Get the bouncing behaviour of the internal scroller.
16315 * Get whether the internal scroller should bounce when the edge of each
16316 * axis is reached scrolling.
16318 * @param obj The list object.
16319 * @param h_bounce Pointer where to store the bounce state of the horizontal
16321 * @param v_bounce Pointer where to store the bounce state of the vertical
16324 * @see elm_scroller_bounce_get()
16325 * @see elm_list_bounce_set()
16329 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16332 * Set the scrollbar policy.
16334 * @param obj The list object
16335 * @param policy_h Horizontal scrollbar policy.
16336 * @param policy_v Vertical scrollbar policy.
16338 * This sets the scrollbar visibility policy for the given scroller.
16339 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16340 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16341 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16342 * This applies respectively for the horizontal and vertical scrollbars.
16344 * The both are disabled by default, i.e., are set to
16345 * #ELM_SCROLLER_POLICY_OFF.
16349 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16352 * Get the scrollbar policy.
16354 * @see elm_list_scroller_policy_get() for details.
16356 * @param obj The list object.
16357 * @param policy_h Pointer where to store horizontal scrollbar policy.
16358 * @param policy_v Pointer where to store vertical scrollbar policy.
16362 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);
16365 * Append a new item to the list object.
16367 * @param obj The list object.
16368 * @param label The label of the list item.
16369 * @param icon The icon object to use for the left side of the item. An
16370 * icon can be any Evas object, but usually it is an icon created
16371 * with elm_icon_add().
16372 * @param end The icon object to use for the right side of the item. An
16373 * icon can be any Evas object.
16374 * @param func The function to call when the item is clicked.
16375 * @param data The data to associate with the item for related callbacks.
16377 * @return The created item or @c NULL upon failure.
16379 * A new item will be created and appended to the list, i.e., will
16380 * be set as @b last item.
16382 * Items created with this method can be deleted with
16383 * elm_list_item_del().
16385 * Associated @p data can be properly freed when item is deleted if a
16386 * callback function is set with elm_list_item_del_cb_set().
16388 * If a function is passed as argument, it will be called everytime this item
16389 * is selected, i.e., the user clicks over an unselected item.
16390 * If always select is enabled it will call this function every time
16391 * user clicks over an item (already selected or not).
16392 * If such function isn't needed, just passing
16393 * @c NULL as @p func is enough. The same should be done for @p data.
16395 * Simple example (with no function callback or data associated):
16397 * li = elm_list_add(win);
16398 * ic = elm_icon_add(win);
16399 * elm_icon_file_set(ic, "path/to/image", NULL);
16400 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16401 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16403 * evas_object_show(li);
16406 * @see elm_list_always_select_mode_set()
16407 * @see elm_list_item_del()
16408 * @see elm_list_item_del_cb_set()
16409 * @see elm_list_clear()
16410 * @see elm_icon_add()
16414 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);
16417 * Prepend a new item to the list object.
16419 * @param obj The list object.
16420 * @param label The label of the list item.
16421 * @param icon The icon object to use for the left side of the item. An
16422 * icon can be any Evas object, but usually it is an icon created
16423 * with elm_icon_add().
16424 * @param end The icon object to use for the right side of the item. An
16425 * icon can be any Evas object.
16426 * @param func The function to call when the item is clicked.
16427 * @param data The data to associate with the item for related callbacks.
16429 * @return The created item or @c NULL upon failure.
16431 * A new item will be created and prepended to the list, i.e., will
16432 * be set as @b first item.
16434 * Items created with this method can be deleted with
16435 * elm_list_item_del().
16437 * Associated @p data can be properly freed when item is deleted if a
16438 * callback function is set with elm_list_item_del_cb_set().
16440 * If a function is passed as argument, it will be called everytime this item
16441 * is selected, i.e., the user clicks over an unselected item.
16442 * If always select is enabled it will call this function every time
16443 * user clicks over an item (already selected or not).
16444 * If such function isn't needed, just passing
16445 * @c NULL as @p func is enough. The same should be done for @p data.
16447 * @see elm_list_item_append() for a simple code example.
16448 * @see elm_list_always_select_mode_set()
16449 * @see elm_list_item_del()
16450 * @see elm_list_item_del_cb_set()
16451 * @see elm_list_clear()
16452 * @see elm_icon_add()
16456 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);
16459 * Insert a new item into the list object before item @p before.
16461 * @param obj The list object.
16462 * @param before The list item to insert before.
16463 * @param label The label of the list item.
16464 * @param icon The icon object to use for the left side of the item. An
16465 * icon can be any Evas object, but usually it is an icon created
16466 * with elm_icon_add().
16467 * @param end The icon object to use for the right side of the item. An
16468 * icon can be any Evas object.
16469 * @param func The function to call when the item is clicked.
16470 * @param data The data to associate with the item for related callbacks.
16472 * @return The created item or @c NULL upon failure.
16474 * A new item will be created and added to the list. Its position in
16475 * this list will be just before item @p before.
16477 * Items created with this method can be deleted with
16478 * elm_list_item_del().
16480 * Associated @p data can be properly freed when item is deleted if a
16481 * callback function is set with elm_list_item_del_cb_set().
16483 * If a function is passed as argument, it will be called everytime this item
16484 * is selected, i.e., the user clicks over an unselected item.
16485 * If always select is enabled it will call this function every time
16486 * user clicks over an item (already selected or not).
16487 * If such function isn't needed, just passing
16488 * @c NULL as @p func is enough. The same should be done for @p data.
16490 * @see elm_list_item_append() for a simple code example.
16491 * @see elm_list_always_select_mode_set()
16492 * @see elm_list_item_del()
16493 * @see elm_list_item_del_cb_set()
16494 * @see elm_list_clear()
16495 * @see elm_icon_add()
16499 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);
16502 * Insert a new item into the list object after item @p after.
16504 * @param obj The list object.
16505 * @param after The list item to insert after.
16506 * @param label The label of the list item.
16507 * @param icon The icon object to use for the left side of the item. An
16508 * icon can be any Evas object, but usually it is an icon created
16509 * with elm_icon_add().
16510 * @param end The icon object to use for the right side of the item. An
16511 * icon can be any Evas object.
16512 * @param func The function to call when the item is clicked.
16513 * @param data The data to associate with the item for related callbacks.
16515 * @return The created item or @c NULL upon failure.
16517 * A new item will be created and added to the list. Its position in
16518 * this list will be just after item @p after.
16520 * Items created with this method can be deleted with
16521 * elm_list_item_del().
16523 * Associated @p data can be properly freed when item is deleted if a
16524 * callback function is set with elm_list_item_del_cb_set().
16526 * If a function is passed as argument, it will be called everytime this item
16527 * is selected, i.e., the user clicks over an unselected item.
16528 * If always select is enabled it will call this function every time
16529 * user clicks over an item (already selected or not).
16530 * If such function isn't needed, just passing
16531 * @c NULL as @p func is enough. The same should be done for @p data.
16533 * @see elm_list_item_append() for a simple code example.
16534 * @see elm_list_always_select_mode_set()
16535 * @see elm_list_item_del()
16536 * @see elm_list_item_del_cb_set()
16537 * @see elm_list_clear()
16538 * @see elm_icon_add()
16542 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);
16545 * Insert a new item into the sorted list object.
16547 * @param obj The list object.
16548 * @param label The label of the list item.
16549 * @param icon The icon object to use for the left side of the item. An
16550 * icon can be any Evas object, but usually it is an icon created
16551 * with elm_icon_add().
16552 * @param end The icon object to use for the right side of the item. An
16553 * icon can be any Evas object.
16554 * @param func The function to call when the item is clicked.
16555 * @param data The data to associate with the item for related callbacks.
16556 * @param cmp_func The comparing function to be used to sort list
16557 * items <b>by #Elm_List_Item item handles</b>. This function will
16558 * receive two items and compare them, returning a non-negative integer
16559 * if the second item should be place after the first, or negative value
16560 * if should be placed before.
16562 * @return The created item or @c NULL upon failure.
16564 * @note This function inserts values into a list object assuming it was
16565 * sorted and the result will be sorted.
16567 * A new item will be created and added to the list. Its position in
16568 * this list will be found comparing the new item with previously inserted
16569 * items using function @p cmp_func.
16571 * Items created with this method can be deleted with
16572 * elm_list_item_del().
16574 * Associated @p data can be properly freed when item is deleted if a
16575 * callback function is set with elm_list_item_del_cb_set().
16577 * If a function is passed as argument, it will be called everytime this item
16578 * is selected, i.e., the user clicks over an unselected item.
16579 * If always select is enabled it will call this function every time
16580 * user clicks over an item (already selected or not).
16581 * If such function isn't needed, just passing
16582 * @c NULL as @p func is enough. The same should be done for @p data.
16584 * @see elm_list_item_append() for a simple code example.
16585 * @see elm_list_always_select_mode_set()
16586 * @see elm_list_item_del()
16587 * @see elm_list_item_del_cb_set()
16588 * @see elm_list_clear()
16589 * @see elm_icon_add()
16593 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);
16596 * Remove all list's items.
16598 * @param obj The list object
16600 * @see elm_list_item_del()
16601 * @see elm_list_item_append()
16605 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16608 * Get a list of all the list items.
16610 * @param obj The list object
16611 * @return An @c Eina_List of list items, #Elm_List_Item,
16612 * or @c NULL on failure.
16614 * @see elm_list_item_append()
16615 * @see elm_list_item_del()
16616 * @see elm_list_clear()
16620 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16623 * Get the selected item.
16625 * @param obj The list object.
16626 * @return The selected list item.
16628 * The selected item can be unselected with function
16629 * elm_list_item_selected_set().
16631 * The selected item always will be highlighted on list.
16633 * @see elm_list_selected_items_get()
16637 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16640 * Return a list of the currently selected list items.
16642 * @param obj The list object.
16643 * @return An @c Eina_List of list items, #Elm_List_Item,
16644 * or @c NULL on failure.
16646 * Multiple items can be selected if multi select is enabled. It can be
16647 * done with elm_list_multi_select_set().
16649 * @see elm_list_selected_item_get()
16650 * @see elm_list_multi_select_set()
16654 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16657 * Set the selected state of an item.
16659 * @param item The list item
16660 * @param selected The selected state
16662 * This sets the selected state of the given item @p it.
16663 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16665 * If a new item is selected the previosly selected will be unselected,
16666 * unless multiple selection is enabled with elm_list_multi_select_set().
16667 * Previoulsy selected item can be get with function
16668 * elm_list_selected_item_get().
16670 * Selected items will be highlighted.
16672 * @see elm_list_item_selected_get()
16673 * @see elm_list_selected_item_get()
16674 * @see elm_list_multi_select_set()
16678 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16681 * Get whether the @p item is selected or not.
16683 * @param item The list item.
16684 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16685 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16687 * @see elm_list_selected_item_set() for details.
16688 * @see elm_list_item_selected_get()
16692 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16695 * Set or unset item as a separator.
16697 * @param it The list item.
16698 * @param setting @c EINA_TRUE to set item @p it as separator or
16699 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16701 * Items aren't set as separator by default.
16703 * If set as separator it will display separator theme, so won't display
16706 * @see elm_list_item_separator_get()
16710 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16713 * Get a value whether item is a separator or not.
16715 * @see elm_list_item_separator_set() for details.
16717 * @param it The list item.
16718 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16719 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16723 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16726 * Show @p item in the list view.
16728 * @param item The list item to be shown.
16730 * It won't animate list until item is visible. If such behavior is wanted,
16731 * use elm_list_bring_in() intead.
16735 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16738 * Bring in the given item to list view.
16740 * @param item The item.
16742 * This causes list to jump to the given item @p item and show it
16743 * (by scrolling), if it is not fully visible.
16745 * This may use animation to do so and take a period of time.
16747 * If animation isn't wanted, elm_list_item_show() can be used.
16751 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16754 * Delete them item from the list.
16756 * @param item The item of list to be deleted.
16758 * If deleting all list items is required, elm_list_clear()
16759 * should be used instead of getting items list and deleting each one.
16761 * @see elm_list_clear()
16762 * @see elm_list_item_append()
16763 * @see elm_list_item_del_cb_set()
16767 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16770 * Set the function called when a list item is freed.
16772 * @param item The item to set the callback on
16773 * @param func The function called
16775 * If there is a @p func, then it will be called prior item's memory release.
16776 * That will be called with the following arguments:
16778 * @li item's Evas object;
16781 * This way, a data associated to a list item could be properly freed.
16785 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16788 * Get the data associated to the item.
16790 * @param item The list item
16791 * @return The data associated to @p item
16793 * The return value is a pointer to data associated to @p item when it was
16794 * created, with function elm_list_item_append() or similar. If no data
16795 * was passed as argument, it will return @c NULL.
16797 * @see elm_list_item_append()
16801 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16804 * Get the left side icon associated to the item.
16806 * @param item The list item
16807 * @return The left side icon associated to @p item
16809 * The return value is a pointer to the icon associated to @p item when
16811 * created, with function elm_list_item_append() or similar, or later
16812 * with function elm_list_item_icon_set(). If no icon
16813 * was passed as argument, it will return @c NULL.
16815 * @see elm_list_item_append()
16816 * @see elm_list_item_icon_set()
16820 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16823 * Set the left side icon associated to the item.
16825 * @param item The list item
16826 * @param icon The left side icon object to associate with @p item
16828 * The icon object to use at left side of the item. An
16829 * icon can be any Evas object, but usually it is an icon created
16830 * with elm_icon_add().
16832 * Once the icon object is set, a previously set one will be deleted.
16833 * @warning Setting the same icon for two items will cause the icon to
16834 * dissapear from the first item.
16836 * If an icon was passed as argument on item creation, with function
16837 * elm_list_item_append() or similar, it will be already
16838 * associated to the item.
16840 * @see elm_list_item_append()
16841 * @see elm_list_item_icon_get()
16845 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16848 * Get the right side icon associated to the item.
16850 * @param item The list item
16851 * @return The right side icon associated to @p item
16853 * The return value is a pointer to the icon associated to @p item when
16855 * created, with function elm_list_item_append() or similar, or later
16856 * with function elm_list_item_icon_set(). If no icon
16857 * was passed as argument, it will return @c NULL.
16859 * @see elm_list_item_append()
16860 * @see elm_list_item_icon_set()
16864 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16867 * Set the right side icon associated to the item.
16869 * @param item The list item
16870 * @param end The right side icon object to associate with @p item
16872 * The icon object to use at right side of the item. An
16873 * icon can be any Evas object, but usually it is an icon created
16874 * with elm_icon_add().
16876 * Once the icon object is set, a previously set one will be deleted.
16877 * @warning Setting the same icon for two items will cause the icon to
16878 * dissapear from the first item.
16880 * If an icon was passed as argument on item creation, with function
16881 * elm_list_item_append() or similar, it will be already
16882 * associated to the item.
16884 * @see elm_list_item_append()
16885 * @see elm_list_item_end_get()
16889 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
16892 * Gets the base object of the item.
16894 * @param item The list item
16895 * @return The base object associated with @p item
16897 * Base object is the @c Evas_Object that represents that item.
16901 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16902 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16905 * Get the label of item.
16907 * @param item The item of list.
16908 * @return The label of item.
16910 * The return value is a pointer to the label associated to @p item when
16911 * it was created, with function elm_list_item_append(), or later
16912 * with function elm_list_item_label_set. If no label
16913 * was passed as argument, it will return @c NULL.
16915 * @see elm_list_item_label_set() for more details.
16916 * @see elm_list_item_append()
16920 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16923 * Set the label of item.
16925 * @param item The item of list.
16926 * @param text The label of item.
16928 * The label to be displayed by the item.
16929 * Label will be placed between left and right side icons (if set).
16931 * If a label was passed as argument on item creation, with function
16932 * elm_list_item_append() or similar, it will be already
16933 * displayed by the item.
16935 * @see elm_list_item_label_get()
16936 * @see elm_list_item_append()
16940 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16944 * Get the item before @p it in list.
16946 * @param it The list item.
16947 * @return The item before @p it, or @c NULL if none or on failure.
16949 * @note If it is the first item, @c NULL will be returned.
16951 * @see elm_list_item_append()
16952 * @see elm_list_items_get()
16956 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16959 * Get the item after @p it in list.
16961 * @param it The list item.
16962 * @return The item after @p it, or @c NULL if none or on failure.
16964 * @note If it is the last item, @c NULL will be returned.
16966 * @see elm_list_item_append()
16967 * @see elm_list_items_get()
16971 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16974 * Sets the disabled/enabled state of a list item.
16976 * @param it The item.
16977 * @param disabled The disabled state.
16979 * A disabled item cannot be selected or unselected. It will also
16980 * change its appearance (generally greyed out). This sets the
16981 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
16986 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16989 * Get a value whether list item is disabled or not.
16991 * @param it The item.
16992 * @return The disabled state.
16994 * @see elm_list_item_disabled_set() for more details.
16998 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17001 * Set the text to be shown in a given list item's tooltips.
17003 * @param item Target item.
17004 * @param text The text to set in the content.
17006 * Setup the text as tooltip to object. The item can have only one tooltip,
17007 * so any previous tooltip data - set with this function or
17008 * elm_list_item_tooltip_content_cb_set() - is removed.
17010 * @see elm_object_tooltip_text_set() for more details.
17014 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17018 * @brief Disable size restrictions on an object's tooltip
17019 * @param item The tooltip's anchor object
17020 * @param disable If EINA_TRUE, size restrictions are disabled
17021 * @return EINA_FALSE on failure, EINA_TRUE on success
17023 * This function allows a tooltip to expand beyond its parant window's canvas.
17024 * It will instead be limited only by the size of the display.
17026 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17028 * @brief Retrieve size restriction state of an object's tooltip
17029 * @param obj The tooltip's anchor object
17030 * @return If EINA_TRUE, size restrictions are disabled
17032 * This function returns whether a tooltip is allowed to expand beyond
17033 * its parant window's canvas.
17034 * It will instead be limited only by the size of the display.
17036 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17039 * Set the content to be shown in the tooltip item.
17041 * Setup the tooltip to item. The item can have only one tooltip,
17042 * so any previous tooltip data is removed. @p func(with @p data) will
17043 * be called every time that need show the tooltip and it should
17044 * return a valid Evas_Object. This object is then managed fully by
17045 * tooltip system and is deleted when the tooltip is gone.
17047 * @param item the list item being attached a tooltip.
17048 * @param func the function used to create the tooltip contents.
17049 * @param data what to provide to @a func as callback data/context.
17050 * @param del_cb called when data is not needed anymore, either when
17051 * another callback replaces @a func, the tooltip is unset with
17052 * elm_list_item_tooltip_unset() or the owner @a item
17053 * dies. This callback receives as the first parameter the
17054 * given @a data, and @c event_info is the item.
17056 * @see elm_object_tooltip_content_cb_set() for more details.
17060 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);
17063 * Unset tooltip from item.
17065 * @param item list item to remove previously set tooltip.
17067 * Remove tooltip from item. The callback provided as del_cb to
17068 * elm_list_item_tooltip_content_cb_set() will be called to notify
17069 * it is not used anymore.
17071 * @see elm_object_tooltip_unset() for more details.
17072 * @see elm_list_item_tooltip_content_cb_set()
17076 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17079 * Sets a different style for this item tooltip.
17081 * @note before you set a style you should define a tooltip with
17082 * elm_list_item_tooltip_content_cb_set() or
17083 * elm_list_item_tooltip_text_set()
17085 * @param item list item with tooltip already set.
17086 * @param style the theme style to use (default, transparent, ...)
17088 * @see elm_object_tooltip_style_set() for more details.
17092 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17095 * Get the style for this item tooltip.
17097 * @param item list item with tooltip already set.
17098 * @return style the theme style in use, defaults to "default". If the
17099 * object does not have a tooltip set, then NULL is returned.
17101 * @see elm_object_tooltip_style_get() for more details.
17102 * @see elm_list_item_tooltip_style_set()
17106 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17109 * Set the type of mouse pointer/cursor decoration to be shown,
17110 * when the mouse pointer is over the given list widget item
17112 * @param item list item to customize cursor on
17113 * @param cursor the cursor type's name
17115 * This function works analogously as elm_object_cursor_set(), but
17116 * here the cursor's changing area is restricted to the item's
17117 * area, and not the whole widget's. Note that that item cursors
17118 * have precedence over widget cursors, so that a mouse over an
17119 * item with custom cursor set will always show @b that cursor.
17121 * If this function is called twice for an object, a previously set
17122 * cursor will be unset on the second call.
17124 * @see elm_object_cursor_set()
17125 * @see elm_list_item_cursor_get()
17126 * @see elm_list_item_cursor_unset()
17130 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17133 * Get the type of mouse pointer/cursor decoration set to be shown,
17134 * when the mouse pointer is over the given list widget item
17136 * @param item list item with custom cursor set
17137 * @return the cursor type's name or @c NULL, if no custom cursors
17138 * were set to @p item (and on errors)
17140 * @see elm_object_cursor_get()
17141 * @see elm_list_item_cursor_set()
17142 * @see elm_list_item_cursor_unset()
17146 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17149 * Unset any custom mouse pointer/cursor decoration set to be
17150 * shown, when the mouse pointer is over the given list widget
17151 * item, thus making it show the @b default cursor again.
17153 * @param item a list item
17155 * Use this call to undo any custom settings on this item's cursor
17156 * decoration, bringing it back to defaults (no custom style set).
17158 * @see elm_object_cursor_unset()
17159 * @see elm_list_item_cursor_set()
17163 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17166 * Set a different @b style for a given custom cursor set for a
17169 * @param item list item with custom cursor set
17170 * @param style the <b>theme style</b> to use (e.g. @c "default",
17171 * @c "transparent", etc)
17173 * This function only makes sense when one is using custom mouse
17174 * cursor decorations <b>defined in a theme file</b>, which can have,
17175 * given a cursor name/type, <b>alternate styles</b> on it. It
17176 * works analogously as elm_object_cursor_style_set(), but here
17177 * applyed only to list item objects.
17179 * @warning Before you set a cursor style you should have definen a
17180 * custom cursor previously on the item, with
17181 * elm_list_item_cursor_set()
17183 * @see elm_list_item_cursor_engine_only_set()
17184 * @see elm_list_item_cursor_style_get()
17188 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17191 * Get the current @b style set for a given list item's custom
17194 * @param item list item with custom cursor set.
17195 * @return style the cursor style in use. If the object does not
17196 * have a cursor set, then @c NULL is returned.
17198 * @see elm_list_item_cursor_style_set() for more details
17202 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17205 * Set if the (custom)cursor for a given list item should be
17206 * searched in its theme, also, or should only rely on the
17207 * rendering engine.
17209 * @param item item with custom (custom) cursor already set on
17210 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17211 * only on those provided by the rendering engine, @c EINA_FALSE to
17212 * have them searched on the widget's theme, as well.
17214 * @note This call is of use only if you've set a custom cursor
17215 * for list items, with elm_list_item_cursor_set().
17217 * @note By default, cursors will only be looked for between those
17218 * provided by the rendering engine.
17222 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17225 * Get if the (custom) cursor for a given list item is being
17226 * searched in its theme, also, or is only relying on the rendering
17229 * @param item a list item
17230 * @return @c EINA_TRUE, if cursors are being looked for only on
17231 * those provided by the rendering engine, @c EINA_FALSE if they
17232 * are being searched on the widget's theme, as well.
17234 * @see elm_list_item_cursor_engine_only_set(), for more details
17238 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17245 * @defgroup Slider Slider
17246 * @ingroup Elementary
17248 * @image html img/widget/slider/preview-00.png
17249 * @image latex img/widget/slider/preview-00.eps width=\textwidth
17251 * The slider adds a dragable āsliderā widget for selecting the value of
17252 * something within a range.
17254 * A slider can be horizontal or vertical. It can contain an Icon and has a
17255 * primary label as well as a units label (that is formatted with floating
17256 * point values and thus accepts a printf-style format string, like
17257 * ā%1.2f unitsā. There is also an indicator string that may be somewhere
17258 * else (like on the slider itself) that also accepts a format string like
17259 * units. Label, Icon Unit and Indicator strings/objects are optional.
17261 * A slider may be inverted which means values invert, with high vales being
17262 * on the left or top and low values on the right or bottom (as opposed to
17263 * normally being low on the left or top and high on the bottom and right).
17265 * The slider should have its minimum and maximum values set by the
17266 * application with elm_slider_min_max_set() and value should also be set by
17267 * the application before use with elm_slider_value_set(). The span of the
17268 * slider is its length (horizontally or vertically). This will be scaled by
17269 * the object or applications scaling factor. At any point code can query the
17270 * slider for its value with elm_slider_value_get().
17272 * Smart callbacks one can listen to:
17273 * - "changed" - Whenever the slider value is changed by the user.
17274 * - "slider,drag,start" - dragging the slider indicator around has started.
17275 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17276 * - "delay,changed" - A short time after the value is changed by the user.
17277 * This will be called only when the user stops dragging for
17278 * a very short period or when they release their
17279 * finger/mouse, so it avoids possibly expensive reactions to
17280 * the value change.
17282 * Available styles for it:
17285 * Default contents parts of the slider widget that you can use for are:
17286 * @li "elm.swallow.icon" - A icon of the slider
17287 * @li "elm.swallow.end" - A end part content of the slider
17289 * Here is an example on its usage:
17290 * @li @ref slider_example
17293 #define ELM_SLIDER_CONTENT_ICON "elm.swallow.icon"
17294 #define ELM_SLIDER_CONTENT_END "elm.swallow.end"
17297 * @addtogroup Slider
17302 * Add a new slider widget to the given parent Elementary
17303 * (container) object.
17305 * @param parent The parent object.
17306 * @return a new slider widget handle or @c NULL, on errors.
17308 * This function inserts a new slider widget on the canvas.
17312 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17315 * Set the label of a given slider widget
17317 * @param obj The progress bar object
17318 * @param label The text label string, in UTF-8
17321 * @deprecated use elm_object_text_set() instead.
17323 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17326 * Get the label of a given slider widget
17328 * @param obj The progressbar object
17329 * @return The text label string, in UTF-8
17332 * @deprecated use elm_object_text_get() instead.
17334 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17337 * Set the icon object of the slider object.
17339 * @param obj The slider object.
17340 * @param icon The icon object.
17342 * On horizontal mode, icon is placed at left, and on vertical mode,
17345 * @note Once the icon object is set, a previously set one will be deleted.
17346 * If you want to keep that old content object, use the
17347 * elm_slider_icon_unset() function.
17349 * @warning If the object being set does not have minimum size hints set,
17350 * it won't get properly displayed.
17354 EINA_DEPRECATED EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17357 * Unset an icon set on a given slider widget.
17359 * @param obj The slider object.
17360 * @return The icon object that was being used, if any was set, or
17361 * @c NULL, otherwise (and on errors).
17363 * On horizontal mode, icon is placed at left, and on vertical mode,
17366 * This call will unparent and return the icon object which was set
17367 * for this widget, previously, on success.
17369 * @see elm_slider_icon_set() for more details
17370 * @see elm_slider_icon_get()
17374 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17377 * Retrieve the icon object set for a given slider widget.
17379 * @param obj The slider object.
17380 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17381 * otherwise (and on errors).
17383 * On horizontal mode, icon is placed at left, and on vertical mode,
17386 * @see elm_slider_icon_set() for more details
17387 * @see elm_slider_icon_unset()
17391 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17394 * Set the end object of the slider object.
17396 * @param obj The slider object.
17397 * @param end The end object.
17399 * On horizontal mode, end is placed at left, and on vertical mode,
17400 * placed at bottom.
17402 * @note Once the icon object is set, a previously set one will be deleted.
17403 * If you want to keep that old content object, use the
17404 * elm_slider_end_unset() function.
17406 * @warning If the object being set does not have minimum size hints set,
17407 * it won't get properly displayed.
17411 EINA_DEPRECATED EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17414 * Unset an end object set on a given slider widget.
17416 * @param obj The slider object.
17417 * @return The end object that was being used, if any was set, or
17418 * @c NULL, otherwise (and on errors).
17420 * On horizontal mode, end is placed at left, and on vertical mode,
17421 * placed at bottom.
17423 * This call will unparent and return the icon object which was set
17424 * for this widget, previously, on success.
17426 * @see elm_slider_end_set() for more details.
17427 * @see elm_slider_end_get()
17431 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17434 * Retrieve the end object set for a given slider widget.
17436 * @param obj The slider object.
17437 * @return The end object's handle, if @p obj had one set, or @c NULL,
17438 * otherwise (and on errors).
17440 * On horizontal mode, icon is placed at right, and on vertical mode,
17441 * placed at bottom.
17443 * @see elm_slider_end_set() for more details.
17444 * @see elm_slider_end_unset()
17448 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17451 * Set the (exact) length of the bar region of a given slider widget.
17453 * @param obj The slider object.
17454 * @param size The length of the slider's bar region.
17456 * This sets the minimum width (when in horizontal mode) or height
17457 * (when in vertical mode) of the actual bar area of the slider
17458 * @p obj. This in turn affects the object's minimum size. Use
17459 * this when you're not setting other size hints expanding on the
17460 * given direction (like weight and alignment hints) and you would
17461 * like it to have a specific size.
17463 * @note Icon, end, label, indicator and unit text around @p obj
17464 * will require their
17465 * own space, which will make @p obj to require more the @p size,
17468 * @see elm_slider_span_size_get()
17472 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17475 * Get the length set for the bar region of a given slider widget
17477 * @param obj The slider object.
17478 * @return The length of the slider's bar region.
17480 * If that size was not set previously, with
17481 * elm_slider_span_size_set(), this call will return @c 0.
17485 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17488 * Set the format string for the unit label.
17490 * @param obj The slider object.
17491 * @param format The format string for the unit display.
17493 * Unit label is displayed all the time, if set, after slider's bar.
17494 * In horizontal mode, at right and in vertical mode, at bottom.
17496 * If @c NULL, unit label won't be visible. If not it sets the format
17497 * string for the label text. To the label text is provided a floating point
17498 * value, so the label text can display up to 1 floating point value.
17499 * Note that this is optional.
17501 * Use a format string such as "%1.2f meters" for example, and it will
17502 * display values like: "3.14 meters" for a value equal to 3.14159.
17504 * Default is unit label disabled.
17506 * @see elm_slider_indicator_format_get()
17510 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17513 * Get the unit label format of the slider.
17515 * @param obj The slider object.
17516 * @return The unit label format string in UTF-8.
17518 * Unit label is displayed all the time, if set, after slider's bar.
17519 * In horizontal mode, at right and in vertical mode, at bottom.
17521 * @see elm_slider_unit_format_set() for more
17522 * information on how this works.
17526 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17529 * Set the format string for the indicator label.
17531 * @param obj The slider object.
17532 * @param indicator The format string for the indicator display.
17534 * The slider may display its value somewhere else then unit label,
17535 * for example, above the slider knob that is dragged around. This function
17536 * sets the format string used for this.
17538 * If @c NULL, indicator label won't be visible. If not it sets the format
17539 * string for the label text. To the label text is provided a floating point
17540 * value, so the label text can display up to 1 floating point value.
17541 * Note that this is optional.
17543 * Use a format string such as "%1.2f meters" for example, and it will
17544 * display values like: "3.14 meters" for a value equal to 3.14159.
17546 * Default is indicator label disabled.
17548 * @see elm_slider_indicator_format_get()
17552 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17555 * Get the indicator label format of the slider.
17557 * @param obj The slider object.
17558 * @return The indicator label format string in UTF-8.
17560 * The slider may display its value somewhere else then unit label,
17561 * for example, above the slider knob that is dragged around. This function
17562 * gets the format string used for this.
17564 * @see elm_slider_indicator_format_set() for more
17565 * information on how this works.
17569 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17572 * Set the format function pointer for the indicator label
17574 * @param obj The slider object.
17575 * @param func The indicator format function.
17576 * @param free_func The freeing function for the format string.
17578 * Set the callback function to format the indicator string.
17580 * @see elm_slider_indicator_format_set() for more info on how this works.
17584 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);
17587 * Set the format function pointer for the units label
17589 * @param obj The slider object.
17590 * @param func The units format function.
17591 * @param free_func The freeing function for the format string.
17593 * Set the callback function to format the indicator string.
17595 * @see elm_slider_units_format_set() for more info on how this works.
17599 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);
17602 * Set the orientation of a given slider widget.
17604 * @param obj The slider object.
17605 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17606 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17608 * Use this function to change how your slider is to be
17609 * disposed: vertically or horizontally.
17611 * By default it's displayed horizontally.
17613 * @see elm_slider_horizontal_get()
17617 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17620 * Retrieve the orientation of a given slider widget
17622 * @param obj The slider object.
17623 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17624 * @c EINA_FALSE if it's @b vertical (and on errors).
17626 * @see elm_slider_horizontal_set() for more details.
17630 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17633 * Set the minimum and maximum values for the slider.
17635 * @param obj The slider object.
17636 * @param min The minimum value.
17637 * @param max The maximum value.
17639 * Define the allowed range of values to be selected by the user.
17641 * If actual value is less than @p min, it will be updated to @p min. If it
17642 * is bigger then @p max, will be updated to @p max. Actual value can be
17643 * get with elm_slider_value_get().
17645 * By default, min is equal to 0.0, and max is equal to 1.0.
17647 * @warning Maximum must be greater than minimum, otherwise behavior
17650 * @see elm_slider_min_max_get()
17654 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17657 * Get the minimum and maximum values of the slider.
17659 * @param obj The slider object.
17660 * @param min Pointer where to store the minimum value.
17661 * @param max Pointer where to store the maximum value.
17663 * @note If only one value is needed, the other pointer can be passed
17666 * @see elm_slider_min_max_set() for details.
17670 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17673 * Set the value the slider displays.
17675 * @param obj The slider object.
17676 * @param val The value to be displayed.
17678 * Value will be presented on the unit label following format specified with
17679 * elm_slider_unit_format_set() and on indicator with
17680 * elm_slider_indicator_format_set().
17682 * @warning The value must to be between min and max values. This values
17683 * are set by elm_slider_min_max_set().
17685 * @see elm_slider_value_get()
17686 * @see elm_slider_unit_format_set()
17687 * @see elm_slider_indicator_format_set()
17688 * @see elm_slider_min_max_set()
17692 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17695 * Get the value displayed by the spinner.
17697 * @param obj The spinner object.
17698 * @return The value displayed.
17700 * @see elm_spinner_value_set() for details.
17704 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17707 * Invert a given slider widget's displaying values order
17709 * @param obj The slider object.
17710 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17711 * @c EINA_FALSE to bring it back to default, non-inverted values.
17713 * A slider may be @b inverted, in which state it gets its
17714 * values inverted, with high vales being on the left or top and
17715 * low values on the right or bottom, as opposed to normally have
17716 * the low values on the former and high values on the latter,
17717 * respectively, for horizontal and vertical modes.
17719 * @see elm_slider_inverted_get()
17723 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17726 * Get whether a given slider widget's displaying values are
17729 * @param obj The slider object.
17730 * @return @c EINA_TRUE, if @p obj has inverted values,
17731 * @c EINA_FALSE otherwise (and on errors).
17733 * @see elm_slider_inverted_set() for more details.
17737 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17740 * Set whether to enlarge slider indicator (augmented knob) or not.
17742 * @param obj The slider object.
17743 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17744 * let the knob always at default size.
17746 * By default, indicator will be bigger while dragged by the user.
17748 * @warning It won't display values set with
17749 * elm_slider_indicator_format_set() if you disable indicator.
17753 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17756 * Get whether a given slider widget's enlarging indicator or not.
17758 * @param obj The slider object.
17759 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17760 * @c EINA_FALSE otherwise (and on errors).
17762 * @see elm_slider_indicator_show_set() for details.
17766 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17773 * @addtogroup Actionslider Actionslider
17775 * @image html img/widget/actionslider/preview-00.png
17776 * @image latex img/widget/actionslider/preview-00.eps
17778 * An actionslider is a switcher for 2 or 3 labels with customizable magnet
17779 * properties. The user drags and releases the indicator, to choose a label.
17781 * Labels occupy the following positions.
17786 * Positions can be enabled or disabled.
17788 * Magnets can be set on the above positions.
17790 * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
17792 * @note By default all positions are set as enabled.
17794 * Signals that you can add callbacks for are:
17796 * "selected" - when user selects an enabled position (the label is passed
17799 * "pos_changed" - when the indicator reaches any of the positions("left",
17800 * "right" or "center").
17802 * See an example of actionslider usage @ref actionslider_example_page "here"
17805 typedef enum _Elm_Actionslider_Pos
17807 ELM_ACTIONSLIDER_NONE = 0,
17808 ELM_ACTIONSLIDER_LEFT = 1 << 0,
17809 ELM_ACTIONSLIDER_CENTER = 1 << 1,
17810 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
17811 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
17812 } Elm_Actionslider_Pos;
17815 * Add a new actionslider to the parent.
17817 * @param parent The parent object
17818 * @return The new actionslider object or NULL if it cannot be created
17820 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17822 * Set actionslider labels.
17824 * @param obj The actionslider object
17825 * @param left_label The label to be set on the left.
17826 * @param center_label The label to be set on the center.
17827 * @param right_label The label to be set on the right.
17828 * @deprecated use elm_object_text_set() instead.
17830 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);
17832 * Get actionslider labels.
17834 * @param obj The actionslider object
17835 * @param left_label A char** to place the left_label of @p obj into.
17836 * @param center_label A char** to place the center_label of @p obj into.
17837 * @param right_label A char** to place the right_label of @p obj into.
17838 * @deprecated use elm_object_text_set() instead.
17840 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);
17842 * Get actionslider selected label.
17844 * @param obj The actionslider object
17845 * @return The selected label
17847 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17849 * Set actionslider indicator position.
17851 * @param obj The actionslider object.
17852 * @param pos The position of the indicator.
17854 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17856 * Get actionslider indicator position.
17858 * @param obj The actionslider object.
17859 * @return The position of the indicator.
17861 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17863 * Set actionslider magnet position. To make multiple positions magnets @c or
17864 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
17866 * @param obj The actionslider object.
17867 * @param pos Bit mask indicating the magnet positions.
17869 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17871 * Get actionslider magnet position.
17873 * @param obj The actionslider object.
17874 * @return The positions with magnet property.
17876 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17878 * Set actionslider enabled position. To set multiple positions as enabled @c or
17879 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
17881 * @note All the positions are enabled by default.
17883 * @param obj The actionslider object.
17884 * @param pos Bit mask indicating the enabled positions.
17886 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17888 * Get actionslider enabled position.
17890 * @param obj The actionslider object.
17891 * @return The enabled positions.
17893 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17895 * Set the label used on the indicator.
17897 * @param obj The actionslider object
17898 * @param label The label to be set on the indicator.
17899 * @deprecated use elm_object_text_set() instead.
17901 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17903 * Get the label used on the indicator object.
17905 * @param obj The actionslider object
17906 * @return The indicator label
17907 * @deprecated use elm_object_text_get() instead.
17909 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
17915 * @defgroup Genlist Genlist
17917 * @image html img/widget/genlist/preview-00.png
17918 * @image latex img/widget/genlist/preview-00.eps
17919 * @image html img/genlist.png
17920 * @image latex img/genlist.eps
17922 * This widget aims to have more expansive list than the simple list in
17923 * Elementary that could have more flexible items and allow many more entries
17924 * while still being fast and low on memory usage. At the same time it was
17925 * also made to be able to do tree structures. But the price to pay is more
17926 * complexity when it comes to usage. If all you want is a simple list with
17927 * icons and a single label, use the normal @ref List object.
17929 * Genlist has a fairly large API, mostly because it's relatively complex,
17930 * trying to be both expansive, powerful and efficient. First we will begin
17931 * an overview on the theory behind genlist.
17933 * @section Genlist_Item_Class Genlist item classes - creating items
17935 * In order to have the ability to add and delete items on the fly, genlist
17936 * implements a class (callback) system where the application provides a
17937 * structure with information about that type of item (genlist may contain
17938 * multiple different items with different classes, states and styles).
17939 * Genlist will call the functions in this struct (methods) when an item is
17940 * "realized" (i.e., created dynamically, while the user is scrolling the
17941 * grid). All objects will simply be deleted when no longer needed with
17942 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
17943 * following members:
17944 * - @c item_style - This is a constant string and simply defines the name
17945 * of the item style. It @b must be specified and the default should be @c
17948 * - @c func - A struct with pointers to functions that will be called when
17949 * an item is going to be actually created. All of them receive a @c data
17950 * parameter that will point to the same data passed to
17951 * elm_genlist_item_append() and related item creation functions, and a @c
17952 * obj parameter that points to the genlist object itself.
17954 * The function pointers inside @c func are @c label_get, @c icon_get, @c
17955 * state_get and @c del. The 3 first functions also receive a @c part
17956 * parameter described below. A brief description of these functions follows:
17958 * - @c label_get - The @c part parameter is the name string of one of the
17959 * existing text parts in the Edje group implementing the item's theme.
17960 * This function @b must return a strdup'()ed string, as the caller will
17961 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
17962 * - @c content_get - The @c part parameter is the name string of one of the
17963 * existing (content) swallow parts in the Edje group implementing the item's
17964 * theme. It must return @c NULL, when no content is desired, or a valid
17965 * object handle, otherwise. The object will be deleted by the genlist on
17966 * its deletion or when the item is "unrealized". See
17967 * #Elm_Genlist_Item_Icon_Get_Cb.
17968 * - @c func.state_get - The @c part parameter is the name string of one of
17969 * the state parts in the Edje group implementing the item's theme. Return
17970 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
17971 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
17972 * and @c "elm" as "emission" and "source" arguments, respectively, when
17973 * the state is true (the default is false), where @c XXX is the name of
17974 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
17975 * - @c func.del - This is intended for use when genlist items are deleted,
17976 * so any data attached to the item (e.g. its data parameter on creation)
17977 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
17979 * available item styles:
17981 * - default_style - The text part is a textblock
17983 * @image html img/widget/genlist/preview-04.png
17984 * @image latex img/widget/genlist/preview-04.eps
17988 * @image html img/widget/genlist/preview-01.png
17989 * @image latex img/widget/genlist/preview-01.eps
17991 * - icon_top_text_bottom
17993 * @image html img/widget/genlist/preview-02.png
17994 * @image latex img/widget/genlist/preview-02.eps
17998 * @image html img/widget/genlist/preview-03.png
17999 * @image latex img/widget/genlist/preview-03.eps
18001 * @section Genlist_Items Structure of items
18003 * An item in a genlist can have 0 or more text labels (they can be regular
18004 * text or textblock Evas objects - that's up to the style to determine), 0
18005 * or more contents (which are simply objects swallowed into the genlist item's
18006 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18007 * behavior left to the user to define. The Edje part names for each of
18008 * these properties will be looked up, in the theme file for the genlist,
18009 * under the Edje (string) data items named @c "labels", @c "contents" and @c
18010 * "states", respectively. For each of those properties, if more than one
18011 * part is provided, they must have names listed separated by spaces in the
18012 * data fields. For the default genlist item theme, we have @b one label
18013 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18014 * "elm.swallow.end") and @b no state parts.
18016 * A genlist item may be at one of several styles. Elementary provides one
18017 * by default - "default", but this can be extended by system or application
18018 * custom themes/overlays/extensions (see @ref Theme "themes" for more
18021 * @section Genlist_Manipulation Editing and Navigating
18023 * Items can be added by several calls. All of them return a @ref
18024 * Elm_Genlist_Item handle that is an internal member inside the genlist.
18025 * They all take a data parameter that is meant to be used for a handle to
18026 * the applications internal data (eg the struct with the original item
18027 * data). The parent parameter is the parent genlist item this belongs to if
18028 * it is a tree or an indexed group, and NULL if there is no parent. The
18029 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18030 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18031 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18032 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
18033 * is set then this item is group index item that is displayed at the top
18034 * until the next group comes. The func parameter is a convenience callback
18035 * that is called when the item is selected and the data parameter will be
18036 * the func_data parameter, obj be the genlist object and event_info will be
18037 * the genlist item.
18039 * elm_genlist_item_append() adds an item to the end of the list, or if
18040 * there is a parent, to the end of all the child items of the parent.
18041 * elm_genlist_item_prepend() is the same but adds to the beginning of
18042 * the list or children list. elm_genlist_item_insert_before() inserts at
18043 * item before another item and elm_genlist_item_insert_after() inserts after
18044 * the indicated item.
18046 * The application can clear the list with elm_genlist_clear() which deletes
18047 * all the items in the list and elm_genlist_item_del() will delete a specific
18048 * item. elm_genlist_item_subitems_clear() will clear all items that are
18049 * children of the indicated parent item.
18051 * To help inspect list items you can jump to the item at the top of the list
18052 * with elm_genlist_first_item_get() which will return the item pointer, and
18053 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18054 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18055 * and previous items respectively relative to the indicated item. Using
18056 * these calls you can walk the entire item list/tree. Note that as a tree
18057 * the items are flattened in the list, so elm_genlist_item_parent_get() will
18058 * let you know which item is the parent (and thus know how to skip them if
18061 * @section Genlist_Muti_Selection Multi-selection
18063 * If the application wants multiple items to be able to be selected,
18064 * elm_genlist_multi_select_set() can enable this. If the list is
18065 * single-selection only (the default), then elm_genlist_selected_item_get()
18066 * will return the selected item, if any, or NULL I none is selected. If the
18067 * list is multi-select then elm_genlist_selected_items_get() will return a
18068 * list (that is only valid as long as no items are modified (added, deleted,
18069 * selected or unselected)).
18071 * @section Genlist_Usage_Hints Usage hints
18073 * There are also convenience functions. elm_genlist_item_genlist_get() will
18074 * return the genlist object the item belongs to. elm_genlist_item_show()
18075 * will make the scroller scroll to show that specific item so its visible.
18076 * elm_genlist_item_data_get() returns the data pointer set by the item
18077 * creation functions.
18079 * If an item changes (state of boolean changes, label or contents change),
18080 * then use elm_genlist_item_update() to have genlist update the item with
18081 * the new state. Genlist will re-realize the item thus call the functions
18082 * in the _Elm_Genlist_Item_Class for that item.
18084 * To programmatically (un)select an item use elm_genlist_item_selected_set().
18085 * To get its selected state use elm_genlist_item_selected_get(). Similarly
18086 * to expand/contract an item and get its expanded state, use
18087 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18088 * again to make an item disabled (unable to be selected and appear
18089 * differently) use elm_genlist_item_disabled_set() to set this and
18090 * elm_genlist_item_disabled_get() to get the disabled state.
18092 * In general to indicate how the genlist should expand items horizontally to
18093 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18094 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18095 * mode means that if items are too wide to fit, the scroller will scroll
18096 * horizontally. Otherwise items are expanded to fill the width of the
18097 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18098 * to the viewport width and limited to that size. This can be combined with
18099 * a different style that uses edjes' ellipsis feature (cutting text off like
18102 * Items will only call their selection func and callback when first becoming
18103 * selected. Any further clicks will do nothing, unless you enable always
18104 * select with elm_genlist_always_select_mode_set(). This means even if
18105 * selected, every click will make the selected callbacks be called.
18106 * elm_genlist_no_select_mode_set() will turn off the ability to select
18107 * items entirely and they will neither appear selected nor call selected
18108 * callback functions.
18110 * Remember that you can create new styles and add your own theme augmentation
18111 * per application with elm_theme_extension_add(). If you absolutely must
18112 * have a specific style that overrides any theme the user or system sets up
18113 * you can use elm_theme_overlay_add() to add such a file.
18115 * @section Genlist_Implementation Implementation
18117 * Evas tracks every object you create. Every time it processes an event
18118 * (mouse move, down, up etc.) it needs to walk through objects and find out
18119 * what event that affects. Even worse every time it renders display updates,
18120 * in order to just calculate what to re-draw, it needs to walk through many
18121 * many many objects. Thus, the more objects you keep active, the more
18122 * overhead Evas has in just doing its work. It is advisable to keep your
18123 * active objects to the minimum working set you need. Also remember that
18124 * object creation and deletion carries an overhead, so there is a
18125 * middle-ground, which is not easily determined. But don't keep massive lists
18126 * of objects you can't see or use. Genlist does this with list objects. It
18127 * creates and destroys them dynamically as you scroll around. It groups them
18128 * into blocks so it can determine the visibility etc. of a whole block at
18129 * once as opposed to having to walk the whole list. This 2-level list allows
18130 * for very large numbers of items to be in the list (tests have used up to
18131 * 2,000,000 items). Also genlist employs a queue for adding items. As items
18132 * may be different sizes, every item added needs to be calculated as to its
18133 * size and thus this presents a lot of overhead on populating the list, this
18134 * genlist employs a queue. Any item added is queued and spooled off over
18135 * time, actually appearing some time later, so if your list has many members
18136 * you may find it takes a while for them to all appear, with your process
18137 * consuming a lot of CPU while it is busy spooling.
18139 * Genlist also implements a tree structure, but it does so with callbacks to
18140 * the application, with the application filling in tree structures when
18141 * requested (allowing for efficient building of a very deep tree that could
18142 * even be used for file-management). See the above smart signal callbacks for
18145 * @section Genlist_Smart_Events Genlist smart events
18147 * Signals that you can add callbacks for are:
18148 * - @c "activated" - The user has double-clicked or pressed
18149 * (enter|return|spacebar) on an item. The @c event_info parameter is the
18150 * item that was activated.
18151 * - @c "clicked,double" - The user has double-clicked an item. The @c
18152 * event_info parameter is the item that was double-clicked.
18153 * - @c "selected" - This is called when a user has made an item selected.
18154 * The event_info parameter is the genlist item that was selected.
18155 * - @c "unselected" - This is called when a user has made an item
18156 * unselected. The event_info parameter is the genlist item that was
18158 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18159 * called and the item is now meant to be expanded. The event_info
18160 * parameter is the genlist item that was indicated to expand. It is the
18161 * job of this callback to then fill in the child items.
18162 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18163 * called and the item is now meant to be contracted. The event_info
18164 * parameter is the genlist item that was indicated to contract. It is the
18165 * job of this callback to then delete the child items.
18166 * - @c "expand,request" - This is called when a user has indicated they want
18167 * to expand a tree branch item. The callback should decide if the item can
18168 * expand (has any children) and then call elm_genlist_item_expanded_set()
18169 * appropriately to set the state. The event_info parameter is the genlist
18170 * item that was indicated to expand.
18171 * - @c "contract,request" - This is called when a user has indicated they
18172 * want to contract a tree branch item. The callback should decide if the
18173 * item can contract (has any children) and then call
18174 * elm_genlist_item_expanded_set() appropriately to set the state. The
18175 * event_info parameter is the genlist item that was indicated to contract.
18176 * - @c "realized" - This is called when the item in the list is created as a
18177 * real evas object. event_info parameter is the genlist item that was
18178 * created. The object may be deleted at any time, so it is up to the
18179 * caller to not use the object pointer from elm_genlist_item_object_get()
18180 * in a way where it may point to freed objects.
18181 * - @c "unrealized" - This is called just before an item is unrealized.
18182 * After this call content objects provided will be deleted and the item
18183 * object itself delete or be put into a floating cache.
18184 * - @c "drag,start,up" - This is called when the item in the list has been
18185 * dragged (not scrolled) up.
18186 * - @c "drag,start,down" - This is called when the item in the list has been
18187 * dragged (not scrolled) down.
18188 * - @c "drag,start,left" - This is called when the item in the list has been
18189 * dragged (not scrolled) left.
18190 * - @c "drag,start,right" - This is called when the item in the list has
18191 * been dragged (not scrolled) right.
18192 * - @c "drag,stop" - This is called when the item in the list has stopped
18194 * - @c "drag" - This is called when the item in the list is being dragged.
18195 * - @c "longpressed" - This is called when the item is pressed for a certain
18196 * amount of time. By default it's 1 second.
18197 * - @c "scroll,anim,start" - This is called when scrolling animation has
18199 * - @c "scroll,anim,stop" - This is called when scrolling animation has
18201 * - @c "scroll,drag,start" - This is called when dragging the content has
18203 * - @c "scroll,drag,stop" - This is called when dragging the content has
18205 * - @c "edge,top" - This is called when the genlist is scrolled until
18207 * - @c "edge,bottom" - This is called when the genlist is scrolled
18208 * until the bottom edge.
18209 * - @c "edge,left" - This is called when the genlist is scrolled
18210 * until the left edge.
18211 * - @c "edge,right" - This is called when the genlist is scrolled
18212 * until the right edge.
18213 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18215 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18217 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18219 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18221 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18222 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
18223 * multi-touch pinched in.
18224 * - @c "swipe" - This is called when the genlist is swiped.
18225 * - @c "moved" - This is called when a genlist item is moved.
18226 * - @c "language,changed" - This is called when the program's language is
18229 * @section Genlist_Examples Examples
18231 * Here is a list of examples that use the genlist, trying to show some of
18232 * its capabilities:
18233 * - @ref genlist_example_01
18234 * - @ref genlist_example_02
18235 * - @ref genlist_example_03
18236 * - @ref genlist_example_04
18237 * - @ref genlist_example_05
18241 * @addtogroup Genlist
18246 * @enum _Elm_Genlist_Item_Flags
18247 * @typedef Elm_Genlist_Item_Flags
18249 * Defines if the item is of any special type (has subitems or it's the
18250 * index of a group), or is just a simple item.
18254 typedef enum _Elm_Genlist_Item_Flags
18256 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18257 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18258 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18259 } Elm_Genlist_Item_Flags;
18260 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
18261 #define Elm_Genlist_Item_Class Elm_Gen_Item_Class
18262 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18263 #define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18264 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
18265 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
18266 typedef Evas_Object *(*Elm_Genlist_Item_Content_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Content (swallowed object) fetching class function for genlist item classes. */
18267 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. */
18268 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
18271 * @struct _Elm_Genlist_Item_Class
18273 * Genlist item class definition structs.
18275 * This struct contains the style and fetching functions that will define the
18276 * contents of each item.
18278 * @see @ref Genlist_Item_Class
18280 struct _Elm_Genlist_Item_Class
18282 const char *item_style; /**< style of this class. */
18283 struct Elm_Genlist_Item_Class_Func
18285 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
18286 Elm_Genlist_Item_Content_Get_Cb content_get; /**< Content fetching class function for genlist item classes. */
18287 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
18288 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
18291 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18293 * Add a new genlist widget to the given parent Elementary
18294 * (container) object
18296 * @param parent The parent object
18297 * @return a new genlist widget handle or @c NULL, on errors
18299 * This function inserts a new genlist widget on the canvas.
18301 * @see elm_genlist_item_append()
18302 * @see elm_genlist_item_del()
18303 * @see elm_genlist_clear()
18307 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18309 * Remove all items from a given genlist widget.
18311 * @param obj The genlist object
18313 * This removes (and deletes) all items in @p obj, leaving it empty.
18315 * @see elm_genlist_item_del(), to remove just one item.
18319 EINA_DEPRECATED EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18321 * Enable or disable multi-selection in the genlist
18323 * @param obj The genlist object
18324 * @param multi Multi-select enable/disable. Default is disabled.
18326 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18327 * the list. This allows more than 1 item to be selected. To retrieve the list
18328 * of selected items, use elm_genlist_selected_items_get().
18330 * @see elm_genlist_selected_items_get()
18331 * @see elm_genlist_multi_select_get()
18335 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18337 * Gets if multi-selection in genlist is enabled or disabled.
18339 * @param obj The genlist object
18340 * @return Multi-select enabled/disabled
18341 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18343 * @see elm_genlist_multi_select_set()
18347 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18349 * This sets the horizontal stretching mode.
18351 * @param obj The genlist object
18352 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18354 * This sets the mode used for sizing items horizontally. Valid modes
18355 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18356 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18357 * the scroller will scroll horizontally. Otherwise items are expanded
18358 * to fill the width of the viewport of the scroller. If it is
18359 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18360 * limited to that size.
18362 * @see elm_genlist_horizontal_get()
18366 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18367 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18369 * Gets the horizontal stretching mode.
18371 * @param obj The genlist object
18372 * @return The mode to use
18373 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18375 * @see elm_genlist_horizontal_set()
18379 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18380 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18382 * Set the always select mode.
18384 * @param obj The genlist object
18385 * @param always_select The always select mode (@c EINA_TRUE = on, @c
18386 * EINA_FALSE = off). Default is @c EINA_FALSE.
18388 * Items will only call their selection func and callback when first
18389 * becoming selected. Any further clicks will do nothing, unless you
18390 * enable always select with elm_genlist_always_select_mode_set().
18391 * This means that, even if selected, every click will make the selected
18392 * callbacks be called.
18394 * @see elm_genlist_always_select_mode_get()
18398 EINA_DEPRECATED EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18400 * Get the always select mode.
18402 * @param obj The genlist object
18403 * @return The always select mode
18404 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18406 * @see elm_genlist_always_select_mode_set()
18410 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18412 * Enable/disable the no select mode.
18414 * @param obj The genlist object
18415 * @param no_select The no select mode
18416 * (EINA_TRUE = on, EINA_FALSE = off)
18418 * This will turn off the ability to select items entirely and they
18419 * will neither appear selected nor call selected callback functions.
18421 * @see elm_genlist_no_select_mode_get()
18425 EINA_DEPRECATED EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18427 * Gets whether the no select mode is enabled.
18429 * @param obj The genlist object
18430 * @return The no select mode
18431 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18433 * @see elm_genlist_no_select_mode_set()
18437 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18439 * Enable/disable compress mode.
18441 * @param obj The genlist object
18442 * @param compress The compress mode
18443 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18445 * This will enable the compress mode where items are "compressed"
18446 * horizontally to fit the genlist scrollable viewport width. This is
18447 * special for genlist. Do not rely on
18448 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18449 * work as genlist needs to handle it specially.
18451 * @see elm_genlist_compress_mode_get()
18455 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18457 * Get whether the compress mode is enabled.
18459 * @param obj The genlist object
18460 * @return The compress mode
18461 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18463 * @see elm_genlist_compress_mode_set()
18467 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18469 * Enable/disable height-for-width mode.
18471 * @param obj The genlist object
18472 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18473 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18475 * With height-for-width mode the item width will be fixed (restricted
18476 * to a minimum of) to the list width when calculating its size in
18477 * order to allow the height to be calculated based on it. This allows,
18478 * for instance, text block to wrap lines if the Edje part is
18479 * configured with "text.min: 0 1".
18481 * @note This mode will make list resize slower as it will have to
18482 * recalculate every item height again whenever the list width
18485 * @note When height-for-width mode is enabled, it also enables
18486 * compress mode (see elm_genlist_compress_mode_set()) and
18487 * disables homogeneous (see elm_genlist_homogeneous_set()).
18491 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18493 * Get whether the height-for-width mode is enabled.
18495 * @param obj The genlist object
18496 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18501 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18503 * Enable/disable horizontal and vertical bouncing effect.
18505 * @param obj The genlist object
18506 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18507 * EINA_FALSE = off). Default is @c EINA_FALSE.
18508 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18509 * EINA_FALSE = off). Default is @c EINA_TRUE.
18511 * This will enable or disable the scroller bouncing effect for the
18512 * genlist. See elm_scroller_bounce_set() for details.
18514 * @see elm_scroller_bounce_set()
18515 * @see elm_genlist_bounce_get()
18519 EINA_DEPRECATED EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18521 * Get whether the horizontal and vertical bouncing effect is enabled.
18523 * @param obj The genlist object
18524 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18526 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18529 * @see elm_genlist_bounce_set()
18533 EINA_DEPRECATED EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18535 * Enable/disable homogenous mode.
18537 * @param obj The genlist object
18538 * @param homogeneous Assume the items within the genlist are of the
18539 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18542 * This will enable the homogeneous mode where items are of the same
18543 * height and width so that genlist may do the lazy-loading at its
18544 * maximum (which increases the performance for scrolling the list). This
18545 * implies 'compressed' mode.
18547 * @see elm_genlist_compress_mode_set()
18548 * @see elm_genlist_homogeneous_get()
18552 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18554 * Get whether the homogenous mode is enabled.
18556 * @param obj The genlist object
18557 * @return Assume the items within the genlist are of the same height
18558 * and width (EINA_TRUE = on, EINA_FALSE = off)
18560 * @see elm_genlist_homogeneous_set()
18564 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18566 * Set the maximum number of items within an item block
18568 * @param obj The genlist object
18569 * @param n Maximum number of items within an item block. Default is 32.
18571 * This will configure the block count to tune to the target with
18572 * particular performance matrix.
18574 * A block of objects will be used to reduce the number of operations due to
18575 * many objects in the screen. It can determine the visibility, or if the
18576 * object has changed, it theme needs to be updated, etc. doing this kind of
18577 * calculation to the entire block, instead of per object.
18579 * The default value for the block count is enough for most lists, so unless
18580 * you know you will have a lot of objects visible in the screen at the same
18581 * time, don't try to change this.
18583 * @see elm_genlist_block_count_get()
18584 * @see @ref Genlist_Implementation
18588 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18590 * Get the maximum number of items within an item block
18592 * @param obj The genlist object
18593 * @return Maximum number of items within an item block
18595 * @see elm_genlist_block_count_set()
18599 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18601 * Set the timeout in seconds for the longpress event.
18603 * @param obj The genlist object
18604 * @param timeout timeout in seconds. Default is 1.
18606 * This option will change how long it takes to send an event "longpressed"
18607 * after the mouse down signal is sent to the list. If this event occurs, no
18608 * "clicked" event will be sent.
18610 * @see elm_genlist_longpress_timeout_set()
18614 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18616 * Get the timeout in seconds for the longpress event.
18618 * @param obj The genlist object
18619 * @return timeout in seconds
18621 * @see elm_genlist_longpress_timeout_get()
18625 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18627 * Append a new item in a given genlist widget.
18629 * @param obj The genlist object
18630 * @param itc The item class for the item
18631 * @param data The item data
18632 * @param parent The parent item, or NULL if none
18633 * @param flags Item flags
18634 * @param func Convenience function called when the item is selected
18635 * @param func_data Data passed to @p func above.
18636 * @return A handle to the item added or @c NULL if not possible
18638 * This adds the given item to the end of the list or the end of
18639 * the children list if the @p parent is given.
18641 * @see elm_genlist_item_prepend()
18642 * @see elm_genlist_item_insert_before()
18643 * @see elm_genlist_item_insert_after()
18644 * @see elm_genlist_item_del()
18648 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);
18650 * Prepend a new item in a given genlist widget.
18652 * @param obj The genlist object
18653 * @param itc The item class for the item
18654 * @param data The item data
18655 * @param parent The parent item, or NULL if none
18656 * @param flags Item flags
18657 * @param func Convenience function called when the item is selected
18658 * @param func_data Data passed to @p func above.
18659 * @return A handle to the item added or NULL if not possible
18661 * This adds an item to the beginning of the list or beginning of the
18662 * children of the parent if given.
18664 * @see elm_genlist_item_append()
18665 * @see elm_genlist_item_insert_before()
18666 * @see elm_genlist_item_insert_after()
18667 * @see elm_genlist_item_del()
18671 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);
18673 * Insert an item before another in a genlist widget
18675 * @param obj The genlist object
18676 * @param itc The item class for the item
18677 * @param data The item data
18678 * @param before The item to place this new one before.
18679 * @param flags Item flags
18680 * @param func Convenience function called when the item is selected
18681 * @param func_data Data passed to @p func above.
18682 * @return A handle to the item added or @c NULL if not possible
18684 * This inserts an item before another in the list. It will be in the
18685 * same tree level or group as the item it is inserted before.
18687 * @see elm_genlist_item_append()
18688 * @see elm_genlist_item_prepend()
18689 * @see elm_genlist_item_insert_after()
18690 * @see elm_genlist_item_del()
18694 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);
18696 * Insert an item after another in a genlist widget
18698 * @param obj The genlist object
18699 * @param itc The item class for the item
18700 * @param data The item data
18701 * @param after The item to place this new one after.
18702 * @param flags Item flags
18703 * @param func Convenience function called when the item is selected
18704 * @param func_data Data passed to @p func above.
18705 * @return A handle to the item added or @c NULL if not possible
18707 * This inserts an item after another in the list. It will be in the
18708 * same tree level or group as the item it is inserted after.
18710 * @see elm_genlist_item_append()
18711 * @see elm_genlist_item_prepend()
18712 * @see elm_genlist_item_insert_before()
18713 * @see elm_genlist_item_del()
18717 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);
18719 * Insert a new item into the sorted genlist object
18721 * @param obj The genlist object
18722 * @param itc The item class for the item
18723 * @param data The item data
18724 * @param parent The parent item, or NULL if none
18725 * @param flags Item flags
18726 * @param comp The function called for the sort
18727 * @param func Convenience function called when item selected
18728 * @param func_data Data passed to @p func above.
18729 * @return A handle to the item added or NULL if not possible
18733 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);
18734 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);
18735 /* operations to retrieve existing items */
18737 * Get the selectd item in the genlist.
18739 * @param obj The genlist object
18740 * @return The selected item, or NULL if none is selected.
18742 * This gets the selected item in the list (if multi-selection is enabled, only
18743 * the item that was first selected in the list is returned - which is not very
18744 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18747 * If no item is selected, NULL is returned.
18749 * @see elm_genlist_selected_items_get()
18753 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18755 * Get a list of selected items in the genlist.
18757 * @param obj The genlist object
18758 * @return The list of selected items, or NULL if none are selected.
18760 * It returns a list of the selected items. This list pointer is only valid so
18761 * long as the selection doesn't change (no items are selected or unselected, or
18762 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18763 * pointers. The order of the items in this list is the order which they were
18764 * selected, i.e. the first item in this list is the first item that was
18765 * selected, and so on.
18767 * @note If not in multi-select mode, consider using function
18768 * elm_genlist_selected_item_get() instead.
18770 * @see elm_genlist_multi_select_set()
18771 * @see elm_genlist_selected_item_get()
18775 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18777 * Get the mode item style of items in the genlist
18778 * @param obj The genlist object
18779 * @return The mode item style string, or NULL if none is specified
18781 * This is a constant string and simply defines the name of the
18782 * style that will be used for mode animations. It can be
18783 * @c NULL if you don't plan to use Genlist mode. See
18784 * elm_genlist_item_mode_set() for more info.
18788 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18790 * Set the mode item style of items in the genlist
18791 * @param obj The genlist object
18792 * @param style The mode item style string, or NULL if none is desired
18794 * This is a constant string and simply defines the name of the
18795 * style that will be used for mode animations. It can be
18796 * @c NULL if you don't plan to use Genlist mode. See
18797 * elm_genlist_item_mode_set() for more info.
18801 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
18803 * Get a list of realized items in genlist
18805 * @param obj The genlist object
18806 * @return The list of realized items, nor NULL if none are realized.
18808 * This returns a list of the realized items in the genlist. The list
18809 * contains Elm_Genlist_Item pointers. The list must be freed by the
18810 * caller when done with eina_list_free(). The item pointers in the
18811 * list are only valid so long as those items are not deleted or the
18812 * genlist is not deleted.
18814 * @see elm_genlist_realized_items_update()
18818 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18820 * Get the item that is at the x, y canvas coords.
18822 * @param obj The gelinst object.
18823 * @param x The input x coordinate
18824 * @param y The input y coordinate
18825 * @param posret The position relative to the item returned here
18826 * @return The item at the coordinates or NULL if none
18828 * This returns the item at the given coordinates (which are canvas
18829 * relative, not object-relative). If an item is at that coordinate,
18830 * that item handle is returned, and if @p posret is not NULL, the
18831 * integer pointed to is set to a value of -1, 0 or 1, depending if
18832 * the coordinate is on the upper portion of that item (-1), on the
18833 * middle section (0) or on the lower part (1). If NULL is returned as
18834 * an item (no item found there), then posret may indicate -1 or 1
18835 * based if the coordinate is above or below all items respectively in
18840 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);
18842 * Get the first item in the genlist
18844 * This returns the first item in the list.
18846 * @param obj The genlist object
18847 * @return The first item, or NULL if none
18851 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18853 * Get the last item in the genlist
18855 * This returns the last item in the list.
18857 * @return The last item, or NULL if none
18861 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18863 * Set the scrollbar policy
18865 * @param obj The genlist object
18866 * @param policy_h Horizontal scrollbar policy.
18867 * @param policy_v Vertical scrollbar policy.
18869 * This sets the scrollbar visibility policy for the given genlist
18870 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
18871 * made visible if it is needed, and otherwise kept hidden.
18872 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
18873 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
18874 * respectively for the horizontal and vertical scrollbars. Default is
18875 * #ELM_SMART_SCROLLER_POLICY_AUTO
18877 * @see elm_genlist_scroller_policy_get()
18881 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
18883 * Get the scrollbar policy
18885 * @param obj The genlist object
18886 * @param policy_h Pointer to store the horizontal scrollbar policy.
18887 * @param policy_v Pointer to store the vertical scrollbar policy.
18889 * @see elm_genlist_scroller_policy_set()
18893 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);
18895 * Get the @b next item in a genlist widget's internal list of items,
18896 * given a handle to one of those items.
18898 * @param item The genlist item to fetch next from
18899 * @return The item after @p item, or @c NULL if there's none (and
18902 * This returns the item placed after the @p item, on the container
18905 * @see elm_genlist_item_prev_get()
18909 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18911 * Get the @b previous item in a genlist widget's internal list of items,
18912 * given a handle to one of those items.
18914 * @param item The genlist item to fetch previous from
18915 * @return The item before @p item, or @c NULL if there's none (and
18918 * This returns the item placed before the @p item, on the container
18921 * @see elm_genlist_item_next_get()
18925 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18927 * Get the genlist object's handle which contains a given genlist
18930 * @param item The item to fetch the container from
18931 * @return The genlist (parent) object
18933 * This returns the genlist object itself that an item belongs to.
18937 EINA_DEPRECATED EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18939 * Get the parent item of the given item
18941 * @param it The item
18942 * @return The parent of the item or @c NULL if it has no parent.
18944 * This returns the item that was specified as parent of the item @p it on
18945 * elm_genlist_item_append() and insertion related functions.
18949 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18951 * Remove all sub-items (children) of the given item
18953 * @param it The item
18955 * This removes all items that are children (and their descendants) of the
18956 * given item @p it.
18958 * @see elm_genlist_clear()
18959 * @see elm_genlist_item_del()
18963 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18965 * Set whether a given genlist item is selected or not
18967 * @param it The item
18968 * @param selected Use @c EINA_TRUE, to make it selected, @c
18969 * EINA_FALSE to make it unselected
18971 * This sets the selected state of an item. If multi selection is
18972 * not enabled on the containing genlist and @p selected is @c
18973 * EINA_TRUE, any other previously selected items will get
18974 * unselected in favor of this new one.
18976 * @see elm_genlist_item_selected_get()
18980 EINA_DEPRECATED EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
18982 * Get whether a given genlist item is selected or not
18984 * @param it The item
18985 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
18987 * @see elm_genlist_item_selected_set() for more details
18991 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18993 * Sets the expanded state of an item.
18995 * @param it The item
18996 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
18998 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19001 * The theme will respond to this change visually, and a signal "expanded" or
19002 * "contracted" will be sent from the genlist with a pointer to the item that
19003 * has been expanded/contracted.
19005 * Calling this function won't show or hide any child of this item (if it is
19006 * a parent). You must manually delete and create them on the callbacks fo
19007 * the "expanded" or "contracted" signals.
19009 * @see elm_genlist_item_expanded_get()
19013 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19015 * Get the expanded state of an item
19017 * @param it The item
19018 * @return The expanded state
19020 * This gets the expanded state of an item.
19022 * @see elm_genlist_item_expanded_set()
19026 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19028 * Get the depth of expanded item
19030 * @param it The genlist item object
19031 * @return The depth of expanded item
19035 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19037 * Set whether a given genlist item is disabled or not.
19039 * @param it The item
19040 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19041 * to enable it back.
19043 * A disabled item cannot be selected or unselected. It will also
19044 * change its appearance, to signal the user it's disabled.
19046 * @see elm_genlist_item_disabled_get()
19050 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19052 * Get whether a given genlist item is disabled or not.
19054 * @param it The item
19055 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19058 * @see elm_genlist_item_disabled_set() for more details
19062 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19064 * Sets the display only state of an item.
19066 * @param it The item
19067 * @param display_only @c EINA_TRUE if the item is display only, @c
19068 * EINA_FALSE otherwise.
19070 * A display only item cannot be selected or unselected. It is for
19071 * display only and not selecting or otherwise clicking, dragging
19072 * etc. by the user, thus finger size rules will not be applied to
19075 * It's good to set group index items to display only state.
19077 * @see elm_genlist_item_display_only_get()
19081 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19083 * Get the display only state of an item
19085 * @param it The item
19086 * @return @c EINA_TRUE if the item is display only, @c
19087 * EINA_FALSE otherwise.
19089 * @see elm_genlist_item_display_only_set()
19093 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19095 * Show the portion of a genlist's internal list containing a given
19096 * item, immediately.
19098 * @param it The item to display
19100 * This causes genlist to jump to the given item @p it and show it (by
19101 * immediately scrolling to that position), if it is not fully visible.
19103 * @see elm_genlist_item_bring_in()
19104 * @see elm_genlist_item_top_show()
19105 * @see elm_genlist_item_middle_show()
19109 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19111 * Animatedly bring in, to the visible are of a genlist, a given
19114 * @param it The item to display
19116 * This causes genlist to jump to the given item @p it and show it (by
19117 * animatedly scrolling), if it is not fully visible. This may use animation
19118 * to do so and take a period of time
19120 * @see elm_genlist_item_show()
19121 * @see elm_genlist_item_top_bring_in()
19122 * @see elm_genlist_item_middle_bring_in()
19126 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19128 * Show the portion of a genlist's internal list containing a given
19129 * item, immediately.
19131 * @param it The item to display
19133 * This causes genlist to jump to the given item @p it and show it (by
19134 * immediately scrolling to that position), if it is not fully visible.
19136 * The item will be positioned at the top of the genlist viewport.
19138 * @see elm_genlist_item_show()
19139 * @see elm_genlist_item_top_bring_in()
19143 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19145 * Animatedly bring in, to the visible are of a genlist, a given
19148 * @param it The item
19150 * This causes genlist to jump to the given item @p it and show it (by
19151 * animatedly scrolling), if it is not fully visible. This may use animation
19152 * to do so and take a period of time
19154 * The item will be positioned at the top of the genlist viewport.
19156 * @see elm_genlist_item_bring_in()
19157 * @see elm_genlist_item_top_show()
19161 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19163 * Show the portion of a genlist's internal list containing a given
19164 * item, immediately.
19166 * @param it The item to display
19168 * This causes genlist to jump to the given item @p it and show it (by
19169 * immediately scrolling to that position), if it is not fully visible.
19171 * The item will be positioned at the middle of the genlist viewport.
19173 * @see elm_genlist_item_show()
19174 * @see elm_genlist_item_middle_bring_in()
19178 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19180 * Animatedly bring in, to the visible are of a genlist, a given
19183 * @param it The item
19185 * This causes genlist to jump to the given item @p it and show it (by
19186 * animatedly scrolling), if it is not fully visible. This may use animation
19187 * to do so and take a period of time
19189 * The item will be positioned at the middle of the genlist viewport.
19191 * @see elm_genlist_item_bring_in()
19192 * @see elm_genlist_item_middle_show()
19196 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19198 * Remove a genlist item from the its parent, deleting it.
19200 * @param item The item to be removed.
19201 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19203 * @see elm_genlist_clear(), to remove all items in a genlist at
19208 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19210 * Return the data associated to a given genlist item
19212 * @param item The genlist item.
19213 * @return the data associated to this item.
19215 * This returns the @c data value passed on the
19216 * elm_genlist_item_append() and related item addition calls.
19218 * @see elm_genlist_item_append()
19219 * @see elm_genlist_item_data_set()
19223 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19225 * Set the data associated to a given genlist item
19227 * @param item The genlist item
19228 * @param data The new data pointer to set on it
19230 * This @b overrides the @c data value passed on the
19231 * elm_genlist_item_append() and related item addition calls. This
19232 * function @b won't call elm_genlist_item_update() automatically,
19233 * so you'd issue it afterwards if you want to hove the item
19234 * updated to reflect the that new data.
19236 * @see elm_genlist_item_data_get()
19240 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19242 * Tells genlist to "orphan" icons fetchs by the item class
19244 * @param it The item
19246 * This instructs genlist to release references to icons in the item,
19247 * meaning that they will no longer be managed by genlist and are
19248 * floating "orphans" that can be re-used elsewhere if the user wants
19253 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19254 EINA_DEPRECATED EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19256 * Get the real Evas object created to implement the view of a
19257 * given genlist item
19259 * @param item The genlist item.
19260 * @return the Evas object implementing this item's view.
19262 * This returns the actual Evas object used to implement the
19263 * specified genlist item's view. This may be @c NULL, as it may
19264 * not have been created or may have been deleted, at any time, by
19265 * the genlist. <b>Do not modify this object</b> (move, resize,
19266 * show, hide, etc.), as the genlist is controlling it. This
19267 * function is for querying, emitting custom signals or hooking
19268 * lower level callbacks for events on that object. Do not delete
19269 * this object under any circumstances.
19271 * @see elm_genlist_item_data_get()
19275 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19277 * Update the contents of an item
19279 * @param it The item
19281 * This updates an item by calling all the item class functions again
19282 * to get the icons, labels and states. Use this when the original
19283 * item data has changed and the changes are desired to be reflected.
19285 * Use elm_genlist_realized_items_update() to update all already realized
19288 * @see elm_genlist_realized_items_update()
19292 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19294 * Update the item class of an item
19296 * @param it The item
19297 * @param itc The item class for the item
19299 * This sets another class fo the item, changing the way that it is
19300 * displayed. After changing the item class, elm_genlist_item_update() is
19301 * called on the item @p it.
19305 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19306 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19308 * Set the text to be shown in a given genlist item's tooltips.
19310 * @param item The genlist item
19311 * @param text The text to set in the content
19313 * This call will setup the text to be used as tooltip to that item
19314 * (analogous to elm_object_tooltip_text_set(), but being item
19315 * tooltips with higher precedence than object tooltips). It can
19316 * have only one tooltip at a time, so any previous tooltip data
19317 * will get removed.
19319 * In order to set an icon or something else as a tooltip, look at
19320 * elm_genlist_item_tooltip_content_cb_set().
19324 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19326 * Set the content to be shown in a given genlist item's tooltips
19328 * @param item The genlist item.
19329 * @param func The function returning the tooltip contents.
19330 * @param data What to provide to @a func as callback data/context.
19331 * @param del_cb Called when data is not needed anymore, either when
19332 * another callback replaces @p func, the tooltip is unset with
19333 * elm_genlist_item_tooltip_unset() or the owner @p item
19334 * dies. This callback receives as its first parameter the
19335 * given @p data, being @c event_info the item handle.
19337 * This call will setup the tooltip's contents to @p item
19338 * (analogous to elm_object_tooltip_content_cb_set(), but being
19339 * item tooltips with higher precedence than object tooltips). It
19340 * can have only one tooltip at a time, so any previous tooltip
19341 * content will get removed. @p func (with @p data) will be called
19342 * every time Elementary needs to show the tooltip and it should
19343 * return a valid Evas object, which will be fully managed by the
19344 * tooltip system, getting deleted when the tooltip is gone.
19346 * In order to set just a text as a tooltip, look at
19347 * elm_genlist_item_tooltip_text_set().
19351 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);
19353 * Unset a tooltip from a given genlist item
19355 * @param item genlist item to remove a previously set tooltip from.
19357 * This call removes any tooltip set on @p item. The callback
19358 * provided as @c del_cb to
19359 * elm_genlist_item_tooltip_content_cb_set() will be called to
19360 * notify it is not used anymore (and have resources cleaned, if
19363 * @see elm_genlist_item_tooltip_content_cb_set()
19367 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19369 * Set a different @b style for a given genlist item's tooltip.
19371 * @param item genlist item with tooltip set
19372 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19373 * "default", @c "transparent", etc)
19375 * Tooltips can have <b>alternate styles</b> to be displayed on,
19376 * which are defined by the theme set on Elementary. This function
19377 * works analogously as elm_object_tooltip_style_set(), but here
19378 * applied only to genlist item objects. The default style for
19379 * tooltips is @c "default".
19381 * @note before you set a style you should define a tooltip with
19382 * elm_genlist_item_tooltip_content_cb_set() or
19383 * elm_genlist_item_tooltip_text_set()
19385 * @see elm_genlist_item_tooltip_style_get()
19389 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19391 * Get the style set a given genlist item's tooltip.
19393 * @param item genlist item with tooltip already set on.
19394 * @return style the theme style in use, which defaults to
19395 * "default". If the object does not have a tooltip set,
19396 * then @c NULL is returned.
19398 * @see elm_genlist_item_tooltip_style_set() for more details
19402 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19404 * @brief Disable size restrictions on an object's tooltip
19405 * @param item The tooltip's anchor object
19406 * @param disable If EINA_TRUE, size restrictions are disabled
19407 * @return EINA_FALSE on failure, EINA_TRUE on success
19409 * This function allows a tooltip to expand beyond its parant window's canvas.
19410 * It will instead be limited only by the size of the display.
19412 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19414 * @brief Retrieve size restriction state of an object's tooltip
19415 * @param item The tooltip's anchor object
19416 * @return If EINA_TRUE, size restrictions are disabled
19418 * This function returns whether a tooltip is allowed to expand beyond
19419 * its parant window's canvas.
19420 * It will instead be limited only by the size of the display.
19422 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19424 * Set the type of mouse pointer/cursor decoration to be shown,
19425 * when the mouse pointer is over the given genlist widget item
19427 * @param item genlist item to customize cursor on
19428 * @param cursor the cursor type's name
19430 * This function works analogously as elm_object_cursor_set(), but
19431 * here the cursor's changing area is restricted to the item's
19432 * area, and not the whole widget's. Note that that item cursors
19433 * have precedence over widget cursors, so that a mouse over @p
19434 * item will always show cursor @p type.
19436 * If this function is called twice for an object, a previously set
19437 * cursor will be unset on the second call.
19439 * @see elm_object_cursor_set()
19440 * @see elm_genlist_item_cursor_get()
19441 * @see elm_genlist_item_cursor_unset()
19445 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19447 * Get the type of mouse pointer/cursor decoration set to be shown,
19448 * when the mouse pointer is over the given genlist widget item
19450 * @param item genlist item with custom cursor set
19451 * @return the cursor type's name or @c NULL, if no custom cursors
19452 * were set to @p item (and on errors)
19454 * @see elm_object_cursor_get()
19455 * @see elm_genlist_item_cursor_set() for more details
19456 * @see elm_genlist_item_cursor_unset()
19460 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19462 * Unset any custom mouse pointer/cursor decoration set to be
19463 * shown, when the mouse pointer is over the given genlist widget
19464 * item, thus making it show the @b default cursor again.
19466 * @param item a genlist item
19468 * Use this call to undo any custom settings on this item's cursor
19469 * decoration, bringing it back to defaults (no custom style set).
19471 * @see elm_object_cursor_unset()
19472 * @see elm_genlist_item_cursor_set() for more details
19476 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19478 * Set a different @b style for a given custom cursor set for a
19481 * @param item genlist item with custom cursor set
19482 * @param style the <b>theme style</b> to use (e.g. @c "default",
19483 * @c "transparent", etc)
19485 * This function only makes sense when one is using custom mouse
19486 * cursor decorations <b>defined in a theme file</b> , which can
19487 * have, given a cursor name/type, <b>alternate styles</b> on
19488 * it. It works analogously as elm_object_cursor_style_set(), but
19489 * here applied only to genlist item objects.
19491 * @warning Before you set a cursor style you should have defined a
19492 * custom cursor previously on the item, with
19493 * elm_genlist_item_cursor_set()
19495 * @see elm_genlist_item_cursor_engine_only_set()
19496 * @see elm_genlist_item_cursor_style_get()
19500 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19502 * Get the current @b style set for a given genlist item's custom
19505 * @param item genlist item with custom cursor set.
19506 * @return style the cursor style in use. If the object does not
19507 * have a cursor set, then @c NULL is returned.
19509 * @see elm_genlist_item_cursor_style_set() for more details
19513 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19515 * Set if the (custom) cursor for a given genlist item should be
19516 * searched in its theme, also, or should only rely on the
19517 * rendering engine.
19519 * @param item item with custom (custom) cursor already set on
19520 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19521 * only on those provided by the rendering engine, @c EINA_FALSE to
19522 * have them searched on the widget's theme, as well.
19524 * @note This call is of use only if you've set a custom cursor
19525 * for genlist items, with elm_genlist_item_cursor_set().
19527 * @note By default, cursors will only be looked for between those
19528 * provided by the rendering engine.
19532 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19534 * Get if the (custom) cursor for a given genlist item is being
19535 * searched in its theme, also, or is only relying on the rendering
19538 * @param item a genlist item
19539 * @return @c EINA_TRUE, if cursors are being looked for only on
19540 * those provided by the rendering engine, @c EINA_FALSE if they
19541 * are being searched on the widget's theme, as well.
19543 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19547 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19549 * Update the contents of all realized items.
19551 * @param obj The genlist object.
19553 * This updates all realized items by calling all the item class functions again
19554 * to get the icons, labels and states. Use this when the original
19555 * item data has changed and the changes are desired to be reflected.
19557 * To update just one item, use elm_genlist_item_update().
19559 * @see elm_genlist_realized_items_get()
19560 * @see elm_genlist_item_update()
19564 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19566 * Activate a genlist mode on an item
19568 * @param item The genlist item
19569 * @param mode Mode name
19570 * @param mode_set Boolean to define set or unset mode.
19572 * A genlist mode is a different way of selecting an item. Once a mode is
19573 * activated on an item, any other selected item is immediately unselected.
19574 * This feature provides an easy way of implementing a new kind of animation
19575 * for selecting an item, without having to entirely rewrite the item style
19576 * theme. However, the elm_genlist_selected_* API can't be used to get what
19577 * item is activate for a mode.
19579 * The current item style will still be used, but applying a genlist mode to
19580 * an item will select it using a different kind of animation.
19582 * The current active item for a mode can be found by
19583 * elm_genlist_mode_item_get().
19585 * The characteristics of genlist mode are:
19586 * - Only one mode can be active at any time, and for only one item.
19587 * - Genlist handles deactivating other items when one item is activated.
19588 * - A mode is defined in the genlist theme (edc), and more modes can easily
19590 * - A mode style and the genlist item style are different things. They
19591 * can be combined to provide a default style to the item, with some kind
19592 * of animation for that item when the mode is activated.
19594 * When a mode is activated on an item, a new view for that item is created.
19595 * The theme of this mode defines the animation that will be used to transit
19596 * the item from the old view to the new view. This second (new) view will be
19597 * active for that item while the mode is active on the item, and will be
19598 * destroyed after the mode is totally deactivated from that item.
19600 * @see elm_genlist_mode_get()
19601 * @see elm_genlist_mode_item_get()
19605 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19607 * Get the last (or current) genlist mode used.
19609 * @param obj The genlist object
19611 * This function just returns the name of the last used genlist mode. It will
19612 * be the current mode if it's still active.
19614 * @see elm_genlist_item_mode_set()
19615 * @see elm_genlist_mode_item_get()
19619 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19621 * Get active genlist mode item
19623 * @param obj The genlist object
19624 * @return The active item for that current mode. Or @c NULL if no item is
19625 * activated with any mode.
19627 * This function returns the item that was activated with a mode, by the
19628 * function elm_genlist_item_mode_set().
19630 * @see elm_genlist_item_mode_set()
19631 * @see elm_genlist_mode_get()
19635 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19640 * @param obj The genlist object
19641 * @param reorder_mode The reorder mode
19642 * (EINA_TRUE = on, EINA_FALSE = off)
19646 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19649 * Get the reorder mode
19651 * @param obj The genlist object
19652 * @return The reorder mode
19653 * (EINA_TRUE = on, EINA_FALSE = off)
19657 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19664 * @defgroup Check Check
19666 * @image html img/widget/check/preview-00.png
19667 * @image latex img/widget/check/preview-00.eps
19668 * @image html img/widget/check/preview-01.png
19669 * @image latex img/widget/check/preview-01.eps
19670 * @image html img/widget/check/preview-02.png
19671 * @image latex img/widget/check/preview-02.eps
19673 * @brief The check widget allows for toggling a value between true and
19676 * Check objects are a lot like radio objects in layout and functionality
19677 * except they do not work as a group, but independently and only toggle the
19678 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19679 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19680 * returns the current state. For convenience, like the radio objects, you
19681 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19682 * for it to modify.
19684 * Signals that you can add callbacks for are:
19685 * "changed" - This is called whenever the user changes the state of one of
19686 * the check object(event_info is NULL).
19688 * Default contents parts of the check widget that you can use for are:
19689 * @li "elm.swallow.content" - A icon of the check
19691 * Default text parts of the check widget that you can use for are:
19692 * @li "elm.text" - Label of the check
19694 * @ref tutorial_check should give you a firm grasp of how to use this widget
19699 * @brief Add a new Check object
19701 * @param parent The parent object
19702 * @return The new object or NULL if it cannot be created
19704 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19706 * @brief Set the text label of the check object
19708 * @param obj The check object
19709 * @param label The text label string in UTF-8
19711 * @deprecated use elm_object_text_set() instead.
19713 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19715 * @brief Get the text label of the check object
19717 * @param obj The check object
19718 * @return The text label string in UTF-8
19720 * @deprecated use elm_object_text_get() instead.
19722 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19724 * @brief Set the icon object of the check object
19726 * @param obj The check object
19727 * @param icon The icon object
19729 * Once the icon object is set, a previously set one will be deleted.
19730 * If you want to keep that old content object, use the
19731 * elm_object_content_unset() function.
19733 EINA_DEPRECATED EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19735 * @brief Get the icon object of the check object
19737 * @param obj The check object
19738 * @return The icon object
19740 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19742 * @brief Unset the icon used for the check object
19744 * @param obj The check object
19745 * @return The icon object that was being used
19747 * Unparent and return the icon object which was set for this widget.
19749 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19751 * @brief Set the on/off state of the check object
19753 * @param obj The check object
19754 * @param state The state to use (1 == on, 0 == off)
19756 * This sets the state of the check. If set
19757 * with elm_check_state_pointer_set() the state of that variable is also
19758 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19760 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19762 * @brief Get the state of the check object
19764 * @param obj The check object
19765 * @return The boolean state
19767 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19769 * @brief Set a convenience pointer to a boolean to change
19771 * @param obj The check object
19772 * @param statep Pointer to the boolean to modify
19774 * This sets a pointer to a boolean, that, in addition to the check objects
19775 * state will also be modified directly. To stop setting the object pointed
19776 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19777 * then when this is called, the check objects state will also be modified to
19778 * reflect the value of the boolean @p statep points to, just like calling
19779 * elm_check_state_set().
19781 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19782 EINA_DEPRECATED EAPI void elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
19783 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);
19790 * @defgroup Radio Radio
19792 * @image html img/widget/radio/preview-00.png
19793 * @image latex img/widget/radio/preview-00.eps
19795 * @brief Radio is a widget that allows for 1 or more options to be displayed
19796 * and have the user choose only 1 of them.
19798 * A radio object contains an indicator, an optional Label and an optional
19799 * icon object. While it's possible to have a group of only one radio they,
19800 * are normally used in groups of 2 or more. To add a radio to a group use
19801 * elm_radio_group_add(). The radio object(s) will select from one of a set
19802 * of integer values, so any value they are configuring needs to be mapped to
19803 * a set of integers. To configure what value that radio object represents,
19804 * use elm_radio_state_value_set() to set the integer it represents. To set
19805 * the value the whole group(which one is currently selected) is to indicate
19806 * use elm_radio_value_set() on any group member, and to get the groups value
19807 * use elm_radio_value_get(). For convenience the radio objects are also able
19808 * to directly set an integer(int) to the value that is selected. To specify
19809 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19810 * The radio objects will modify this directly. That implies the pointer must
19811 * point to valid memory for as long as the radio objects exist.
19813 * Signals that you can add callbacks for are:
19814 * @li changed - This is called whenever the user changes the state of one of
19815 * the radio objects within the group of radio objects that work together.
19817 * Default contents parts of the radio widget that you can use for are:
19818 * @li "elm.swallow.content" - A icon of the radio
19820 * @ref tutorial_radio show most of this API in action.
19824 * @brief Add a new radio to the parent
19826 * @param parent The parent object
19827 * @return The new object or NULL if it cannot be created
19829 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19831 * @brief Set the text label of the radio object
19833 * @param obj The radio object
19834 * @param label The text label string in UTF-8
19836 * @deprecated use elm_object_text_set() instead.
19838 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19840 * @brief Get the text label of the radio object
19842 * @param obj The radio object
19843 * @return The text label string in UTF-8
19845 * @deprecated use elm_object_text_set() instead.
19847 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19849 * @brief Set the icon object of the radio object
19851 * @param obj The radio object
19852 * @param icon The icon object
19854 * Once the icon object is set, a previously set one will be deleted. If you
19855 * want to keep that old content object, use the elm_radio_icon_unset()
19858 EINA_DEPRECATED EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19860 * @brief Get the icon object of the radio object
19862 * @param obj The radio object
19863 * @return The icon object
19865 * @see elm_radio_icon_set()
19867 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19869 * @brief Unset the icon used for the radio object
19871 * @param obj The radio object
19872 * @return The icon object that was being used
19874 * Unparent and return the icon object which was set for this widget.
19876 * @see elm_radio_icon_set()
19878 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19880 * @brief Add this radio to a group of other radio objects
19882 * @param obj The radio object
19883 * @param group Any object whose group the @p obj is to join.
19885 * Radio objects work in groups. Each member should have a different integer
19886 * value assigned. In order to have them work as a group, they need to know
19887 * about each other. This adds the given radio object to the group of which
19888 * the group object indicated is a member.
19890 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
19892 * @brief Set the integer value that this radio object represents
19894 * @param obj The radio object
19895 * @param value The value to use if this radio object is selected
19897 * This sets the value of the radio.
19899 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19901 * @brief Get the integer value that this radio object represents
19903 * @param obj The radio object
19904 * @return The value used if this radio object is selected
19906 * This gets the value of the radio.
19908 * @see elm_radio_value_set()
19910 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19912 * @brief Set the value of the radio.
19914 * @param obj The radio object
19915 * @param value The value to use for the group
19917 * This sets the value of the radio group and will also set the value if
19918 * pointed to, to the value supplied, but will not call any callbacks.
19920 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19922 * @brief Get the state of the radio object
19924 * @param obj The radio object
19925 * @return The integer state
19927 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19929 * @brief Set a convenience pointer to a integer to change
19931 * @param obj The radio object
19932 * @param valuep Pointer to the integer to modify
19934 * This sets a pointer to a integer, that, in addition to the radio objects
19935 * state will also be modified directly. To stop setting the object pointed
19936 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
19937 * when this is called, the radio objects state will also be modified to
19938 * reflect the value of the integer valuep points to, just like calling
19939 * elm_radio_value_set().
19941 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
19947 * @defgroup Pager Pager
19949 * @image html img/widget/pager/preview-00.png
19950 * @image latex img/widget/pager/preview-00.eps
19952 * @brief Widget that allows flipping between 1 or more āpagesā of objects.
19954 * The flipping between āpagesā of objects is animated. All content in pager
19955 * is kept in a stack, the last content to be added will be on the top of the
19956 * stack(be visible).
19958 * Objects can be pushed or popped from the stack or deleted as normal.
19959 * Pushes and pops will animate (and a pop will delete the object once the
19960 * animation is finished). Any object already in the pager can be promoted to
19961 * the top(from its current stacking position) through the use of
19962 * elm_pager_content_promote(). Objects are pushed to the top with
19963 * elm_pager_content_push() and when the top item is no longer wanted, simply
19964 * pop it with elm_pager_content_pop() and it will also be deleted. If an
19965 * object is no longer needed and is not the top item, just delete it as
19966 * normal. You can query which objects are the top and bottom with
19967 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
19969 * Signals that you can add callbacks for are:
19970 * "hide,finished" - when the previous page is hided
19972 * This widget has the following styles available:
19975 * @li fade_translucide
19976 * @li fade_invisible
19977 * @note This styles affect only the flipping animations, the appearance when
19978 * not animating is unaffected by styles.
19980 * @ref tutorial_pager gives a good overview of the usage of the API.
19984 * Add a new pager to the parent
19986 * @param parent The parent object
19987 * @return The new object or NULL if it cannot be created
19991 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19993 * @brief Push an object to the top of the pager stack (and show it).
19995 * @param obj The pager object
19996 * @param content The object to push
19998 * The object pushed becomes a child of the pager, it will be controlled and
19999 * deleted when the pager is deleted.
20001 * @note If the content is already in the stack use
20002 * elm_pager_content_promote().
20003 * @warning Using this function on @p content already in the stack results in
20004 * undefined behavior.
20006 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20008 * @brief Pop the object that is on top of the stack
20010 * @param obj The pager object
20012 * This pops the object that is on the top(visible) of the pager, makes it
20013 * disappear, then deletes the object. The object that was underneath it on
20014 * the stack will become visible.
20016 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20018 * @brief Moves an object already in the pager stack to the top of the stack.
20020 * @param obj The pager object
20021 * @param content The object to promote
20023 * This will take the @p content and move it to the top of the stack as
20024 * if it had been pushed there.
20026 * @note If the content isn't already in the stack use
20027 * elm_pager_content_push().
20028 * @warning Using this function on @p content not already in the stack
20029 * results in undefined behavior.
20031 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20033 * @brief Return the object at the bottom of the pager stack
20035 * @param obj The pager object
20036 * @return The bottom object or NULL if none
20038 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20040 * @brief Return the object at the top of the pager stack
20042 * @param obj The pager object
20043 * @return The top object or NULL if none
20045 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20052 * @defgroup Slideshow Slideshow
20054 * @image html img/widget/slideshow/preview-00.png
20055 * @image latex img/widget/slideshow/preview-00.eps
20057 * This widget, as the name indicates, is a pre-made image
20058 * slideshow panel, with API functions acting on (child) image
20059 * items presentation. Between those actions, are:
20060 * - advance to next/previous image
20061 * - select the style of image transition animation
20062 * - set the exhibition time for each image
20063 * - start/stop the slideshow
20065 * The transition animations are defined in the widget's theme,
20066 * consequently new animations can be added without having to
20067 * update the widget's code.
20069 * @section Slideshow_Items Slideshow items
20071 * For slideshow items, just like for @ref Genlist "genlist" ones,
20072 * the user defines a @b classes, specifying functions that will be
20073 * called on the item's creation and deletion times.
20075 * The #Elm_Slideshow_Item_Class structure contains the following
20078 * - @c func.get - When an item is displayed, this function is
20079 * called, and it's where one should create the item object, de
20080 * facto. For example, the object can be a pure Evas image object
20081 * or an Elementary @ref Photocam "photocam" widget. See
20082 * #SlideshowItemGetFunc.
20083 * - @c func.del - When an item is no more displayed, this function
20084 * is called, where the user must delete any data associated to
20085 * the item. See #SlideshowItemDelFunc.
20087 * @section Slideshow_Caching Slideshow caching
20089 * The slideshow provides facilities to have items adjacent to the
20090 * one being displayed <b>already "realized"</b> (i.e. loaded) for
20091 * you, so that the system does not have to decode image data
20092 * anymore at the time it has to actually switch images on its
20093 * viewport. The user is able to set the numbers of items to be
20094 * cached @b before and @b after the current item, in the widget's
20097 * Smart events one can add callbacks for are:
20099 * - @c "changed" - when the slideshow switches its view to a new
20102 * List of examples for the slideshow widget:
20103 * @li @ref slideshow_example
20107 * @addtogroup Slideshow
20111 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20112 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20113 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
20114 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20115 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20118 * @struct _Elm_Slideshow_Item_Class
20120 * Slideshow item class definition. See @ref Slideshow_Items for
20123 struct _Elm_Slideshow_Item_Class
20125 struct _Elm_Slideshow_Item_Class_Func
20127 SlideshowItemGetFunc get;
20128 SlideshowItemDelFunc del;
20130 }; /**< #Elm_Slideshow_Item_Class member definitions */
20133 * Add a new slideshow widget to the given parent Elementary
20134 * (container) object
20136 * @param parent The parent object
20137 * @return A new slideshow widget handle or @c NULL, on errors
20139 * This function inserts a new slideshow widget on the canvas.
20141 * @ingroup Slideshow
20143 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20146 * Add (append) a new item in a given slideshow widget.
20148 * @param obj The slideshow object
20149 * @param itc The item class for the item
20150 * @param data The item's data
20151 * @return A handle to the item added or @c NULL, on errors
20153 * Add a new item to @p obj's internal list of items, appending it.
20154 * The item's class must contain the function really fetching the
20155 * image object to show for this item, which could be an Evas image
20156 * object or an Elementary photo, for example. The @p data
20157 * parameter is going to be passed to both class functions of the
20160 * @see #Elm_Slideshow_Item_Class
20161 * @see elm_slideshow_item_sorted_insert()
20163 * @ingroup Slideshow
20165 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20168 * Insert a new item into the given slideshow widget, using the @p func
20169 * function to sort items (by item handles).
20171 * @param obj The slideshow object
20172 * @param itc The item class for the item
20173 * @param data The item's data
20174 * @param func The comparing function to be used to sort slideshow
20175 * items <b>by #Elm_Slideshow_Item item handles</b>
20176 * @return Returns The slideshow item handle, on success, or
20177 * @c NULL, on errors
20179 * Add a new item to @p obj's internal list of items, in a position
20180 * determined by the @p func comparing function. The item's class
20181 * must contain the function really fetching the image object to
20182 * show for this item, which could be an Evas image object or an
20183 * Elementary photo, for example. The @p data parameter is going to
20184 * be passed to both class functions of the item.
20186 * @see #Elm_Slideshow_Item_Class
20187 * @see elm_slideshow_item_add()
20189 * @ingroup Slideshow
20191 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);
20194 * Display a given slideshow widget's item, programmatically.
20196 * @param obj The slideshow object
20197 * @param item The item to display on @p obj's viewport
20199 * The change between the current item and @p item will use the
20200 * transition @p obj is set to use (@see
20201 * elm_slideshow_transition_set()).
20203 * @ingroup Slideshow
20205 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20208 * Slide to the @b next item, in a given slideshow widget
20210 * @param obj The slideshow object
20212 * The sliding animation @p obj is set to use will be the
20213 * transition effect used, after this call is issued.
20215 * @note If the end of the slideshow's internal list of items is
20216 * reached, it'll wrap around to the list's beginning, again.
20218 * @ingroup Slideshow
20220 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20223 * Slide to the @b previous item, in a given slideshow widget
20225 * @param obj The slideshow object
20227 * The sliding animation @p obj is set to use will be the
20228 * transition effect used, after this call is issued.
20230 * @note If the beginning of the slideshow's internal list of items
20231 * is reached, it'll wrap around to the list's end, again.
20233 * @ingroup Slideshow
20235 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20238 * Returns the list of sliding transition/effect names available, for a
20239 * given slideshow widget.
20241 * @param obj The slideshow object
20242 * @return The list of transitions (list of @b stringshared strings
20245 * The transitions, which come from @p obj's theme, must be an EDC
20246 * data item named @c "transitions" on the theme file, with (prefix)
20247 * names of EDC programs actually implementing them.
20249 * The available transitions for slideshows on the default theme are:
20250 * - @c "fade" - the current item fades out, while the new one
20251 * fades in to the slideshow's viewport.
20252 * - @c "black_fade" - the current item fades to black, and just
20253 * then, the new item will fade in.
20254 * - @c "horizontal" - the current item slides horizontally, until
20255 * it gets out of the slideshow's viewport, while the new item
20256 * comes from the left to take its place.
20257 * - @c "vertical" - the current item slides vertically, until it
20258 * gets out of the slideshow's viewport, while the new item comes
20259 * from the bottom to take its place.
20260 * - @c "square" - the new item starts to appear from the middle of
20261 * the current one, but with a tiny size, growing until its
20262 * target (full) size and covering the old one.
20264 * @warning The stringshared strings get no new references
20265 * exclusive to the user grabbing the list, here, so if you'd like
20266 * to use them out of this call's context, you'd better @c
20267 * eina_stringshare_ref() them.
20269 * @see elm_slideshow_transition_set()
20271 * @ingroup Slideshow
20273 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20276 * Set the current slide transition/effect in use for a given
20279 * @param obj The slideshow object
20280 * @param transition The new transition's name string
20282 * If @p transition is implemented in @p obj's theme (i.e., is
20283 * contained in the list returned by
20284 * elm_slideshow_transitions_get()), this new sliding effect will
20285 * be used on the widget.
20287 * @see elm_slideshow_transitions_get() for more details
20289 * @ingroup Slideshow
20291 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20294 * Get the current slide transition/effect in use for a given
20297 * @param obj The slideshow object
20298 * @return The current transition's name
20300 * @see elm_slideshow_transition_set() for more details
20302 * @ingroup Slideshow
20304 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20307 * Set the interval between each image transition on a given
20308 * slideshow widget, <b>and start the slideshow, itself</b>
20310 * @param obj The slideshow object
20311 * @param timeout The new displaying timeout for images
20313 * After this call, the slideshow widget will start cycling its
20314 * view, sequentially and automatically, with the images of the
20315 * items it has. The time between each new image displayed is going
20316 * to be @p timeout, in @b seconds. If a different timeout was set
20317 * previously and an slideshow was in progress, it will continue
20318 * with the new time between transitions, after this call.
20320 * @note A value less than or equal to 0 on @p timeout will disable
20321 * the widget's internal timer, thus halting any slideshow which
20322 * could be happening on @p obj.
20324 * @see elm_slideshow_timeout_get()
20326 * @ingroup Slideshow
20328 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20331 * Get the interval set for image transitions on a given slideshow
20334 * @param obj The slideshow object
20335 * @return Returns the timeout set on it
20337 * @see elm_slideshow_timeout_set() for more details
20339 * @ingroup Slideshow
20341 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20344 * Set if, after a slideshow is started, for a given slideshow
20345 * widget, its items should be displayed cyclically or not.
20347 * @param obj The slideshow object
20348 * @param loop Use @c EINA_TRUE to make it cycle through items or
20349 * @c EINA_FALSE for it to stop at the end of @p obj's internal
20352 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20353 * ignore what is set by this functions, i.e., they'll @b always
20354 * cycle through items. This affects only the "automatic"
20355 * slideshow, as set by elm_slideshow_timeout_set().
20357 * @see elm_slideshow_loop_get()
20359 * @ingroup Slideshow
20361 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20364 * Get if, after a slideshow is started, for a given slideshow
20365 * widget, its items are to be displayed cyclically or not.
20367 * @param obj The slideshow object
20368 * @return @c EINA_TRUE, if the items in @p obj will be cycled
20369 * through or @c EINA_FALSE, otherwise
20371 * @see elm_slideshow_loop_set() for more details
20373 * @ingroup Slideshow
20375 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20378 * Remove all items from a given slideshow widget
20380 * @param obj The slideshow object
20382 * This removes (and deletes) all items in @p obj, leaving it
20385 * @see elm_slideshow_item_del(), to remove just one item.
20387 * @ingroup Slideshow
20389 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20392 * Get the internal list of items in a given slideshow widget.
20394 * @param obj The slideshow object
20395 * @return The list of items (#Elm_Slideshow_Item as data) or
20396 * @c NULL on errors.
20398 * This list is @b not to be modified in any way and must not be
20399 * freed. Use the list members with functions like
20400 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20402 * @warning This list is only valid until @p obj object's internal
20403 * items list is changed. It should be fetched again with another
20404 * call to this function when changes happen.
20406 * @ingroup Slideshow
20408 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20411 * Delete a given item from a slideshow widget.
20413 * @param item The slideshow item
20415 * @ingroup Slideshow
20417 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20420 * Return the data associated with a given slideshow item
20422 * @param item The slideshow item
20423 * @return Returns the data associated to this item
20425 * @ingroup Slideshow
20427 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20430 * Returns the currently displayed item, in a given slideshow widget
20432 * @param obj The slideshow object
20433 * @return A handle to the item being displayed in @p obj or
20434 * @c NULL, if none is (and on errors)
20436 * @ingroup Slideshow
20438 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20441 * Get the real Evas object created to implement the view of a
20442 * given slideshow item
20444 * @param item The slideshow item.
20445 * @return the Evas object implementing this item's view.
20447 * This returns the actual Evas object used to implement the
20448 * specified slideshow item's view. This may be @c NULL, as it may
20449 * not have been created or may have been deleted, at any time, by
20450 * the slideshow. <b>Do not modify this object</b> (move, resize,
20451 * show, hide, etc.), as the slideshow is controlling it. This
20452 * function is for querying, emitting custom signals or hooking
20453 * lower level callbacks for events on that object. Do not delete
20454 * this object under any circumstances.
20456 * @see elm_slideshow_item_data_get()
20458 * @ingroup Slideshow
20460 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20463 * Get the the item, in a given slideshow widget, placed at
20464 * position @p nth, in its internal items list
20466 * @param obj The slideshow object
20467 * @param nth The number of the item to grab a handle to (0 being
20469 * @return The item stored in @p obj at position @p nth or @c NULL,
20470 * if there's no item with that index (and on errors)
20472 * @ingroup Slideshow
20474 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20477 * Set the current slide layout in use for a given slideshow widget
20479 * @param obj The slideshow object
20480 * @param layout The new layout's name string
20482 * If @p layout is implemented in @p obj's theme (i.e., is contained
20483 * in the list returned by elm_slideshow_layouts_get()), this new
20484 * images layout will be used on the widget.
20486 * @see elm_slideshow_layouts_get() for more details
20488 * @ingroup Slideshow
20490 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20493 * Get the current slide layout in use for a given slideshow widget
20495 * @param obj The slideshow object
20496 * @return The current layout's name
20498 * @see elm_slideshow_layout_set() for more details
20500 * @ingroup Slideshow
20502 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20505 * Returns the list of @b layout names available, for a given
20506 * slideshow widget.
20508 * @param obj The slideshow object
20509 * @return The list of layouts (list of @b stringshared strings
20512 * Slideshow layouts will change how the widget is to dispose each
20513 * image item in its viewport, with regard to cropping, scaling,
20516 * The layouts, which come from @p obj's theme, must be an EDC
20517 * data item name @c "layouts" on the theme file, with (prefix)
20518 * names of EDC programs actually implementing them.
20520 * The available layouts for slideshows on the default theme are:
20521 * - @c "fullscreen" - item images with original aspect, scaled to
20522 * touch top and down slideshow borders or, if the image's heigh
20523 * is not enough, left and right slideshow borders.
20524 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20525 * one, but always leaving 10% of the slideshow's dimensions of
20526 * distance between the item image's borders and the slideshow
20527 * borders, for each axis.
20529 * @warning The stringshared strings get no new references
20530 * exclusive to the user grabbing the list, here, so if you'd like
20531 * to use them out of this call's context, you'd better @c
20532 * eina_stringshare_ref() them.
20534 * @see elm_slideshow_layout_set()
20536 * @ingroup Slideshow
20538 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20541 * Set the number of items to cache, on a given slideshow widget,
20542 * <b>before the current item</b>
20544 * @param obj The slideshow object
20545 * @param count Number of items to cache before the current one
20547 * The default value for this property is @c 2. See
20548 * @ref Slideshow_Caching "slideshow caching" for more details.
20550 * @see elm_slideshow_cache_before_get()
20552 * @ingroup Slideshow
20554 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20557 * Retrieve the number of items to cache, on a given slideshow widget,
20558 * <b>before the current item</b>
20560 * @param obj The slideshow object
20561 * @return The number of items set to be cached before the current one
20563 * @see elm_slideshow_cache_before_set() for more details
20565 * @ingroup Slideshow
20567 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20570 * Set the number of items to cache, on a given slideshow widget,
20571 * <b>after the current item</b>
20573 * @param obj The slideshow object
20574 * @param count Number of items to cache after the current one
20576 * The default value for this property is @c 2. See
20577 * @ref Slideshow_Caching "slideshow caching" for more details.
20579 * @see elm_slideshow_cache_after_get()
20581 * @ingroup Slideshow
20583 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20586 * Retrieve the number of items to cache, on a given slideshow widget,
20587 * <b>after the current item</b>
20589 * @param obj The slideshow object
20590 * @return The number of items set to be cached after the current one
20592 * @see elm_slideshow_cache_after_set() for more details
20594 * @ingroup Slideshow
20596 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20599 * Get the number of items stored in a given slideshow widget
20601 * @param obj The slideshow object
20602 * @return The number of items on @p obj, at the moment of this call
20604 * @ingroup Slideshow
20606 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20613 * @defgroup Fileselector File Selector
20615 * @image html img/widget/fileselector/preview-00.png
20616 * @image latex img/widget/fileselector/preview-00.eps
20618 * A file selector is a widget that allows a user to navigate
20619 * through a file system, reporting file selections back via its
20622 * It contains shortcut buttons for home directory (@c ~) and to
20623 * jump one directory upwards (..), as well as cancel/ok buttons to
20624 * confirm/cancel a given selection. After either one of those two
20625 * former actions, the file selector will issue its @c "done" smart
20628 * There's a text entry on it, too, showing the name of the current
20629 * selection. There's the possibility of making it editable, so it
20630 * is useful on file saving dialogs on applications, where one
20631 * gives a file name to save contents to, in a given directory in
20632 * the system. This custom file name will be reported on the @c
20633 * "done" smart callback (explained in sequence).
20635 * Finally, it has a view to display file system items into in two
20640 * If Elementary is built with support of the Ethumb thumbnailing
20641 * library, the second form of view will display preview thumbnails
20642 * of files which it supports.
20644 * Smart callbacks one can register to:
20646 * - @c "selected" - the user has clicked on a file (when not in
20647 * folders-only mode) or directory (when in folders-only mode)
20648 * - @c "directory,open" - the list has been populated with new
20649 * content (@c event_info is a pointer to the directory's
20650 * path, a @b stringshared string)
20651 * - @c "done" - the user has clicked on the "ok" or "cancel"
20652 * buttons (@c event_info is a pointer to the selection's
20653 * path, a @b stringshared string)
20655 * Here is an example on its usage:
20656 * @li @ref fileselector_example
20660 * @addtogroup Fileselector
20665 * Defines how a file selector widget is to layout its contents
20666 * (file system entries).
20668 typedef enum _Elm_Fileselector_Mode
20670 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20671 ELM_FILESELECTOR_GRID, /**< layout as a grid */
20672 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20673 } Elm_Fileselector_Mode;
20676 * Add a new file selector widget to the given parent Elementary
20677 * (container) object
20679 * @param parent The parent object
20680 * @return a new file selector widget handle or @c NULL, on errors
20682 * This function inserts a new file selector widget on the canvas.
20684 * @ingroup Fileselector
20686 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20689 * Enable/disable the file name entry box where the user can type
20690 * in a name for a file, in a given file selector widget
20692 * @param obj The file selector object
20693 * @param is_save @c EINA_TRUE to make the file selector a "saving
20694 * dialog", @c EINA_FALSE otherwise
20696 * Having the entry editable is useful on file saving dialogs on
20697 * applications, where one gives a file name to save contents to,
20698 * in a given directory in the system. This custom file name will
20699 * be reported on the @c "done" smart callback.
20701 * @see elm_fileselector_is_save_get()
20703 * @ingroup Fileselector
20705 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20708 * Get whether the given file selector is in "saving dialog" mode
20710 * @param obj The file selector object
20711 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20712 * mode, @c EINA_FALSE otherwise (and on errors)
20714 * @see elm_fileselector_is_save_set() for more details
20716 * @ingroup Fileselector
20718 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20721 * Enable/disable folder-only view for a given file selector widget
20723 * @param obj The file selector object
20724 * @param only @c EINA_TRUE to make @p obj only display
20725 * directories, @c EINA_FALSE to make files to be displayed in it
20728 * If enabled, the widget's view will only display folder items,
20731 * @see elm_fileselector_folder_only_get()
20733 * @ingroup Fileselector
20735 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20738 * Get whether folder-only view is set for a given file selector
20741 * @param obj The file selector object
20742 * @return only @c EINA_TRUE if @p obj is only displaying
20743 * directories, @c EINA_FALSE if files are being displayed in it
20744 * too (and on errors)
20746 * @see elm_fileselector_folder_only_get()
20748 * @ingroup Fileselector
20750 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20753 * Enable/disable the "ok" and "cancel" buttons on a given file
20756 * @param obj The file selector object
20757 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20759 * @note A file selector without those buttons will never emit the
20760 * @c "done" smart event, and is only usable if one is just hooking
20761 * to the other two events.
20763 * @see elm_fileselector_buttons_ok_cancel_get()
20765 * @ingroup Fileselector
20767 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20770 * Get whether the "ok" and "cancel" buttons on a given file
20771 * selector widget are being shown.
20773 * @param obj The file selector object
20774 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20775 * otherwise (and on errors)
20777 * @see elm_fileselector_buttons_ok_cancel_set() for more details
20779 * @ingroup Fileselector
20781 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20784 * Enable/disable a tree view in the given file selector widget,
20785 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20787 * @param obj The file selector object
20788 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20791 * In a tree view, arrows are created on the sides of directories,
20792 * allowing them to expand in place.
20794 * @note If it's in other mode, the changes made by this function
20795 * will only be visible when one switches back to "list" mode.
20797 * @see elm_fileselector_expandable_get()
20799 * @ingroup Fileselector
20801 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20804 * Get whether tree view is enabled for the given file selector
20807 * @param obj The file selector object
20808 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20809 * otherwise (and or errors)
20811 * @see elm_fileselector_expandable_set() for more details
20813 * @ingroup Fileselector
20815 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20818 * Set, programmatically, the @b directory that a given file
20819 * selector widget will display contents from
20821 * @param obj The file selector object
20822 * @param path The path to display in @p obj
20824 * This will change the @b directory that @p obj is displaying. It
20825 * will also clear the text entry area on the @p obj object, which
20826 * displays select files' names.
20828 * @see elm_fileselector_path_get()
20830 * @ingroup Fileselector
20832 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20835 * Get the parent directory's path that a given file selector
20836 * widget is displaying
20838 * @param obj The file selector object
20839 * @return The (full) path of the directory the file selector is
20840 * displaying, a @b stringshared string
20842 * @see elm_fileselector_path_set()
20844 * @ingroup Fileselector
20846 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20849 * Set, programmatically, the currently selected file/directory in
20850 * the given file selector widget
20852 * @param obj The file selector object
20853 * @param path The (full) path to a file or directory
20854 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
20855 * latter case occurs if the directory or file pointed to do not
20858 * @see elm_fileselector_selected_get()
20860 * @ingroup Fileselector
20862 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20865 * Get the currently selected item's (full) path, in the given file
20868 * @param obj The file selector object
20869 * @return The absolute path of the selected item, a @b
20870 * stringshared string
20872 * @note Custom editions on @p obj object's text entry, if made,
20873 * will appear on the return string of this function, naturally.
20875 * @see elm_fileselector_selected_set() for more details
20877 * @ingroup Fileselector
20879 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20882 * Set the mode in which a given file selector widget will display
20883 * (layout) file system entries in its view
20885 * @param obj The file selector object
20886 * @param mode The mode of the fileselector, being it one of
20887 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
20888 * first one, naturally, will display the files in a list. The
20889 * latter will make the widget to display its entries in a grid
20892 * @note By using elm_fileselector_expandable_set(), the user may
20893 * trigger a tree view for that list.
20895 * @note If Elementary is built with support of the Ethumb
20896 * thumbnailing library, the second form of view will display
20897 * preview thumbnails of files which it supports. You must have
20898 * elm_need_ethumb() called in your Elementary for thumbnailing to
20901 * @see elm_fileselector_expandable_set().
20902 * @see elm_fileselector_mode_get().
20904 * @ingroup Fileselector
20906 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
20909 * Get the mode in which a given file selector widget is displaying
20910 * (layouting) file system entries in its view
20912 * @param obj The fileselector object
20913 * @return The mode in which the fileselector is at
20915 * @see elm_fileselector_mode_set() for more details
20917 * @ingroup Fileselector
20919 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20926 * @defgroup Progressbar Progress bar
20928 * The progress bar is a widget for visually representing the
20929 * progress status of a given job/task.
20931 * A progress bar may be horizontal or vertical. It may display an
20932 * icon besides it, as well as primary and @b units labels. The
20933 * former is meant to label the widget as a whole, while the
20934 * latter, which is formatted with floating point values (and thus
20935 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
20936 * units"</c>), is meant to label the widget's <b>progress
20937 * value</b>. Label, icon and unit strings/objects are @b optional
20938 * for progress bars.
20940 * A progress bar may be @b inverted, in which state it gets its
20941 * values inverted, with high values being on the left or top and
20942 * low values on the right or bottom, as opposed to normally have
20943 * the low values on the former and high values on the latter,
20944 * respectively, for horizontal and vertical modes.
20946 * The @b span of the progress, as set by
20947 * elm_progressbar_span_size_set(), is its length (horizontally or
20948 * vertically), unless one puts size hints on the widget to expand
20949 * on desired directions, by any container. That length will be
20950 * scaled by the object or applications scaling factor. At any
20951 * point code can query the progress bar for its value with
20952 * elm_progressbar_value_get().
20954 * Available widget styles for progress bars:
20956 * - @c "wheel" (simple style, no text, no progression, only
20957 * "pulse" effect is available)
20959 * Default contents parts of the progressbar widget that you can use for are:
20960 * @li "elm.swallow.content" - A icon of the progressbar
20962 * Here is an example on its usage:
20963 * @li @ref progressbar_example
20967 * Add a new progress bar widget to the given parent Elementary
20968 * (container) object
20970 * @param parent The parent object
20971 * @return a new progress bar widget handle or @c NULL, on errors
20973 * This function inserts a new progress bar widget on the canvas.
20975 * @ingroup Progressbar
20977 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20980 * Set whether a given progress bar widget is at "pulsing mode" or
20983 * @param obj The progress bar object
20984 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
20985 * @c EINA_FALSE to put it back to its default one
20987 * By default, progress bars will display values from the low to
20988 * high value boundaries. There are, though, contexts in which the
20989 * state of progression of a given task is @b unknown. For those,
20990 * one can set a progress bar widget to a "pulsing state", to give
20991 * the user an idea that some computation is being held, but
20992 * without exact progress values. In the default theme it will
20993 * animate its bar with the contents filling in constantly and back
20994 * to non-filled, in a loop. To start and stop this pulsing
20995 * animation, one has to explicitly call elm_progressbar_pulse().
20997 * @see elm_progressbar_pulse_get()
20998 * @see elm_progressbar_pulse()
21000 * @ingroup Progressbar
21002 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21005 * Get whether a given progress bar widget is at "pulsing mode" or
21008 * @param obj The progress bar object
21009 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21010 * if it's in the default one (and on errors)
21012 * @ingroup Progressbar
21014 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21017 * Start/stop a given progress bar "pulsing" animation, if its
21020 * @param obj The progress bar object
21021 * @param state @c EINA_TRUE, to @b start the pulsing animation,
21022 * @c EINA_FALSE to @b stop it
21024 * @note This call won't do anything if @p obj is not under "pulsing mode".
21026 * @see elm_progressbar_pulse_set() for more details.
21028 * @ingroup Progressbar
21030 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21033 * Set the progress value (in percentage) on a given progress bar
21036 * @param obj The progress bar object
21037 * @param val The progress value (@b must be between @c 0.0 and @c
21040 * Use this call to set progress bar levels.
21042 * @note If you passes a value out of the specified range for @p
21043 * val, it will be interpreted as the @b closest of the @b boundary
21044 * values in the range.
21046 * @ingroup Progressbar
21048 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21051 * Get the progress value (in percentage) on a given progress bar
21054 * @param obj The progress bar object
21055 * @return The value of the progressbar
21057 * @see elm_progressbar_value_set() for more details
21059 * @ingroup Progressbar
21061 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21064 * Set the label of a given progress bar widget
21066 * @param obj The progress bar object
21067 * @param label The text label string, in UTF-8
21069 * @ingroup Progressbar
21070 * @deprecated use elm_object_text_set() instead.
21072 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21075 * Get the label of a given progress bar widget
21077 * @param obj The progressbar object
21078 * @return The text label string, in UTF-8
21080 * @ingroup Progressbar
21081 * @deprecated use elm_object_text_set() instead.
21083 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21086 * Set the icon object of a given progress bar widget
21088 * @param obj The progress bar object
21089 * @param icon The icon object
21091 * Use this call to decorate @p obj with an icon next to it.
21093 * @note Once the icon object is set, a previously set one will be
21094 * deleted. If you want to keep that old content object, use the
21095 * elm_progressbar_icon_unset() function.
21097 * @see elm_progressbar_icon_get()
21099 * @ingroup Progressbar
21101 EINA_DEPRECATED EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21104 * Retrieve the icon object set for a given progress bar widget
21106 * @param obj The progress bar object
21107 * @return The icon object's handle, if @p obj had one set, or @c NULL,
21108 * otherwise (and on errors)
21110 * @see elm_progressbar_icon_set() for more details
21112 * @ingroup Progressbar
21114 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21117 * Unset an icon set on a given progress bar widget
21119 * @param obj The progress bar object
21120 * @return The icon object that was being used, if any was set, or
21121 * @c NULL, otherwise (and on errors)
21123 * This call will unparent and return the icon object which was set
21124 * for this widget, previously, on success.
21126 * @see elm_progressbar_icon_set() for more details
21128 * @ingroup Progressbar
21130 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21133 * Set the (exact) length of the bar region of a given progress bar
21136 * @param obj The progress bar object
21137 * @param size The length of the progress bar's bar region
21139 * This sets the minimum width (when in horizontal mode) or height
21140 * (when in vertical mode) of the actual bar area of the progress
21141 * bar @p obj. This in turn affects the object's minimum size. Use
21142 * this when you're not setting other size hints expanding on the
21143 * given direction (like weight and alignment hints) and you would
21144 * like it to have a specific size.
21146 * @note Icon, label and unit text around @p obj will require their
21147 * own space, which will make @p obj to require more the @p size,
21150 * @see elm_progressbar_span_size_get()
21152 * @ingroup Progressbar
21154 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21157 * Get the length set for the bar region of a given progress bar
21160 * @param obj The progress bar object
21161 * @return The length of the progress bar's bar region
21163 * If that size was not set previously, with
21164 * elm_progressbar_span_size_set(), this call will return @c 0.
21166 * @ingroup Progressbar
21168 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21171 * Set the format string for a given progress bar widget's units
21174 * @param obj The progress bar object
21175 * @param format The format string for @p obj's units label
21177 * If @c NULL is passed on @p format, it will make @p obj's units
21178 * area to be hidden completely. If not, it'll set the <b>format
21179 * string</b> for the units label's @b text. The units label is
21180 * provided a floating point value, so the units text is up display
21181 * at most one floating point falue. Note that the units label is
21182 * optional. Use a format string such as "%1.2f meters" for
21185 * @note The default format string for a progress bar is an integer
21186 * percentage, as in @c "%.0f %%".
21188 * @see elm_progressbar_unit_format_get()
21190 * @ingroup Progressbar
21192 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21195 * Retrieve the format string set for a given progress bar widget's
21198 * @param obj The progress bar object
21199 * @return The format set string for @p obj's units label or
21200 * @c NULL, if none was set (and on errors)
21202 * @see elm_progressbar_unit_format_set() for more details
21204 * @ingroup Progressbar
21206 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21209 * Set the orientation of a given progress bar widget
21211 * @param obj The progress bar object
21212 * @param horizontal Use @c EINA_TRUE to make @p obj to be
21213 * @b horizontal, @c EINA_FALSE to make it @b vertical
21215 * Use this function to change how your progress bar is to be
21216 * disposed: vertically or horizontally.
21218 * @see elm_progressbar_horizontal_get()
21220 * @ingroup Progressbar
21222 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21225 * Retrieve the orientation of a given progress bar widget
21227 * @param obj The progress bar object
21228 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21229 * @c EINA_FALSE if it's @b vertical (and on errors)
21231 * @see elm_progressbar_horizontal_set() for more details
21233 * @ingroup Progressbar
21235 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21238 * Invert a given progress bar widget's displaying values order
21240 * @param obj The progress bar object
21241 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21242 * @c EINA_FALSE to bring it back to default, non-inverted values.
21244 * A progress bar may be @b inverted, in which state it gets its
21245 * values inverted, with high values being on the left or top and
21246 * low values on the right or bottom, as opposed to normally have
21247 * the low values on the former and high values on the latter,
21248 * respectively, for horizontal and vertical modes.
21250 * @see elm_progressbar_inverted_get()
21252 * @ingroup Progressbar
21254 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21257 * Get whether a given progress bar widget's displaying values are
21260 * @param obj The progress bar object
21261 * @return @c EINA_TRUE, if @p obj has inverted values,
21262 * @c EINA_FALSE otherwise (and on errors)
21264 * @see elm_progressbar_inverted_set() for more details
21266 * @ingroup Progressbar
21268 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21271 * @defgroup Separator Separator
21273 * @brief Separator is a very thin object used to separate other objects.
21275 * A separator can be vertical or horizontal.
21277 * @ref tutorial_separator is a good example of how to use a separator.
21281 * @brief Add a separator object to @p parent
21283 * @param parent The parent object
21285 * @return The separator object, or NULL upon failure
21287 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21289 * @brief Set the horizontal mode of a separator object
21291 * @param obj The separator object
21292 * @param horizontal If true, the separator is horizontal
21294 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21296 * @brief Get the horizontal mode of a separator object
21298 * @param obj The separator object
21299 * @return If true, the separator is horizontal
21301 * @see elm_separator_horizontal_set()
21303 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21309 * @defgroup Spinner Spinner
21310 * @ingroup Elementary
21312 * @image html img/widget/spinner/preview-00.png
21313 * @image latex img/widget/spinner/preview-00.eps
21315 * A spinner is a widget which allows the user to increase or decrease
21316 * numeric values using arrow buttons, or edit values directly, clicking
21317 * over it and typing the new value.
21319 * By default the spinner will not wrap and has a label
21320 * of "%.0f" (just showing the integer value of the double).
21322 * A spinner has a label that is formatted with floating
21323 * point values and thus accepts a printf-style format string, like
21324 * ā%1.2f unitsā.
21326 * It also allows specific values to be replaced by pre-defined labels.
21328 * Smart callbacks one can register to:
21330 * - "changed" - Whenever the spinner value is changed.
21331 * - "delay,changed" - A short time after the value is changed by the user.
21332 * This will be called only when the user stops dragging for a very short
21333 * period or when they release their finger/mouse, so it avoids possibly
21334 * expensive reactions to the value change.
21336 * Available styles for it:
21338 * - @c "vertical": up/down buttons at the right side and text left aligned.
21340 * Here is an example on its usage:
21341 * @ref spinner_example
21345 * @addtogroup Spinner
21350 * Add a new spinner widget to the given parent Elementary
21351 * (container) object.
21353 * @param parent The parent object.
21354 * @return a new spinner widget handle or @c NULL, on errors.
21356 * This function inserts a new spinner widget on the canvas.
21361 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21364 * Set the format string of the displayed label.
21366 * @param obj The spinner object.
21367 * @param fmt The format string for the label display.
21369 * If @c NULL, this sets the format to "%.0f". If not it sets the format
21370 * string for the label text. The label text is provided a floating point
21371 * value, so the label text can display up to 1 floating point value.
21372 * Note that this is optional.
21374 * Use a format string such as "%1.2f meters" for example, and it will
21375 * display values like: "3.14 meters" for a value equal to 3.14159.
21377 * Default is "%0.f".
21379 * @see elm_spinner_label_format_get()
21383 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21386 * Get the label format of the spinner.
21388 * @param obj The spinner object.
21389 * @return The text label format string in UTF-8.
21391 * @see elm_spinner_label_format_set() for details.
21395 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21398 * Set the minimum and maximum values for the spinner.
21400 * @param obj The spinner object.
21401 * @param min The minimum value.
21402 * @param max The maximum value.
21404 * Define the allowed range of values to be selected by the user.
21406 * If actual value is less than @p min, it will be updated to @p min. If it
21407 * is bigger then @p max, will be updated to @p max. Actual value can be
21408 * get with elm_spinner_value_get().
21410 * By default, min is equal to 0, and max is equal to 100.
21412 * @warning Maximum must be greater than minimum.
21414 * @see elm_spinner_min_max_get()
21418 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21421 * Get the minimum and maximum values of the spinner.
21423 * @param obj The spinner object.
21424 * @param min Pointer where to store the minimum value.
21425 * @param max Pointer where to store the maximum value.
21427 * @note If only one value is needed, the other pointer can be passed
21430 * @see elm_spinner_min_max_set() for details.
21434 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21437 * Set the step used to increment or decrement the spinner value.
21439 * @param obj The spinner object.
21440 * @param step The step value.
21442 * This value will be incremented or decremented to the displayed value.
21443 * It will be incremented while the user keep right or top arrow pressed,
21444 * and will be decremented while the user keep left or bottom arrow pressed.
21446 * The interval to increment / decrement can be set with
21447 * elm_spinner_interval_set().
21449 * By default step value is equal to 1.
21451 * @see elm_spinner_step_get()
21455 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21458 * Get the step used to increment or decrement the spinner value.
21460 * @param obj The spinner object.
21461 * @return The step value.
21463 * @see elm_spinner_step_get() for more details.
21467 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21470 * Set the value the spinner displays.
21472 * @param obj The spinner object.
21473 * @param val The value to be displayed.
21475 * Value will be presented on the label following format specified with
21476 * elm_spinner_format_set().
21478 * @warning The value must to be between min and max values. This values
21479 * are set by elm_spinner_min_max_set().
21481 * @see elm_spinner_value_get().
21482 * @see elm_spinner_format_set().
21483 * @see elm_spinner_min_max_set().
21487 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21490 * Get the value displayed by the spinner.
21492 * @param obj The spinner object.
21493 * @return The value displayed.
21495 * @see elm_spinner_value_set() for details.
21499 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21502 * Set whether the spinner should wrap when it reaches its
21503 * minimum or maximum value.
21505 * @param obj The spinner object.
21506 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21509 * Disabled by default. If disabled, when the user tries to increment the
21511 * but displayed value plus step value is bigger than maximum value,
21513 * won't allow it. The same happens when the user tries to decrement it,
21514 * but the value less step is less than minimum value.
21516 * When wrap is enabled, in such situations it will allow these changes,
21517 * but will get the value that would be less than minimum and subtracts
21518 * from maximum. Or add the value that would be more than maximum to
21522 * @li min value = 10
21523 * @li max value = 50
21524 * @li step value = 20
21525 * @li displayed value = 20
21527 * When the user decrement value (using left or bottom arrow), it will
21528 * displays @c 40, because max - (min - (displayed - step)) is
21529 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21531 * @see elm_spinner_wrap_get().
21535 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21538 * Get whether the spinner should wrap when it reaches its
21539 * minimum or maximum value.
21541 * @param obj The spinner object
21542 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21543 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21545 * @see elm_spinner_wrap_set() for details.
21549 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21552 * Set whether the spinner can be directly edited by the user or not.
21554 * @param obj The spinner object.
21555 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21556 * don't allow users to edit it directly.
21558 * Spinner objects can have edition @b disabled, in which state they will
21559 * be changed only by arrows.
21560 * Useful for contexts
21561 * where you don't want your users to interact with it writting the value.
21563 * when using special values, the user can see real value instead
21564 * of special label on edition.
21566 * It's enabled by default.
21568 * @see elm_spinner_editable_get()
21572 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21575 * Get whether the spinner can be directly edited by the user or not.
21577 * @param obj The spinner object.
21578 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21579 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21581 * @see elm_spinner_editable_set() for details.
21585 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21588 * Set a special string to display in the place of the numerical value.
21590 * @param obj The spinner object.
21591 * @param value The value to be replaced.
21592 * @param label The label to be used.
21594 * It's useful for cases when a user should select an item that is
21595 * better indicated by a label than a value. For example, weekdays or months.
21599 * sp = elm_spinner_add(win);
21600 * elm_spinner_min_max_set(sp, 1, 3);
21601 * elm_spinner_special_value_add(sp, 1, "January");
21602 * elm_spinner_special_value_add(sp, 2, "February");
21603 * elm_spinner_special_value_add(sp, 3, "March");
21604 * evas_object_show(sp);
21609 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21612 * Set the interval on time updates for an user mouse button hold
21613 * on spinner widgets' arrows.
21615 * @param obj The spinner object.
21616 * @param interval The (first) interval value in seconds.
21618 * This interval value is @b decreased while the user holds the
21619 * mouse pointer either incrementing or decrementing spinner's value.
21621 * This helps the user to get to a given value distant from the
21622 * current one easier/faster, as it will start to change quicker and
21623 * quicker on mouse button holds.
21625 * The calculation for the next change interval value, starting from
21626 * the one set with this call, is the previous interval divided by
21627 * @c 1.05, so it decreases a little bit.
21629 * The default starting interval value for automatic changes is
21632 * @see elm_spinner_interval_get()
21636 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21639 * Get the interval on time updates for an user mouse button hold
21640 * on spinner widgets' arrows.
21642 * @param obj The spinner object.
21643 * @return The (first) interval value, in seconds, set on it.
21645 * @see elm_spinner_interval_set() for more details.
21649 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21656 * @defgroup Index Index
21658 * @image html img/widget/index/preview-00.png
21659 * @image latex img/widget/index/preview-00.eps
21661 * An index widget gives you an index for fast access to whichever
21662 * group of other UI items one might have. It's a list of text
21663 * items (usually letters, for alphabetically ordered access).
21665 * Index widgets are by default hidden and just appear when the
21666 * user clicks over it's reserved area in the canvas. In its
21667 * default theme, it's an area one @ref Fingers "finger" wide on
21668 * the right side of the index widget's container.
21670 * When items on the index are selected, smart callbacks get
21671 * called, so that its user can make other container objects to
21672 * show a given area or child object depending on the index item
21673 * selected. You'd probably be using an index together with @ref
21674 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21677 * Smart events one can add callbacks for are:
21678 * - @c "changed" - When the selected index item changes. @c
21679 * event_info is the selected item's data pointer.
21680 * - @c "delay,changed" - When the selected index item changes, but
21681 * after a small idling period. @c event_info is the selected
21682 * item's data pointer.
21683 * - @c "selected" - When the user releases a mouse button and
21684 * selects an item. @c event_info is the selected item's data
21686 * - @c "level,up" - when the user moves a finger from the first
21687 * level to the second level
21688 * - @c "level,down" - when the user moves a finger from the second
21689 * level to the first level
21691 * The @c "delay,changed" event is so that it'll wait a small time
21692 * before actually reporting those events and, moreover, just the
21693 * last event happening on those time frames will actually be
21696 * Here are some examples on its usage:
21697 * @li @ref index_example_01
21698 * @li @ref index_example_02
21702 * @addtogroup Index
21706 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21709 * Add a new index widget to the given parent Elementary
21710 * (container) object
21712 * @param parent The parent object
21713 * @return a new index widget handle or @c NULL, on errors
21715 * This function inserts a new index widget on the canvas.
21719 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21722 * Set whether a given index widget is or not visible,
21725 * @param obj The index object
21726 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21728 * Not to be confused with visible as in @c evas_object_show() --
21729 * visible with regard to the widget's auto hiding feature.
21731 * @see elm_index_active_get()
21735 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21738 * Get whether a given index widget is currently visible or not.
21740 * @param obj The index object
21741 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21743 * @see elm_index_active_set() for more details
21747 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21750 * Set the items level for a given index widget.
21752 * @param obj The index object.
21753 * @param level @c 0 or @c 1, the currently implemented levels.
21755 * @see elm_index_item_level_get()
21759 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21762 * Get the items level set for a given index widget.
21764 * @param obj The index object.
21765 * @return @c 0 or @c 1, which are the levels @p obj might be at.
21767 * @see elm_index_item_level_set() for more information
21771 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21774 * Returns the last selected item's data, for a given index widget.
21776 * @param obj The index object.
21777 * @return The item @b data associated to the last selected item on
21778 * @p obj (or @c NULL, on errors).
21780 * @warning The returned value is @b not an #Elm_Index_Item item
21781 * handle, but the data associated to it (see the @c item parameter
21782 * in elm_index_item_append(), as an example).
21786 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21789 * Append a new item on a given index widget.
21791 * @param obj The index object.
21792 * @param letter Letter under which the item should be indexed
21793 * @param item The item data to set for the index's item
21795 * Despite the most common usage of the @p letter argument is for
21796 * single char strings, one could use arbitrary strings as index
21799 * @c item will be the pointer returned back on @c "changed", @c
21800 * "delay,changed" and @c "selected" smart events.
21804 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21807 * Prepend a new item on a given index widget.
21809 * @param obj The index object.
21810 * @param letter Letter under which the item should be indexed
21811 * @param item The item data to set for the index's item
21813 * Despite the most common usage of the @p letter argument is for
21814 * single char strings, one could use arbitrary strings as index
21817 * @c item will be the pointer returned back on @c "changed", @c
21818 * "delay,changed" and @c "selected" smart events.
21822 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21825 * Append a new item, on a given index widget, <b>after the item
21826 * having @p relative as data</b>.
21828 * @param obj The index object.
21829 * @param letter Letter under which the item should be indexed
21830 * @param item The item data to set for the index's item
21831 * @param relative The item data of the index item to be the
21832 * predecessor of this new one
21834 * Despite the most common usage of the @p letter argument is for
21835 * single char strings, one could use arbitrary strings as index
21838 * @c item will be the pointer returned back on @c "changed", @c
21839 * "delay,changed" and @c "selected" smart events.
21841 * @note If @p relative is @c NULL or if it's not found to be data
21842 * set on any previous item on @p obj, this function will behave as
21843 * elm_index_item_append().
21847 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21850 * Prepend a new item, on a given index widget, <b>after the item
21851 * having @p relative as data</b>.
21853 * @param obj The index object.
21854 * @param letter Letter under which the item should be indexed
21855 * @param item The item data to set for the index's item
21856 * @param relative The item data of the index item to be the
21857 * successor of this new one
21859 * Despite the most common usage of the @p letter argument is for
21860 * single char strings, one could use arbitrary strings as index
21863 * @c item will be the pointer returned back on @c "changed", @c
21864 * "delay,changed" and @c "selected" smart events.
21866 * @note If @p relative is @c NULL or if it's not found to be data
21867 * set on any previous item on @p obj, this function will behave as
21868 * elm_index_item_prepend().
21872 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21875 * Insert a new item into the given index widget, using @p cmp_func
21876 * function to sort items (by item handles).
21878 * @param obj The index object.
21879 * @param letter Letter under which the item should be indexed
21880 * @param item The item data to set for the index's item
21881 * @param cmp_func The comparing function to be used to sort index
21882 * items <b>by #Elm_Index_Item item handles</b>
21883 * @param cmp_data_func A @b fallback function to be called for the
21884 * sorting of index items <b>by item data</b>). It will be used
21885 * when @p cmp_func returns @c 0 (equality), which means an index
21886 * item with provided item data already exists. To decide which
21887 * data item should be pointed to by the index item in question, @p
21888 * cmp_data_func will be used. If @p cmp_data_func returns a
21889 * non-negative value, the previous index item data will be
21890 * replaced by the given @p item pointer. If the previous data need
21891 * to be freed, it should be done by the @p cmp_data_func function,
21892 * because all references to it will be lost. If this function is
21893 * not provided (@c NULL is given), index items will be @b
21894 * duplicated, if @p cmp_func returns @c 0.
21896 * Despite the most common usage of the @p letter argument is for
21897 * single char strings, one could use arbitrary strings as index
21900 * @c item will be the pointer returned back on @c "changed", @c
21901 * "delay,changed" and @c "selected" smart events.
21905 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);
21908 * Remove an item from a given index widget, <b>to be referenced by
21909 * it's data value</b>.
21911 * @param obj The index object
21912 * @param item The item's data pointer for the item to be removed
21915 * If a deletion callback is set, via elm_index_item_del_cb_set(),
21916 * that callback function will be called by this one.
21918 * @warning The item to be removed from @p obj will be found via
21919 * its item data pointer, and not by an #Elm_Index_Item handle.
21923 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21926 * Find a given index widget's item, <b>using item data</b>.
21928 * @param obj The index object
21929 * @param item The item data pointed to by the desired index item
21930 * @return The index item handle, if found, or @c NULL otherwise
21934 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21937 * Removes @b all items from a given index widget.
21939 * @param obj The index object.
21941 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
21942 * that callback function will be called for each item in @p obj.
21946 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21949 * Go to a given items level on a index widget
21951 * @param obj The index object
21952 * @param level The index level (one of @c 0 or @c 1)
21956 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21959 * Return the data associated with a given index widget item
21961 * @param it The index widget item handle
21962 * @return The data associated with @p it
21964 * @see elm_index_item_data_set()
21968 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21971 * Set the data associated with a given index widget item
21973 * @param it The index widget item handle
21974 * @param data The new data pointer to set to @p it
21976 * This sets new item data on @p it.
21978 * @warning The old data pointer won't be touched by this function, so
21979 * the user had better to free that old data himself/herself.
21983 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
21986 * Set the function to be called when a given index widget item is freed.
21988 * @param it The item to set the callback on
21989 * @param func The function to call on the item's deletion
21991 * When called, @p func will have both @c data and @c event_info
21992 * arguments with the @p it item's data value and, naturally, the
21993 * @c obj argument with a handle to the parent index widget.
21997 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22000 * Get the letter (string) set on a given index widget item.
22002 * @param it The index item handle
22003 * @return The letter string set on @p it
22007 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22014 * @defgroup Photocam Photocam
22016 * @image html img/widget/photocam/preview-00.png
22017 * @image latex img/widget/photocam/preview-00.eps
22019 * This is a widget specifically for displaying high-resolution digital
22020 * camera photos giving speedy feedback (fast load), low memory footprint
22021 * and zooming and panning as well as fitting logic. It is entirely focused
22022 * on jpeg images, and takes advantage of properties of the jpeg format (via
22023 * evas loader features in the jpeg loader).
22025 * Signals that you can add callbacks for are:
22026 * @li "clicked" - This is called when a user has clicked the photo without
22028 * @li "press" - This is called when a user has pressed down on the photo.
22029 * @li "longpressed" - This is called when a user has pressed down on the
22030 * photo for a long time without dragging around.
22031 * @li "clicked,double" - This is called when a user has double-clicked the
22033 * @li "load" - Photo load begins.
22034 * @li "loaded" - This is called when the image file load is complete for the
22035 * first view (low resolution blurry version).
22036 * @li "load,detail" - Photo detailed data load begins.
22037 * @li "loaded,detail" - This is called when the image file load is complete
22038 * for the detailed image data (full resolution needed).
22039 * @li "zoom,start" - Zoom animation started.
22040 * @li "zoom,stop" - Zoom animation stopped.
22041 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22042 * @li "scroll" - the content has been scrolled (moved)
22043 * @li "scroll,anim,start" - scrolling animation has started
22044 * @li "scroll,anim,stop" - scrolling animation has stopped
22045 * @li "scroll,drag,start" - dragging the contents around has started
22046 * @li "scroll,drag,stop" - dragging the contents around has stopped
22048 * @ref tutorial_photocam shows the API in action.
22052 * @brief Types of zoom available.
22054 typedef enum _Elm_Photocam_Zoom_Mode
22056 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
22057 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22058 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22059 ELM_PHOTOCAM_ZOOM_MODE_LAST
22060 } Elm_Photocam_Zoom_Mode;
22062 * @brief Add a new Photocam object
22064 * @param parent The parent object
22065 * @return The new object or NULL if it cannot be created
22067 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22069 * @brief Set the photo file to be shown
22071 * @param obj The photocam object
22072 * @param file The photo file
22073 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22075 * This sets (and shows) the specified file (with a relative or absolute
22076 * path) and will return a load error (same error that
22077 * evas_object_image_load_error_get() will return). The image will change and
22078 * adjust its size at this point and begin a background load process for this
22079 * photo that at some time in the future will be displayed at the full
22082 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22084 * @brief Returns the path of the current image file
22086 * @param obj The photocam object
22087 * @return Returns the path
22089 * @see elm_photocam_file_set()
22091 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22093 * @brief Set the zoom level of the photo
22095 * @param obj The photocam object
22096 * @param zoom The zoom level to set
22098 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22099 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22100 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22101 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22104 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22106 * @brief Get the zoom level of the photo
22108 * @param obj The photocam object
22109 * @return The current zoom level
22111 * This returns the current zoom level of the photocam object. Note that if
22112 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22113 * (which is the default), the zoom level may be changed at any time by the
22114 * photocam object itself to account for photo size and photocam viewpoer
22117 * @see elm_photocam_zoom_set()
22118 * @see elm_photocam_zoom_mode_set()
22120 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22122 * @brief Set the zoom mode
22124 * @param obj The photocam object
22125 * @param mode The desired mode
22127 * This sets the zoom mode to manual or one of several automatic levels.
22128 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22129 * elm_photocam_zoom_set() and will stay at that level until changed by code
22130 * or until zoom mode is changed. This is the default mode. The Automatic
22131 * modes will allow the photocam object to automatically adjust zoom mode
22132 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22133 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22134 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22135 * pixels within the frame are left unfilled.
22137 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22139 * @brief Get the zoom mode
22141 * @param obj The photocam object
22142 * @return The current zoom mode
22144 * This gets the current zoom mode of the photocam object.
22146 * @see elm_photocam_zoom_mode_set()
22148 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22150 * @brief Get the current image pixel width and height
22152 * @param obj The photocam object
22153 * @param w A pointer to the width return
22154 * @param h A pointer to the height return
22156 * This gets the current photo pixel width and height (for the original).
22157 * The size will be returned in the integers @p w and @p h that are pointed
22160 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22162 * @brief Get the area of the image that is currently shown
22165 * @param x A pointer to the X-coordinate of region
22166 * @param y A pointer to the Y-coordinate of region
22167 * @param w A pointer to the width
22168 * @param h A pointer to the height
22170 * @see elm_photocam_image_region_show()
22171 * @see elm_photocam_image_region_bring_in()
22173 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22175 * @brief Set the viewed portion of the image
22177 * @param obj The photocam object
22178 * @param x X-coordinate of region in image original pixels
22179 * @param y Y-coordinate of region in image original pixels
22180 * @param w Width of region in image original pixels
22181 * @param h Height of region in image original pixels
22183 * This shows the region of the image without using animation.
22185 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22187 * @brief Bring in the viewed portion of the image
22189 * @param obj The photocam object
22190 * @param x X-coordinate of region in image original pixels
22191 * @param y Y-coordinate of region in image original pixels
22192 * @param w Width of region in image original pixels
22193 * @param h Height of region in image original pixels
22195 * This shows the region of the image using animation.
22197 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22199 * @brief Set the paused state for photocam
22201 * @param obj The photocam object
22202 * @param paused The pause state to set
22204 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22205 * photocam. The default is off. This will stop zooming using animation on
22206 * zoom levels changes and change instantly. This will stop any existing
22207 * animations that are running.
22209 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22211 * @brief Get the paused state for photocam
22213 * @param obj The photocam object
22214 * @return The current paused state
22216 * This gets the current paused state for the photocam object.
22218 * @see elm_photocam_paused_set()
22220 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22222 * @brief Get the internal low-res image used for photocam
22224 * @param obj The photocam object
22225 * @return The internal image object handle, or NULL if none exists
22227 * This gets the internal image object inside photocam. Do not modify it. It
22228 * is for inspection only, and hooking callbacks to. Nothing else. It may be
22229 * deleted at any time as well.
22231 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22233 * @brief Set the photocam scrolling bouncing.
22235 * @param obj The photocam object
22236 * @param h_bounce bouncing for horizontal
22237 * @param v_bounce bouncing for vertical
22239 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22241 * @brief Get the photocam scrolling bouncing.
22243 * @param obj The photocam object
22244 * @param h_bounce bouncing for horizontal
22245 * @param v_bounce bouncing for vertical
22247 * @see elm_photocam_bounce_set()
22249 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22255 * @defgroup Map Map
22256 * @ingroup Elementary
22258 * @image html img/widget/map/preview-00.png
22259 * @image latex img/widget/map/preview-00.eps
22261 * This is a widget specifically for displaying a map. It uses basically
22262 * OpenStreetMap provider http://www.openstreetmap.org/,
22263 * but custom providers can be added.
22265 * It supports some basic but yet nice features:
22266 * @li zoom and scroll
22267 * @li markers with content to be displayed when user clicks over it
22268 * @li group of markers
22271 * Smart callbacks one can listen to:
22273 * - "clicked" - This is called when a user has clicked the map without
22275 * - "press" - This is called when a user has pressed down on the map.
22276 * - "longpressed" - This is called when a user has pressed down on the map
22277 * for a long time without dragging around.
22278 * - "clicked,double" - This is called when a user has double-clicked
22280 * - "load,detail" - Map detailed data load begins.
22281 * - "loaded,detail" - This is called when all currently visible parts of
22282 * the map are loaded.
22283 * - "zoom,start" - Zoom animation started.
22284 * - "zoom,stop" - Zoom animation stopped.
22285 * - "zoom,change" - Zoom changed when using an auto zoom mode.
22286 * - "scroll" - the content has been scrolled (moved).
22287 * - "scroll,anim,start" - scrolling animation has started.
22288 * - "scroll,anim,stop" - scrolling animation has stopped.
22289 * - "scroll,drag,start" - dragging the contents around has started.
22290 * - "scroll,drag,stop" - dragging the contents around has stopped.
22291 * - "downloaded" - This is called when all currently required map images
22293 * - "route,load" - This is called when route request begins.
22294 * - "route,loaded" - This is called when route request ends.
22295 * - "name,load" - This is called when name request begins.
22296 * - "name,loaded- This is called when name request ends.
22298 * Available style for map widget:
22301 * Available style for markers:
22306 * Available style for marker bubble:
22309 * List of examples:
22310 * @li @ref map_example_01
22311 * @li @ref map_example_02
22312 * @li @ref map_example_03
22321 * @enum _Elm_Map_Zoom_Mode
22322 * @typedef Elm_Map_Zoom_Mode
22324 * Set map's zoom behavior. It can be set to manual or automatic.
22326 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22328 * Values <b> don't </b> work as bitmask, only one can be choosen.
22330 * @note Valid sizes are 2^zoom, consequently the map may be smaller
22331 * than the scroller view.
22333 * @see elm_map_zoom_mode_set()
22334 * @see elm_map_zoom_mode_get()
22338 typedef enum _Elm_Map_Zoom_Mode
22340 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22341 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22342 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22343 ELM_MAP_ZOOM_MODE_LAST
22344 } Elm_Map_Zoom_Mode;
22347 * @enum _Elm_Map_Route_Sources
22348 * @typedef Elm_Map_Route_Sources
22350 * Set route service to be used. By default used source is
22351 * #ELM_MAP_ROUTE_SOURCE_YOURS.
22353 * @see elm_map_route_source_set()
22354 * @see elm_map_route_source_get()
22358 typedef enum _Elm_Map_Route_Sources
22360 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22361 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. */
22362 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22363 ELM_MAP_ROUTE_SOURCE_LAST
22364 } Elm_Map_Route_Sources;
22366 typedef enum _Elm_Map_Name_Sources
22368 ELM_MAP_NAME_SOURCE_NOMINATIM,
22369 ELM_MAP_NAME_SOURCE_LAST
22370 } Elm_Map_Name_Sources;
22373 * @enum _Elm_Map_Route_Type
22374 * @typedef Elm_Map_Route_Type
22376 * Set type of transport used on route.
22378 * @see elm_map_route_add()
22382 typedef enum _Elm_Map_Route_Type
22384 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22385 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22386 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22387 ELM_MAP_ROUTE_TYPE_LAST
22388 } Elm_Map_Route_Type;
22391 * @enum _Elm_Map_Route_Method
22392 * @typedef Elm_Map_Route_Method
22394 * Set the routing method, what should be priorized, time or distance.
22396 * @see elm_map_route_add()
22400 typedef enum _Elm_Map_Route_Method
22402 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22403 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22404 ELM_MAP_ROUTE_METHOD_LAST
22405 } Elm_Map_Route_Method;
22407 typedef enum _Elm_Map_Name_Method
22409 ELM_MAP_NAME_METHOD_SEARCH,
22410 ELM_MAP_NAME_METHOD_REVERSE,
22411 ELM_MAP_NAME_METHOD_LAST
22412 } Elm_Map_Name_Method;
22414 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(). */
22415 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(). */
22416 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(). */
22417 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(). */
22418 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
22419 typedef struct _Elm_Map_Track Elm_Map_Track;
22421 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. */
22422 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22423 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22424 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22426 typedef char *(*ElmMapModuleSourceFunc) (void);
22427 typedef int (*ElmMapModuleZoomMinFunc) (void);
22428 typedef int (*ElmMapModuleZoomMaxFunc) (void);
22429 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22430 typedef int (*ElmMapModuleRouteSourceFunc) (void);
22431 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22432 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22433 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22434 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22437 * Add a new map widget to the given parent Elementary (container) object.
22439 * @param parent The parent object.
22440 * @return a new map widget handle or @c NULL, on errors.
22442 * This function inserts a new map widget on the canvas.
22446 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22449 * Set the zoom level of the map.
22451 * @param obj The map object.
22452 * @param zoom The zoom level to set.
22454 * This sets the zoom level.
22456 * It will respect limits defined by elm_map_source_zoom_min_set() and
22457 * elm_map_source_zoom_max_set().
22459 * By default these values are 0 (world map) and 18 (maximum zoom).
22461 * This function should be used when zoom mode is set to
22462 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22463 * with elm_map_zoom_mode_set().
22465 * @see elm_map_zoom_mode_set().
22466 * @see elm_map_zoom_get().
22470 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22473 * Get the zoom level of the map.
22475 * @param obj The map object.
22476 * @return The current zoom level.
22478 * This returns the current zoom level of the map object.
22480 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22481 * (which is the default), the zoom level may be changed at any time by the
22482 * map object itself to account for map size and map viewport size.
22484 * @see elm_map_zoom_set() for details.
22488 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22491 * Set the zoom mode used by the map object.
22493 * @param obj The map object.
22494 * @param mode The zoom mode of the map, being it one of
22495 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22496 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22498 * This sets the zoom mode to manual or one of the automatic levels.
22499 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22500 * elm_map_zoom_set() and will stay at that level until changed by code
22501 * or until zoom mode is changed. This is the default mode.
22503 * The Automatic modes will allow the map object to automatically
22504 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22505 * adjust zoom so the map fits inside the scroll frame with no pixels
22506 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22507 * ensure no pixels within the frame are left unfilled. Do not forget that
22508 * the valid sizes are 2^zoom, consequently the map may be smaller than
22509 * the scroller view.
22511 * @see elm_map_zoom_set()
22515 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22518 * Get the zoom mode used by the map object.
22520 * @param obj The map object.
22521 * @return The zoom mode of the map, being it one of
22522 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22523 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22525 * This function returns the current zoom mode used by the map object.
22527 * @see elm_map_zoom_mode_set() for more details.
22531 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22534 * Get the current coordinates of the map.
22536 * @param obj The map object.
22537 * @param lon Pointer where to store longitude.
22538 * @param lat Pointer where to store latitude.
22540 * This gets the current center coordinates of the map object. It can be
22541 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22543 * @see elm_map_geo_region_bring_in()
22544 * @see elm_map_geo_region_show()
22548 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22551 * Animatedly bring in given coordinates to the center of the map.
22553 * @param obj The map object.
22554 * @param lon Longitude to center at.
22555 * @param lat Latitude to center at.
22557 * This causes map to jump to the given @p lat and @p lon coordinates
22558 * and show it (by scrolling) in the center of the viewport, if it is not
22559 * already centered. This will use animation to do so and take a period
22560 * of time to complete.
22562 * @see elm_map_geo_region_show() for a function to avoid animation.
22563 * @see elm_map_geo_region_get()
22567 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22570 * Show the given coordinates at the center of the map, @b immediately.
22572 * @param obj The map object.
22573 * @param lon Longitude to center at.
22574 * @param lat Latitude to center at.
22576 * This causes map to @b redraw its viewport's contents to the
22577 * region contining the given @p lat and @p lon, that will be moved to the
22578 * center of the map.
22580 * @see elm_map_geo_region_bring_in() for a function to move with animation.
22581 * @see elm_map_geo_region_get()
22585 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22588 * Pause or unpause the map.
22590 * @param obj The map object.
22591 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22594 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22597 * The default is off.
22599 * This will stop zooming using animation, changing zoom levels will
22600 * change instantly. This will stop any existing animations that are running.
22602 * @see elm_map_paused_get()
22606 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22609 * Get a value whether map is paused or not.
22611 * @param obj The map object.
22612 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22613 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22615 * This gets the current paused state for the map object.
22617 * @see elm_map_paused_set() for details.
22621 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22624 * Set to show markers during zoom level changes or not.
22626 * @param obj The map object.
22627 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22630 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22633 * The default is off.
22635 * This will stop zooming using animation, changing zoom levels will
22636 * change instantly. This will stop any existing animations that are running.
22638 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22641 * The default is off.
22643 * Enabling it will force the map to stop displaying the markers during
22644 * zoom level changes. Set to on if you have a large number of markers.
22646 * @see elm_map_paused_markers_get()
22650 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22653 * Get a value whether markers will be displayed on zoom level changes or not
22655 * @param obj The map object.
22656 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22657 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22659 * This gets the current markers paused state for the map object.
22661 * @see elm_map_paused_markers_set() for details.
22665 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22668 * Get the information of downloading status.
22670 * @param obj The map object.
22671 * @param try_num Pointer where to store number of tiles being downloaded.
22672 * @param finish_num Pointer where to store number of tiles successfully
22675 * This gets the current downloading status for the map object, the number
22676 * of tiles being downloaded and the number of tiles already downloaded.
22680 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22683 * Convert a pixel coordinate (x,y) into a geographic coordinate
22684 * (longitude, latitude).
22686 * @param obj The map object.
22687 * @param x the coordinate.
22688 * @param y the coordinate.
22689 * @param size the size in pixels of the map.
22690 * The map is a square and generally his size is : pow(2.0, zoom)*256.
22691 * @param lon Pointer where to store the longitude that correspond to x.
22692 * @param lat Pointer where to store the latitude that correspond to y.
22694 * @note Origin pixel point is the top left corner of the viewport.
22695 * Map zoom and size are taken on account.
22697 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22701 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);
22704 * Convert a geographic coordinate (longitude, latitude) into a pixel
22705 * coordinate (x, y).
22707 * @param obj The map object.
22708 * @param lon the longitude.
22709 * @param lat the latitude.
22710 * @param size the size in pixels of the map. The map is a square
22711 * and generally his size is : pow(2.0, zoom)*256.
22712 * @param x Pointer where to store the horizontal pixel coordinate that
22713 * correspond to the longitude.
22714 * @param y Pointer where to store the vertical pixel coordinate that
22715 * correspond to the latitude.
22717 * @note Origin pixel point is the top left corner of the viewport.
22718 * Map zoom and size are taken on account.
22720 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22724 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);
22727 * Convert a geographic coordinate (longitude, latitude) into a name
22730 * @param obj The map object.
22731 * @param lon the longitude.
22732 * @param lat the latitude.
22733 * @return name A #Elm_Map_Name handle for this coordinate.
22735 * To get the string for this address, elm_map_name_address_get()
22738 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22742 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22745 * Convert a name (address) into a geographic coordinate
22746 * (longitude, latitude).
22748 * @param obj The map object.
22749 * @param name The address.
22750 * @return name A #Elm_Map_Name handle for this address.
22752 * To get the longitude and latitude, elm_map_name_region_get()
22755 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22759 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22762 * Convert a pixel coordinate into a rotated pixel coordinate.
22764 * @param obj The map object.
22765 * @param x horizontal coordinate of the point to rotate.
22766 * @param y vertical coordinate of the point to rotate.
22767 * @param cx rotation's center horizontal position.
22768 * @param cy rotation's center vertical position.
22769 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22770 * @param xx Pointer where to store rotated x.
22771 * @param yy Pointer where to store rotated y.
22775 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);
22778 * Add a new marker to the map object.
22780 * @param obj The map object.
22781 * @param lon The longitude of the marker.
22782 * @param lat The latitude of the marker.
22783 * @param clas The class, to use when marker @b isn't grouped to others.
22784 * @param clas_group The class group, to use when marker is grouped to others
22785 * @param data The data passed to the callbacks.
22787 * @return The created marker or @c NULL upon failure.
22789 * A marker will be created and shown in a specific point of the map, defined
22790 * by @p lon and @p lat.
22792 * It will be displayed using style defined by @p class when this marker
22793 * is displayed alone (not grouped). A new class can be created with
22794 * elm_map_marker_class_new().
22796 * If the marker is grouped to other markers, it will be displayed with
22797 * style defined by @p class_group. Markers with the same group are grouped
22798 * if they are close. A new group class can be created with
22799 * elm_map_marker_group_class_new().
22801 * Markers created with this method can be deleted with
22802 * elm_map_marker_remove().
22804 * A marker can have associated content to be displayed by a bubble,
22805 * when a user click over it, as well as an icon. These objects will
22806 * be fetch using class' callback functions.
22808 * @see elm_map_marker_class_new()
22809 * @see elm_map_marker_group_class_new()
22810 * @see elm_map_marker_remove()
22814 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);
22817 * Set the maximum numbers of markers' content to be displayed in a group.
22819 * @param obj The map object.
22820 * @param max The maximum numbers of items displayed in a bubble.
22822 * A bubble will be displayed when the user clicks over the group,
22823 * and will place the content of markers that belong to this group
22826 * A group can have a long list of markers, consequently the creation
22827 * of the content of the bubble can be very slow.
22829 * In order to avoid this, a maximum number of items is displayed
22832 * By default this number is 30.
22834 * Marker with the same group class are grouped if they are close.
22836 * @see elm_map_marker_add()
22840 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
22843 * Remove a marker from the map.
22845 * @param marker The marker to remove.
22847 * @see elm_map_marker_add()
22851 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22854 * Get the current coordinates of the marker.
22856 * @param marker marker.
22857 * @param lat Pointer where to store the marker's latitude.
22858 * @param lon Pointer where to store the marker's longitude.
22860 * These values are set when adding markers, with function
22861 * elm_map_marker_add().
22863 * @see elm_map_marker_add()
22867 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
22870 * Animatedly bring in given marker to the center of the map.
22872 * @param marker The marker to center at.
22874 * This causes map to jump to the given @p marker's coordinates
22875 * and show it (by scrolling) in the center of the viewport, if it is not
22876 * already centered. This will use animation to do so and take a period
22877 * of time to complete.
22879 * @see elm_map_marker_show() for a function to avoid animation.
22880 * @see elm_map_marker_region_get()
22884 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22887 * Show the given marker at the center of the map, @b immediately.
22889 * @param marker The marker to center at.
22891 * This causes map to @b redraw its viewport's contents to the
22892 * region contining the given @p marker's coordinates, that will be
22893 * moved to the center of the map.
22895 * @see elm_map_marker_bring_in() for a function to move with animation.
22896 * @see elm_map_markers_list_show() if more than one marker need to be
22898 * @see elm_map_marker_region_get()
22902 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22905 * Move and zoom the map to display a list of markers.
22907 * @param markers A list of #Elm_Map_Marker handles.
22909 * The map will be centered on the center point of the markers in the list.
22910 * Then the map will be zoomed in order to fit the markers using the maximum
22911 * zoom which allows display of all the markers.
22913 * @warning All the markers should belong to the same map object.
22915 * @see elm_map_marker_show() to show a single marker.
22916 * @see elm_map_marker_bring_in()
22920 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
22923 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
22925 * @param marker The marker wich content should be returned.
22926 * @return Return the evas object if it exists, else @c NULL.
22928 * To set callback function #ElmMapMarkerGetFunc for the marker class,
22929 * elm_map_marker_class_get_cb_set() should be used.
22931 * This content is what will be inside the bubble that will be displayed
22932 * when an user clicks over the marker.
22934 * This returns the actual Evas object used to be placed inside
22935 * the bubble. This may be @c NULL, as it may
22936 * not have been created or may have been deleted, at any time, by
22937 * the map. <b>Do not modify this object</b> (move, resize,
22938 * show, hide, etc.), as the map is controlling it. This
22939 * function is for querying, emitting custom signals or hooking
22940 * lower level callbacks for events on that object. Do not delete
22941 * this object under any circumstances.
22945 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22948 * Update the marker
22950 * @param marker The marker to be updated.
22952 * If a content is set to this marker, it will call function to delete it,
22953 * #ElmMapMarkerDelFunc, and then will fetch the content again with
22954 * #ElmMapMarkerGetFunc.
22956 * These functions are set for the marker class with
22957 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
22961 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22964 * Close all the bubbles opened by the user.
22966 * @param obj The map object.
22968 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
22969 * when the user clicks on a marker.
22971 * This functions is set for the marker class with
22972 * elm_map_marker_class_get_cb_set().
22976 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
22979 * Create a new group class.
22981 * @param obj The map object.
22982 * @return Returns the new group class.
22984 * Each marker must be associated to a group class. Markers in the same
22985 * group are grouped if they are close.
22987 * The group class defines the style of the marker when a marker is grouped
22988 * to others markers. When it is alone, another class will be used.
22990 * A group class will need to be provided when creating a marker with
22991 * elm_map_marker_add().
22993 * Some properties and functions can be set by class, as:
22994 * - style, with elm_map_group_class_style_set()
22995 * - data - to be associated to the group class. It can be set using
22996 * elm_map_group_class_data_set().
22997 * - min zoom to display markers, set with
22998 * elm_map_group_class_zoom_displayed_set().
22999 * - max zoom to group markers, set using
23000 * elm_map_group_class_zoom_grouped_set().
23001 * - visibility - set if markers will be visible or not, set with
23002 * elm_map_group_class_hide_set().
23003 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23004 * It can be set using elm_map_group_class_icon_cb_set().
23006 * @see elm_map_marker_add()
23007 * @see elm_map_group_class_style_set()
23008 * @see elm_map_group_class_data_set()
23009 * @see elm_map_group_class_zoom_displayed_set()
23010 * @see elm_map_group_class_zoom_grouped_set()
23011 * @see elm_map_group_class_hide_set()
23012 * @see elm_map_group_class_icon_cb_set()
23016 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23019 * Set the marker's style of a group class.
23021 * @param clas The group class.
23022 * @param style The style to be used by markers.
23024 * Each marker must be associated to a group class, and will use the style
23025 * defined by such class when grouped to other markers.
23027 * The following styles are provided by default theme:
23028 * @li @c radio - blue circle
23029 * @li @c radio2 - green circle
23032 * @see elm_map_group_class_new() for more details.
23033 * @see elm_map_marker_add()
23037 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23040 * Set the icon callback function of a group class.
23042 * @param clas The group class.
23043 * @param icon_get The callback function that will return the icon.
23045 * Each marker must be associated to a group class, and it can display a
23046 * custom icon. The function @p icon_get must return this icon.
23048 * @see elm_map_group_class_new() for more details.
23049 * @see elm_map_marker_add()
23053 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23056 * Set the data associated to the group class.
23058 * @param clas The group class.
23059 * @param data The new user data.
23061 * This data will be passed for callback functions, like icon get callback,
23062 * that can be set with elm_map_group_class_icon_cb_set().
23064 * If a data was previously set, the object will lose the pointer for it,
23065 * so if needs to be freed, you must do it yourself.
23067 * @see elm_map_group_class_new() for more details.
23068 * @see elm_map_group_class_icon_cb_set()
23069 * @see elm_map_marker_add()
23073 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23076 * Set the minimum zoom from where the markers are displayed.
23078 * @param clas The group class.
23079 * @param zoom The minimum zoom.
23081 * Markers only will be displayed when the map is displayed at @p zoom
23084 * @see elm_map_group_class_new() for more details.
23085 * @see elm_map_marker_add()
23089 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23092 * Set the zoom from where the markers are no more grouped.
23094 * @param clas The group class.
23095 * @param zoom The maximum zoom.
23097 * Markers only will be grouped when the map is displayed at
23098 * less than @p zoom.
23100 * @see elm_map_group_class_new() for more details.
23101 * @see elm_map_marker_add()
23105 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23108 * Set if the markers associated to the group class @clas are hidden or not.
23110 * @param clas The group class.
23111 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23114 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23119 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23122 * Create a new marker class.
23124 * @param obj The map object.
23125 * @return Returns the new group class.
23127 * Each marker must be associated to a class.
23129 * The marker class defines the style of the marker when a marker is
23130 * displayed alone, i.e., not grouped to to others markers. When grouped
23131 * it will use group class style.
23133 * A marker class will need to be provided when creating a marker with
23134 * elm_map_marker_add().
23136 * Some properties and functions can be set by class, as:
23137 * - style, with elm_map_marker_class_style_set()
23138 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23139 * It can be set using elm_map_marker_class_icon_cb_set().
23140 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23141 * Set using elm_map_marker_class_get_cb_set().
23142 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23143 * Set using elm_map_marker_class_del_cb_set().
23145 * @see elm_map_marker_add()
23146 * @see elm_map_marker_class_style_set()
23147 * @see elm_map_marker_class_icon_cb_set()
23148 * @see elm_map_marker_class_get_cb_set()
23149 * @see elm_map_marker_class_del_cb_set()
23153 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23156 * Set the marker's style of a marker class.
23158 * @param clas The marker class.
23159 * @param style The style to be used by markers.
23161 * Each marker must be associated to a marker class, and will use the style
23162 * defined by such class when alone, i.e., @b not grouped to other markers.
23164 * The following styles are provided by default theme:
23169 * @see elm_map_marker_class_new() for more details.
23170 * @see elm_map_marker_add()
23174 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23177 * Set the icon callback function of a marker class.
23179 * @param clas The marker class.
23180 * @param icon_get The callback function that will return the icon.
23182 * Each marker must be associated to a marker class, and it can display a
23183 * custom icon. The function @p icon_get must return this icon.
23185 * @see elm_map_marker_class_new() for more details.
23186 * @see elm_map_marker_add()
23190 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23193 * Set the bubble content callback function of a marker class.
23195 * @param clas The marker class.
23196 * @param get The callback function that will return the content.
23198 * Each marker must be associated to a marker class, and it can display a
23199 * a content on a bubble that opens when the user click over the marker.
23200 * The function @p get must return this content object.
23202 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23205 * @see elm_map_marker_class_new() for more details.
23206 * @see elm_map_marker_class_del_cb_set()
23207 * @see elm_map_marker_add()
23211 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23214 * Set the callback function used to delete bubble content of a marker class.
23216 * @param clas The marker class.
23217 * @param del The callback function that will delete the content.
23219 * Each marker must be associated to a marker class, and it can display a
23220 * a content on a bubble that opens when the user click over the marker.
23221 * The function to return such content can be set with
23222 * elm_map_marker_class_get_cb_set().
23224 * If this content must be freed, a callback function need to be
23225 * set for that task with this function.
23227 * If this callback is defined it will have to delete (or not) the
23228 * object inside, but if the callback is not defined the object will be
23229 * destroyed with evas_object_del().
23231 * @see elm_map_marker_class_new() for more details.
23232 * @see elm_map_marker_class_get_cb_set()
23233 * @see elm_map_marker_add()
23237 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23240 * Get the list of available sources.
23242 * @param obj The map object.
23243 * @return The source names list.
23245 * It will provide a list with all available sources, that can be set as
23246 * current source with elm_map_source_name_set(), or get with
23247 * elm_map_source_name_get().
23249 * Available sources:
23255 * @see elm_map_source_name_set() for more details.
23256 * @see elm_map_source_name_get()
23260 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23263 * Set the source of the map.
23265 * @param obj The map object.
23266 * @param source The source to be used.
23268 * Map widget retrieves images that composes the map from a web service.
23269 * This web service can be set with this method.
23271 * A different service can return a different maps with different
23272 * information and it can use different zoom values.
23274 * The @p source_name need to match one of the names provided by
23275 * elm_map_source_names_get().
23277 * The current source can be get using elm_map_source_name_get().
23279 * @see elm_map_source_names_get()
23280 * @see elm_map_source_name_get()
23285 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23288 * Get the name of currently used source.
23290 * @param obj The map object.
23291 * @return Returns the name of the source in use.
23293 * @see elm_map_source_name_set() for more details.
23297 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23300 * Set the source of the route service to be used by the map.
23302 * @param obj The map object.
23303 * @param source The route service to be used, being it one of
23304 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23305 * and #ELM_MAP_ROUTE_SOURCE_ORS.
23307 * Each one has its own algorithm, so the route retrieved may
23308 * differ depending on the source route. Now, only the default is working.
23310 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23311 * http://www.yournavigation.org/.
23313 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23314 * assumptions. Its routing core is based on Contraction Hierarchies.
23316 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23318 * @see elm_map_route_source_get().
23322 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23325 * Get the current route source.
23327 * @param obj The map object.
23328 * @return The source of the route service used by the map.
23330 * @see elm_map_route_source_set() for details.
23334 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23337 * Set the minimum zoom of the source.
23339 * @param obj The map object.
23340 * @param zoom New minimum zoom value to be used.
23342 * By default, it's 0.
23346 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23349 * Get the minimum zoom of the source.
23351 * @param obj The map object.
23352 * @return Returns the minimum zoom of the source.
23354 * @see elm_map_source_zoom_min_set() for details.
23358 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23361 * Set the maximum zoom of the source.
23363 * @param obj The map object.
23364 * @param zoom New maximum zoom value to be used.
23366 * By default, it's 18.
23370 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23373 * Get the maximum zoom of the source.
23375 * @param obj The map object.
23376 * @return Returns the maximum zoom of the source.
23378 * @see elm_map_source_zoom_min_set() for details.
23382 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23385 * Set the user agent used by the map object to access routing services.
23387 * @param obj The map object.
23388 * @param user_agent The user agent to be used by the map.
23390 * User agent is a client application implementing a network protocol used
23391 * in communications within a clientāserver distributed computing system
23393 * The @p user_agent identification string will transmitted in a header
23394 * field @c User-Agent.
23396 * @see elm_map_user_agent_get()
23400 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23403 * Get the user agent used by the map object.
23405 * @param obj The map object.
23406 * @return The user agent identification string used by the map.
23408 * @see elm_map_user_agent_set() for details.
23412 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23415 * Add a new route to the map object.
23417 * @param obj The map object.
23418 * @param type The type of transport to be considered when tracing a route.
23419 * @param method The routing method, what should be priorized.
23420 * @param flon The start longitude.
23421 * @param flat The start latitude.
23422 * @param tlon The destination longitude.
23423 * @param tlat The destination latitude.
23425 * @return The created route or @c NULL upon failure.
23427 * A route will be traced by point on coordinates (@p flat, @p flon)
23428 * to point on coordinates (@p tlat, @p tlon), using the route service
23429 * set with elm_map_route_source_set().
23431 * It will take @p type on consideration to define the route,
23432 * depending if the user will be walking or driving, the route may vary.
23433 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23434 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23436 * Another parameter is what the route should priorize, the minor distance
23437 * or the less time to be spend on the route. So @p method should be one
23438 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23440 * Routes created with this method can be deleted with
23441 * elm_map_route_remove(), colored with elm_map_route_color_set(),
23442 * and distance can be get with elm_map_route_distance_get().
23444 * @see elm_map_route_remove()
23445 * @see elm_map_route_color_set()
23446 * @see elm_map_route_distance_get()
23447 * @see elm_map_route_source_set()
23451 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);
23454 * Remove a route from the map.
23456 * @param route The route to remove.
23458 * @see elm_map_route_add()
23462 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23465 * Set the route color.
23467 * @param route The route object.
23468 * @param r Red channel value, from 0 to 255.
23469 * @param g Green channel value, from 0 to 255.
23470 * @param b Blue channel value, from 0 to 255.
23471 * @param a Alpha channel value, from 0 to 255.
23473 * It uses an additive color model, so each color channel represents
23474 * how much of each primary colors must to be used. 0 represents
23475 * ausence of this color, so if all of the three are set to 0,
23476 * the color will be black.
23478 * These component values should be integers in the range 0 to 255,
23479 * (single 8-bit byte).
23481 * This sets the color used for the route. By default, it is set to
23482 * solid red (r = 255, g = 0, b = 0, a = 255).
23484 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23486 * @see elm_map_route_color_get()
23490 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23493 * Get the route color.
23495 * @param route The route object.
23496 * @param r Pointer where to store the red channel value.
23497 * @param g Pointer where to store the green channel value.
23498 * @param b Pointer where to store the blue channel value.
23499 * @param a Pointer where to store the alpha channel value.
23501 * @see elm_map_route_color_set() for details.
23505 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23508 * Get the route distance in kilometers.
23510 * @param route The route object.
23511 * @return The distance of route (unit : km).
23515 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23518 * Get the information of route nodes.
23520 * @param route The route object.
23521 * @return Returns a string with the nodes of route.
23525 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23528 * Get the information of route waypoint.
23530 * @param route the route object.
23531 * @return Returns a string with information about waypoint of route.
23535 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23538 * Get the address of the name.
23540 * @param name The name handle.
23541 * @return Returns the address string of @p name.
23543 * This gets the coordinates of the @p name, created with one of the
23544 * conversion functions.
23546 * @see elm_map_utils_convert_name_into_coord()
23547 * @see elm_map_utils_convert_coord_into_name()
23551 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23554 * Get the current coordinates of the name.
23556 * @param name The name handle.
23557 * @param lat Pointer where to store the latitude.
23558 * @param lon Pointer where to store The longitude.
23560 * This gets the coordinates of the @p name, created with one of the
23561 * conversion functions.
23563 * @see elm_map_utils_convert_name_into_coord()
23564 * @see elm_map_utils_convert_coord_into_name()
23568 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23571 * Remove a name from the map.
23573 * @param name The name to remove.
23575 * Basically the struct handled by @p name will be freed, so convertions
23576 * between address and coordinates will be lost.
23578 * @see elm_map_utils_convert_name_into_coord()
23579 * @see elm_map_utils_convert_coord_into_name()
23583 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23588 * @param obj The map object.
23589 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23590 * @param cx Rotation's center horizontal position.
23591 * @param cy Rotation's center vertical position.
23593 * @see elm_map_rotate_get()
23597 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23600 * Get the rotate degree of the map
23602 * @param obj The map object
23603 * @param degree Pointer where to store degrees from 0.0 to 360.0
23604 * to rotate arount Z axis.
23605 * @param cx Pointer where to store rotation's center horizontal position.
23606 * @param cy Pointer where to store rotation's center vertical position.
23608 * @see elm_map_rotate_set() to set map rotation.
23612 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);
23615 * Enable or disable mouse wheel to be used to zoom in / out the map.
23617 * @param obj The map object.
23618 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23621 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23623 * It's disabled by default.
23625 * @see elm_map_wheel_disabled_get()
23629 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23632 * Get a value whether mouse wheel is enabled or not.
23634 * @param obj The map object.
23635 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23636 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23638 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23640 * @see elm_map_wheel_disabled_set() for details.
23644 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23648 * Add a track on the map
23650 * @param obj The map object.
23651 * @param emap The emap route object.
23652 * @return The route object. This is an elm object of type Route.
23654 * @see elm_route_add() for details.
23658 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23662 * Remove a track from the map
23664 * @param obj The map object.
23665 * @param route The track to remove.
23669 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23676 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23678 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23680 EAPI double elm_route_lon_min_get(Evas_Object *obj);
23681 EAPI double elm_route_lat_min_get(Evas_Object *obj);
23682 EAPI double elm_route_lon_max_get(Evas_Object *obj);
23683 EAPI double elm_route_lat_max_get(Evas_Object *obj);
23687 * @defgroup Panel Panel
23689 * @image html img/widget/panel/preview-00.png
23690 * @image latex img/widget/panel/preview-00.eps
23692 * @brief A panel is a type of animated container that contains subobjects.
23693 * It can be expanded or contracted by clicking the button on it's edge.
23695 * Orientations are as follows:
23696 * @li ELM_PANEL_ORIENT_TOP
23697 * @li ELM_PANEL_ORIENT_LEFT
23698 * @li ELM_PANEL_ORIENT_RIGHT
23700 * To set/get/unset the content of the panel, you can use
23701 * elm_object_content_set/get/unset APIs.
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_object_content_unset() function
23706 * @ref tutorial_panel shows one way to use this widget.
23709 typedef enum _Elm_Panel_Orient
23711 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23712 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23713 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23714 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23715 } Elm_Panel_Orient;
23717 * @brief Adds a panel object
23719 * @param parent The parent object
23721 * @return The panel object, or NULL on failure
23723 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23725 * @brief Sets the orientation of the panel
23727 * @param parent The parent object
23728 * @param orient The panel orientation. Can be one of the following:
23729 * @li ELM_PANEL_ORIENT_TOP
23730 * @li ELM_PANEL_ORIENT_LEFT
23731 * @li ELM_PANEL_ORIENT_RIGHT
23733 * Sets from where the panel will (dis)appear.
23735 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23737 * @brief Get the orientation of the panel.
23739 * @param obj The panel object
23740 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23742 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23744 * @brief Set the content of the panel.
23746 * @param obj The panel object
23747 * @param content The panel content
23749 * Once the content object is set, a previously set one will be deleted.
23750 * If you want to keep that old content object, use the
23751 * elm_panel_content_unset() function.
23753 EINA_DEPRECATED EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23755 * @brief Get the content of the panel.
23757 * @param obj The panel object
23758 * @return The content that is being used
23760 * Return the content object which is set for this widget.
23762 * @see elm_panel_content_set()
23764 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23766 * @brief Unset the content of the panel.
23768 * @param obj The panel object
23769 * @return The content that was being used
23771 * Unparent and return the content object which was set for this widget.
23773 * @see elm_panel_content_set()
23775 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23777 * @brief Set the state of the panel.
23779 * @param obj The panel object
23780 * @param hidden If true, the panel will run the animation to contract
23782 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23784 * @brief Get the state of the panel.
23786 * @param obj The panel object
23787 * @param hidden If true, the panel is in the "hide" state
23789 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23791 * @brief Toggle the hidden state of the panel from code
23793 * @param obj The panel object
23795 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23801 * @defgroup Panes Panes
23802 * @ingroup Elementary
23804 * @image html img/widget/panes/preview-00.png
23805 * @image latex img/widget/panes/preview-00.eps width=\textwidth
23807 * @image html img/panes.png
23808 * @image latex img/panes.eps width=\textwidth
23810 * The panes adds a dragable bar between two contents. When dragged
23811 * this bar will resize contents size.
23813 * Panes can be displayed vertically or horizontally, and contents
23814 * size proportion can be customized (homogeneous by default).
23816 * Smart callbacks one can listen to:
23817 * - "press" - The panes has been pressed (button wasn't released yet).
23818 * - "unpressed" - The panes was released after being pressed.
23819 * - "clicked" - The panes has been clicked>
23820 * - "clicked,double" - The panes has been double clicked
23822 * Available styles for it:
23825 * Default contents parts of the panes widget that you can use for are:
23826 * @li "elm.swallow.left" - A leftside content of the panes
23827 * @li "elm.swallow.right" - A rightside content of the panes
23829 * If panes is displayed vertically, left content will be displayed at
23832 * Here is an example on its usage:
23833 * @li @ref panes_example
23836 #define ELM_PANES_CONTENT_LEFT "elm.swallow.left"
23837 #define ELM_PANES_CONTENT_RIGHT "elm.swallow.right"
23840 * @addtogroup Panes
23845 * Add a new panes widget to the given parent Elementary
23846 * (container) object.
23848 * @param parent The parent object.
23849 * @return a new panes widget handle or @c NULL, on errors.
23851 * This function inserts a new panes widget on the canvas.
23855 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23858 * Set the left content of the panes widget.
23860 * @param obj The panes object.
23861 * @param content The new left content object.
23863 * Once the content object is set, a previously set one will be deleted.
23864 * If you want to keep that old content object, use the
23865 * elm_panes_content_left_unset() function.
23867 * If panes is displayed vertically, left content will be displayed at
23870 * @see elm_panes_content_left_get()
23871 * @see elm_panes_content_right_set() to set content on the other side.
23875 EINA_DEPRECATED EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23878 * Set the right content of the panes widget.
23880 * @param obj The panes object.
23881 * @param content The new right content object.
23883 * Once the content object is set, a previously set one will be deleted.
23884 * If you want to keep that old content object, use the
23885 * elm_panes_content_right_unset() function.
23887 * If panes is displayed vertically, left content will be displayed at
23890 * @see elm_panes_content_right_get()
23891 * @see elm_panes_content_left_set() to set content on the other side.
23895 EINA_DEPRECATED EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23898 * Get the left content of the panes.
23900 * @param obj The panes object.
23901 * @return The left content object that is being used.
23903 * Return the left content object which is set for this widget.
23905 * @see elm_panes_content_left_set() for details.
23909 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23912 * Get the right content of the panes.
23914 * @param obj The panes object
23915 * @return The right content object that is being used
23917 * Return the right content object which is set for this widget.
23919 * @see elm_panes_content_right_set() for details.
23923 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23926 * Unset the left content used for the panes.
23928 * @param obj The panes object.
23929 * @return The left content object that was being used.
23931 * Unparent and return the left content object which was set for this widget.
23933 * @see elm_panes_content_left_set() for details.
23934 * @see elm_panes_content_left_get().
23938 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23941 * Unset the right content used for the panes.
23943 * @param obj The panes object.
23944 * @return The right content object that was being used.
23946 * Unparent and return the right content object which was set for this
23949 * @see elm_panes_content_right_set() for details.
23950 * @see elm_panes_content_right_get().
23954 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23957 * Get the size proportion of panes widget's left side.
23959 * @param obj The panes object.
23960 * @return float value between 0.0 and 1.0 representing size proportion
23963 * @see elm_panes_content_left_size_set() for more details.
23967 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23970 * Set the size proportion of panes widget's left side.
23972 * @param obj The panes object.
23973 * @param size Value between 0.0 and 1.0 representing size proportion
23976 * By default it's homogeneous, i.e., both sides have the same size.
23978 * If something different is required, it can be set with this function.
23979 * For example, if the left content should be displayed over
23980 * 75% of the panes size, @p size should be passed as @c 0.75.
23981 * This way, right content will be resized to 25% of panes size.
23983 * If displayed vertically, left content is displayed at top, and
23984 * right content at bottom.
23986 * @note This proportion will change when user drags the panes bar.
23988 * @see elm_panes_content_left_size_get()
23992 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
23995 * Set the orientation of a given panes widget.
23997 * @param obj The panes object.
23998 * @param horizontal Use @c EINA_TRUE to make @p obj to be
23999 * @b horizontal, @c EINA_FALSE to make it @b vertical.
24001 * Use this function to change how your panes is to be
24002 * disposed: vertically or horizontally.
24004 * By default it's displayed horizontally.
24006 * @see elm_panes_horizontal_get()
24010 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24013 * Retrieve the orientation of a given panes widget.
24015 * @param obj The panes object.
24016 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24017 * @c EINA_FALSE if it's @b vertical (and on errors).
24019 * @see elm_panes_horizontal_set() for more details.
24023 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24024 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24025 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24032 * @defgroup Flip Flip
24034 * @image html img/widget/flip/preview-00.png
24035 * @image latex img/widget/flip/preview-00.eps
24037 * This widget holds 2 content objects(Evas_Object): one on the front and one
24038 * on the back. It allows you to flip from front to back and vice-versa using
24039 * various animations.
24041 * If either the front or back contents are not set the flip will treat that
24042 * as transparent. So if you wore to set the front content but not the back,
24043 * and then call elm_flip_go() you would see whatever is below the flip.
24045 * For a list of supported animations see elm_flip_go().
24047 * Signals that you can add callbacks for are:
24048 * "animate,begin" - when a flip animation was started
24049 * "animate,done" - when a flip animation is finished
24051 * @ref tutorial_flip show how to use most of the API.
24055 typedef enum _Elm_Flip_Mode
24057 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24058 ELM_FLIP_ROTATE_X_CENTER_AXIS,
24059 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24060 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24061 ELM_FLIP_CUBE_LEFT,
24062 ELM_FLIP_CUBE_RIGHT,
24064 ELM_FLIP_CUBE_DOWN,
24065 ELM_FLIP_PAGE_LEFT,
24066 ELM_FLIP_PAGE_RIGHT,
24070 typedef enum _Elm_Flip_Interaction
24072 ELM_FLIP_INTERACTION_NONE,
24073 ELM_FLIP_INTERACTION_ROTATE,
24074 ELM_FLIP_INTERACTION_CUBE,
24075 ELM_FLIP_INTERACTION_PAGE
24076 } Elm_Flip_Interaction;
24077 typedef enum _Elm_Flip_Direction
24079 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24080 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24081 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24082 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24083 } Elm_Flip_Direction;
24085 * @brief Add a new flip to the parent
24087 * @param parent The parent object
24088 * @return The new object or NULL if it cannot be created
24090 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24092 * @brief Set the front content of the flip widget.
24094 * @param obj The flip object
24095 * @param content The new front content object
24097 * Once the content object is set, a previously set one will be deleted.
24098 * If you want to keep that old content object, use the
24099 * elm_flip_content_front_unset() function.
24101 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24103 * @brief Set the back content of the flip widget.
24105 * @param obj The flip object
24106 * @param content The new back content object
24108 * Once the content object is set, a previously set one will be deleted.
24109 * If you want to keep that old content object, use the
24110 * elm_flip_content_back_unset() function.
24112 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24114 * @brief Get the front content used for the flip
24116 * @param obj The flip object
24117 * @return The front content object that is being used
24119 * Return the front content object which is set for this widget.
24121 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24123 * @brief Get the back content used for the flip
24125 * @param obj The flip object
24126 * @return The back content object that is being used
24128 * Return the back content object which is set for this widget.
24130 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24132 * @brief Unset the front content used for the flip
24134 * @param obj The flip object
24135 * @return The front content object that was being used
24137 * Unparent and return the front content object which was set for this widget.
24139 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24141 * @brief Unset the back content used for the flip
24143 * @param obj The flip object
24144 * @return The back content object that was being used
24146 * Unparent and return the back content object which was set for this widget.
24148 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24150 * @brief Get flip front visibility state
24152 * @param obj The flip objct
24153 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24156 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24158 * @brief Set flip perspective
24160 * @param obj The flip object
24161 * @param foc The coordinate to set the focus on
24162 * @param x The X coordinate
24163 * @param y The Y coordinate
24165 * @warning This function currently does nothing.
24167 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24169 * @brief Runs the flip animation
24171 * @param obj The flip object
24172 * @param mode The mode type
24174 * Flips the front and back contents using the @p mode animation. This
24175 * efectively hides the currently visible content and shows the hidden one.
24177 * There a number of possible animations to use for the flipping:
24178 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24179 * around a horizontal axis in the middle of its height, the other content
24180 * is shown as the other side of the flip.
24181 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24182 * around a vertical axis in the middle of its width, the other content is
24183 * shown as the other side of the flip.
24184 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24185 * around a diagonal axis in the middle of its width, the other content is
24186 * shown as the other side of the flip.
24187 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24188 * around a diagonal axis in the middle of its height, the other content is
24189 * shown as the other side of the flip.
24190 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24191 * as if the flip was a cube, the other content is show as the right face of
24193 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24194 * right as if the flip was a cube, the other content is show as the left
24195 * face of the cube.
24196 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24197 * flip was a cube, the other content is show as the bottom face of the cube.
24198 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24199 * the flip was a cube, the other content is show as the upper face of the
24201 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24202 * if the flip was a book, the other content is shown as the page below that.
24203 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24204 * as if the flip was a book, the other content is shown as the page below
24206 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24207 * flip was a book, the other content is shown as the page below that.
24208 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24209 * flip was a book, the other content is shown as the page below that.
24211 * @image html elm_flip.png
24212 * @image latex elm_flip.eps width=\textwidth
24214 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24216 * @brief Set the interactive flip mode
24218 * @param obj The flip object
24219 * @param mode The interactive flip mode to use
24221 * This sets if the flip should be interactive (allow user to click and
24222 * drag a side of the flip to reveal the back page and cause it to flip).
24223 * By default a flip is not interactive. You may also need to set which
24224 * sides of the flip are "active" for flipping and how much space they use
24225 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24226 * and elm_flip_interacton_direction_hitsize_set()
24228 * The four avilable mode of interaction are:
24229 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24230 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24231 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24232 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24234 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24235 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24236 * happen, those can only be acheived with elm_flip_go();
24238 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24240 * @brief Get the interactive flip mode
24242 * @param obj The flip object
24243 * @return The interactive flip mode
24245 * Returns the interactive flip mode set by elm_flip_interaction_set()
24247 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24249 * @brief Set which directions of the flip respond to interactive flip
24251 * @param obj The flip object
24252 * @param dir The direction to change
24253 * @param enabled If that direction is enabled or not
24255 * By default all directions are disabled, so you may want to enable the
24256 * desired directions for flipping if you need interactive flipping. You must
24257 * call this function once for each direction that should be enabled.
24259 * @see elm_flip_interaction_set()
24261 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24263 * @brief Get the enabled state of that flip direction
24265 * @param obj The flip object
24266 * @param dir The direction to check
24267 * @return If that direction is enabled or not
24269 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24271 * @see elm_flip_interaction_set()
24273 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24275 * @brief Set the amount of the flip that is sensitive to interactive flip
24277 * @param obj The flip object
24278 * @param dir The direction to modify
24279 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24281 * Set the amount of the flip that is sensitive to interactive flip, with 0
24282 * representing no area in the flip and 1 representing the entire flip. There
24283 * is however a consideration to be made in that the area will never be
24284 * smaller than the finger size set(as set in your Elementary configuration).
24286 * @see elm_flip_interaction_set()
24288 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24290 * @brief Get the amount of the flip that is sensitive to interactive flip
24292 * @param obj The flip object
24293 * @param dir The direction to check
24294 * @return The size set for that direction
24296 * Returns the amount os sensitive area set by
24297 * elm_flip_interacton_direction_hitsize_set().
24299 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24304 /* scrolledentry */
24305 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24306 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24307 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24308 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24309 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24310 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24311 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24312 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24313 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24314 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24315 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24316 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24317 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24318 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24319 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24320 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24321 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24322 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24323 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24324 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24325 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24326 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24327 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24328 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24329 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24330 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24331 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24332 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24333 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24334 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24335 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24336 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24337 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24338 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24339 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24340 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);
24341 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24342 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24343 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);
24344 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24345 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);
24346 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24347 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24348 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24349 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24350 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24351 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24352 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24353 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24354 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);
24355 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);
24356 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);
24357 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);
24358 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);
24359 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);
24360 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24361 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24362 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24363 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24364 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24365 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24366 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24369 * @defgroup Conformant Conformant
24370 * @ingroup Elementary
24372 * @image html img/widget/conformant/preview-00.png
24373 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24375 * @image html img/conformant.png
24376 * @image latex img/conformant.eps width=\textwidth
24378 * The aim is to provide a widget that can be used in elementary apps to
24379 * account for space taken up by the indicator, virtual keypad & softkey
24380 * windows when running the illume2 module of E17.
24382 * So conformant content will be sized and positioned considering the
24383 * space required for such stuff, and when they popup, as a keyboard
24384 * shows when an entry is selected, conformant content won't change.
24386 * Available styles for it:
24389 * Default contents parts of the conformant widget that you can use for are:
24390 * @li "elm.swallow.content" - A content of the conformant
24392 * See how to use this widget in this example:
24393 * @ref conformant_example
24397 * @addtogroup Conformant
24402 * Add a new conformant widget to the given parent Elementary
24403 * (container) object.
24405 * @param parent The parent object.
24406 * @return A new conformant widget handle or @c NULL, on errors.
24408 * This function inserts a new conformant widget on the canvas.
24410 * @ingroup Conformant
24412 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24415 * Set the content of the conformant widget.
24417 * @param obj The conformant object.
24418 * @param content The content to be displayed by the conformant.
24420 * Content will be sized and positioned considering the space required
24421 * to display a virtual keyboard. So it won't fill all the conformant
24422 * size. This way is possible to be sure that content won't resize
24423 * or be re-positioned after the keyboard is displayed.
24425 * Once the content object is set, a previously set one will be deleted.
24426 * If you want to keep that old content object, use the
24427 * elm_object_content_unset() function.
24429 * @see elm_object_content_unset()
24430 * @see elm_object_content_get()
24432 * @ingroup Conformant
24434 EINA_DEPRECATED EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24437 * Get the content of the conformant widget.
24439 * @param obj The conformant object.
24440 * @return The content that is being used.
24442 * Return the content object which is set for this widget.
24443 * It won't be unparent from conformant. For that, use
24444 * elm_object_content_unset().
24446 * @see elm_object_content_set().
24447 * @see elm_object_content_unset()
24449 * @ingroup Conformant
24451 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24454 * Unset the content of the conformant widget.
24456 * @param obj The conformant object.
24457 * @return The content that was being used.
24459 * Unparent and return the content object which was set for this widget.
24461 * @see elm_object_content_set().
24463 * @ingroup Conformant
24465 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24468 * Returns the Evas_Object that represents the content area.
24470 * @param obj The conformant object.
24471 * @return The content area of the widget.
24473 * @ingroup Conformant
24475 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24482 * @defgroup Mapbuf Mapbuf
24483 * @ingroup Elementary
24485 * @image html img/widget/mapbuf/preview-00.png
24486 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24488 * This holds one content object and uses an Evas Map of transformation
24489 * points to be later used with this content. So the content will be
24490 * moved, resized, etc as a single image. So it will improve performance
24491 * when you have a complex interafce, with a lot of elements, and will
24492 * need to resize or move it frequently (the content object and its
24495 * To set/get/unset the content of the mapbuf, you can use
24496 * elm_object_content_set/get/unset APIs.
24497 * Once the content object is set, a previously set one will be deleted.
24498 * If you want to keep that old content object, use the
24499 * elm_object_content_unset() function.
24501 * To enable map, elm_mapbuf_enabled_set() should be used.
24503 * See how to use this widget in this example:
24504 * @ref mapbuf_example
24508 * @addtogroup Mapbuf
24513 * Add a new mapbuf widget to the given parent Elementary
24514 * (container) object.
24516 * @param parent The parent object.
24517 * @return A new mapbuf widget handle or @c NULL, on errors.
24519 * This function inserts a new mapbuf widget on the canvas.
24523 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24526 * Set the content of the mapbuf.
24528 * @param obj The mapbuf object.
24529 * @param content The content that will be filled in this mapbuf object.
24531 * Once the content object is set, a previously set one will be deleted.
24532 * If you want to keep that old content object, use the
24533 * elm_mapbuf_content_unset() function.
24535 * To enable map, elm_mapbuf_enabled_set() should be used.
24539 EINA_DEPRECATED EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24542 * Get the content of the mapbuf.
24544 * @param obj The mapbuf object.
24545 * @return The content that is being used.
24547 * Return the content object which is set for this widget.
24549 * @see elm_mapbuf_content_set() for details.
24553 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24556 * Unset the content of the mapbuf.
24558 * @param obj The mapbuf object.
24559 * @return The content that was being used.
24561 * Unparent and return the content object which was set for this widget.
24563 * @see elm_mapbuf_content_set() for details.
24567 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24570 * Enable or disable the map.
24572 * @param obj The mapbuf object.
24573 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24575 * This enables the map that is set or disables it. On enable, the object
24576 * geometry will be saved, and the new geometry will change (position and
24577 * size) to reflect the map geometry set.
24579 * Also, when enabled, alpha and smooth states will be used, so if the
24580 * content isn't solid, alpha should be enabled, for example, otherwise
24581 * a black retangle will fill the content.
24583 * When disabled, the stored map will be freed and geometry prior to
24584 * enabling the map will be restored.
24586 * It's disabled by default.
24588 * @see elm_mapbuf_alpha_set()
24589 * @see elm_mapbuf_smooth_set()
24593 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24596 * Get a value whether map is enabled or not.
24598 * @param obj The mapbuf object.
24599 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24600 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24602 * @see elm_mapbuf_enabled_set() for details.
24606 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24609 * Enable or disable smooth map rendering.
24611 * @param obj The mapbuf object.
24612 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24615 * This sets smoothing for map rendering. If the object is a type that has
24616 * its own smoothing settings, then both the smooth settings for this object
24617 * and the map must be turned off.
24619 * By default smooth maps are enabled.
24623 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24626 * Get a value whether smooth map rendering is enabled or not.
24628 * @param obj The mapbuf object.
24629 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24630 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24632 * @see elm_mapbuf_smooth_set() for details.
24636 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24639 * Set or unset alpha flag for map rendering.
24641 * @param obj The mapbuf object.
24642 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24645 * This sets alpha flag for map rendering. If the object is a type that has
24646 * its own alpha settings, then this will take precedence. Only image objects
24647 * have this currently. It stops alpha blending of the map area, and is
24648 * useful if you know the object and/or all sub-objects is 100% solid.
24650 * Alpha is enabled by default.
24654 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24657 * Get a value whether alpha blending is enabled or not.
24659 * @param obj The mapbuf object.
24660 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24661 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24663 * @see elm_mapbuf_alpha_set() for details.
24667 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24674 * @defgroup Flipselector Flip Selector
24676 * @image html img/widget/flipselector/preview-00.png
24677 * @image latex img/widget/flipselector/preview-00.eps
24679 * A flip selector is a widget to show a set of @b text items, one
24680 * at a time, with the same sheet switching style as the @ref Clock
24681 * "clock" widget, when one changes the current displaying sheet
24682 * (thus, the "flip" in the name).
24684 * User clicks to flip sheets which are @b held for some time will
24685 * make the flip selector to flip continuosly and automatically for
24686 * the user. The interval between flips will keep growing in time,
24687 * so that it helps the user to reach an item which is distant from
24688 * the current selection.
24690 * Smart callbacks one can register to:
24691 * - @c "selected" - when the widget's selected text item is changed
24692 * - @c "overflowed" - when the widget's current selection is changed
24693 * from the first item in its list to the last
24694 * - @c "underflowed" - when the widget's current selection is changed
24695 * from the last item in its list to the first
24697 * Available styles for it:
24700 * Here is an example on its usage:
24701 * @li @ref flipselector_example
24705 * @addtogroup Flipselector
24709 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24712 * Add a new flip selector widget to the given parent Elementary
24713 * (container) widget
24715 * @param parent The parent object
24716 * @return a new flip selector widget handle or @c NULL, on errors
24718 * This function inserts a new flip selector widget on the canvas.
24720 * @ingroup Flipselector
24722 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24725 * Programmatically select the next item of a flip selector widget
24727 * @param obj The flipselector object
24729 * @note The selection will be animated. Also, if it reaches the
24730 * end of its list of member items, it will continue with the first
24733 * @ingroup Flipselector
24735 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24738 * Programmatically select the previous item of a flip selector
24741 * @param obj The flipselector object
24743 * @note The selection will be animated. Also, if it reaches the
24744 * beginning of its list of member items, it will continue with the
24745 * last one backwards.
24747 * @ingroup Flipselector
24749 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24752 * Append a (text) item to a flip selector widget
24754 * @param obj The flipselector object
24755 * @param label The (text) label of the new item
24756 * @param func Convenience callback function to take place when
24758 * @param data Data passed to @p func, above
24759 * @return A handle to the item added or @c NULL, on errors
24761 * The widget's list of labels to show will be appended with the
24762 * given value. If the user wishes so, a callback function pointer
24763 * can be passed, which will get called when this same item is
24766 * @note The current selection @b won't be modified by appending an
24767 * element to the list.
24769 * @note The maximum length of the text label is going to be
24770 * determined <b>by the widget's theme</b>. Strings larger than
24771 * that value are going to be @b truncated.
24773 * @ingroup Flipselector
24775 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24778 * Prepend a (text) item to a flip selector widget
24780 * @param obj The flipselector object
24781 * @param label The (text) label of the new item
24782 * @param func Convenience callback function to take place when
24784 * @param data Data passed to @p func, above
24785 * @return A handle to the item added or @c NULL, on errors
24787 * The widget's list of labels to show will be prepended with the
24788 * given value. If the user wishes so, a callback function pointer
24789 * can be passed, which will get called when this same item is
24792 * @note The current selection @b won't be modified by prepending
24793 * an element to the list.
24795 * @note The maximum length of the text label is going to be
24796 * determined <b>by the widget's theme</b>. Strings larger than
24797 * that value are going to be @b truncated.
24799 * @ingroup Flipselector
24801 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24804 * Get the internal list of items in a given flip selector widget.
24806 * @param obj The flipselector object
24807 * @return The list of items (#Elm_Flipselector_Item as data) or
24808 * @c NULL on errors.
24810 * This list is @b not to be modified in any way and must not be
24811 * freed. Use the list members with functions like
24812 * elm_flipselector_item_label_set(),
24813 * elm_flipselector_item_label_get(),
24814 * elm_flipselector_item_del(),
24815 * elm_flipselector_item_selected_get(),
24816 * elm_flipselector_item_selected_set().
24818 * @warning This list is only valid until @p obj object's internal
24819 * items list is changed. It should be fetched again with another
24820 * call to this function when changes happen.
24822 * @ingroup Flipselector
24824 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24827 * Get the first item in the given flip selector widget's list of
24830 * @param obj The flipselector object
24831 * @return The first item or @c NULL, if it has no items (and on
24834 * @see elm_flipselector_item_append()
24835 * @see elm_flipselector_last_item_get()
24837 * @ingroup Flipselector
24839 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24842 * Get the last item in the given flip selector widget's list of
24845 * @param obj The flipselector object
24846 * @return The last item or @c NULL, if it has no items (and on
24849 * @see elm_flipselector_item_prepend()
24850 * @see elm_flipselector_first_item_get()
24852 * @ingroup Flipselector
24854 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24857 * Get the currently selected item in a flip selector widget.
24859 * @param obj The flipselector object
24860 * @return The selected item or @c NULL, if the widget has no items
24863 * @ingroup Flipselector
24865 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24868 * Set whether a given flip selector widget's item should be the
24869 * currently selected one.
24871 * @param item The flip selector item
24872 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
24874 * This sets whether @p item is or not the selected (thus, under
24875 * display) one. If @p item is different than one under display,
24876 * the latter will be unselected. If the @p item is set to be
24877 * unselected, on the other hand, the @b first item in the widget's
24878 * internal members list will be the new selected one.
24880 * @see elm_flipselector_item_selected_get()
24882 * @ingroup Flipselector
24884 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24887 * Get whether a given flip selector widget's item is the currently
24890 * @param item The flip selector item
24891 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
24894 * @see elm_flipselector_item_selected_set()
24896 * @ingroup Flipselector
24898 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24901 * Delete a given item from a flip selector widget.
24903 * @param item The item to delete
24905 * @ingroup Flipselector
24907 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24910 * Get the label of a given flip selector widget's item.
24912 * @param item The item to get label from
24913 * @return The text label of @p item or @c NULL, on errors
24915 * @see elm_flipselector_item_label_set()
24917 * @ingroup Flipselector
24919 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24922 * Set the label of a given flip selector widget's item.
24924 * @param item The item to set label on
24925 * @param label The text label string, in UTF-8 encoding
24927 * @see elm_flipselector_item_label_get()
24929 * @ingroup Flipselector
24931 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24934 * Gets the item before @p item in a flip selector widget's
24935 * internal list of items.
24937 * @param item The item to fetch previous from
24938 * @return The item before the @p item, in its parent's list. If
24939 * there is no previous item for @p item or there's an
24940 * error, @c NULL is returned.
24942 * @see elm_flipselector_item_next_get()
24944 * @ingroup Flipselector
24946 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24949 * Gets the item after @p item in a flip selector widget's
24950 * internal list of items.
24952 * @param item The item to fetch next from
24953 * @return The item after the @p item, in its parent's list. If
24954 * there is no next item for @p item or there's an
24955 * error, @c NULL is returned.
24957 * @see elm_flipselector_item_next_get()
24959 * @ingroup Flipselector
24961 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24964 * Set the interval on time updates for an user mouse button hold
24965 * on a flip selector widget.
24967 * @param obj The flip selector object
24968 * @param interval The (first) interval value in seconds
24970 * This interval value is @b decreased while the user holds the
24971 * mouse pointer either flipping up or flipping doww a given flip
24974 * This helps the user to get to a given item distant from the
24975 * current one easier/faster, as it will start to flip quicker and
24976 * quicker on mouse button holds.
24978 * The calculation for the next flip interval value, starting from
24979 * the one set with this call, is the previous interval divided by
24980 * 1.05, so it decreases a little bit.
24982 * The default starting interval value for automatic flips is
24985 * @see elm_flipselector_interval_get()
24987 * @ingroup Flipselector
24989 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
24992 * Get the interval on time updates for an user mouse button hold
24993 * on a flip selector widget.
24995 * @param obj The flip selector object
24996 * @return The (first) interval value, in seconds, set on it
24998 * @see elm_flipselector_interval_set() for more details
25000 * @ingroup Flipselector
25002 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25008 * @addtogroup Calendar
25013 * @enum _Elm_Calendar_Mark_Repeat
25014 * @typedef Elm_Calendar_Mark_Repeat
25016 * Event periodicity, used to define if a mark should be repeated
25017 * @b beyond event's day. It's set when a mark is added.
25019 * So, for a mark added to 13th May with periodicity set to WEEKLY,
25020 * there will be marks every week after this date. Marks will be displayed
25021 * at 13th, 20th, 27th, 3rd June ...
25023 * Values don't work as bitmask, only one can be choosen.
25025 * @see elm_calendar_mark_add()
25027 * @ingroup Calendar
25029 typedef enum _Elm_Calendar_Mark_Repeat
25031 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25032 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25033 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25034 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*/
25035 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. */
25036 } Elm_Calendar_Mark_Repeat;
25038 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(). */
25041 * Add a new calendar widget to the given parent Elementary
25042 * (container) object.
25044 * @param parent The parent object.
25045 * @return a new calendar widget handle or @c NULL, on errors.
25047 * This function inserts a new calendar widget on the canvas.
25049 * @ref calendar_example_01
25051 * @ingroup Calendar
25053 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25056 * Get weekdays names displayed by the calendar.
25058 * @param obj The calendar object.
25059 * @return Array of seven strings to be used as weekday names.
25061 * By default, weekdays abbreviations get from system are displayed:
25062 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25063 * The first string is related to Sunday, the second to Monday...
25065 * @see elm_calendar_weekdays_name_set()
25067 * @ref calendar_example_05
25069 * @ingroup Calendar
25071 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25074 * Set weekdays names to be displayed by the calendar.
25076 * @param obj The calendar object.
25077 * @param weekdays Array of seven strings to be used as weekday names.
25078 * @warning It must have 7 elements, or it will access invalid memory.
25079 * @warning The strings must be NULL terminated ('@\0').
25081 * By default, weekdays abbreviations get from system are displayed:
25082 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25084 * The first string should be related to Sunday, the second to Monday...
25086 * The usage should be like this:
25088 * const char *weekdays[] =
25090 * "Sunday", "Monday", "Tuesday", "Wednesday",
25091 * "Thursday", "Friday", "Saturday"
25093 * elm_calendar_weekdays_names_set(calendar, weekdays);
25096 * @see elm_calendar_weekdays_name_get()
25098 * @ref calendar_example_02
25100 * @ingroup Calendar
25102 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25105 * Set the minimum and maximum values for the year
25107 * @param obj The calendar object
25108 * @param min The minimum year, greater than 1901;
25109 * @param max The maximum year;
25111 * Maximum must be greater than minimum, except if you don't wan't to set
25113 * Default values are 1902 and -1.
25115 * If the maximum year is a negative value, it will be limited depending
25116 * on the platform architecture (year 2037 for 32 bits);
25118 * @see elm_calendar_min_max_year_get()
25120 * @ref calendar_example_03
25122 * @ingroup Calendar
25124 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25127 * Get the minimum and maximum values for the year
25129 * @param obj The calendar object.
25130 * @param min The minimum year.
25131 * @param max The maximum year.
25133 * Default values are 1902 and -1.
25135 * @see elm_calendar_min_max_year_get() for more details.
25137 * @ref calendar_example_05
25139 * @ingroup Calendar
25141 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25144 * Enable or disable day selection
25146 * @param obj The calendar object.
25147 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25150 * Enabled by default. If disabled, the user still can select months,
25151 * but not days. Selected days are highlighted on calendar.
25152 * It should be used if you won't need such selection for the widget usage.
25154 * When a day is selected, or month is changed, smart callbacks for
25155 * signal "changed" will be called.
25157 * @see elm_calendar_day_selection_enable_get()
25159 * @ref calendar_example_04
25161 * @ingroup Calendar
25163 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25166 * Get a value whether day selection is enabled or not.
25168 * @see elm_calendar_day_selection_enable_set() for details.
25170 * @param obj The calendar object.
25171 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25172 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25174 * @ref calendar_example_05
25176 * @ingroup Calendar
25178 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25182 * Set selected date to be highlighted on calendar.
25184 * @param obj The calendar object.
25185 * @param selected_time A @b tm struct to represent the selected date.
25187 * Set the selected date, changing the displayed month if needed.
25188 * Selected date changes when the user goes to next/previous month or
25189 * select a day pressing over it on calendar.
25191 * @see elm_calendar_selected_time_get()
25193 * @ref calendar_example_04
25195 * @ingroup Calendar
25197 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25200 * Get selected date.
25202 * @param obj The calendar object
25203 * @param selected_time A @b tm struct to point to selected date
25204 * @return EINA_FALSE means an error ocurred and returned time shouldn't
25207 * Get date selected by the user or set by function
25208 * elm_calendar_selected_time_set().
25209 * Selected date changes when the user goes to next/previous month or
25210 * select a day pressing over it on calendar.
25212 * @see elm_calendar_selected_time_get()
25214 * @ref calendar_example_05
25216 * @ingroup Calendar
25218 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25221 * Set a function to format the string that will be used to display
25224 * @param obj The calendar object
25225 * @param format_function Function to set the month-year string given
25226 * the selected date
25228 * By default it uses strftime with "%B %Y" format string.
25229 * It should allocate the memory that will be used by the string,
25230 * that will be freed by the widget after usage.
25231 * A pointer to the string and a pointer to the time struct will be provided.
25236 * _format_month_year(struct tm *selected_time)
25239 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25240 * return strdup(buf);
25243 * elm_calendar_format_function_set(calendar, _format_month_year);
25246 * @ref calendar_example_02
25248 * @ingroup Calendar
25250 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25253 * Add a new mark to the calendar
25255 * @param obj The calendar object
25256 * @param mark_type A string used to define the type of mark. It will be
25257 * emitted to the theme, that should display a related modification on these
25258 * days representation.
25259 * @param mark_time A time struct to represent the date of inclusion of the
25260 * mark. For marks that repeats it will just be displayed after the inclusion
25261 * date in the calendar.
25262 * @param repeat Repeat the event following this periodicity. Can be a unique
25263 * mark (that don't repeat), daily, weekly, monthly or annually.
25264 * @return The created mark or @p NULL upon failure.
25266 * Add a mark that will be drawn in the calendar respecting the insertion
25267 * time and periodicity. It will emit the type as signal to the widget theme.
25268 * Default theme supports "holiday" and "checked", but it can be extended.
25270 * It won't immediately update the calendar, drawing the marks.
25271 * For this, call elm_calendar_marks_draw(). However, when user selects
25272 * next or previous month calendar forces marks drawn.
25274 * Marks created with this method can be deleted with
25275 * elm_calendar_mark_del().
25279 * struct tm selected_time;
25280 * time_t current_time;
25282 * current_time = time(NULL) + 5 * 84600;
25283 * localtime_r(¤t_time, &selected_time);
25284 * elm_calendar_mark_add(cal, "holiday", selected_time,
25285 * ELM_CALENDAR_ANNUALLY);
25287 * current_time = time(NULL) + 1 * 84600;
25288 * localtime_r(¤t_time, &selected_time);
25289 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25291 * elm_calendar_marks_draw(cal);
25294 * @see elm_calendar_marks_draw()
25295 * @see elm_calendar_mark_del()
25297 * @ref calendar_example_06
25299 * @ingroup Calendar
25301 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);
25304 * Delete mark from the calendar.
25306 * @param mark The mark to be deleted.
25308 * If deleting all calendar marks is required, elm_calendar_marks_clear()
25309 * should be used instead of getting marks list and deleting each one.
25311 * @see elm_calendar_mark_add()
25313 * @ref calendar_example_06
25315 * @ingroup Calendar
25317 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25320 * Remove all calendar's marks
25322 * @param obj The calendar object.
25324 * @see elm_calendar_mark_add()
25325 * @see elm_calendar_mark_del()
25327 * @ingroup Calendar
25329 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25333 * Get a list of all the calendar marks.
25335 * @param obj The calendar object.
25336 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25338 * @see elm_calendar_mark_add()
25339 * @see elm_calendar_mark_del()
25340 * @see elm_calendar_marks_clear()
25342 * @ingroup Calendar
25344 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25347 * Draw calendar marks.
25349 * @param obj The calendar object.
25351 * Should be used after adding, removing or clearing marks.
25352 * It will go through the entire marks list updating the calendar.
25353 * If lots of marks will be added, add all the marks and then call
25356 * When the month is changed, i.e. user selects next or previous month,
25357 * marks will be drawed.
25359 * @see elm_calendar_mark_add()
25360 * @see elm_calendar_mark_del()
25361 * @see elm_calendar_marks_clear()
25363 * @ref calendar_example_06
25365 * @ingroup Calendar
25367 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25370 * Set a day text color to the same that represents Saturdays.
25372 * @param obj The calendar object.
25373 * @param pos The text position. Position is the cell counter, from left
25374 * to right, up to down. It starts on 0 and ends on 41.
25376 * @deprecated use elm_calendar_mark_add() instead like:
25379 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25380 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25383 * @see elm_calendar_mark_add()
25385 * @ingroup Calendar
25387 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25390 * Set a day text color to the same that represents Sundays.
25392 * @param obj The calendar object.
25393 * @param pos The text position. Position is the cell counter, from left
25394 * to right, up to down. It starts on 0 and ends on 41.
25396 * @deprecated use elm_calendar_mark_add() instead like:
25399 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25400 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25403 * @see elm_calendar_mark_add()
25405 * @ingroup Calendar
25407 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25410 * Set a day text color to the same that represents Weekdays.
25412 * @param obj The calendar object
25413 * @param pos The text position. Position is the cell counter, from left
25414 * to right, up to down. It starts on 0 and ends on 41.
25416 * @deprecated use elm_calendar_mark_add() instead like:
25419 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25421 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25422 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25423 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25424 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25425 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25426 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25427 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25428 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25429 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25432 * @see elm_calendar_mark_add()
25434 * @ingroup Calendar
25436 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25439 * Set the interval on time updates for an user mouse button hold
25440 * on calendar widgets' month selection.
25442 * @param obj The calendar object
25443 * @param interval The (first) interval value in seconds
25445 * This interval value is @b decreased while the user holds the
25446 * mouse pointer either selecting next or previous month.
25448 * This helps the user to get to a given month distant from the
25449 * current one easier/faster, as it will start to change quicker and
25450 * quicker on mouse button holds.
25452 * The calculation for the next change interval value, starting from
25453 * the one set with this call, is the previous interval divided by
25454 * 1.05, so it decreases a little bit.
25456 * The default starting interval value for automatic changes is
25459 * @see elm_calendar_interval_get()
25461 * @ingroup Calendar
25463 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25466 * Get the interval on time updates for an user mouse button hold
25467 * on calendar widgets' month selection.
25469 * @param obj The calendar object
25470 * @return The (first) interval value, in seconds, set on it
25472 * @see elm_calendar_interval_set() for more details
25474 * @ingroup Calendar
25476 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25483 * @defgroup Diskselector Diskselector
25484 * @ingroup Elementary
25486 * @image html img/widget/diskselector/preview-00.png
25487 * @image latex img/widget/diskselector/preview-00.eps
25489 * A diskselector is a kind of list widget. It scrolls horizontally,
25490 * and can contain label and icon objects. Three items are displayed
25491 * with the selected one in the middle.
25493 * It can act like a circular list with round mode and labels can be
25494 * reduced for a defined length for side items.
25496 * Smart callbacks one can listen to:
25497 * - "selected" - when item is selected, i.e. scroller stops.
25499 * Available styles for it:
25502 * List of examples:
25503 * @li @ref diskselector_example_01
25504 * @li @ref diskselector_example_02
25508 * @addtogroup Diskselector
25512 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(). */
25515 * Add a new diskselector widget to the given parent Elementary
25516 * (container) object.
25518 * @param parent The parent object.
25519 * @return a new diskselector widget handle or @c NULL, on errors.
25521 * This function inserts a new diskselector widget on the canvas.
25523 * @ingroup Diskselector
25525 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25528 * Enable or disable round mode.
25530 * @param obj The diskselector object.
25531 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25534 * Disabled by default. If round mode is enabled the items list will
25535 * work like a circle list, so when the user reaches the last item,
25536 * the first one will popup.
25538 * @see elm_diskselector_round_get()
25540 * @ingroup Diskselector
25542 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25545 * Get a value whether round mode is enabled or not.
25547 * @see elm_diskselector_round_set() for details.
25549 * @param obj The diskselector object.
25550 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25551 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25553 * @ingroup Diskselector
25555 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25558 * Get the side labels max length.
25560 * @deprecated use elm_diskselector_side_label_length_get() instead:
25562 * @param obj The diskselector object.
25563 * @return The max length defined for side labels, or 0 if not a valid
25566 * @ingroup Diskselector
25568 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25571 * Set the side labels max length.
25573 * @deprecated use elm_diskselector_side_label_length_set() instead:
25575 * @param obj The diskselector object.
25576 * @param len The max length defined for side labels.
25578 * @ingroup Diskselector
25580 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25583 * Get the side labels max length.
25585 * @see elm_diskselector_side_label_length_set() for details.
25587 * @param obj The diskselector object.
25588 * @return The max length defined for side labels, or 0 if not a valid
25591 * @ingroup Diskselector
25593 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25596 * Set the side labels max length.
25598 * @param obj The diskselector object.
25599 * @param len The max length defined for side labels.
25601 * Length is the number of characters of items' label that will be
25602 * visible when it's set on side positions. It will just crop
25603 * the string after defined size. E.g.:
25605 * An item with label "January" would be displayed on side position as
25606 * "Jan" if max length is set to 3, or "Janu", if this property
25609 * When it's selected, the entire label will be displayed, except for
25610 * width restrictions. In this case label will be cropped and "..."
25611 * will be concatenated.
25613 * Default side label max length is 3.
25615 * This property will be applyed over all items, included before or
25616 * later this function call.
25618 * @ingroup Diskselector
25620 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25623 * Set the number of items to be displayed.
25625 * @param obj The diskselector object.
25626 * @param num The number of items the diskselector will display.
25628 * Default value is 3, and also it's the minimun. If @p num is less
25629 * than 3, it will be set to 3.
25631 * Also, it can be set on theme, using data item @c display_item_num
25632 * on group "elm/diskselector/item/X", where X is style set.
25635 * group { name: "elm/diskselector/item/X";
25637 * item: "display_item_num" "5";
25640 * @ingroup Diskselector
25642 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25645 * Get the number of items in the diskselector object.
25647 * @param obj The diskselector object.
25649 * @ingroup Diskselector
25651 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25654 * Set bouncing behaviour when the scrolled content reaches an edge.
25656 * Tell the internal scroller object whether it should bounce or not
25657 * when it reaches the respective edges for each axis.
25659 * @param obj The diskselector object.
25660 * @param h_bounce Whether to bounce or not in the horizontal axis.
25661 * @param v_bounce Whether to bounce or not in the vertical axis.
25663 * @see elm_scroller_bounce_set()
25665 * @ingroup Diskselector
25667 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25670 * Get the bouncing behaviour of the internal scroller.
25672 * Get whether the internal scroller should bounce when the edge of each
25673 * axis is reached scrolling.
25675 * @param obj The diskselector object.
25676 * @param h_bounce Pointer where to store the bounce state of the horizontal
25678 * @param v_bounce Pointer where to store the bounce state of the vertical
25681 * @see elm_scroller_bounce_get()
25682 * @see elm_diskselector_bounce_set()
25684 * @ingroup Diskselector
25686 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25689 * Get the scrollbar policy.
25691 * @see elm_diskselector_scroller_policy_get() for details.
25693 * @param obj The diskselector object.
25694 * @param policy_h Pointer where to store horizontal scrollbar policy.
25695 * @param policy_v Pointer where to store vertical scrollbar policy.
25697 * @ingroup Diskselector
25699 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);
25702 * Set the scrollbar policy.
25704 * @param obj The diskselector object.
25705 * @param policy_h Horizontal scrollbar policy.
25706 * @param policy_v Vertical scrollbar policy.
25708 * This sets the scrollbar visibility policy for the given scroller.
25709 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25710 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25711 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25712 * This applies respectively for the horizontal and vertical scrollbars.
25714 * The both are disabled by default, i.e., are set to
25715 * #ELM_SCROLLER_POLICY_OFF.
25717 * @ingroup Diskselector
25719 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
25722 * Remove all diskselector's items.
25724 * @param obj The diskselector object.
25726 * @see elm_diskselector_item_del()
25727 * @see elm_diskselector_item_append()
25729 * @ingroup Diskselector
25731 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25734 * Get a list of all the diskselector items.
25736 * @param obj The diskselector object.
25737 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
25738 * or @c NULL on failure.
25740 * @see elm_diskselector_item_append()
25741 * @see elm_diskselector_item_del()
25742 * @see elm_diskselector_clear()
25744 * @ingroup Diskselector
25746 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25749 * Appends a new item to the diskselector object.
25751 * @param obj The diskselector object.
25752 * @param label The label of the diskselector item.
25753 * @param icon The icon object to use at left side of the item. An
25754 * icon can be any Evas object, but usually it is an icon created
25755 * with elm_icon_add().
25756 * @param func The function to call when the item is selected.
25757 * @param data The data to associate with the item for related callbacks.
25759 * @return The created item or @c NULL upon failure.
25761 * A new item will be created and appended to the diskselector, i.e., will
25762 * be set as last item. Also, if there is no selected item, it will
25763 * be selected. This will always happens for the first appended item.
25765 * If no icon is set, label will be centered on item position, otherwise
25766 * the icon will be placed at left of the label, that will be shifted
25769 * Items created with this method can be deleted with
25770 * elm_diskselector_item_del().
25772 * Associated @p data can be properly freed when item is deleted if a
25773 * callback function is set with elm_diskselector_item_del_cb_set().
25775 * If a function is passed as argument, it will be called everytime this item
25776 * is selected, i.e., the user stops the diskselector with this
25777 * item on center position. If such function isn't needed, just passing
25778 * @c NULL as @p func is enough. The same should be done for @p data.
25780 * Simple example (with no function callback or data associated):
25782 * disk = elm_diskselector_add(win);
25783 * ic = elm_icon_add(win);
25784 * elm_icon_file_set(ic, "path/to/image", NULL);
25785 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25786 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
25789 * @see elm_diskselector_item_del()
25790 * @see elm_diskselector_item_del_cb_set()
25791 * @see elm_diskselector_clear()
25792 * @see elm_icon_add()
25794 * @ingroup Diskselector
25796 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);
25800 * Delete them item from the diskselector.
25802 * @param it The item of diskselector to be deleted.
25804 * If deleting all diskselector items is required, elm_diskselector_clear()
25805 * should be used instead of getting items list and deleting each one.
25807 * @see elm_diskselector_clear()
25808 * @see elm_diskselector_item_append()
25809 * @see elm_diskselector_item_del_cb_set()
25811 * @ingroup Diskselector
25813 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25816 * Set the function called when a diskselector item is freed.
25818 * @param it The item to set the callback on
25819 * @param func The function called
25821 * If there is a @p func, then it will be called prior item's memory release.
25822 * That will be called with the following arguments:
25824 * @li item's Evas object;
25827 * This way, a data associated to a diskselector item could be properly
25830 * @ingroup Diskselector
25832 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
25835 * Get the data associated to the item.
25837 * @param it The diskselector item
25838 * @return The data associated to @p it
25840 * The return value is a pointer to data associated to @p item when it was
25841 * created, with function elm_diskselector_item_append(). If no data
25842 * was passed as argument, it will return @c NULL.
25844 * @see elm_diskselector_item_append()
25846 * @ingroup Diskselector
25848 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25851 * Set the icon associated to the item.
25853 * @param it The diskselector item
25854 * @param icon The icon object to associate with @p it
25856 * The icon object to use at left side of the item. An
25857 * icon can be any Evas object, but usually it is an icon created
25858 * with elm_icon_add().
25860 * Once the icon object is set, a previously set one will be deleted.
25861 * @warning Setting the same icon for two items will cause the icon to
25862 * dissapear from the first item.
25864 * If an icon was passed as argument on item creation, with function
25865 * elm_diskselector_item_append(), it will be already
25866 * associated to the item.
25868 * @see elm_diskselector_item_append()
25869 * @see elm_diskselector_item_icon_get()
25871 * @ingroup Diskselector
25873 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
25876 * Get the icon associated to the item.
25878 * @param it The diskselector item
25879 * @return The icon associated to @p it
25881 * The return value is a pointer to the icon associated to @p item when it was
25882 * created, with function elm_diskselector_item_append(), or later
25883 * with function elm_diskselector_item_icon_set. If no icon
25884 * was passed as argument, it will return @c NULL.
25886 * @see elm_diskselector_item_append()
25887 * @see elm_diskselector_item_icon_set()
25889 * @ingroup Diskselector
25891 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25894 * Set the label of item.
25896 * @param it The item of diskselector.
25897 * @param label The label of item.
25899 * The label to be displayed by the item.
25901 * If no icon is set, label will be centered on item position, otherwise
25902 * the icon will be placed at left of the label, that will be shifted
25905 * An item with label "January" would be displayed on side position as
25906 * "Jan" if max length is set to 3 with function
25907 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
25910 * When this @p item is selected, the entire label will be displayed,
25911 * except for width restrictions.
25912 * In this case label will be cropped and "..." will be concatenated,
25913 * but only for display purposes. It will keep the entire string, so
25914 * if diskselector is resized the remaining characters will be displayed.
25916 * If a label was passed as argument on item creation, with function
25917 * elm_diskselector_item_append(), it will be already
25918 * displayed by the item.
25920 * @see elm_diskselector_side_label_lenght_set()
25921 * @see elm_diskselector_item_label_get()
25922 * @see elm_diskselector_item_append()
25924 * @ingroup Diskselector
25926 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
25929 * Get the label of item.
25931 * @param it The item of diskselector.
25932 * @return The label of item.
25934 * The return value is a pointer to the label associated to @p item when it was
25935 * created, with function elm_diskselector_item_append(), or later
25936 * with function elm_diskselector_item_label_set. If no label
25937 * was passed as argument, it will return @c NULL.
25939 * @see elm_diskselector_item_label_set() for more details.
25940 * @see elm_diskselector_item_append()
25942 * @ingroup Diskselector
25944 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25947 * Get the selected item.
25949 * @param obj The diskselector object.
25950 * @return The selected diskselector item.
25952 * The selected item can be unselected with function
25953 * elm_diskselector_item_selected_set(), and the first item of
25954 * diskselector will be selected.
25956 * The selected item always will be centered on diskselector, with
25957 * full label displayed, i.e., max lenght set to side labels won't
25958 * apply on the selected item. More details on
25959 * elm_diskselector_side_label_length_set().
25961 * @ingroup Diskselector
25963 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25966 * Set the selected state of an item.
25968 * @param it The diskselector item
25969 * @param selected The selected state
25971 * This sets the selected state of the given item @p it.
25972 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
25974 * If a new item is selected the previosly selected will be unselected.
25975 * Previoulsy selected item can be get with function
25976 * elm_diskselector_selected_item_get().
25978 * If the item @p it is unselected, the first item of diskselector will
25981 * Selected items will be visible on center position of diskselector.
25982 * So if it was on another position before selected, or was invisible,
25983 * diskselector will animate items until the selected item reaches center
25986 * @see elm_diskselector_item_selected_get()
25987 * @see elm_diskselector_selected_item_get()
25989 * @ingroup Diskselector
25991 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
25994 * Get whether the @p item is selected or not.
25996 * @param it The diskselector item.
25997 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
25998 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26000 * @see elm_diskselector_selected_item_set() for details.
26001 * @see elm_diskselector_item_selected_get()
26003 * @ingroup Diskselector
26005 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26008 * Get the first item of the diskselector.
26010 * @param obj The diskselector object.
26011 * @return The first item, or @c NULL if none.
26013 * The list of items follows append order. So it will return the first
26014 * item appended to the widget that wasn't deleted.
26016 * @see elm_diskselector_item_append()
26017 * @see elm_diskselector_items_get()
26019 * @ingroup Diskselector
26021 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26024 * Get the last item of the diskselector.
26026 * @param obj The diskselector object.
26027 * @return The last item, or @c NULL if none.
26029 * The list of items follows append order. So it will return last first
26030 * item appended to the widget that wasn't deleted.
26032 * @see elm_diskselector_item_append()
26033 * @see elm_diskselector_items_get()
26035 * @ingroup Diskselector
26037 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26040 * Get the item before @p item in diskselector.
26042 * @param it The diskselector item.
26043 * @return The item before @p item, or @c NULL if none or on failure.
26045 * The list of items follows append order. So it will return item appended
26046 * just before @p item and that wasn't deleted.
26048 * If it is the first item, @c NULL will be returned.
26049 * First item can be get by elm_diskselector_first_item_get().
26051 * @see elm_diskselector_item_append()
26052 * @see elm_diskselector_items_get()
26054 * @ingroup Diskselector
26056 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26059 * Get the item after @p item in diskselector.
26061 * @param it The diskselector item.
26062 * @return The item after @p item, or @c NULL if none or on failure.
26064 * The list of items follows append order. So it will return item appended
26065 * just after @p item and that wasn't deleted.
26067 * If it is the last item, @c NULL will be returned.
26068 * Last item can be get by elm_diskselector_last_item_get().
26070 * @see elm_diskselector_item_append()
26071 * @see elm_diskselector_items_get()
26073 * @ingroup Diskselector
26075 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26078 * Set the text to be shown in the diskselector item.
26080 * @param item Target item
26081 * @param text The text to set in the content
26083 * Setup the text as tooltip to object. The item can have only one tooltip,
26084 * so any previous tooltip data is removed.
26086 * @see elm_object_tooltip_text_set() for more details.
26088 * @ingroup Diskselector
26090 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26093 * Set the content to be shown in the tooltip item.
26095 * Setup the tooltip to item. The item can have only one tooltip,
26096 * so any previous tooltip data is removed. @p func(with @p data) will
26097 * be called every time that need show the tooltip and it should
26098 * return a valid Evas_Object. This object is then managed fully by
26099 * tooltip system and is deleted when the tooltip is gone.
26101 * @param item the diskselector item being attached a tooltip.
26102 * @param func the function used to create the tooltip contents.
26103 * @param data what to provide to @a func as callback data/context.
26104 * @param del_cb called when data is not needed anymore, either when
26105 * another callback replaces @p func, the tooltip is unset with
26106 * elm_diskselector_item_tooltip_unset() or the owner @a item
26107 * dies. This callback receives as the first parameter the
26108 * given @a data, and @c event_info is the item.
26110 * @see elm_object_tooltip_content_cb_set() for more details.
26112 * @ingroup Diskselector
26114 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);
26117 * Unset tooltip from item.
26119 * @param item diskselector item to remove previously set tooltip.
26121 * Remove tooltip from item. The callback provided as del_cb to
26122 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26123 * it is not used anymore.
26125 * @see elm_object_tooltip_unset() for more details.
26126 * @see elm_diskselector_item_tooltip_content_cb_set()
26128 * @ingroup Diskselector
26130 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26134 * Sets a different style for this item tooltip.
26136 * @note before you set a style you should define a tooltip with
26137 * elm_diskselector_item_tooltip_content_cb_set() or
26138 * elm_diskselector_item_tooltip_text_set()
26140 * @param item diskselector item with tooltip already set.
26141 * @param style the theme style to use (default, transparent, ...)
26143 * @see elm_object_tooltip_style_set() for more details.
26145 * @ingroup Diskselector
26147 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26150 * Get the style for this item tooltip.
26152 * @param item diskselector item with tooltip already set.
26153 * @return style the theme style in use, defaults to "default". If the
26154 * object does not have a tooltip set, then NULL is returned.
26156 * @see elm_object_tooltip_style_get() for more details.
26157 * @see elm_diskselector_item_tooltip_style_set()
26159 * @ingroup Diskselector
26161 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26164 * Set the cursor to be shown when mouse is over the diskselector item
26166 * @param item Target item
26167 * @param cursor the cursor name to be used.
26169 * @see elm_object_cursor_set() for more details.
26171 * @ingroup Diskselector
26173 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26176 * Get the cursor to be shown when mouse is over the diskselector item
26178 * @param item diskselector item with cursor already set.
26179 * @return the cursor name.
26181 * @see elm_object_cursor_get() for more details.
26182 * @see elm_diskselector_cursor_set()
26184 * @ingroup Diskselector
26186 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26190 * Unset the cursor to be shown when mouse is over the diskselector item
26192 * @param item Target item
26194 * @see elm_object_cursor_unset() for more details.
26195 * @see elm_diskselector_cursor_set()
26197 * @ingroup Diskselector
26199 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26202 * Sets a different style for this item cursor.
26204 * @note before you set a style you should define a cursor with
26205 * elm_diskselector_item_cursor_set()
26207 * @param item diskselector item with cursor already set.
26208 * @param style the theme style to use (default, transparent, ...)
26210 * @see elm_object_cursor_style_set() for more details.
26212 * @ingroup Diskselector
26214 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26218 * Get the style for this item cursor.
26220 * @param item diskselector item with cursor already set.
26221 * @return style the theme style in use, defaults to "default". If the
26222 * object does not have a cursor set, then @c NULL is returned.
26224 * @see elm_object_cursor_style_get() for more details.
26225 * @see elm_diskselector_item_cursor_style_set()
26227 * @ingroup Diskselector
26229 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26233 * Set if the cursor set should be searched on the theme or should use
26234 * the provided by the engine, only.
26236 * @note before you set if should look on theme you should define a cursor
26237 * with elm_diskselector_item_cursor_set().
26238 * By default it will only look for cursors provided by the engine.
26240 * @param item widget item with cursor already set.
26241 * @param engine_only boolean to define if cursors set with
26242 * elm_diskselector_item_cursor_set() should be searched only
26243 * between cursors provided by the engine or searched on widget's
26246 * @see elm_object_cursor_engine_only_set() for more details.
26248 * @ingroup Diskselector
26250 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26253 * Get the cursor engine only usage for this item cursor.
26255 * @param item widget item with cursor already set.
26256 * @return engine_only boolean to define it cursors should be looked only
26257 * between the provided by the engine or searched on widget's theme as well.
26258 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26260 * @see elm_object_cursor_engine_only_get() for more details.
26261 * @see elm_diskselector_item_cursor_engine_only_set()
26263 * @ingroup Diskselector
26265 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26272 * @defgroup Colorselector Colorselector
26276 * @image html img/widget/colorselector/preview-00.png
26277 * @image latex img/widget/colorselector/preview-00.eps
26279 * @brief Widget for user to select a color.
26281 * Signals that you can add callbacks for are:
26282 * "changed" - When the color value changes(event_info is NULL).
26284 * See @ref tutorial_colorselector.
26287 * @brief Add a new colorselector to the parent
26289 * @param parent The parent object
26290 * @return The new object or NULL if it cannot be created
26292 * @ingroup Colorselector
26294 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26296 * Set a color for the colorselector
26298 * @param obj Colorselector object
26299 * @param r r-value of color
26300 * @param g g-value of color
26301 * @param b b-value of color
26302 * @param a a-value of color
26304 * @ingroup Colorselector
26306 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26308 * Get a color from the colorselector
26310 * @param obj Colorselector object
26311 * @param r integer pointer for r-value of color
26312 * @param g integer pointer for g-value of color
26313 * @param b integer pointer for b-value of color
26314 * @param a integer pointer for a-value of color
26316 * @ingroup Colorselector
26318 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26324 * @defgroup Ctxpopup Ctxpopup
26326 * @image html img/widget/ctxpopup/preview-00.png
26327 * @image latex img/widget/ctxpopup/preview-00.eps
26329 * @brief Context popup widet.
26331 * A ctxpopup is a widget that, when shown, pops up a list of items.
26332 * It automatically chooses an area inside its parent object's view
26333 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26334 * optimally fit into it. In the default theme, it will also point an
26335 * arrow to it's top left position at the time one shows it. Ctxpopup
26336 * items have a label and/or an icon. It is intended for a small
26337 * number of items (hence the use of list, not genlist).
26339 * @note Ctxpopup is a especialization of @ref Hover.
26341 * Signals that you can add callbacks for are:
26342 * "dismissed" - the ctxpopup was dismissed
26344 * Default contents parts of the ctxpopup widget that you can use for are:
26345 * @li "elm.swallow.content" - A content of the ctxpopup
26347 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26350 typedef enum _Elm_Ctxpopup_Direction
26352 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26354 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26355 the clicked area */
26356 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26357 the clicked area */
26358 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26360 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26361 } Elm_Ctxpopup_Direction;
26364 * @brief Add a new Ctxpopup object to the parent.
26366 * @param parent Parent object
26367 * @return New object or @c NULL, if it cannot be created
26369 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26371 * @brief Set the Ctxpopup's parent
26373 * @param obj The ctxpopup object
26374 * @param area The parent to use
26376 * Set the parent object.
26378 * @note elm_ctxpopup_add() will automatically call this function
26379 * with its @c parent argument.
26381 * @see elm_ctxpopup_add()
26382 * @see elm_hover_parent_set()
26384 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26386 * @brief Get the Ctxpopup's parent
26388 * @param obj The ctxpopup object
26390 * @see elm_ctxpopup_hover_parent_set() for more information
26392 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26394 * @brief Clear all items in the given ctxpopup object.
26396 * @param obj Ctxpopup object
26398 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26400 * @brief Change the ctxpopup's orientation to horizontal or vertical.
26402 * @param obj Ctxpopup object
26403 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26405 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26407 * @brief Get the value of current ctxpopup object's orientation.
26409 * @param obj Ctxpopup object
26410 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26412 * @see elm_ctxpopup_horizontal_set()
26414 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26416 * @brief Add a new item to a ctxpopup object.
26418 * @param obj Ctxpopup object
26419 * @param icon Icon to be set on new item
26420 * @param label The Label of the new item
26421 * @param func Convenience function called when item selected
26422 * @param data Data passed to @p func
26423 * @return A handle to the item added or @c NULL, on errors
26425 * @warning Ctxpopup can't hold both an item list and a content at the same
26426 * time. When an item is added, any previous content will be removed.
26428 * @see elm_ctxpopup_content_set()
26430 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);
26432 * @brief Delete the given item in a ctxpopup object.
26434 * @param it Ctxpopup item to be deleted
26436 * @see elm_ctxpopup_item_append()
26438 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26440 * @brief Set the ctxpopup item's state as disabled or enabled.
26442 * @param it Ctxpopup item to be enabled/disabled
26443 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26445 * When disabled the item is greyed out to indicate it's state.
26447 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26449 * @brief Get the ctxpopup item's disabled/enabled state.
26451 * @param it Ctxpopup item to be enabled/disabled
26452 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26454 * @see elm_ctxpopup_item_disabled_set()
26456 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26458 * @brief Get the icon object for the given ctxpopup item.
26460 * @param it Ctxpopup item
26461 * @return icon object or @c NULL, if the item does not have icon or an error
26464 * @see elm_ctxpopup_item_append()
26465 * @see elm_ctxpopup_item_icon_set()
26467 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26469 * @brief Sets the side icon associated with the ctxpopup item
26471 * @param it Ctxpopup item
26472 * @param icon Icon object to be set
26474 * Once the icon object is set, a previously set one will be deleted.
26475 * @warning Setting the same icon for two items will cause the icon to
26476 * dissapear from the first item.
26478 * @see elm_ctxpopup_item_append()
26480 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26482 * @brief Get the label for the given ctxpopup item.
26484 * @param it Ctxpopup item
26485 * @return label string or @c NULL, if the item does not have label or an
26488 * @see elm_ctxpopup_item_append()
26489 * @see elm_ctxpopup_item_label_set()
26491 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26493 * @brief (Re)set the label on the given ctxpopup item.
26495 * @param it Ctxpopup item
26496 * @param label String to set as label
26498 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26500 * @brief Set an elm widget as the content of the ctxpopup.
26502 * @param obj Ctxpopup object
26503 * @param content Content to be swallowed
26505 * If the content object is already set, a previous one will bedeleted. If
26506 * you want to keep that old content object, use the
26507 * elm_ctxpopup_content_unset() function.
26509 * @deprecated use elm_object_content_set()
26511 * @warning Ctxpopup can't hold both a item list and a content at the same
26512 * time. When a content is set, any previous items will be removed.
26514 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26516 * @brief Unset the ctxpopup content
26518 * @param obj Ctxpopup object
26519 * @return The content that was being used
26521 * Unparent and return the content object which was set for this widget.
26523 * @deprecated use elm_object_content_unset()
26525 * @see elm_ctxpopup_content_set()
26527 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26529 * @brief Set the direction priority of a ctxpopup.
26531 * @param obj Ctxpopup object
26532 * @param first 1st priority of direction
26533 * @param second 2nd priority of direction
26534 * @param third 3th priority of direction
26535 * @param fourth 4th priority of direction
26537 * This functions gives a chance to user to set the priority of ctxpopup
26538 * showing direction. This doesn't guarantee the ctxpopup will appear in the
26539 * requested direction.
26541 * @see Elm_Ctxpopup_Direction
26543 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);
26545 * @brief Get the direction priority of a ctxpopup.
26547 * @param obj Ctxpopup object
26548 * @param first 1st priority of direction to be returned
26549 * @param second 2nd priority of direction to be returned
26550 * @param third 3th priority of direction to be returned
26551 * @param fourth 4th priority of direction to be returned
26553 * @see elm_ctxpopup_direction_priority_set() for more information.
26555 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);
26558 * @brief Get the current direction of a ctxpopup.
26560 * @param obj Ctxpopup object
26561 * @return current direction of a ctxpopup
26563 * @warning Once the ctxpopup showed up, the direction would be determined
26565 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26574 * @defgroup Transit Transit
26575 * @ingroup Elementary
26577 * Transit is designed to apply various animated transition effects to @c
26578 * Evas_Object, such like translation, rotation, etc. For using these
26579 * effects, create an @ref Elm_Transit and add the desired transition effects.
26581 * Once the effects are added into transit, they will be automatically
26582 * managed (their callback will be called until the duration is ended, and
26583 * they will be deleted on completion).
26587 * Elm_Transit *trans = elm_transit_add();
26588 * elm_transit_object_add(trans, obj);
26589 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26590 * elm_transit_duration_set(transit, 1);
26591 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26592 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26593 * elm_transit_repeat_times_set(transit, 3);
26596 * Some transition effects are used to change the properties of objects. They
26598 * @li @ref elm_transit_effect_translation_add
26599 * @li @ref elm_transit_effect_color_add
26600 * @li @ref elm_transit_effect_rotation_add
26601 * @li @ref elm_transit_effect_wipe_add
26602 * @li @ref elm_transit_effect_zoom_add
26603 * @li @ref elm_transit_effect_resizing_add
26605 * Other transition effects are used to make one object disappear and another
26606 * object appear on its old place. These effects are:
26608 * @li @ref elm_transit_effect_flip_add
26609 * @li @ref elm_transit_effect_resizable_flip_add
26610 * @li @ref elm_transit_effect_fade_add
26611 * @li @ref elm_transit_effect_blend_add
26613 * It's also possible to make a transition chain with @ref
26614 * elm_transit_chain_transit_add.
26616 * @warning We strongly recommend to use elm_transit just when edje can not do
26617 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26618 * animations can be manipulated inside the theme.
26620 * List of examples:
26621 * @li @ref transit_example_01_explained
26622 * @li @ref transit_example_02_explained
26623 * @li @ref transit_example_03_c
26624 * @li @ref transit_example_04_c
26630 * @enum Elm_Transit_Tween_Mode
26632 * The type of acceleration used in the transition.
26636 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26637 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26638 over time, then decrease again
26640 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26642 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26644 } Elm_Transit_Tween_Mode;
26647 * @enum Elm_Transit_Effect_Flip_Axis
26649 * The axis where flip effect should be applied.
26653 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26654 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26655 } Elm_Transit_Effect_Flip_Axis;
26657 * @enum Elm_Transit_Effect_Wipe_Dir
26659 * The direction where the wipe effect should occur.
26663 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26664 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26665 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26666 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26667 } Elm_Transit_Effect_Wipe_Dir;
26668 /** @enum Elm_Transit_Effect_Wipe_Type
26670 * Whether the wipe effect should show or hide the object.
26674 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26676 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26678 } Elm_Transit_Effect_Wipe_Type;
26681 * @typedef Elm_Transit
26683 * The Transit created with elm_transit_add(). This type has the information
26684 * about the objects which the transition will be applied, and the
26685 * transition effects that will be used. It also contains info about
26686 * duration, number of repetitions, auto-reverse, etc.
26688 typedef struct _Elm_Transit Elm_Transit;
26689 typedef void Elm_Transit_Effect;
26691 * @typedef Elm_Transit_Effect_Transition_Cb
26693 * Transition callback called for this effect on each transition iteration.
26695 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26697 * Elm_Transit_Effect_End_Cb
26699 * Transition callback called for this effect when the transition is over.
26701 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26704 * Elm_Transit_Del_Cb
26706 * A callback called when the transit is deleted.
26708 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26713 * @note Is not necessary to delete the transit object, it will be deleted at
26714 * the end of its operation.
26715 * @note The transit will start playing when the program enter in the main loop, is not
26716 * necessary to give a start to the transit.
26718 * @return The transit object.
26722 EAPI Elm_Transit *elm_transit_add(void);
26725 * Stops the animation and delete the @p transit object.
26727 * Call this function if you wants to stop the animation before the duration
26728 * time. Make sure the @p transit object is still alive with
26729 * elm_transit_del_cb_set() function.
26730 * All added effects will be deleted, calling its repective data_free_cb
26731 * functions. The function setted by elm_transit_del_cb_set() will be called.
26733 * @see elm_transit_del_cb_set()
26735 * @param transit The transit object to be deleted.
26738 * @warning Just call this function if you are sure the transit is alive.
26740 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26743 * Add a new effect to the transit.
26745 * @note The cb function and the data are the key to the effect. If you try to
26746 * add an already added effect, nothing is done.
26747 * @note After the first addition of an effect in @p transit, if its
26748 * effect list become empty again, the @p transit will be killed by
26749 * elm_transit_del(transit) function.
26753 * Elm_Transit *transit = elm_transit_add();
26754 * elm_transit_effect_add(transit,
26755 * elm_transit_effect_blend_op,
26756 * elm_transit_effect_blend_context_new(),
26757 * elm_transit_effect_blend_context_free);
26760 * @param transit The transit object.
26761 * @param transition_cb The operation function. It is called when the
26762 * animation begins, it is the function that actually performs the animation.
26763 * It is called with the @p data, @p transit and the time progression of the
26764 * animation (a double value between 0.0 and 1.0).
26765 * @param effect The context data of the effect.
26766 * @param end_cb The function to free the context data, it will be called
26767 * at the end of the effect, it must finalize the animation and free the
26771 * @warning The transit free the context data at the and of the transition with
26772 * the data_free_cb function, do not use the context data in another transit.
26774 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);
26777 * Delete an added effect.
26779 * This function will remove the effect from the @p transit, calling the
26780 * data_free_cb to free the @p data.
26782 * @see elm_transit_effect_add()
26784 * @note If the effect is not found, nothing is done.
26785 * @note If the effect list become empty, this function will call
26786 * elm_transit_del(transit), that is, it will kill the @p transit.
26788 * @param transit The transit object.
26789 * @param transition_cb The operation function.
26790 * @param effect The context data of the effect.
26794 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);
26797 * Add new object to apply the effects.
26799 * @note After the first addition of an object in @p transit, if its
26800 * object list become empty again, the @p transit will be killed by
26801 * elm_transit_del(transit) function.
26802 * @note If the @p obj belongs to another transit, the @p obj will be
26803 * removed from it and it will only belong to the @p transit. If the old
26804 * transit stays without objects, it will die.
26805 * @note When you add an object into the @p transit, its state from
26806 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26807 * transit ends, if you change this state whith evas_object_pass_events_set()
26808 * after add the object, this state will change again when @p transit stops to
26811 * @param transit The transit object.
26812 * @param obj Object to be animated.
26815 * @warning It is not allowed to add a new object after transit begins to go.
26817 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26820 * Removes an added object from the transit.
26822 * @note If the @p obj is not in the @p transit, nothing is done.
26823 * @note If the list become empty, this function will call
26824 * elm_transit_del(transit), that is, it will kill the @p transit.
26826 * @param transit The transit object.
26827 * @param obj Object to be removed from @p transit.
26830 * @warning It is not allowed to remove objects after transit begins to go.
26832 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26835 * Get the objects of the transit.
26837 * @param transit The transit object.
26838 * @return a Eina_List with the objects from the transit.
26842 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26845 * Enable/disable keeping up the objects states.
26846 * If it is not kept, the objects states will be reset when transition ends.
26848 * @note @p transit can not be NULL.
26849 * @note One state includes geometry, color, map data.
26851 * @param transit The transit object.
26852 * @param state_keep Keeping or Non Keeping.
26856 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
26859 * Get a value whether the objects states will be reset or not.
26861 * @note @p transit can not be NULL
26863 * @see elm_transit_objects_final_state_keep_set()
26865 * @param transit The transit object.
26866 * @return EINA_TRUE means the states of the objects will be reset.
26867 * If @p transit is NULL, EINA_FALSE is returned
26871 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26874 * Set the event enabled when transit is operating.
26876 * If @p enabled is EINA_TRUE, the objects of the transit will receives
26877 * events from mouse and keyboard during the animation.
26878 * @note When you add an object with elm_transit_object_add(), its state from
26879 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26880 * transit ends, if you change this state with evas_object_pass_events_set()
26881 * after adding the object, this state will change again when @p transit stops
26884 * @param transit The transit object.
26885 * @param enabled Events are received when enabled is @c EINA_TRUE, and
26886 * ignored otherwise.
26890 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26893 * Get the value of event enabled status.
26895 * @see elm_transit_event_enabled_set()
26897 * @param transit The Transit object
26898 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
26899 * EINA_FALSE is returned
26903 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26906 * Set the user-callback function when the transit is deleted.
26908 * @note Using this function twice will overwrite the first function setted.
26909 * @note the @p transit object will be deleted after call @p cb function.
26911 * @param transit The transit object.
26912 * @param cb Callback function pointer. This function will be called before
26913 * the deletion of the transit.
26914 * @param data Callback funtion user data. It is the @p op parameter.
26918 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
26921 * Set reverse effect automatically.
26923 * If auto reverse is setted, after running the effects with the progress
26924 * parameter from 0 to 1, it will call the effecs again with the progress
26925 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
26926 * where the duration was setted with the function elm_transit_add and
26927 * the repeat with the function elm_transit_repeat_times_set().
26929 * @param transit The transit object.
26930 * @param reverse EINA_TRUE means the auto_reverse is on.
26934 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
26937 * Get if the auto reverse is on.
26939 * @see elm_transit_auto_reverse_set()
26941 * @param transit The transit object.
26942 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
26943 * EINA_FALSE is returned
26947 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26950 * Set the transit repeat count. Effect will be repeated by repeat count.
26952 * This function sets the number of repetition the transit will run after
26953 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
26954 * If the @p repeat is a negative number, it will repeat infinite times.
26956 * @note If this function is called during the transit execution, the transit
26957 * will run @p repeat times, ignoring the times it already performed.
26959 * @param transit The transit object
26960 * @param repeat Repeat count
26964 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
26967 * Get the transit repeat count.
26969 * @see elm_transit_repeat_times_set()
26971 * @param transit The Transit object.
26972 * @return The repeat count. If @p transit is NULL
26977 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26980 * Set the transit animation acceleration type.
26982 * This function sets the tween mode of the transit that can be:
26983 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
26984 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
26985 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
26986 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
26988 * @param transit The transit object.
26989 * @param tween_mode The tween type.
26993 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
26996 * Get the transit animation acceleration type.
26998 * @note @p transit can not be NULL
27000 * @param transit The transit object.
27001 * @return The tween type. If @p transit is NULL
27002 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27006 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27009 * Set the transit animation time
27011 * @note @p transit can not be NULL
27013 * @param transit The transit object.
27014 * @param duration The animation time.
27018 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27021 * Get the transit animation time
27023 * @note @p transit can not be NULL
27025 * @param transit The transit object.
27027 * @return The transit animation time.
27031 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27034 * Starts the transition.
27035 * Once this API is called, the transit begins to measure the time.
27037 * @note @p transit can not be NULL
27039 * @param transit The transit object.
27043 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27046 * Pause/Resume the transition.
27048 * If you call elm_transit_go again, the transit will be started from the
27049 * beginning, and will be unpaused.
27051 * @note @p transit can not be NULL
27053 * @param transit The transit object.
27054 * @param paused Whether the transition should be paused or not.
27058 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27061 * Get the value of paused status.
27063 * @see elm_transit_paused_set()
27065 * @note @p transit can not be NULL
27067 * @param transit The transit object.
27068 * @return EINA_TRUE means transition is paused. If @p transit is NULL
27069 * EINA_FALSE is returned
27073 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27076 * Get the time progression of the animation (a double value between 0.0 and 1.0).
27078 * The value returned is a fraction (current time / total time). It
27079 * represents the progression position relative to the total.
27081 * @note @p transit can not be NULL
27083 * @param transit The transit object.
27085 * @return The time progression value. If @p transit is NULL
27090 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27093 * Makes the chain relationship between two transits.
27095 * @note @p transit can not be NULL. Transit would have multiple chain transits.
27096 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27098 * @param transit The transit object.
27099 * @param chain_transit The chain transit object. This transit will be operated
27100 * after transit is done.
27102 * This function adds @p chain_transit transition to a chain after the @p
27103 * transit, and will be started as soon as @p transit ends. See @ref
27104 * transit_example_02_explained for a full example.
27108 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27111 * Cut off the chain relationship between two transits.
27113 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27114 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27116 * @param transit The transit object.
27117 * @param chain_transit The chain transit object.
27119 * This function remove the @p chain_transit transition from the @p transit.
27123 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27126 * Get the current chain transit list.
27128 * @note @p transit can not be NULL.
27130 * @param transit The transit object.
27131 * @return chain transit list.
27135 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
27138 * Add the Resizing Effect to Elm_Transit.
27140 * @note This API is one of the facades. It creates resizing effect context
27141 * and add it's required APIs to elm_transit_effect_add.
27143 * @see elm_transit_effect_add()
27145 * @param transit Transit object.
27146 * @param from_w Object width size when effect begins.
27147 * @param from_h Object height size when effect begins.
27148 * @param to_w Object width size when effect ends.
27149 * @param to_h Object height size when effect ends.
27150 * @return Resizing effect context data.
27154 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);
27157 * Add the Translation Effect to Elm_Transit.
27159 * @note This API is one of the facades. It creates translation effect context
27160 * and add it's required APIs to elm_transit_effect_add.
27162 * @see elm_transit_effect_add()
27164 * @param transit Transit object.
27165 * @param from_dx X Position variation when effect begins.
27166 * @param from_dy Y Position variation when effect begins.
27167 * @param to_dx X Position variation when effect ends.
27168 * @param to_dy Y Position variation when effect ends.
27169 * @return Translation effect context data.
27172 * @warning It is highly recommended just create a transit with this effect when
27173 * the window that the objects of the transit belongs has already been created.
27174 * This is because this effect needs the geometry information about the objects,
27175 * and if the window was not created yet, it can get a wrong information.
27177 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);
27180 * Add the Zoom Effect to Elm_Transit.
27182 * @note This API is one of the facades. It creates zoom effect context
27183 * and add it's required APIs to elm_transit_effect_add.
27185 * @see elm_transit_effect_add()
27187 * @param transit Transit object.
27188 * @param from_rate Scale rate when effect begins (1 is current rate).
27189 * @param to_rate Scale rate when effect ends.
27190 * @return Zoom effect context data.
27193 * @warning It is highly recommended just create a transit with this effect when
27194 * the window that the objects of the transit belongs has already been created.
27195 * This is because this effect needs the geometry information about the objects,
27196 * and if the window was not created yet, it can get a wrong information.
27198 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27201 * Add the Flip Effect to Elm_Transit.
27203 * @note This API is one of the facades. It creates flip effect context
27204 * and add it's required APIs to elm_transit_effect_add.
27205 * @note This effect is applied to each pair of objects in the order they are listed
27206 * in the transit list of objects. The first object in the pair will be the
27207 * "front" object and the second will be the "back" object.
27209 * @see elm_transit_effect_add()
27211 * @param transit Transit object.
27212 * @param axis Flipping Axis(X or Y).
27213 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27214 * @return Flip effect context data.
27217 * @warning It is highly recommended just create a transit with this effect when
27218 * the window that the objects of the transit belongs has already been created.
27219 * This is because this effect needs the geometry information about the objects,
27220 * and if the window was not created yet, it can get a wrong information.
27222 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27225 * Add the Resizable Flip Effect to Elm_Transit.
27227 * @note This API is one of the facades. It creates resizable flip effect context
27228 * and add it's required APIs to elm_transit_effect_add.
27229 * @note This effect is applied to each pair of objects in the order they are listed
27230 * in the transit list of objects. The first object in the pair will be the
27231 * "front" object and the second will be the "back" object.
27233 * @see elm_transit_effect_add()
27235 * @param transit Transit object.
27236 * @param axis Flipping Axis(X or Y).
27237 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27238 * @return Resizable flip effect context data.
27241 * @warning It is highly recommended just create a transit with this effect when
27242 * the window that the objects of the transit belongs has already been created.
27243 * This is because this effect needs the geometry information about the objects,
27244 * and if the window was not created yet, it can get a wrong information.
27246 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27249 * Add the Wipe Effect to Elm_Transit.
27251 * @note This API is one of the facades. It creates wipe effect context
27252 * and add it's required APIs to elm_transit_effect_add.
27254 * @see elm_transit_effect_add()
27256 * @param transit Transit object.
27257 * @param type Wipe type. Hide or show.
27258 * @param dir Wipe Direction.
27259 * @return Wipe effect context data.
27262 * @warning It is highly recommended just create a transit with this effect when
27263 * the window that the objects of the transit belongs has already been created.
27264 * This is because this effect needs the geometry information about the objects,
27265 * and if the window was not created yet, it can get a wrong information.
27267 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27270 * Add the Color Effect to Elm_Transit.
27272 * @note This API is one of the facades. It creates color effect context
27273 * and add it's required APIs to elm_transit_effect_add.
27275 * @see elm_transit_effect_add()
27277 * @param transit Transit object.
27278 * @param from_r RGB R when effect begins.
27279 * @param from_g RGB G when effect begins.
27280 * @param from_b RGB B when effect begins.
27281 * @param from_a RGB A when effect begins.
27282 * @param to_r RGB R when effect ends.
27283 * @param to_g RGB G when effect ends.
27284 * @param to_b RGB B when effect ends.
27285 * @param to_a RGB A when effect ends.
27286 * @return Color effect context data.
27290 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);
27293 * Add the Fade Effect to Elm_Transit.
27295 * @note This API is one of the facades. It creates fade effect context
27296 * and add it's required APIs to elm_transit_effect_add.
27297 * @note This effect is applied to each pair of objects in the order they are listed
27298 * in the transit list of objects. The first object in the pair will be the
27299 * "before" object and the second will be the "after" object.
27301 * @see elm_transit_effect_add()
27303 * @param transit Transit object.
27304 * @return Fade effect context data.
27307 * @warning It is highly recommended just create a transit with this effect when
27308 * the window that the objects of the transit belongs has already been created.
27309 * This is because this effect needs the color information about the objects,
27310 * and if the window was not created yet, it can get a wrong information.
27312 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27315 * Add the Blend Effect to Elm_Transit.
27317 * @note This API is one of the facades. It creates blend effect context
27318 * and add it's required APIs to elm_transit_effect_add.
27319 * @note This effect is applied to each pair of objects in the order they are listed
27320 * in the transit list of objects. The first object in the pair will be the
27321 * "before" object and the second will be the "after" object.
27323 * @see elm_transit_effect_add()
27325 * @param transit Transit object.
27326 * @return Blend effect context data.
27329 * @warning It is highly recommended just create a transit with this effect when
27330 * the window that the objects of the transit belongs has already been created.
27331 * This is because this effect needs the color information about the objects,
27332 * and if the window was not created yet, it can get a wrong information.
27334 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27337 * Add the Rotation Effect to Elm_Transit.
27339 * @note This API is one of the facades. It creates rotation effect context
27340 * and add it's required APIs to elm_transit_effect_add.
27342 * @see elm_transit_effect_add()
27344 * @param transit Transit object.
27345 * @param from_degree Degree when effect begins.
27346 * @param to_degree Degree when effect is ends.
27347 * @return Rotation effect context data.
27350 * @warning It is highly recommended just create a transit with this effect when
27351 * the window that the objects of the transit belongs has already been created.
27352 * This is because this effect needs the geometry information about the objects,
27353 * and if the window was not created yet, it can get a wrong information.
27355 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27358 * Add the ImageAnimation Effect to Elm_Transit.
27360 * @note This API is one of the facades. It creates image animation effect context
27361 * and add it's required APIs to elm_transit_effect_add.
27362 * The @p images parameter is a list images paths. This list and
27363 * its contents will be deleted at the end of the effect by
27364 * elm_transit_effect_image_animation_context_free() function.
27368 * char buf[PATH_MAX];
27369 * Eina_List *images = NULL;
27370 * Elm_Transit *transi = elm_transit_add();
27372 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27373 * images = eina_list_append(images, eina_stringshare_add(buf));
27375 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27376 * images = eina_list_append(images, eina_stringshare_add(buf));
27377 * elm_transit_effect_image_animation_add(transi, images);
27381 * @see elm_transit_effect_add()
27383 * @param transit Transit object.
27384 * @param images Eina_List of images file paths. This list and
27385 * its contents will be deleted at the end of the effect by
27386 * elm_transit_effect_image_animation_context_free() function.
27387 * @return Image Animation effect context data.
27391 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27396 typedef struct _Elm_Store Elm_Store;
27397 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
27398 typedef struct _Elm_Store_Item Elm_Store_Item;
27399 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
27400 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
27401 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27402 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
27403 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
27404 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
27405 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
27406 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
27408 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27409 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
27410 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
27411 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27415 ELM_STORE_ITEM_MAPPING_NONE = 0,
27416 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27417 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27418 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27419 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27420 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27421 // can add more here as needed by common apps
27422 ELM_STORE_ITEM_MAPPING_LAST
27423 } Elm_Store_Item_Mapping_Type;
27425 struct _Elm_Store_Item_Mapping_Icon
27427 // FIXME: allow edje file icons
27429 Elm_Icon_Lookup_Order lookup_order;
27430 Eina_Bool standard_name : 1;
27431 Eina_Bool no_scale : 1;
27432 Eina_Bool smooth : 1;
27433 Eina_Bool scale_up : 1;
27434 Eina_Bool scale_down : 1;
27437 struct _Elm_Store_Item_Mapping_Empty
27442 struct _Elm_Store_Item_Mapping_Photo
27447 struct _Elm_Store_Item_Mapping_Custom
27449 Elm_Store_Item_Mapping_Cb func;
27452 struct _Elm_Store_Item_Mapping
27454 Elm_Store_Item_Mapping_Type type;
27459 Elm_Store_Item_Mapping_Empty empty;
27460 Elm_Store_Item_Mapping_Icon icon;
27461 Elm_Store_Item_Mapping_Photo photo;
27462 Elm_Store_Item_Mapping_Custom custom;
27463 // add more types here
27467 struct _Elm_Store_Item_Info
27469 Elm_Genlist_Item_Class *item_class;
27470 const Elm_Store_Item_Mapping *mapping;
27475 struct _Elm_Store_Item_Info_Filesystem
27477 Elm_Store_Item_Info base;
27481 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27482 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27484 EAPI void elm_store_free(Elm_Store *st);
27486 EAPI Elm_Store *elm_store_filesystem_new(void);
27487 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27488 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27489 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27491 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27493 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27494 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27495 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27496 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27497 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27498 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27500 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27501 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27502 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27503 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27504 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27505 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27506 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27509 * @defgroup SegmentControl SegmentControl
27510 * @ingroup Elementary
27512 * @image html img/widget/segment_control/preview-00.png
27513 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27515 * @image html img/segment_control.png
27516 * @image latex img/segment_control.eps width=\textwidth
27518 * Segment control widget is a horizontal control made of multiple segment
27519 * items, each segment item functioning similar to discrete two state button.
27520 * A segment control groups the items together and provides compact
27521 * single button with multiple equal size segments.
27523 * Segment item size is determined by base widget
27524 * size and the number of items added.
27525 * Only one segment item can be at selected state. A segment item can display
27526 * combination of Text and any Evas_Object like Images or other widget.
27528 * Smart callbacks one can listen to:
27529 * - "changed" - When the user clicks on a segment item which is not
27530 * previously selected and get selected. The event_info parameter is the
27531 * segment item pointer.
27533 * Available styles for it:
27536 * Here is an example on its usage:
27537 * @li @ref segment_control_example
27541 * @addtogroup SegmentControl
27545 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27548 * Add a new segment control widget to the given parent Elementary
27549 * (container) object.
27551 * @param parent The parent object.
27552 * @return a new segment control widget handle or @c NULL, on errors.
27554 * This function inserts a new segment control widget on the canvas.
27556 * @ingroup SegmentControl
27558 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27561 * Append a new item to the segment control object.
27563 * @param obj The segment control object.
27564 * @param icon The icon object to use for the left side of the item. An
27565 * icon can be any Evas object, but usually it is an icon created
27566 * with elm_icon_add().
27567 * @param label The label of the item.
27568 * Note that, NULL is different from empty string "".
27569 * @return The created item or @c NULL upon failure.
27571 * A new item will be created and appended to the segment control, i.e., will
27572 * be set as @b last item.
27574 * If it should be inserted at another position,
27575 * elm_segment_control_item_insert_at() should be used instead.
27577 * Items created with this function can be deleted with function
27578 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27580 * @note @p label set to @c NULL is different from empty string "".
27582 * only has icon, it will be displayed bigger and centered. If it has
27583 * icon and label, even that an empty string, icon will be smaller and
27584 * positioned at left.
27588 * sc = elm_segment_control_add(win);
27589 * ic = elm_icon_add(win);
27590 * elm_icon_file_set(ic, "path/to/image", NULL);
27591 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27592 * elm_segment_control_item_add(sc, ic, "label");
27593 * evas_object_show(sc);
27596 * @see elm_segment_control_item_insert_at()
27597 * @see elm_segment_control_item_del()
27599 * @ingroup SegmentControl
27601 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27604 * Insert a new item to the segment control object at specified position.
27606 * @param obj The segment control object.
27607 * @param icon The icon object to use for the left side of the item. An
27608 * icon can be any Evas object, but usually it is an icon created
27609 * with elm_icon_add().
27610 * @param label The label of the item.
27611 * @param index Item position. Value should be between 0 and items count.
27612 * @return The created item or @c NULL upon failure.
27614 * Index values must be between @c 0, when item will be prepended to
27615 * segment control, and items count, that can be get with
27616 * elm_segment_control_item_count_get(), case when item will be appended
27617 * to segment control, just like elm_segment_control_item_add().
27619 * Items created with this function can be deleted with function
27620 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27622 * @note @p label set to @c NULL is different from empty string "".
27624 * only has icon, it will be displayed bigger and centered. If it has
27625 * icon and label, even that an empty string, icon will be smaller and
27626 * positioned at left.
27628 * @see elm_segment_control_item_add()
27629 * @see elm_segment_control_item_count_get()
27630 * @see elm_segment_control_item_del()
27632 * @ingroup SegmentControl
27634 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);
27637 * Remove a segment control item from its parent, deleting it.
27639 * @param it The item to be removed.
27641 * Items can be added with elm_segment_control_item_add() or
27642 * elm_segment_control_item_insert_at().
27644 * @ingroup SegmentControl
27646 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27649 * Remove a segment control item at given index from its parent,
27652 * @param obj The segment control object.
27653 * @param index The position of the segment control item to be deleted.
27655 * Items can be added with elm_segment_control_item_add() or
27656 * elm_segment_control_item_insert_at().
27658 * @ingroup SegmentControl
27660 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27663 * Get the Segment items count from segment control.
27665 * @param obj The segment control object.
27666 * @return Segment items count.
27668 * It will just return the number of items added to segment control @p obj.
27670 * @ingroup SegmentControl
27672 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27675 * Get the item placed at specified index.
27677 * @param obj The segment control object.
27678 * @param index The index of the segment item.
27679 * @return The segment control item or @c NULL on failure.
27681 * Index is the position of an item in segment control widget. Its
27682 * range is from @c 0 to <tt> count - 1 </tt>.
27683 * Count is the number of items, that can be get with
27684 * elm_segment_control_item_count_get().
27686 * @ingroup SegmentControl
27688 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27691 * Get the label of item.
27693 * @param obj The segment control object.
27694 * @param index The index of the segment item.
27695 * @return The label of the item at @p index.
27697 * The return value is a pointer to the label associated to the item when
27698 * it was created, with function elm_segment_control_item_add(), or later
27699 * with function elm_segment_control_item_label_set. If no label
27700 * was passed as argument, it will return @c NULL.
27702 * @see elm_segment_control_item_label_set() for more details.
27703 * @see elm_segment_control_item_add()
27705 * @ingroup SegmentControl
27707 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27710 * Set the label of item.
27712 * @param it The item of segment control.
27713 * @param text The label of item.
27715 * The label to be displayed by the item.
27716 * Label will be at right of the icon (if set).
27718 * If a label was passed as argument on item creation, with function
27719 * elm_control_segment_item_add(), it will be already
27720 * displayed by the item.
27722 * @see elm_segment_control_item_label_get()
27723 * @see elm_segment_control_item_add()
27725 * @ingroup SegmentControl
27727 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
27730 * Get the icon associated to the item.
27732 * @param obj The segment control object.
27733 * @param index The index of the segment item.
27734 * @return The left side icon associated to the item at @p index.
27736 * The return value is a pointer to the icon associated to the item when
27737 * it was created, with function elm_segment_control_item_add(), or later
27738 * with function elm_segment_control_item_icon_set(). If no icon
27739 * was passed as argument, it will return @c NULL.
27741 * @see elm_segment_control_item_add()
27742 * @see elm_segment_control_item_icon_set()
27744 * @ingroup SegmentControl
27746 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27749 * Set the icon associated to the item.
27751 * @param it The segment control item.
27752 * @param icon The icon object to associate with @p it.
27754 * The icon object to use at left side of the item. An
27755 * icon can be any Evas object, but usually it is an icon created
27756 * with elm_icon_add().
27758 * Once the icon object is set, a previously set one will be deleted.
27759 * @warning Setting the same icon for two items will cause the icon to
27760 * dissapear from the first item.
27762 * If an icon was passed as argument on item creation, with function
27763 * elm_segment_control_item_add(), it will be already
27764 * associated to the item.
27766 * @see elm_segment_control_item_add()
27767 * @see elm_segment_control_item_icon_get()
27769 * @ingroup SegmentControl
27771 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27774 * Get the index of an item.
27776 * @param it The segment control item.
27777 * @return The position of item in segment control widget.
27779 * Index is the position of an item in segment control widget. Its
27780 * range is from @c 0 to <tt> count - 1 </tt>.
27781 * Count is the number of items, that can be get with
27782 * elm_segment_control_item_count_get().
27784 * @ingroup SegmentControl
27786 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27789 * Get the base object of the item.
27791 * @param it The segment control item.
27792 * @return The base object associated with @p it.
27794 * Base object is the @c Evas_Object that represents that item.
27796 * @ingroup SegmentControl
27798 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27801 * Get the selected item.
27803 * @param obj The segment control object.
27804 * @return The selected item or @c NULL if none of segment items is
27807 * The selected item can be unselected with function
27808 * elm_segment_control_item_selected_set().
27810 * The selected item always will be highlighted on segment control.
27812 * @ingroup SegmentControl
27814 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27817 * Set the selected state of an item.
27819 * @param it The segment control item
27820 * @param select The selected state
27822 * This sets the selected state of the given item @p it.
27823 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27825 * If a new item is selected the previosly selected will be unselected.
27826 * Previoulsy selected item can be get with function
27827 * elm_segment_control_item_selected_get().
27829 * The selected item always will be highlighted on segment control.
27831 * @see elm_segment_control_item_selected_get()
27833 * @ingroup SegmentControl
27835 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
27842 * @defgroup Grid Grid
27844 * The grid is a grid layout widget that lays out a series of children as a
27845 * fixed "grid" of widgets using a given percentage of the grid width and
27846 * height each using the child object.
27848 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
27849 * widgets size itself. The default is 100 x 100, so that means the
27850 * position and sizes of children will effectively be percentages (0 to 100)
27851 * of the width or height of the grid widget
27857 * Add a new grid to the parent
27859 * @param parent The parent object
27860 * @return The new object or NULL if it cannot be created
27864 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
27867 * Set the virtual size of the grid
27869 * @param obj The grid object
27870 * @param w The virtual width of the grid
27871 * @param h The virtual height of the grid
27875 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
27878 * Get the virtual size of the grid
27880 * @param obj The grid object
27881 * @param w Pointer to integer to store the virtual width of the grid
27882 * @param h Pointer to integer to store the virtual height of the grid
27886 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
27889 * Pack child at given position and size
27891 * @param obj The grid object
27892 * @param subobj The child to pack
27893 * @param x The virtual x coord at which to pack it
27894 * @param y The virtual y coord at which to pack it
27895 * @param w The virtual width at which to pack it
27896 * @param h The virtual height at which to pack it
27900 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
27903 * Unpack a child from a grid object
27905 * @param obj The grid object
27906 * @param subobj The child to unpack
27910 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
27913 * Faster way to remove all child objects from a grid object.
27915 * @param obj The grid object
27916 * @param clear If true, it will delete just removed children
27920 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
27923 * Set packing of an existing child at to position and size
27925 * @param subobj The child to set packing of
27926 * @param x The virtual x coord at which to pack it
27927 * @param y The virtual y coord at which to pack it
27928 * @param w The virtual width at which to pack it
27929 * @param h The virtual height at which to pack it
27933 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
27936 * get packing of a child
27938 * @param subobj The child to query
27939 * @param x Pointer to integer to store the virtual x coord
27940 * @param y Pointer to integer to store the virtual y coord
27941 * @param w Pointer to integer to store the virtual width
27942 * @param h Pointer to integer to store the virtual height
27946 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
27952 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
27953 EINA_DEPRECATED EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
27954 EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
27955 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
27956 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
27957 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
27960 * @defgroup Video Video
27962 * @addtogroup Video
27965 * Elementary comes with two object that help design application that need
27966 * to display video. The main one, Elm_Video, display a video by using Emotion.
27967 * It does embedded the video inside an Edje object, so you can do some
27968 * animation depending on the video state change. It does also implement a
27969 * ressource management policy to remove this burden from the application writer.
27971 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
27972 * It take care of updating its content according to Emotion event and provide a
27973 * way to theme itself. It also does automatically raise the priority of the
27974 * linked Elm_Video so it will use the video decoder if available. It also does
27975 * activate the remember function on the linked Elm_Video object.
27977 * Signals that you can add callback for are :
27979 * "forward,clicked" - the user clicked the forward button.
27980 * "info,clicked" - the user clicked the info button.
27981 * "next,clicked" - the user clicked the next button.
27982 * "pause,clicked" - the user clicked the pause button.
27983 * "play,clicked" - the user clicked the play button.
27984 * "prev,clicked" - the user clicked the prev button.
27985 * "rewind,clicked" - the user clicked the rewind button.
27986 * "stop,clicked" - the user clicked the stop button.
27990 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
27992 * @param parent The parent object
27993 * @return a new player widget handle or @c NULL, on errors.
27995 * This function inserts a new player widget on the canvas.
27997 * @see elm_player_video_set()
28001 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28004 * @brief Link a Elm_Payer with an Elm_Video object.
28006 * @param player the Elm_Player object.
28007 * @param video The Elm_Video object.
28009 * This mean that action on the player widget will affect the
28010 * video object and the state of the video will be reflected in
28011 * the player itself.
28013 * @see elm_player_add()
28014 * @see elm_video_add()
28018 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28021 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28023 * @param parent The parent object
28024 * @return a new video widget handle or @c NULL, on errors.
28026 * This function inserts a new video widget on the canvas.
28028 * @seeelm_video_file_set()
28029 * @see elm_video_uri_set()
28033 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28036 * @brief Define the file that will be the video source.
28038 * @param video The video object to define the file for.
28039 * @param filename The file to target.
28041 * This function will explicitly define a filename as a source
28042 * for the video of the Elm_Video object.
28044 * @see elm_video_uri_set()
28045 * @see elm_video_add()
28046 * @see elm_player_add()
28050 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28053 * @brief Define the uri that will be the video source.
28055 * @param video The video object to define the file for.
28056 * @param uri The uri to target.
28058 * This function will define an uri as a source for the video of the
28059 * Elm_Video object. URI could be remote source of video, like http:// or local source
28060 * like for example WebCam who are most of the time v4l2:// (but that depend and
28061 * you should use Emotion API to request and list the available Webcam on your system).
28063 * @see elm_video_file_set()
28064 * @see elm_video_add()
28065 * @see elm_player_add()
28069 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28072 * @brief Get the underlying Emotion object.
28074 * @param video The video object to proceed the request on.
28075 * @return the underlying Emotion object.
28079 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
28082 * @brief Start to play the video
28084 * @param video The video object to proceed the request on.
28086 * Start to play the video and cancel all suspend state.
28090 EAPI void elm_video_play(Evas_Object *video);
28093 * @brief Pause the video
28095 * @param video The video object to proceed the request on.
28097 * Pause the video and start a timer to trigger suspend mode.
28101 EAPI void elm_video_pause(Evas_Object *video);
28104 * @brief Stop the video
28106 * @param video The video object to proceed the request on.
28108 * Stop the video and put the emotion in deep sleep mode.
28112 EAPI void elm_video_stop(Evas_Object *video);
28115 * @brief Is the video actually playing.
28117 * @param video The video object to proceed the request on.
28118 * @return EINA_TRUE if the video is actually playing.
28120 * You should consider watching event on the object instead of polling
28121 * the object state.
28125 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
28128 * @brief Is it possible to seek inside the video.
28130 * @param video The video object to proceed the request on.
28131 * @return EINA_TRUE if is possible to seek inside the video.
28135 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
28138 * @brief Is the audio muted.
28140 * @param video The video object to proceed the request on.
28141 * @return EINA_TRUE if the audio is muted.
28145 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
28148 * @brief Change the mute state of the Elm_Video object.
28150 * @param video The video object to proceed the request on.
28151 * @param mute The new mute state.
28155 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28158 * @brief Get the audio level of the current video.
28160 * @param video The video object to proceed the request on.
28161 * @return the current audio level.
28165 EAPI double elm_video_audio_level_get(Evas_Object *video);
28168 * @brief Set the audio level of anElm_Video object.
28170 * @param video The video object to proceed the request on.
28171 * @param volume The new audio volume.
28175 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28177 EAPI double elm_video_play_position_get(Evas_Object *video);
28178 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28179 EAPI double elm_video_play_length_get(Evas_Object *video);
28180 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28181 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
28182 EAPI const char *elm_video_title_get(Evas_Object *video);
28188 * @defgroup Naviframe Naviframe
28189 * @ingroup Elementary
28191 * @brief Naviframe is a kind of view manager for the applications.
28193 * Naviframe provides functions to switch different pages with stack
28194 * mechanism. It means if one page(item) needs to be changed to the new one,
28195 * then naviframe would push the new page to it's internal stack. Of course,
28196 * it can be back to the previous page by popping the top page. Naviframe
28197 * provides some transition effect while the pages are switching (same as
28200 * Since each item could keep the different styles, users could keep the
28201 * same look & feel for the pages or different styles for the items in it's
28204 * Signals that you can add callback for are:
28205 * @li "transition,finished" - When the transition is finished in changing
28207 * @li "title,clicked" - User clicked title area
28209 * Default contents parts of the naviframe items that you can use for are:
28210 * @li "elm.swallow.content" - A main content of the page
28211 * @li "elm.swallow.icon" - A icon in the title area
28212 * @li "elm.swallow.prev_btn" - A button to go to the previous page
28213 * @li "elm.swallow.next_btn" - A button to go to the next page
28215 * Default text parts of the naviframe items that you can use for are:
28216 * @li "elm.text.title" - Title label in the title area
28217 * @li "elm.text.subtitle" - Sub-title label in the title area
28219 * @ref tutorial_naviframe gives a good overview of the usage of the API.
28222 #define ELM_NAVIFRAME_ITEM_CONTENT_ICON "elm.swallow.icon"
28223 #define ELM_NAVIFRAME_ITEM_CONTENT_PREV_BTN "elm.swallow.prev_btn"
28224 #define ELM_NAVIFRAME_ITEM_CONTNET_NEXT_BTN "elm.swallow.next_btn"
28225 #define ELM_NAVIFRAME_ITEM_TEXT_SUBTITLE "elm.text.subtitle"
28228 * @addtogroup Naviframe
28233 * @brief Add a new Naviframe object to the parent.
28235 * @param parent Parent object
28236 * @return New object or @c NULL, if it cannot be created
28238 * @ingroup Naviframe
28240 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28242 * @brief Push a new item to the top of the naviframe stack (and show it).
28244 * @param obj The naviframe object
28245 * @param title_label The label in the title area. The name of the title
28246 * label part is "elm.text.title"
28247 * @param prev_btn The button to go to the previous item. If it is NULL,
28248 * then naviframe will create a back button automatically. The name of
28249 * the prev_btn part is "elm.swallow.prev_btn"
28250 * @param next_btn The button to go to the next item. Or It could be just an
28251 * extra function button. The name of the next_btn part is
28252 * "elm.swallow.next_btn"
28253 * @param content The main content object. The name of content part is
28254 * "elm.swallow.content"
28255 * @param item_style The current item style name. @c NULL would be default.
28256 * @return The created item or @c NULL upon failure.
28258 * The item pushed becomes one page of the naviframe, this item will be
28259 * deleted when it is popped.
28261 * @see also elm_naviframe_item_style_set()
28263 * The following styles are available for this item:
28266 * @ingroup Naviframe
28268 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);
28270 * @brief Pop an item that is on top of the stack
28272 * @param obj The naviframe object
28273 * @return @c NULL or the content object(if the
28274 * elm_naviframe_content_preserve_on_pop_get is true).
28276 * This pops an item that is on the top(visible) of the naviframe, makes it
28277 * disappear, then deletes the item. The item that was underneath it on the
28278 * stack will become visible.
28280 * @see also elm_naviframe_content_preserve_on_pop_get()
28282 * @ingroup Naviframe
28284 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28286 * @brief Pop the items between the top and the above one on the given item.
28288 * @param it The naviframe item
28290 * @ingroup Naviframe
28292 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28294 * Promote an item already in the naviframe stack to the top of the stack
28296 * @param it The naviframe item
28298 * This will take the indicated item and promote it to the top of the stack
28299 * as if it had been pushed there. The item must already be inside the
28300 * naviframe stack to work.
28303 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28305 * @brief Delete the given item instantly.
28307 * @param it The naviframe item
28309 * This just deletes the given item from the naviframe item list instantly.
28310 * So this would not emit any signals for view transitions but just change
28311 * the current view if the given item is a top one.
28313 * @ingroup Naviframe
28315 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28317 * @brief preserve the content objects when items are popped.
28319 * @param obj The naviframe object
28320 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28322 * @see also elm_naviframe_content_preserve_on_pop_get()
28324 * @ingroup Naviframe
28326 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28328 * @brief Get a value whether preserve mode is enabled or not.
28330 * @param obj The naviframe object
28331 * @return If @c EINA_TRUE, preserve mode is enabled
28333 * @see also elm_naviframe_content_preserve_on_pop_set()
28335 * @ingroup Naviframe
28337 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28339 * @brief Get a top item on the naviframe stack
28341 * @param obj The naviframe object
28342 * @return The top item on the naviframe stack or @c NULL, if the stack is
28345 * @ingroup Naviframe
28347 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28349 * @brief Get a bottom item on the naviframe stack
28351 * @param obj The naviframe object
28352 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28355 * @ingroup Naviframe
28357 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28359 * @brief Set an item style
28361 * @param obj The naviframe item
28362 * @param item_style The current item style name. @c NULL would be default
28364 * The following styles are available for this item:
28367 * @see also elm_naviframe_item_style_get()
28369 * @ingroup Naviframe
28371 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28373 * @brief Get an item style
28375 * @param obj The naviframe item
28376 * @return The current item style name
28378 * @see also elm_naviframe_item_style_set()
28380 * @ingroup Naviframe
28382 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28384 * @brief Show/Hide the title area
28386 * @param it The naviframe item
28387 * @param visible If @c EINA_TRUE, title area will be visible, hidden
28390 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
28392 * @see also elm_naviframe_item_title_visible_get()
28394 * @ingroup Naviframe
28396 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28398 * @brief Get a value whether title area is visible or not.
28400 * @param it The naviframe item
28401 * @return If @c EINA_TRUE, title area is visible
28403 * @see also elm_naviframe_item_title_visible_set()
28405 * @ingroup Naviframe
28407 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28410 * @brief Set creating prev button automatically or not
28412 * @param obj The naviframe object
28413 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28414 * be created internally when you pass the @c NULL to the prev_btn
28415 * parameter in elm_naviframe_item_push
28417 * @see also elm_naviframe_item_push()
28419 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28421 * @brief Get a value whether prev button(back button) will be auto pushed or
28424 * @param obj The naviframe object
28425 * @return If @c EINA_TRUE, prev button will be auto pushed.
28427 * @see also elm_naviframe_item_push()
28428 * elm_naviframe_prev_btn_auto_pushed_set()
28430 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);