3 * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
8 @brief Elementary Widget Library
13 @image html elementary.png
17 @section intro What is Elementary?
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
22 It is meant to make the programmers work almost brainless but give them lots
25 @li @ref Start - Go here to quickly get started with writing Apps
27 @section organization Organization
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers which hold the widgets.
34 @section license License
36 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
37 all files in the source tree.
39 @section ack Acknowledgements
40 There is a lot that goes into making a widget set, and they don't happen out of
41 nothing. It's like trying to make everyone everywhere happy, regardless of age,
42 gender, race or nationality - and that is really tough. So thanks to people and
43 organisations behind this, as listed in the @ref authors page.
48 * @defgroup Start Getting Started
50 * To write an Elementary app, you can get started with the following:
53 #include <Elementary.h>
55 elm_main(int argc, char **argv)
57 // create window(s) here and do any application init
58 elm_run(); // run main loop
59 elm_shutdown(); // after mainloop finishes running, shutdown
60 return 0; // exit 0 for exit code
65 * To use autotools (which helps in many ways in the long run, like being able
66 * to immediately create releases of your software directly from your tree
67 * and ensure everything needed to build it is there) you will need a
68 * configure.ac, Makefile.am and autogen.sh file.
73 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
75 AC_CONFIG_SRCDIR(configure.ac)
76 AM_CONFIG_HEADER(config.h)
78 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
79 PKG_CHECK_MODULES([ELEMENTARY], elementary)
86 AUTOMAKE_OPTIONS = 1.4 foreign
87 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
89 INCLUDES = -I$(top_srcdir)
93 myapp_SOURCES = main.c
94 myapp_LDADD = @ELEMENTARY_LIBS@
95 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
102 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
103 echo "Running autoheader..." ; autoheader || exit 1
104 echo "Running autoconf..." ; autoconf || exit 1
105 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
109 * To generate all the things needed to bootstrap just run:
115 * This will generate Makefile.in's, the confgure script and everything else.
116 * After this it works like all normal autotools projects:
123 * Note sudo was assumed to get root permissions, as this would install in
124 * /usr/local which is system-owned. Use any way you like to gain root, or
125 * specify a different prefix with configure:
128 ./confiugre --prefix=$HOME/mysoftware
131 * Also remember that autotools buys you some useful commands like:
136 * This uninstalls the software after it was installed with "make install".
137 * It is very useful to clear up what you built if you wish to clean the
144 * This firstly checks if your build tree is "clean" and ready for
145 * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
146 * ready to upload and distribute to the world, that contains the generated
147 * Makefile.in's and configure script. The users do not need to run
148 * autogen.sh - just configure and on. They don't need autotools installed.
149 * This tarball also builds cleanly, has all the sources it needs to build
150 * included (that is sources for your application, not libraries it depends
151 * on like Elementary). It builds cleanly in a buildroot and does not
152 * contain any files that are temporarily generated like binaries and other
153 * build-generated files, so the tarball is clean, and no need to worry
154 * about cleaning up your tree before packaging.
160 * This cleans up all build files (binaries, objects etc.) from the tree.
166 * This cleans out all files from the build and from configure's output too.
169 make maintainer-clean
172 * This deletes all the files autogen.sh will produce so the tree is clean
173 * to be put into a revision-control system (like CVS, SVN or GIT for example).
175 * There is a more advanced way of making use of the quicklaunch infrastructure
176 * in Elementary (which will not be covered here due to its more advanced
179 * Now let's actually create an interactive "Hello World" gui that you can
180 * click the ok button to exit. It's more code because this now does something
181 * much more significant, but it's still very simple:
184 #include <Elementary.h>
187 on_done(void *data, Evas_Object *obj, void *event_info)
189 // quit the mainloop (elm_run function will return)
194 elm_main(int argc, char **argv)
196 Evas_Object *win, *bg, *box, *lab, *btn;
198 // new window - do the usual and give it a name (hello) and title (Hello)
199 win = elm_win_util_standard_add("hello", "Hello");
200 // when the user clicks "close" on a window there is a request to delete
201 evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
203 // add a box object - default is vertical. a box holds children in a row,
204 // either horizontally or vertically. nothing more.
205 box = elm_box_add(win);
206 // make the box hotizontal
207 elm_box_horizontal_set(box, EINA_TRUE);
208 // add object as a resize object for the window (controls window minimum
209 // size as well as gets resized if window is resized)
210 elm_win_resize_object_add(win, box);
211 evas_object_show(box);
213 // add a label widget, set the text and put it in the pad frame
214 lab = elm_label_add(win);
215 // set default text of the label
216 elm_object_text_set(lab, "Hello out there world!");
217 // pack the label at the end of the box
218 elm_box_pack_end(box, lab);
219 evas_object_show(lab);
222 btn = elm_button_add(win);
223 // set default text of button to "OK"
224 elm_object_text_set(btn, "OK");
225 // pack the button at the end of the box
226 elm_box_pack_end(box, btn);
227 evas_object_show(btn);
228 // call on_done when button is clicked
229 evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
231 // now we are done, show the window
232 evas_object_show(win);
234 // run the mainloop and process events and callbacks
244 @page authors Authors
245 @author Carsten Haitzler <raster@@rasterman.com>
246 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
247 @author Cedric Bail <cedric.bail@@free.fr>
248 @author Vincent Torri <vtorri@@univ-evry.fr>
249 @author Daniel Kolesa <quaker66@@gmail.com>
250 @author Jaime Thomas <avi.thomas@@gmail.com>
251 @author Swisscom - http://www.swisscom.ch/
252 @author Christopher Michael <devilhorns@@comcast.net>
253 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
254 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
255 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
256 @author Brian Wang <brian.wang.0721@@gmail.com>
257 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
258 @author Samsung Electronics <tbd>
259 @author Samsung SAIT <tbd>
260 @author Brett Nash <nash@@nash.id.au>
261 @author Bruno Dilly <bdilly@@profusion.mobi>
262 @author Rafael Fonseca <rfonseca@@profusion.mobi>
263 @author Chuneon Park <hermet@@hermet.pe.kr>
264 @author Woohyun Jung <wh0705.jung@@samsung.com>
265 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
266 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
267 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
268 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
269 @author Gustavo Lima Chaves <glima@@profusion.mobi>
270 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
271 @author Tiago Falcão <tiago@@profusion.mobi>
272 @author Otavio Pontes <otavio@@profusion.mobi>
273 @author Viktor Kojouharov <vkojouharov@@gmail.com>
274 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
275 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
276 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
277 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
278 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
279 @author Jihoon Kim <jihoon48.kim@@samsung.com>
280 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
281 @author Tom Hacohen <tom@@stosb.com>
282 @author Aharon Hillel <a.hillel@@partner.samsung.com>
283 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
284 @author Shinwoo Kim <kimcinoo@@gmail.com>
285 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
286 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
287 @author Sung W. Park <sungwoo@gmail.com>
288 @author Thierry el Borgi <thierry@substantiel.fr>
289 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
290 @author Chanwook Jung <joey.jung@samsung.com>
291 @author Hyoyoung Chang <hyoyoung.chang@samsung.com>
292 @author Guillaume "Kuri" Friloux <guillaume.friloux@asp64.com>
293 @author Kim Yunhan <spbear@gmail.com>
295 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
296 contact with the developers and maintainers.
304 * @brief Elementary's API
309 @ELM_UNIX_DEF@ ELM_UNIX
310 @ELM_WIN32_DEF@ ELM_WIN32
311 @ELM_WINCE_DEF@ ELM_WINCE
312 @ELM_EDBUS_DEF@ ELM_EDBUS
313 @ELM_EFREET_DEF@ ELM_EFREET
314 @ELM_ETHUMB_DEF@ ELM_ETHUMB
315 @ELM_WEB_DEF@ ELM_WEB
316 @ELM_EMAP_DEF@ ELM_EMAP
317 @ELM_DEBUG_DEF@ ELM_DEBUG
318 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
319 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
321 /* Standard headers for standard system calls etc. */
326 #include <sys/types.h>
327 #include <sys/stat.h>
328 #include <sys/time.h>
329 #include <sys/param.h>
341 # ifdef ELM_LIBINTL_H
342 # include <libintl.h>
353 #if defined (ELM_WIN32) || defined (ELM_WINCE)
356 # define alloca _alloca
367 #include <Ecore_Evas.h>
368 #include <Ecore_File.h>
369 #include <Ecore_IMF.h>
370 #include <Ecore_Con.h>
379 # include <Efreet_Mime.h>
380 # include <Efreet_Trash.h>
384 # include <Ethumb_Client.h>
396 # ifdef ELEMENTARY_BUILD
398 # define EAPI __declspec(dllexport)
401 # endif /* ! DLL_EXPORT */
403 # define EAPI __declspec(dllimport)
404 # endif /* ! EFL_EVAS_BUILD */
408 # define EAPI __attribute__ ((visibility("default")))
415 #endif /* ! _WIN32 */
420 # define EAPI_MAIN EAPI
423 /* allow usage from c++ */
428 #define ELM_VERSION_MAJOR @VMAJ@
429 #define ELM_VERSION_MINOR @VMIN@
431 typedef struct _Elm_Version
439 EAPI extern Elm_Version *elm_version;
442 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
443 #define ELM_PI 3.14159265358979323846
446 * @defgroup General General
448 * @brief General Elementary API. Functions that don't relate to
449 * Elementary objects specifically.
451 * Here are documented functions which init/shutdown the library,
452 * that apply to generic Elementary objects, that deal with
453 * configuration, et cetera.
455 * @ref general_functions_example_page "This" example contemplates
456 * some of these functions.
460 * @addtogroup General
465 * Defines couple of standard Evas_Object layers to be used
466 * with evas_object_layer_set().
468 * @note whenever extending with new values, try to keep some padding
469 * to siblings so there is room for further extensions.
471 typedef enum _Elm_Object_Layer
473 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
474 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
475 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
476 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
477 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
478 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
481 /**************************************************************************/
482 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
485 * Emitted when the application has reconfigured elementary settings due
486 * to an external configuration tool asking it to.
488 EAPI extern int ELM_EVENT_CONFIG_ALL_CHANGED;
491 * Emitted when any Elementary's policy value is changed.
493 EAPI extern int ELM_EVENT_POLICY_CHANGED;
496 * @typedef Elm_Event_Policy_Changed
498 * Data on the event when an Elementary policy has changed
500 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
503 * @struct _Elm_Event_Policy_Changed
505 * Data on the event when an Elementary policy has changed
507 struct _Elm_Event_Policy_Changed
509 unsigned int policy; /**< the policy identifier */
510 int new_value; /**< value the policy had before the change */
511 int old_value; /**< new value the policy got */
515 * Policy identifiers.
517 typedef enum _Elm_Policy
519 ELM_POLICY_QUIT, /**< under which circumstances the application
520 * should quit automatically. @see
524 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
527 typedef enum _Elm_Policy_Quit
529 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
531 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
533 * window is closed */
534 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
536 typedef enum _Elm_Focus_Direction
540 } Elm_Focus_Direction;
542 typedef enum _Elm_Text_Format
544 ELM_TEXT_FORMAT_PLAIN_UTF8,
545 ELM_TEXT_FORMAT_MARKUP_UTF8
549 * Line wrapping types.
551 typedef enum _Elm_Wrap_Type
553 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
554 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
555 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
556 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
562 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
563 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
564 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
565 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
566 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
567 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
568 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
569 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
570 ELM_INPUT_PANEL_LAYOUT_INVALID
571 } Elm_Input_Panel_Layout;
575 ELM_AUTOCAPITAL_TYPE_NONE,
576 ELM_AUTOCAPITAL_TYPE_WORD,
577 ELM_AUTOCAPITAL_TYPE_SENTENCE,
578 ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
579 } Elm_Autocapital_Type;
582 * @typedef Elm_Object_Item
583 * An Elementary Object item handle.
586 typedef struct _Elm_Object_Item Elm_Object_Item;
590 * Called back when a widget's tooltip is activated and needs content.
591 * @param data user-data given to elm_object_tooltip_content_cb_set()
592 * @param obj owner widget.
593 * @param tooltip The tooltip object (affix content to this!)
595 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
598 * Called back when a widget's item tooltip is activated and needs content.
599 * @param data user-data given to elm_object_tooltip_content_cb_set()
600 * @param obj owner widget.
601 * @param tooltip The tooltip object (affix content to this!)
602 * @param item context dependent item. As an example, if tooltip was
603 * set on Elm_List_Item, then it is of this type.
605 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
607 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. */
609 #ifndef ELM_LIB_QUICKLAUNCH
610 #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 */
612 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
615 /**************************************************************************/
619 * Initialize Elementary
621 * @param[in] argc System's argument count value
622 * @param[in] argv System's pointer to array of argument strings
623 * @return The init counter value.
625 * This function initializes Elementary and increments a counter of
626 * the number of calls to it. It returns the new counter's value.
628 * @warning This call is exported only for use by the @c ELM_MAIN()
629 * macro. There is no need to use this if you use this macro (which
630 * is highly advisable). An elm_main() should contain the entry
631 * point code for your application, having the same prototype as
632 * elm_init(), and @b not being static (putting the @c EAPI symbol
633 * in front of its type declaration is advisable). The @c
634 * ELM_MAIN() call should be placed just after it.
637 * @dontinclude bg_example_01.c
641 * See the full @ref bg_example_01_c "example".
643 * @see elm_shutdown().
646 EAPI int elm_init(int argc, char **argv);
649 * Shut down Elementary
651 * @return The init counter value.
653 * This should be called at the end of your application, just
654 * before it ceases to do any more processing. This will clean up
655 * any permanent resources your application may have allocated via
656 * Elementary that would otherwise persist.
658 * @see elm_init() for an example
662 EAPI int elm_shutdown(void);
665 * Run Elementary's main loop
667 * This call should be issued just after all initialization is
668 * completed. This function will not return until elm_exit() is
669 * called. It will keep looping, running the main
670 * (event/processing) loop for Elementary.
672 * @see elm_init() for an example
676 EAPI void elm_run(void);
679 * Exit Elementary's main loop
681 * If this call is issued, it will flag the main loop to cease
682 * processing and return back to its parent function (usually your
683 * elm_main() function).
685 * @see elm_init() for an example. There, just after a request to
686 * close the window comes, the main loop will be left.
688 * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
689 * applications, you'll be able to get this function called automatically for you.
693 EAPI void elm_exit(void);
696 * Provide information in order to make Elementary determine the @b
697 * run time location of the software in question, so other data files
698 * such as images, sound files, executable utilities, libraries,
699 * modules and locale files can be found.
701 * @param mainfunc This is your application's main function name,
702 * whose binary's location is to be found. Providing @c NULL
703 * will make Elementary not to use it
704 * @param dom This will be used as the application's "domain", in the
705 * form of a prefix to any environment variables that may
706 * override prefix detection and the directory name, inside the
707 * standard share or data directories, where the software's
708 * data files will be looked for.
709 * @param checkfile This is an (optional) magic file's path to check
710 * for existence (and it must be located in the data directory,
711 * under the share directory provided above). Its presence will
712 * help determine the prefix found was correct. Pass @c NULL if
713 * the check is not to be done.
715 * This function allows one to re-locate the application somewhere
716 * else after compilation, if the developer wishes for easier
717 * distribution of pre-compiled binaries.
719 * The prefix system is designed to locate where the given software is
720 * installed (under a common path prefix) at run time and then report
721 * specific locations of this prefix and common directories inside
722 * this prefix like the binary, library, data and locale directories,
723 * through the @c elm_app_*_get() family of functions.
725 * Call elm_app_info_set() early on before you change working
726 * directory or anything about @c argv[0], so it gets accurate
729 * It will then try and trace back which file @p mainfunc comes from,
730 * if provided, to determine the application's prefix directory.
732 * The @p dom parameter provides a string prefix to prepend before
733 * environment variables, allowing a fallback to @b specific
734 * environment variables to locate the software. You would most
735 * probably provide a lowercase string there, because it will also
736 * serve as directory domain, explained next. For environment
737 * variables purposes, this string is made uppercase. For example if
738 * @c "myapp" is provided as the prefix, then the program would expect
739 * @c "MYAPP_PREFIX" as a master environment variable to specify the
740 * exact install prefix for the software, or more specific environment
741 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
742 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
743 * the user or scripts before launching. If not provided (@c NULL),
744 * environment variables will not be used to override compiled-in
745 * defaults or auto detections.
747 * The @p dom string also provides a subdirectory inside the system
748 * shared data directory for data files. For example, if the system
749 * directory is @c /usr/local/share, then this directory name is
750 * appended, creating @c /usr/local/share/myapp, if it @p was @c
751 * "myapp". It is expected that the application installs data files in
754 * The @p checkfile is a file name or path of something inside the
755 * share or data directory to be used to test that the prefix
756 * detection worked. For example, your app will install a wallpaper
757 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
758 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
761 * @see elm_app_compile_bin_dir_set()
762 * @see elm_app_compile_lib_dir_set()
763 * @see elm_app_compile_data_dir_set()
764 * @see elm_app_compile_locale_set()
765 * @see elm_app_prefix_dir_get()
766 * @see elm_app_bin_dir_get()
767 * @see elm_app_lib_dir_get()
768 * @see elm_app_data_dir_get()
769 * @see elm_app_locale_dir_get()
771 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
774 * Provide information on the @b fallback application's binaries
775 * directory, in scenarios where they get overriden by
776 * elm_app_info_set().
778 * @param dir The path to the default binaries directory (compile time
781 * @note Elementary will as well use this path to determine actual
782 * names of binaries' directory paths, maybe changing it to be @c
783 * something/local/bin instead of @c something/bin, only, for
786 * @warning You should call this function @b before
787 * elm_app_info_set().
789 EAPI void elm_app_compile_bin_dir_set(const char *dir);
792 * Provide information on the @b fallback application's libraries
793 * directory, on scenarios where they get overriden by
794 * elm_app_info_set().
796 * @param dir The path to the default libraries directory (compile
799 * @note Elementary will as well use this path to determine actual
800 * names of libraries' directory paths, maybe changing it to be @c
801 * something/lib32 or @c something/lib64 instead of @c something/lib,
804 * @warning You should call this function @b before
805 * elm_app_info_set().
807 EAPI void elm_app_compile_lib_dir_set(const char *dir);
810 * Provide information on the @b fallback application's data
811 * directory, on scenarios where they get overriden by
812 * elm_app_info_set().
814 * @param dir The path to the default data directory (compile time
817 * @note Elementary will as well use this path to determine actual
818 * names of data directory paths, maybe changing it to be @c
819 * something/local/share instead of @c something/share, only, for
822 * @warning You should call this function @b before
823 * elm_app_info_set().
825 EAPI void elm_app_compile_data_dir_set(const char *dir);
828 * Provide information on the @b fallback application's locale
829 * directory, on scenarios where they get overriden by
830 * elm_app_info_set().
832 * @param dir The path to the default locale directory (compile time
835 * @warning You should call this function @b before
836 * elm_app_info_set().
838 EAPI void elm_app_compile_locale_set(const char *dir);
841 * Retrieve the application's run time prefix directory, as set by
842 * elm_app_info_set() and the way (environment) the application was
845 * @return The directory prefix the application is actually using.
847 EAPI const char *elm_app_prefix_dir_get(void);
850 * Retrieve the application's run time binaries prefix directory, as
851 * set by elm_app_info_set() and the way (environment) the application
854 * @return The binaries directory prefix the application is actually
857 EAPI const char *elm_app_bin_dir_get(void);
860 * Retrieve the application's run time libraries prefix directory, as
861 * set by elm_app_info_set() and the way (environment) the application
864 * @return The libraries directory prefix the application is actually
867 EAPI const char *elm_app_lib_dir_get(void);
870 * Retrieve the application's run time data prefix directory, as
871 * set by elm_app_info_set() and the way (environment) the application
874 * @return The data directory prefix the application is actually
877 EAPI const char *elm_app_data_dir_get(void);
880 * Retrieve the application's run time locale prefix directory, as
881 * set by elm_app_info_set() and the way (environment) the application
884 * @return The locale directory prefix the application is actually
887 EAPI const char *elm_app_locale_dir_get(void);
889 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
890 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
891 EAPI int elm_quicklaunch_init(int argc, char **argv);
892 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
893 EAPI int elm_quicklaunch_sub_shutdown(void);
894 EAPI int elm_quicklaunch_shutdown(void);
895 EAPI void elm_quicklaunch_seed(void);
896 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
897 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
898 EAPI void elm_quicklaunch_cleanup(void);
899 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
900 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
902 EAPI Eina_Bool elm_need_efreet(void);
903 EAPI Eina_Bool elm_need_e_dbus(void);
906 * This must be called before any other function that deals with
907 * elm_thumb objects or ethumb_client instances.
911 EAPI Eina_Bool elm_need_ethumb(void);
914 * This must be called before any other function that deals with
915 * elm_web objects or ewk_view instances.
919 EAPI Eina_Bool elm_need_web(void);
922 * Set a new policy's value (for a given policy group/identifier).
924 * @param policy policy identifier, as in @ref Elm_Policy.
925 * @param value policy value, which depends on the identifier
927 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
929 * Elementary policies define applications' behavior,
930 * somehow. These behaviors are divided in policy groups (see
931 * #Elm_Policy enumeration). This call will emit the Ecore event
932 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
933 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
936 * @note Currently, we have only one policy identifier/group
937 * (#ELM_POLICY_QUIT), which has two possible values.
941 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
944 * Gets the policy value for given policy identifier.
946 * @param policy policy identifier, as in #Elm_Policy.
947 * @return The currently set policy value, for that
948 * identifier. Will be @c 0 if @p policy passed is invalid.
952 EAPI int elm_policy_get(unsigned int policy);
955 * Change the language of the current application
957 * The @p lang passed must be the full name of the locale to use, for
958 * example "en_US.utf8" or "es_ES@euro".
960 * Changing language with this function will make Elementary run through
961 * all its widgets, translating strings set with
962 * elm_object_domain_translatable_text_part_set(). This way, an entire
963 * UI can have its language changed without having to restart the program.
965 * For more complex cases, like having formatted strings that need
966 * translation, widgets will also emit a "language,changed" signal that
967 * the user can listen to to manually translate the text.
969 * @param lang Language to set, must be the full name of the locale
973 EAPI void elm_language_set(const char *lang);
976 * Set a label of an object
978 * @param obj The Elementary object
979 * @param part The text part name to set (NULL for the default label)
980 * @param label The new text of the label
982 * @note Elementary objects may have many labels (e.g. Action Slider)
986 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
988 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
991 * Get a label of an object
993 * @param obj The Elementary object
994 * @param part The text part name to get (NULL for the default label)
995 * @return text of the label or NULL for any error
997 * @note Elementary objects may have many labels (e.g. Action Slider)
1001 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1003 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
1006 * Set the text for an objects' part, marking it as translatable.
1008 * The string to set as @p text must be the original one. Do not pass the
1009 * return of @c gettext() here. Elementary will translate the string
1010 * internally and set it on the object using elm_object_text_part_set(),
1011 * also storing the original string so that it can be automatically
1012 * translated when the language is changed with elm_language_set().
1014 * The @p domain will be stored along to find the translation in the
1015 * correct catalog. It can be NULL, in which case it will use whatever
1016 * domain was set by the application with @c textdomain(). This is useful
1017 * in case you are building a library on top of Elementary that will have
1018 * its own translatable strings, that should not be mixed with those of
1019 * programs using the library.
1021 * @param obj The object containing the text part
1022 * @param part The name of the part to set
1023 * @param domain The translation domain to use
1024 * @param text The original, non-translated text to set
1028 EAPI void elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1030 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1032 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1035 * Gets the original string set as translatable for an object
1037 * When setting translated strings, the function elm_object_text_part_get()
1038 * will return the translation returned by @c gettext(). To get the
1039 * original string use this function.
1041 * @param obj The object
1042 * @param part The name of the part that was set
1044 * @return The original, untranslated string
1048 EAPI const char *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1050 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1053 * Set a content of an object
1055 * @param obj The Elementary object
1056 * @param part The content part name to set (NULL for the default content)
1057 * @param content The new content of the object
1059 * @note Elementary objects may have many contents
1063 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1065 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
1068 * Get a content of an object
1070 * @param obj The Elementary object
1071 * @param item The content part name to get (NULL for the default content)
1072 * @return content of the object or NULL for any error
1074 * @note Elementary objects may have many contents
1078 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1080 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
1083 * Unset a content of an object
1085 * @param obj The Elementary object
1086 * @param item The content part name to unset (NULL for the default content)
1088 * @note Elementary objects may have many contents
1092 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1094 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1097 * Get the widget object's handle which contains a given item
1099 * @param item The Elementary object item
1100 * @return The widget object
1102 * @note This returns the widget object itself that an item belongs to.
1106 EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1109 * Set a content of an object item
1111 * @param it The Elementary object item
1112 * @param part The content part name to set (NULL for the default content)
1113 * @param content The new content of the object item
1115 * @note Elementary object items may have many contents
1119 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1121 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1124 * Get a content of an object item
1126 * @param it The Elementary object item
1127 * @param part The content part name to unset (NULL for the default content)
1128 * @return content of the object item or NULL for any error
1130 * @note Elementary object items may have many contents
1134 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1136 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1139 * Unset a content of an object item
1141 * @param it The Elementary object item
1142 * @param part The content part name to unset (NULL for the default content)
1144 * @note Elementary object items may have many contents
1148 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1150 #define elm_object_item_content_unset(it) elm_object_item_content_part_unset((it), NULL)
1153 * Set a label of an object item
1155 * @param it The Elementary object item
1156 * @param part The text part name to set (NULL for the default label)
1157 * @param label The new text of the label
1159 * @note Elementary object items may have many labels
1163 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1165 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1168 * Get a label of an object item
1170 * @param it The Elementary object item
1171 * @param part The text part name to get (NULL for the default label)
1172 * @return text of the label or NULL for any error
1174 * @note Elementary object items may have many labels
1178 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1180 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1183 * Set the text to read out when in accessibility mode
1185 * @param obj The object which is to be described
1186 * @param txt The text that describes the widget to people with poor or no vision
1190 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1193 * Set the text to read out when in accessibility mode
1195 * @param it The object item which is to be described
1196 * @param txt The text that describes the widget to people with poor or no vision
1200 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1203 * Get the data associated with an object item
1204 * @param it The object item
1205 * @return The data associated with @p it
1209 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1212 * Set the data associated with an object item
1213 * @param it The object item
1214 * @param data The data to be associated with @p it
1218 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1221 * Send a signal to the edje object of the widget item.
1223 * This function sends a signal to the edje object of the obj item. An
1224 * edje program can respond to a signal by specifying matching
1225 * 'signal' and 'source' fields.
1227 * @param it The Elementary object item
1228 * @param emission The signal's name.
1229 * @param source The signal's source.
1232 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1239 * @defgroup Caches Caches
1241 * These are functions which let one fine-tune some cache values for
1242 * Elementary applications, thus allowing for performance adjustments.
1248 * @brief Flush all caches.
1250 * Frees all data that was in cache and is not currently being used to reduce
1251 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1252 * to calling all of the following functions:
1253 * @li edje_file_cache_flush()
1254 * @li edje_collection_cache_flush()
1255 * @li eet_clearcache()
1256 * @li evas_image_cache_flush()
1257 * @li evas_font_cache_flush()
1258 * @li evas_render_dump()
1259 * @note Evas caches are flushed for every canvas associated with a window.
1263 EAPI void elm_all_flush(void);
1266 * Get the configured cache flush interval time
1268 * This gets the globally configured cache flush interval time, in
1271 * @return The cache flush interval time
1274 * @see elm_all_flush()
1276 EAPI int elm_cache_flush_interval_get(void);
1279 * Set the configured cache flush interval time
1281 * This sets the globally configured cache flush interval time, in ticks
1283 * @param size The cache flush interval time
1286 * @see elm_all_flush()
1288 EAPI void elm_cache_flush_interval_set(int size);
1291 * Set the configured cache flush interval time for all applications on the
1294 * This sets the globally configured cache flush interval time -- in ticks
1295 * -- for all applications on the display.
1297 * @param size The cache flush interval time
1300 EAPI void elm_cache_flush_interval_all_set(int size);
1303 * Get the configured cache flush enabled state
1305 * This gets the globally configured cache flush state - if it is enabled
1306 * or not. When cache flushing is enabled, elementary will regularly
1307 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1308 * memory and allow usage to re-seed caches and data in memory where it
1309 * can do so. An idle application will thus minimise its memory usage as
1310 * data will be freed from memory and not be re-loaded as it is idle and
1311 * not rendering or doing anything graphically right now.
1313 * @return The cache flush state
1316 * @see elm_all_flush()
1318 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1321 * Set the configured cache flush enabled state
1323 * This sets the globally configured cache flush enabled state.
1325 * @param size The cache flush enabled state
1328 * @see elm_all_flush()
1330 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1333 * Set the configured cache flush enabled state for all applications on the
1336 * This sets the globally configured cache flush enabled state for all
1337 * applications on the display.
1339 * @param size The cache flush enabled state
1342 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1345 * Get the configured font cache size
1347 * This gets the globally configured font cache size, in bytes.
1349 * @return The font cache size
1352 EAPI int elm_font_cache_get(void);
1355 * Set the configured font cache size
1357 * This sets the globally configured font cache size, in bytes
1359 * @param size The font cache size
1362 EAPI void elm_font_cache_set(int size);
1365 * Set the configured font cache size for all applications on the
1368 * This sets the globally configured font cache size -- in bytes
1369 * -- for all applications on the display.
1371 * @param size The font cache size
1374 EAPI void elm_font_cache_all_set(int size);
1377 * Get the configured image cache size
1379 * This gets the globally configured image cache size, in bytes
1381 * @return The image cache size
1384 EAPI int elm_image_cache_get(void);
1387 * Set the configured image cache size
1389 * This sets the globally configured image cache size, in bytes
1391 * @param size The image cache size
1394 EAPI void elm_image_cache_set(int size);
1397 * Set the configured image cache size for all applications on the
1400 * This sets the globally configured image cache size -- in bytes
1401 * -- for all applications on the display.
1403 * @param size The image cache size
1406 EAPI void elm_image_cache_all_set(int size);
1409 * Get the configured edje file cache size.
1411 * This gets the globally configured edje file cache size, in number
1414 * @return The edje file cache size
1417 EAPI int elm_edje_file_cache_get(void);
1420 * Set the configured edje file cache size
1422 * This sets the globally configured edje file cache size, in number
1425 * @param size The edje file cache size
1428 EAPI void elm_edje_file_cache_set(int size);
1431 * Set the configured edje file cache size for all applications on the
1434 * This sets the globally configured edje file cache size -- in number
1435 * of files -- for all applications on the display.
1437 * @param size The edje file cache size
1440 EAPI void elm_edje_file_cache_all_set(int size);
1443 * Get the configured edje collections (groups) cache size.
1445 * This gets the globally configured edje collections cache size, in
1446 * number of collections.
1448 * @return The edje collections cache size
1451 EAPI int elm_edje_collection_cache_get(void);
1454 * Set the configured edje collections (groups) cache size
1456 * This sets the globally configured edje collections cache size, in
1457 * number of collections.
1459 * @param size The edje collections cache size
1462 EAPI void elm_edje_collection_cache_set(int size);
1465 * Set the configured edje collections (groups) cache size for all
1466 * applications on the display
1468 * This sets the globally configured edje collections cache size -- in
1469 * number of collections -- for all applications on the display.
1471 * @param size The edje collections cache size
1474 EAPI void elm_edje_collection_cache_all_set(int size);
1481 * @defgroup Scaling Widget Scaling
1483 * Different widgets can be scaled independently. These functions
1484 * allow you to manipulate this scaling on a per-widget basis. The
1485 * object and all its children get their scaling factors multiplied
1486 * by the scale factor set. This is multiplicative, in that if a
1487 * child also has a scale size set it is in turn multiplied by its
1488 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1489 * double size, @c 0.5 is half, etc.
1491 * @ref general_functions_example_page "This" example contemplates
1492 * some of these functions.
1496 * Get the global scaling factor
1498 * This gets the globally configured scaling factor that is applied to all
1501 * @return The scaling factor
1504 EAPI double elm_scale_get(void);
1507 * Set the global scaling factor
1509 * This sets the globally configured scaling factor that is applied to all
1512 * @param scale The scaling factor to set
1515 EAPI void elm_scale_set(double scale);
1518 * Set the global scaling factor for all applications on the display
1520 * This sets the globally configured scaling factor that is applied to all
1521 * objects for all applications.
1522 * @param scale The scaling factor to set
1525 EAPI void elm_scale_all_set(double scale);
1528 * Set the scaling factor for a given Elementary object
1530 * @param obj The Elementary to operate on
1531 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1536 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1539 * Get the scaling factor for a given Elementary object
1541 * @param obj The object
1542 * @return The scaling factor set by elm_object_scale_set()
1546 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1549 * @defgroup Password_last_show Password last input show
1551 * Last show feature of password mode enables user to view
1552 * the last input entered for few seconds before masking it.
1553 * These functions allow to set this feature in password mode
1554 * of entry widget and also allow to manipulate the duration
1555 * for which the input has to be visible.
1561 * Get show last setting of password mode.
1563 * This gets the show last input setting of password mode which might be
1564 * enabled or disabled.
1566 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1568 * @ingroup Password_last_show
1570 EAPI Eina_Bool elm_password_show_last_get(void);
1573 * Set show last setting in password mode.
1575 * This enables or disables show last setting of password mode.
1577 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1578 * @see elm_password_show_last_timeout_set()
1579 * @ingroup Password_last_show
1581 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1584 * Get's the timeout value in last show password mode.
1586 * This gets the time out value for which the last input entered in password
1587 * mode will be visible.
1589 * @return The timeout value of last show password mode.
1590 * @ingroup Password_last_show
1592 EAPI double elm_password_show_last_timeout_get(void);
1595 * Set's the timeout value in last show password mode.
1597 * This sets the time out value for which the last input entered in password
1598 * mode will be visible.
1600 * @param password_show_last_timeout The timeout value.
1601 * @see elm_password_show_last_set()
1602 * @ingroup Password_last_show
1604 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1611 * @defgroup UI-Mirroring Selective Widget mirroring
1613 * These functions allow you to set ui-mirroring on specific
1614 * widgets or the whole interface. Widgets can be in one of two
1615 * modes, automatic and manual. Automatic means they'll be changed
1616 * according to the system mirroring mode and manual means only
1617 * explicit changes will matter. You are not supposed to change
1618 * mirroring state of a widget set to automatic, will mostly work,
1619 * but the behavior is not really defined.
1624 EAPI Eina_Bool elm_mirrored_get(void);
1625 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1628 * Get the system mirrored mode. This determines the default mirrored mode
1631 * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1633 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1636 * Set the system mirrored mode. This determines the default mirrored mode
1639 * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1641 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1644 * Returns the widget's mirrored mode setting.
1646 * @param obj The widget.
1647 * @return mirrored mode setting of the object.
1650 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1653 * Sets the widget's mirrored mode setting.
1654 * When widget in automatic mode, it follows the system mirrored mode set by
1655 * elm_mirrored_set().
1656 * @param obj The widget.
1657 * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1659 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1666 * Set the style to use by a widget
1668 * Sets the style name that will define the appearance of a widget. Styles
1669 * vary from widget to widget and may also be defined by other themes
1670 * by means of extensions and overlays.
1672 * @param obj The Elementary widget to style
1673 * @param style The style name to use
1675 * @see elm_theme_extension_add()
1676 * @see elm_theme_extension_del()
1677 * @see elm_theme_overlay_add()
1678 * @see elm_theme_overlay_del()
1682 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1684 * Get the style used by the widget
1686 * This gets the style being used for that widget. Note that the string
1687 * pointer is only valid as longas the object is valid and the style doesn't
1690 * @param obj The Elementary widget to query for its style
1691 * @return The style name used
1693 * @see elm_object_style_set()
1697 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1700 * @defgroup Styles Styles
1702 * Widgets can have different styles of look. These generic API's
1703 * set styles of widgets, if they support them (and if the theme(s)
1706 * @ref general_functions_example_page "This" example contemplates
1707 * some of these functions.
1711 * Set the disabled state of an Elementary object.
1713 * @param obj The Elementary object to operate on
1714 * @param disabled The state to put in in: @c EINA_TRUE for
1715 * disabled, @c EINA_FALSE for enabled
1717 * Elementary objects can be @b disabled, in which state they won't
1718 * receive input and, in general, will be themed differently from
1719 * their normal state, usually greyed out. Useful for contexts
1720 * where you don't want your users to interact with some of the
1721 * parts of you interface.
1723 * This sets the state for the widget, either disabling it or
1728 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1731 * Get the disabled state of an Elementary object.
1733 * @param obj The Elementary object to operate on
1734 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1735 * if it's enabled (or on errors)
1737 * This gets the state of the widget, which might be enabled or disabled.
1741 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1744 * @defgroup WidgetNavigation Widget Tree Navigation.
1746 * How to check if an Evas Object is an Elementary widget? How to
1747 * get the first elementary widget that is parent of the given
1748 * object? These are all covered in widget tree navigation.
1750 * @ref general_functions_example_page "This" example contemplates
1751 * some of these functions.
1755 * Check if the given Evas Object is an Elementary widget.
1757 * @param obj the object to query.
1758 * @return @c EINA_TRUE if it is an elementary widget variant,
1759 * @c EINA_FALSE otherwise
1760 * @ingroup WidgetNavigation
1762 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1765 * Get the first parent of the given object that is an Elementary
1768 * @param obj the Elementary object to query parent from.
1769 * @return the parent object that is an Elementary widget, or @c
1770 * NULL, if it was not found.
1772 * Use this to query for an object's parent widget.
1774 * @note Most of Elementary users wouldn't be mixing non-Elementary
1775 * smart objects in the objects tree of an application, as this is
1776 * an advanced usage of Elementary with Evas. So, except for the
1777 * application's window, which is the root of that tree, all other
1778 * objects would have valid Elementary widget parents.
1780 * @ingroup WidgetNavigation
1782 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1785 * Get the top level parent of an Elementary widget.
1787 * @param obj The object to query.
1788 * @return The top level Elementary widget, or @c NULL if parent cannot be
1790 * @ingroup WidgetNavigation
1792 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1795 * Get the string that represents this Elementary widget.
1797 * @note Elementary is weird and exposes itself as a single
1798 * Evas_Object_Smart_Class of type "elm_widget", so
1799 * evas_object_type_get() always return that, making debug and
1800 * language bindings hard. This function tries to mitigate this
1801 * problem, but the solution is to change Elementary to use
1802 * proper inheritance.
1804 * @param obj the object to query.
1805 * @return Elementary widget name, or @c NULL if not a valid widget.
1806 * @ingroup WidgetNavigation
1808 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1811 * @defgroup Config Elementary Config
1813 * Elementary configuration is formed by a set options bounded to a
1814 * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1815 * "finger size", etc. These are functions with which one syncronizes
1816 * changes made to those values to the configuration storing files, de
1817 * facto. You most probably don't want to use the functions in this
1818 * group unlees you're writing an elementary configuration manager.
1824 * Save back Elementary's configuration, so that it will persist on
1827 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1830 * This function will take effect -- thus, do I/O -- immediately. Use
1831 * it when you want to apply all configuration changes at once. The
1832 * current configuration set will get saved onto the current profile
1833 * configuration file.
1836 EAPI Eina_Bool elm_config_save(void);
1839 * Reload Elementary's configuration, bounded to current selected
1842 * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1845 * Useful when you want to force reloading of configuration values for
1846 * a profile. If one removes user custom configuration directories,
1847 * for example, it will force a reload with system values insted.
1850 EAPI void elm_config_reload(void);
1857 * @defgroup Profile Elementary Profile
1859 * Profiles are pre-set options that affect the whole look-and-feel of
1860 * Elementary-based applications. There are, for example, profiles
1861 * aimed at desktop computer applications and others aimed at mobile,
1862 * touchscreen-based ones. You most probably don't want to use the
1863 * functions in this group unlees you're writing an elementary
1864 * configuration manager.
1870 * Get Elementary's profile in use.
1872 * This gets the global profile that is applied to all Elementary
1875 * @return The profile's name
1878 EAPI const char *elm_profile_current_get(void);
1881 * Get an Elementary's profile directory path in the filesystem. One
1882 * may want to fetch a system profile's dir or an user one (fetched
1885 * @param profile The profile's name
1886 * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1887 * or a system one (@c EINA_FALSE)
1888 * @return The profile's directory path.
1891 * @note You must free it with elm_profile_dir_free().
1893 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1896 * Free an Elementary's profile directory path, as returned by
1897 * elm_profile_dir_get().
1899 * @param p_dir The profile's path
1903 EAPI void elm_profile_dir_free(const char *p_dir);
1906 * Get Elementary's list of available profiles.
1908 * @return The profiles list. List node data are the profile name
1912 * @note One must free this list, after usage, with the function
1913 * elm_profile_list_free().
1915 EAPI Eina_List *elm_profile_list_get(void);
1918 * Free Elementary's list of available profiles.
1920 * @param l The profiles list, as returned by elm_profile_list_get().
1924 EAPI void elm_profile_list_free(Eina_List *l);
1927 * Set Elementary's profile.
1929 * This sets the global profile that is applied to Elementary
1930 * applications. Just the process the call comes from will be
1933 * @param profile The profile's name
1937 EAPI void elm_profile_set(const char *profile);
1940 * Set Elementary's profile.
1942 * This sets the global profile that is applied to all Elementary
1943 * applications. All running Elementary windows will be affected.
1945 * @param profile The profile's name
1949 EAPI void elm_profile_all_set(const char *profile);
1956 * @defgroup Engine Elementary Engine
1958 * These are functions setting and querying which rendering engine
1959 * Elementary will use for drawing its windows' pixels.
1961 * The following are the available engines:
1962 * @li "software_x11"
1965 * @li "software_16_x11"
1966 * @li "software_8_x11"
1969 * @li "software_gdi"
1970 * @li "software_16_wince_gdi"
1972 * @li "software_16_sdl"
1976 * @li "opengl_cocoa"
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)
3647 * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3649 * All engines use a simple string to select the engine to render, EXCEPT
3650 * the "shot" engine. This actually encodes the output of the virtual
3651 * screenshot and how long to delay in the engine string. The engine string
3652 * is encoded in the following way:
3654 * "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3656 * Where options are separated by a ":" char if more than one option is
3657 * given, with delay, if provided being the first option and file the last
3658 * (order is important). The delay specifies how long to wait after the
3659 * window is shown before doing the virtual "in memory" rendering and then
3660 * save the output to the file specified by the file option (and then exit).
3661 * If no delay is given, the default is 0.5 seconds. If no file is given the
3662 * default output file is "out.png". Repeat option is for continous
3663 * capturing screenshots. Repeat range is from 1 to 999 and filename is
3664 * fixed to "out001.png" Some examples of using the shot engine:
3666 * ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3667 * ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3668 * ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3669 * ELM_ENGINE="shot:delay=2.0" elementary_test
3670 * ELM_ENGINE="shot:" elementary_test
3672 * Signals that you can add callbacks for are:
3674 * @li "delete,request": the user requested to close the window. See
3675 * elm_win_autodel_set().
3676 * @li "focus,in": window got focus
3677 * @li "focus,out": window lost focus
3678 * @li "moved": window that holds the canvas was moved
3681 * @li @ref win_example_01
3686 * Defines the types of window that can be created
3688 * These are hints set on the window so that a running Window Manager knows
3689 * how the window should be handled and/or what kind of decorations it
3692 * Currently, only the X11 backed engines use them.
3694 typedef enum _Elm_Win_Type
3696 ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3697 window. Almost every window will be created with this
3699 ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3700 ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3701 window holding desktop icons. */
3702 ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3703 be kept on top of any other window by the Window
3705 ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3707 ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3708 ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3710 ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3711 ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3712 entry in a menubar is clicked. Typically used
3713 with elm_win_override_set(). This hint exists
3714 for completion only, as the EFL way of
3715 implementing a menu would not normally use a
3716 separate window for its contents. */
3717 ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3718 triggered by right-clicking an object. */
3719 ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3720 explanatory text that typically appear after the
3721 mouse cursor hovers over an object for a while.
3722 Typically used with elm_win_override_set() and also
3723 not very commonly used in the EFL. */
3724 ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3725 battery life or a new E-Mail received. */
3726 ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3727 usually used in the EFL. */
3728 ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3729 object being dragged across different windows, or even
3730 applications. Typically used with
3731 elm_win_override_set(). */
3732 ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3733 buffer. No actual window is created for this
3734 type, instead the window and all of its
3735 contents will be rendered to an image buffer.
3736 This allows to have children window inside a
3737 parent one just like any other object would
3738 be, and do other things like applying @c
3739 Evas_Map effects to it. This is the only type
3740 of window that requires the @c parent
3741 parameter of elm_win_add() to be a valid @c
3746 * The differents layouts that can be requested for the virtual keyboard.
3748 * When the application window is being managed by Illume, it may request
3749 * any of the following layouts for the virtual keyboard.
3751 typedef enum _Elm_Win_Keyboard_Mode
3753 ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3754 ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3755 ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3756 ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3757 ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3758 ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3759 ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3760 ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3761 ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3762 ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3763 ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3764 ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3765 ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3766 ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3767 ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3768 ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3769 } Elm_Win_Keyboard_Mode;
3772 * Available commands that can be sent to the Illume manager.
3774 * When running under an Illume session, a window may send commands to the
3775 * Illume manager to perform different actions.
3777 typedef enum _Elm_Illume_Command
3779 ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3781 ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3783 ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3785 ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3786 } Elm_Illume_Command;
3789 * Adds a window object. If this is the first window created, pass NULL as
3792 * @param parent Parent object to add the window to, or NULL
3793 * @param name The name of the window
3794 * @param type The window type, one of #Elm_Win_Type.
3796 * The @p parent paramter can be @c NULL for every window @p type except
3797 * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3798 * which the image object will be created.
3800 * @return The created object, or NULL on failure
3802 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3804 * Adds a window object with standard setup
3806 * @param name The name of the window
3807 * @param title The title for the window
3809 * This creates a window like elm_win_add() but also puts in a standard
3810 * background with elm_bg_add(), as well as setting the window title to
3811 * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
3812 * as the parent widget.
3814 * @return The created object, or NULL on failure
3816 * @see elm_win_add()
3818 EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
3820 * Add @p subobj as a resize object of window @p obj.
3823 * Setting an object as a resize object of the window means that the
3824 * @p subobj child's size and position will be controlled by the window
3825 * directly. That is, the object will be resized to match the window size
3826 * and should never be moved or resized manually by the developer.
3828 * In addition, resize objects of the window control what the minimum size
3829 * of it will be, as well as whether it can or not be resized by the user.
3831 * For the end user to be able to resize a window by dragging the handles
3832 * or borders provided by the Window Manager, or using any other similar
3833 * mechanism, all of the resize objects in the window should have their
3834 * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3836 * @param obj The window object
3837 * @param subobj The resize object to add
3839 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3841 * Delete @p subobj as a resize object of window @p obj.
3843 * This function removes the object @p subobj from the resize objects of
3844 * the window @p obj. It will not delete the object itself, which will be
3845 * left unmanaged and should be deleted by the developer, manually handled
3846 * or set as child of some other container.
3848 * @param obj The window object
3849 * @param subobj The resize object to add
3851 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3853 * Set the title of the window
3855 * @param obj The window object
3856 * @param title The title to set
3858 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3860 * Get the title of the window
3862 * The returned string is an internal one and should not be freed or
3863 * modified. It will also be rendered invalid if a new title is set or if
3864 * the window is destroyed.
3866 * @param obj The window object
3869 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3871 * Set the window's autodel state.
3873 * When closing the window in any way outside of the program control, like
3874 * pressing the X button in the titlebar or using a command from the
3875 * Window Manager, a "delete,request" signal is emitted to indicate that
3876 * this event occurred and the developer can take any action, which may
3877 * include, or not, destroying the window object.
3879 * When the @p autodel parameter is set, the window will be automatically
3880 * destroyed when this event occurs, after the signal is emitted.
3881 * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3882 * and is up to the program to do so when it's required.
3884 * @param obj The window object
3885 * @param autodel If true, the window will automatically delete itself when
3888 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3890 * Get the window's autodel state.
3892 * @param obj The window object
3893 * @return If the window will automatically delete itself when closed
3895 * @see elm_win_autodel_set()
3897 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3899 * Activate a window object.
3901 * This function sends a request to the Window Manager to activate the
3902 * window pointed by @p obj. If honored by the WM, the window will receive
3903 * the keyboard focus.
3905 * @note This is just a request that a Window Manager may ignore, so calling
3906 * this function does not ensure in any way that the window will be the
3907 * active one after it.
3909 * @param obj The window object
3911 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3913 * Lower a window object.
3915 * Places the window pointed by @p obj at the bottom of the stack, so that
3916 * no other window is covered by it.
3918 * If elm_win_override_set() is not set, the Window Manager may ignore this
3921 * @param obj The window object
3923 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3925 * Raise a window object.
3927 * Places the window pointed by @p obj at the top of the stack, so that it's
3928 * not covered by any other window.
3930 * If elm_win_override_set() is not set, the Window Manager may ignore this
3933 * @param obj The window object
3935 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3937 * Set the borderless state of a window.
3939 * This function requests the Window Manager to not draw any decoration
3940 * around the window.
3942 * @param obj The window object
3943 * @param borderless If true, the window is borderless
3945 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3947 * Get the borderless state of a window.
3949 * @param obj The window object
3950 * @return If true, the window is borderless
3952 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3954 * Set the shaped state of a window.
3956 * Shaped windows, when supported, will render the parts of the window that
3957 * has no content, transparent.
3959 * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3960 * background object or cover the entire window in any other way, or the
3961 * parts of the canvas that have no data will show framebuffer artifacts.
3963 * @param obj The window object
3964 * @param shaped If true, the window is shaped
3966 * @see elm_win_alpha_set()
3968 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3970 * Get the shaped state of a window.
3972 * @param obj The window object
3973 * @return If true, the window is shaped
3975 * @see elm_win_shaped_set()
3977 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3979 * Set the alpha channel state of a window.
3981 * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3982 * possibly making parts of the window completely or partially transparent.
3983 * This is also subject to the underlying system supporting it, like for
3984 * example, running under a compositing manager. If no compositing is
3985 * available, enabling this option will instead fallback to using shaped
3986 * windows, with elm_win_shaped_set().
3988 * @param obj The window object
3989 * @param alpha If true, the window has an alpha channel
3991 * @see elm_win_alpha_set()
3993 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3995 * Get the transparency state of a window.
3997 * @param obj The window object
3998 * @return If true, the window is transparent
4000 * @see elm_win_transparent_set()
4002 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4004 * Set the transparency state of a window.
4006 * Use elm_win_alpha_set() instead.
4008 * @param obj The window object
4009 * @param transparent If true, the window is transparent
4011 * @see elm_win_alpha_set()
4013 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4015 * Get the alpha channel state of a window.
4017 * @param obj The window object
4018 * @return If true, the window has an alpha channel
4020 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4022 * Set the override state of a window.
4024 * A window with @p override set to EINA_TRUE will not be managed by the
4025 * Window Manager. This means that no decorations of any kind will be shown
4026 * for it, moving and resizing must be handled by the application, as well
4027 * as the window visibility.
4029 * This should not be used for normal windows, and even for not so normal
4030 * ones, it should only be used when there's a good reason and with a lot
4031 * of care. Mishandling override windows may result situations that
4032 * disrupt the normal workflow of the end user.
4034 * @param obj The window object
4035 * @param override If true, the window is overridden
4037 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4039 * Get the override state of a window.
4041 * @param obj The window object
4042 * @return If true, the window is overridden
4044 * @see elm_win_override_set()
4046 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4048 * Set the fullscreen state of a window.
4050 * @param obj The window object
4051 * @param fullscreen If true, the window is fullscreen
4053 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4055 * Get the fullscreen state of a window.
4057 * @param obj The window object
4058 * @return If true, the window is fullscreen
4060 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4062 * Set the maximized state of a window.
4064 * @param obj The window object
4065 * @param maximized If true, the window is maximized
4067 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4069 * Get the maximized state of a window.
4071 * @param obj The window object
4072 * @return If true, the window is maximized
4074 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4076 * Set the iconified state of a window.
4078 * @param obj The window object
4079 * @param iconified If true, the window is iconified
4081 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4083 * Get the iconified state of a window.
4085 * @param obj The window object
4086 * @return If true, the window is iconified
4088 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4090 * Set the layer of the window.
4092 * What this means exactly will depend on the underlying engine used.
4094 * In the case of X11 backed engines, the value in @p layer has the
4095 * following meanings:
4096 * @li < 3: The window will be placed below all others.
4097 * @li > 5: The window will be placed above all others.
4098 * @li other: The window will be placed in the default layer.
4100 * @param obj The window object
4101 * @param layer The layer of the window
4103 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4105 * Get the layer of the window.
4107 * @param obj The window object
4108 * @return The layer of the window
4110 * @see elm_win_layer_set()
4112 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4114 * Set the rotation of the window.
4116 * Most engines only work with multiples of 90.
4118 * This function is used to set the orientation of the window @p obj to
4119 * match that of the screen. The window itself will be resized to adjust
4120 * to the new geometry of its contents. If you want to keep the window size,
4121 * see elm_win_rotation_with_resize_set().
4123 * @param obj The window object
4124 * @param rotation The rotation of the window, in degrees (0-360),
4125 * counter-clockwise.
4127 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4129 * Rotates the window and resizes it.
4131 * Like elm_win_rotation_set(), but it also resizes the window's contents so
4132 * that they fit inside the current window geometry.
4134 * @param obj The window object
4135 * @param layer The rotation of the window in degrees (0-360),
4136 * counter-clockwise.
4138 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4140 * Get the rotation of the window.
4142 * @param obj The window object
4143 * @return The rotation of the window in degrees (0-360)
4145 * @see elm_win_rotation_set()
4146 * @see elm_win_rotation_with_resize_set()
4148 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4150 * Set the sticky state of the window.
4152 * Hints the Window Manager that the window in @p obj should be left fixed
4153 * at its position even when the virtual desktop it's on moves or changes.
4155 * @param obj The window object
4156 * @param sticky If true, the window's sticky state is enabled
4158 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4160 * Get the sticky state of the window.
4162 * @param obj The window object
4163 * @return If true, the window's sticky state is enabled
4165 * @see elm_win_sticky_set()
4167 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4169 * Set if this window is an illume conformant window
4171 * @param obj The window object
4172 * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4174 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4176 * Get if this window is an illume conformant window
4178 * @param obj The window object
4179 * @return A boolean if this window is illume conformant or not
4181 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4183 * Set a window to be an illume quickpanel window
4185 * By default window objects are not quickpanel windows.
4187 * @param obj The window object
4188 * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4190 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4192 * Get if this window is a quickpanel or not
4194 * @param obj The window object
4195 * @return A boolean if this window is a quickpanel or not
4197 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4199 * Set the major priority of a quickpanel window
4201 * @param obj The window object
4202 * @param priority The major priority for this quickpanel
4204 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4206 * Get the major priority of a quickpanel window
4208 * @param obj The window object
4209 * @return The major priority of this quickpanel
4211 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4213 * Set the minor priority of a quickpanel window
4215 * @param obj The window object
4216 * @param priority The minor priority for this quickpanel
4218 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4220 * Get the minor priority of a quickpanel window
4222 * @param obj The window object
4223 * @return The minor priority of this quickpanel
4225 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4227 * Set which zone this quickpanel should appear in
4229 * @param obj The window object
4230 * @param zone The requested zone for this quickpanel
4232 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4234 * Get which zone this quickpanel should appear in
4236 * @param obj The window object
4237 * @return The requested zone for this quickpanel
4239 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4241 * Set the window to be skipped by keyboard focus
4243 * This sets the window to be skipped by normal keyboard input. This means
4244 * a window manager will be asked to not focus this window as well as omit
4245 * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4247 * Call this and enable it on a window BEFORE you show it for the first time,
4248 * otherwise it may have no effect.
4250 * Use this for windows that have only output information or might only be
4251 * interacted with by the mouse or fingers, and never for typing input.
4252 * Be careful that this may have side-effects like making the window
4253 * non-accessible in some cases unless the window is specially handled. Use
4256 * @param obj The window object
4257 * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4259 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4261 * Send a command to the windowing environment
4263 * This is intended to work in touchscreen or small screen device
4264 * environments where there is a more simplistic window management policy in
4265 * place. This uses the window object indicated to select which part of the
4266 * environment to control (the part that this window lives in), and provides
4267 * a command and an optional parameter structure (use NULL for this if not
4270 * @param obj The window object that lives in the environment to control
4271 * @param command The command to send
4272 * @param params Optional parameters for the command
4274 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4276 * Get the inlined image object handle
4278 * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4279 * then the window is in fact an evas image object inlined in the parent
4280 * canvas. You can get this object (be careful to not manipulate it as it
4281 * is under control of elementary), and use it to do things like get pixel
4282 * data, save the image to a file, etc.
4284 * @param obj The window object to get the inlined image from
4285 * @return The inlined image object, or NULL if none exists
4287 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4289 * Set the enabled status for the focus highlight in a window
4291 * This function will enable or disable the focus highlight only for the
4292 * given window, regardless of the global setting for it
4294 * @param obj The window where to enable the highlight
4295 * @param enabled The enabled value for the highlight
4297 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4299 * Get the enabled value of the focus highlight for this window
4301 * @param obj The window in which to check if the focus highlight is enabled
4303 * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4305 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4307 * Set the style for the focus highlight on this window
4309 * Sets the style to use for theming the highlight of focused objects on
4310 * the given window. If @p style is NULL, the default will be used.
4312 * @param obj The window where to set the style
4313 * @param style The style to set
4315 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4317 * Get the style set for the focus highlight object
4319 * Gets the style set for this windows highilght object, or NULL if none
4322 * @param obj The window to retrieve the highlights style from
4324 * @return The style set or NULL if none was. Default is used in that case.
4326 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4328 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4329 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4330 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4331 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4332 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4333 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4334 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4336 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4337 * (blank mouse, private mouse obj, defaultmouse)
4341 * Sets the keyboard mode of the window.
4343 * @param obj The window object
4344 * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4346 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4348 * Gets the keyboard mode of the window.
4350 * @param obj The window object
4351 * @return The mode, one of #Elm_Win_Keyboard_Mode
4353 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4355 * Sets whether the window is a keyboard.
4357 * @param obj The window object
4358 * @param is_keyboard If true, the window is a virtual keyboard
4360 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4362 * Gets whether the window is a keyboard.
4364 * @param obj The window object
4365 * @return If the window is a virtual keyboard
4367 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4370 * Get the screen position of a window.
4372 * @param obj The window object
4373 * @param x The int to store the x coordinate to
4374 * @param y The int to store the y coordinate to
4376 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4382 * @defgroup Inwin Inwin
4384 * @image html img/widget/inwin/preview-00.png
4385 * @image latex img/widget/inwin/preview-00.eps
4386 * @image html img/widget/inwin/preview-01.png
4387 * @image latex img/widget/inwin/preview-01.eps
4388 * @image html img/widget/inwin/preview-02.png
4389 * @image latex img/widget/inwin/preview-02.eps
4391 * An inwin is a window inside a window that is useful for a quick popup.
4392 * It does not hover.
4394 * It works by creating an object that will occupy the entire window, so it
4395 * must be created using an @ref Win "elm_win" as parent only. The inwin
4396 * object can be hidden or restacked below every other object if it's
4397 * needed to show what's behind it without destroying it. If this is done,
4398 * the elm_win_inwin_activate() function can be used to bring it back to
4399 * full visibility again.
4401 * There are three styles available in the default theme. These are:
4402 * @li default: The inwin is sized to take over most of the window it's
4404 * @li minimal: The size of the inwin will be the minimum necessary to show
4406 * @li minimal_vertical: Horizontally, the inwin takes as much space as
4407 * possible, but it's sized vertically the most it needs to fit its\
4410 * Some examples of Inwin can be found in the following:
4411 * @li @ref inwin_example_01
4416 * Adds an inwin to the current window
4418 * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4419 * Never call this function with anything other than the top-most window
4420 * as its parameter, unless you are fond of undefined behavior.
4422 * After creating the object, the widget will set itself as resize object
4423 * for the window with elm_win_resize_object_add(), so when shown it will
4424 * appear to cover almost the entire window (how much of it depends on its
4425 * content and the style used). It must not be added into other container
4426 * objects and it needs not be moved or resized manually.
4428 * @param parent The parent object
4429 * @return The new object or NULL if it cannot be created
4431 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4433 * Activates an inwin object, ensuring its visibility
4435 * This function will make sure that the inwin @p obj is completely visible
4436 * by calling evas_object_show() and evas_object_raise() on it, to bring it
4437 * to the front. It also sets the keyboard focus to it, which will be passed
4440 * The object's theme will also receive the signal "elm,action,show" with
4443 * @param obj The inwin to activate
4445 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4447 * Set the content of an inwin object.
4449 * Once the content object is set, a previously set one will be deleted.
4450 * If you want to keep that old content object, use the
4451 * elm_win_inwin_content_unset() function.
4453 * @param obj The inwin object
4454 * @param content The object to set as content
4456 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4458 * Get the content of an inwin object.
4460 * Return the content object which is set for this widget.
4462 * The returned object is valid as long as the inwin is still alive and no
4463 * other content is set on it. Deleting the object will notify the inwin
4464 * about it and this one will be left empty.
4466 * If you need to remove an inwin's content to be reused somewhere else,
4467 * see elm_win_inwin_content_unset().
4469 * @param obj The inwin object
4470 * @return The content that is being used
4472 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4474 * Unset the content of an inwin object.
4476 * Unparent and return the content object which was set for this widget.
4478 * @param obj The inwin object
4479 * @return The content that was being used
4481 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4485 /* X specific calls - won't work on non-x engines (return 0) */
4488 * Get the Ecore_X_Window of an Evas_Object
4490 * @param obj The object
4492 * @return The Ecore_X_Window of @p obj
4496 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4498 /* smart callbacks called:
4499 * "delete,request" - the user requested to delete the window
4500 * "focus,in" - window got focus
4501 * "focus,out" - window lost focus
4502 * "moved" - window that holds the canvas was moved
4508 * @image html img/widget/bg/preview-00.png
4509 * @image latex img/widget/bg/preview-00.eps
4511 * @brief Background object, used for setting a solid color, image or Edje
4512 * group as background to a window or any container object.
4514 * The bg object is used for setting a solid background to a window or
4515 * packing into any container object. It works just like an image, but has
4516 * some properties useful to a background, like setting it to tiled,
4517 * centered, scaled or stretched.
4519 * Default contents parts of the bg widget that you can use for are:
4520 * @li "elm.swallow.content" - overlay of the bg
4522 * Here is some sample code using it:
4523 * @li @ref bg_01_example_page
4524 * @li @ref bg_02_example_page
4525 * @li @ref bg_03_example_page
4529 typedef enum _Elm_Bg_Option
4531 ELM_BG_OPTION_CENTER, /**< center the background */
4532 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
4533 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4534 ELM_BG_OPTION_TILE /**< tile background at its original size */
4538 * Add a new background to the parent
4540 * @param parent The parent object
4541 * @return The new object or NULL if it cannot be created
4545 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4548 * Set the file (image or edje) used for the background
4550 * @param obj The bg object
4551 * @param file The file path
4552 * @param group Optional key (group in Edje) within the file
4554 * This sets the image file used in the background object. The image (or edje)
4555 * will be stretched (retaining aspect if its an image file) to completely fill
4556 * the bg object. This may mean some parts are not visible.
4558 * @note Once the image of @p obj is set, a previously set one will be deleted,
4559 * even if @p file is NULL.
4563 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4566 * Get the file (image or edje) used for the background
4568 * @param obj The bg object
4569 * @param file The file path
4570 * @param group Optional key (group in Edje) within the file
4574 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4577 * Set the option used for the background image
4579 * @param obj The bg object
4580 * @param option The desired background option (TILE, SCALE)
4582 * This sets the option used for manipulating the display of the background
4583 * image. The image can be tiled or scaled.
4587 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4590 * Get the option used for the background image
4592 * @param obj The bg object
4593 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4597 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4599 * Set the option used for the background color
4601 * @param obj The bg object
4606 * This sets the color used for the background rectangle. Its range goes
4611 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4613 * Get the option used for the background color
4615 * @param obj The bg object
4622 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4625 * Set the overlay object used for the background object.
4627 * @param obj The bg object
4628 * @param overlay The overlay object
4630 * This provides a way for elm_bg to have an 'overlay' that will be on top
4631 * of the bg. Once the over object is set, a previously set one will be
4632 * deleted, even if you set the new one to NULL. If you want to keep that
4633 * old content object, use the elm_bg_overlay_unset() function.
4638 EINA_DEPRECATED EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4641 * Get the overlay object used for the background object.
4643 * @param obj The bg object
4644 * @return The content that is being used
4646 * Return the content object which is set for this widget
4650 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4653 * Get the overlay object used for the background object.
4655 * @param obj The bg object
4656 * @return The content that was being used
4658 * Unparent and return the overlay object which was set for this widget
4662 EINA_DEPRECATED EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4665 * Set the size of the pixmap representation of the image.
4667 * This option just makes sense if an image is going to be set in the bg.
4669 * @param obj The bg object
4670 * @param w The new width of the image pixmap representation.
4671 * @param h The new height of the image pixmap representation.
4673 * This function sets a new size for pixmap representation of the given bg
4674 * image. It allows the image to be loaded already in the specified size,
4675 * reducing the memory usage and load time when loading a big image with load
4676 * size set to a smaller size.
4678 * NOTE: this is just a hint, the real size of the pixmap may differ
4679 * depending on the type of image being loaded, being bigger than requested.
4683 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4684 /* smart callbacks called:
4688 * @defgroup Icon Icon
4690 * @image html img/widget/icon/preview-00.png
4691 * @image latex img/widget/icon/preview-00.eps
4693 * An object that provides standard icon images (delete, edit, arrows, etc.)
4694 * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4696 * The icon image requested can be in the elementary theme, or in the
4697 * freedesktop.org paths. It's possible to set the order of preference from
4698 * where the image will be used.
4700 * This API is very similar to @ref Image, but with ready to use images.
4702 * Default images provided by the theme are described below.
4704 * The first list contains icons that were first intended to be used in
4705 * toolbars, but can be used in many other places too:
4721 * Now some icons that were designed to be used in menus (but again, you can
4722 * use them anywhere else):
4727 * @li menu/arrow_down
4728 * @li menu/arrow_left
4729 * @li menu/arrow_right
4738 * And here we have some media player specific icons:
4739 * @li media_player/forward
4740 * @li media_player/info
4741 * @li media_player/next
4742 * @li media_player/pause
4743 * @li media_player/play
4744 * @li media_player/prev
4745 * @li media_player/rewind
4746 * @li media_player/stop
4748 * Signals that you can add callbacks for are:
4750 * "clicked" - This is called when a user has clicked the icon
4752 * An example of usage for this API follows:
4753 * @li @ref tutorial_icon
4761 typedef enum _Elm_Icon_Type
4768 * @enum _Elm_Icon_Lookup_Order
4769 * @typedef Elm_Icon_Lookup_Order
4771 * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4772 * theme, FDO paths, or both?
4776 typedef enum _Elm_Icon_Lookup_Order
4778 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4779 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4780 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
4781 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
4782 } Elm_Icon_Lookup_Order;
4785 * Add a new icon object to the parent.
4787 * @param parent The parent object
4788 * @return The new object or NULL if it cannot be created
4790 * @see elm_icon_file_set()
4794 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4796 * Set the file that will be used as icon.
4798 * @param obj The icon object
4799 * @param file The path to file that will be used as icon image
4800 * @param group The group that the icon belongs to an edje file
4802 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4804 * @note The icon image set by this function can be changed by
4805 * elm_icon_standard_set().
4807 * @see elm_icon_file_get()
4811 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4813 * Set a location in memory to be used as an icon
4815 * @param obj The icon object
4816 * @param img The binary data that will be used as an image
4817 * @param size The size of binary data @p img
4818 * @param format Optional format of @p img to pass to the image loader
4819 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4821 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4823 * @note The icon image set by this function can be changed by
4824 * elm_icon_standard_set().
4828 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);
4830 * Get the file that will be used as icon.
4832 * @param obj The icon object
4833 * @param file The path to file that will be used as the icon image
4834 * @param group The group that the icon belongs to, in edje file
4836 * @see elm_icon_file_set()
4840 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4841 EAPI void elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4843 * Set the icon by icon standards names.
4845 * @param obj The icon object
4846 * @param name The icon name
4848 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4850 * For example, freedesktop.org defines standard icon names such as "home",
4851 * "network", etc. There can be different icon sets to match those icon
4852 * keys. The @p name given as parameter is one of these "keys", and will be
4853 * used to look in the freedesktop.org paths and elementary theme. One can
4854 * change the lookup order with elm_icon_order_lookup_set().
4856 * If name is not found in any of the expected locations and it is the
4857 * absolute path of an image file, this image will be used.
4859 * @note The icon image set by this function can be changed by
4860 * elm_icon_file_set().
4862 * @see elm_icon_standard_get()
4863 * @see elm_icon_file_set()
4867 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4869 * Get the icon name set by icon standard names.
4871 * @param obj The icon object
4872 * @return The icon name
4874 * If the icon image was set using elm_icon_file_set() instead of
4875 * elm_icon_standard_set(), then this function will return @c NULL.
4877 * @see elm_icon_standard_set()
4881 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4883 * Set the smooth scaling for an icon object.
4885 * @param obj The icon object
4886 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4887 * otherwise. Default is @c EINA_TRUE.
4889 * Set the scaling algorithm to be used when scaling the icon image. Smooth
4890 * scaling provides a better resulting image, but is slower.
4892 * The smooth scaling should be disabled when making animations that change
4893 * the icon size, since they will be faster. Animations that don't require
4894 * resizing of the icon can keep the smooth scaling enabled (even if the icon
4895 * is already scaled, since the scaled icon image will be cached).
4897 * @see elm_icon_smooth_get()
4901 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4903 * Get whether smooth scaling is enabled for an icon object.
4905 * @param obj The icon object
4906 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4908 * @see elm_icon_smooth_set()
4912 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4914 * Disable scaling of this object.
4916 * @param obj The icon object.
4917 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4918 * otherwise. Default is @c EINA_FALSE.
4920 * This function disables scaling of the icon object through the function
4921 * elm_object_scale_set(). However, this does not affect the object
4922 * size/resize in any way. For that effect, take a look at
4923 * elm_icon_scale_set().
4925 * @see elm_icon_no_scale_get()
4926 * @see elm_icon_scale_set()
4927 * @see elm_object_scale_set()
4931 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4933 * Get whether scaling is disabled on the object.
4935 * @param obj The icon object
4936 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4938 * @see elm_icon_no_scale_set()
4942 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4944 * Set if the object is (up/down) resizable.
4946 * @param obj The icon object
4947 * @param scale_up A bool to set if the object is resizable up. Default is
4949 * @param scale_down A bool to set if the object is resizable down. Default
4952 * This function limits the icon object resize ability. If @p scale_up is set to
4953 * @c EINA_FALSE, the object can't have its height or width resized to a value
4954 * higher than the original icon size. Same is valid for @p scale_down.
4956 * @see elm_icon_scale_get()
4960 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4962 * Get if the object is (up/down) resizable.
4964 * @param obj The icon object
4965 * @param scale_up A bool to set if the object is resizable up
4966 * @param scale_down A bool to set if the object is resizable down
4968 * @see elm_icon_scale_set()
4972 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4974 * Get the object's image size
4976 * @param obj The icon object
4977 * @param w A pointer to store the width in
4978 * @param h A pointer to store the height in
4982 EAPI void elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4984 * Set if the icon fill the entire object area.
4986 * @param obj The icon object
4987 * @param fill_outside @c EINA_TRUE if the object is filled outside,
4988 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4990 * When the icon object is resized to a different aspect ratio from the
4991 * original icon image, the icon image will still keep its aspect. This flag
4992 * tells how the image should fill the object's area. They are: keep the
4993 * entire icon inside the limits of height and width of the object (@p
4994 * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4995 * of the object, and the icon will fill the entire object (@p fill_outside
4998 * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4999 * retain property to false. Thus, the icon image will always keep its
5000 * original aspect ratio.
5002 * @see elm_icon_fill_outside_get()
5003 * @see elm_image_fill_outside_set()
5007 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5009 * Get if the object is filled outside.
5011 * @param obj The icon object
5012 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5014 * @see elm_icon_fill_outside_set()
5018 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5020 * Set the prescale size for the icon.
5022 * @param obj The icon object
5023 * @param size The prescale size. This value is used for both width and
5026 * This function sets a new size for pixmap representation of the given
5027 * icon. It allows the icon to be loaded already in the specified size,
5028 * reducing the memory usage and load time when loading a big icon with load
5029 * size set to a smaller size.
5031 * It's equivalent to the elm_bg_load_size_set() function for bg.
5033 * @note this is just a hint, the real size of the pixmap may differ
5034 * depending on the type of icon being loaded, being bigger than requested.
5036 * @see elm_icon_prescale_get()
5037 * @see elm_bg_load_size_set()
5041 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5043 * Get the prescale size for the icon.
5045 * @param obj The icon object
5046 * @return The prescale size
5048 * @see elm_icon_prescale_set()
5052 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5054 * Sets the icon lookup order used by elm_icon_standard_set().
5056 * @param obj The icon object
5057 * @param order The icon lookup order (can be one of
5058 * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5059 * or ELM_ICON_LOOKUP_THEME)
5061 * @see elm_icon_order_lookup_get()
5062 * @see Elm_Icon_Lookup_Order
5066 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5068 * Gets the icon lookup order.
5070 * @param obj The icon object
5071 * @return The icon lookup order
5073 * @see elm_icon_order_lookup_set()
5074 * @see Elm_Icon_Lookup_Order
5078 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5080 * Get if the icon supports animation or not.
5082 * @param obj The icon object
5083 * @return @c EINA_TRUE if the icon supports animation,
5084 * @c EINA_FALSE otherwise.
5086 * Return if this elm icon's image can be animated. Currently Evas only
5087 * supports gif animation. If the return value is EINA_FALSE, other
5088 * elm_icon_animated_XXX APIs won't work.
5091 EAPI Eina_Bool elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5093 * Set animation mode of the icon.
5095 * @param obj The icon object
5096 * @param anim @c EINA_TRUE if the object do animation job,
5097 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5099 * Since the default animation mode is set to EINA_FALSE,
5100 * the icon is shown without animation.
5101 * This might be desirable when the application developer wants to show
5102 * a snapshot of the animated icon.
5103 * Set it to EINA_TRUE when the icon needs to be animated.
5106 EAPI void elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5108 * Get animation mode of the icon.
5110 * @param obj The icon object
5111 * @return The animation mode of the icon object
5112 * @see elm_icon_animated_set
5115 EAPI Eina_Bool elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5117 * Set animation play mode of the icon.
5119 * @param obj The icon object
5120 * @param play @c EINA_TRUE the object play animation images,
5121 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5123 * To play elm icon's animation, set play to EINA_TURE.
5124 * For example, you make gif player using this set/get API and click event.
5126 * 1. Click event occurs
5127 * 2. Check play flag using elm_icon_animaged_play_get
5128 * 3. If elm icon was playing, set play to EINA_FALSE.
5129 * Then animation will be stopped and vice versa
5132 EAPI void elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5134 * Get animation play mode of the icon.
5136 * @param obj The icon object
5137 * @return The play mode of the icon object
5139 * @see elm_icon_animated_play_get
5142 EAPI Eina_Bool elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5149 * @defgroup Image Image
5151 * @image html img/widget/image/preview-00.png
5152 * @image latex img/widget/image/preview-00.eps
5155 * An object that allows one to load an image file to it. It can be used
5156 * anywhere like any other elementary widget.
5158 * This widget provides most of the functionality provided from @ref Bg or @ref
5159 * Icon, but with a slightly different API (use the one that fits better your
5162 * The features not provided by those two other image widgets are:
5163 * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5164 * @li change the object orientation with elm_image_orient_set();
5165 * @li and turning the image editable with elm_image_editable_set().
5167 * Signals that you can add callbacks for are:
5169 * @li @c "clicked" - This is called when a user has clicked the image
5171 * An example of usage for this API follows:
5172 * @li @ref tutorial_image
5181 * @enum _Elm_Image_Orient
5182 * @typedef Elm_Image_Orient
5184 * Possible orientation options for elm_image_orient_set().
5186 * @image html elm_image_orient_set.png
5187 * @image latex elm_image_orient_set.eps width=\textwidth
5191 typedef enum _Elm_Image_Orient
5193 ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5194 ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5195 ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5196 ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5197 ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5198 ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5199 ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5200 ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5204 * Add a new image to the parent.
5206 * @param parent The parent object
5207 * @return The new object or NULL if it cannot be created
5209 * @see elm_image_file_set()
5213 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5215 * Set the file that will be used as image.
5217 * @param obj The image object
5218 * @param file The path to file that will be used as image
5219 * @param group The group that the image belongs in edje file (if it's an
5222 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5224 * @see elm_image_file_get()
5228 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5230 * Get the file that will be used as image.
5232 * @param obj The image object
5233 * @param file The path to file
5234 * @param group The group that the image belongs in edje file
5236 * @see elm_image_file_set()
5240 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5242 * Set the smooth effect for an image.
5244 * @param obj The image object
5245 * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5246 * otherwise. Default is @c EINA_TRUE.
5248 * Set the scaling algorithm to be used when scaling the image. Smooth
5249 * scaling provides a better resulting image, but is slower.
5251 * The smooth scaling should be disabled when making animations that change
5252 * the image size, since it will be faster. Animations that don't require
5253 * resizing of the image can keep the smooth scaling enabled (even if the
5254 * image is already scaled, since the scaled image will be cached).
5256 * @see elm_image_smooth_get()
5260 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5262 * Get the smooth effect for an image.
5264 * @param obj The image object
5265 * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5267 * @see elm_image_smooth_get()
5271 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5274 * Gets the current size of the image.
5276 * @param obj The image object.
5277 * @param w Pointer to store width, or NULL.
5278 * @param h Pointer to store height, or NULL.
5280 * This is the real size of the image, not the size of the object.
5282 * On error, neither w or h will be written.
5286 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5288 * Disable scaling of this object.
5290 * @param obj The image object.
5291 * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5292 * otherwise. Default is @c EINA_FALSE.
5294 * This function disables scaling of the elm_image widget through the
5295 * function elm_object_scale_set(). However, this does not affect the widget
5296 * size/resize in any way. For that effect, take a look at
5297 * elm_image_scale_set().
5299 * @see elm_image_no_scale_get()
5300 * @see elm_image_scale_set()
5301 * @see elm_object_scale_set()
5305 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5307 * Get whether scaling is disabled on the object.
5309 * @param obj The image object
5310 * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5312 * @see elm_image_no_scale_set()
5316 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5318 * Set if the object is (up/down) resizable.
5320 * @param obj The image object
5321 * @param scale_up A bool to set if the object is resizable up. Default is
5323 * @param scale_down A bool to set if the object is resizable down. Default
5326 * This function limits the image resize ability. If @p scale_up is set to
5327 * @c EINA_FALSE, the object can't have its height or width resized to a value
5328 * higher than the original image size. Same is valid for @p scale_down.
5330 * @see elm_image_scale_get()
5334 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5336 * Get if the object is (up/down) resizable.
5338 * @param obj The image object
5339 * @param scale_up A bool to set if the object is resizable up
5340 * @param scale_down A bool to set if the object is resizable down
5342 * @see elm_image_scale_set()
5346 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5348 * Set if the image fills the entire object area, when keeping the aspect ratio.
5350 * @param obj The image object
5351 * @param fill_outside @c EINA_TRUE if the object is filled outside,
5352 * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5354 * When the image should keep its aspect ratio even if resized to another
5355 * aspect ratio, there are two possibilities to resize it: keep the entire
5356 * image inside the limits of height and width of the object (@p fill_outside
5357 * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5358 * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5360 * @note This option will have no effect if
5361 * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5363 * @see elm_image_fill_outside_get()
5364 * @see elm_image_aspect_ratio_retained_set()
5368 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5370 * Get if the object is filled outside
5372 * @param obj The image object
5373 * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5375 * @see elm_image_fill_outside_set()
5379 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5381 * Set the prescale size for the image
5383 * @param obj The image object
5384 * @param size The prescale size. This value is used for both width and
5387 * This function sets a new size for pixmap representation of the given
5388 * image. It allows the image to be loaded already in the specified size,
5389 * reducing the memory usage and load time when loading a big image with load
5390 * size set to a smaller size.
5392 * It's equivalent to the elm_bg_load_size_set() function for bg.
5394 * @note this is just a hint, the real size of the pixmap may differ
5395 * depending on the type of image being loaded, being bigger than requested.
5397 * @see elm_image_prescale_get()
5398 * @see elm_bg_load_size_set()
5402 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5404 * Get the prescale size for the image
5406 * @param obj The image object
5407 * @return The prescale size
5409 * @see elm_image_prescale_set()
5413 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5415 * Set the image orientation.
5417 * @param obj The image object
5418 * @param orient The image orientation @ref Elm_Image_Orient
5419 * Default is #ELM_IMAGE_ORIENT_NONE.
5421 * This function allows to rotate or flip the given image.
5423 * @see elm_image_orient_get()
5424 * @see @ref Elm_Image_Orient
5428 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5430 * Get the image orientation.
5432 * @param obj The image object
5433 * @return The image orientation @ref Elm_Image_Orient
5435 * @see elm_image_orient_set()
5436 * @see @ref Elm_Image_Orient
5440 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5442 * Make the image 'editable'.
5444 * @param obj Image object.
5445 * @param set Turn on or off editability. Default is @c EINA_FALSE.
5447 * This means the image is a valid drag target for drag and drop, and can be
5448 * cut or pasted too.
5452 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5454 * Check if the image 'editable'.
5456 * @param obj Image object.
5457 * @return Editability.
5459 * A return value of EINA_TRUE means the image is a valid drag target
5460 * for drag and drop, and can be cut or pasted too.
5464 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5466 * Get the basic Evas_Image object from this object (widget).
5468 * @param obj The image object to get the inlined image from
5469 * @return The inlined image object, or NULL if none exists
5471 * This function allows one to get the underlying @c Evas_Object of type
5472 * Image from this elementary widget. It can be useful to do things like get
5473 * the pixel data, save the image to a file, etc.
5475 * @note Be careful to not manipulate it, as it is under control of
5480 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5482 * Set whether the original aspect ratio of the image should be kept on resize.
5484 * @param obj The image object.
5485 * @param retained @c EINA_TRUE if the image should retain the aspect,
5486 * @c EINA_FALSE otherwise.
5488 * The original aspect ratio (width / height) of the image is usually
5489 * distorted to match the object's size. Enabling this option will retain
5490 * this original aspect, and the way that the image is fit into the object's
5491 * area depends on the option set by elm_image_fill_outside_set().
5493 * @see elm_image_aspect_ratio_retained_get()
5494 * @see elm_image_fill_outside_set()
5498 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5500 * Get if the object retains the original aspect ratio.
5502 * @param obj The image object.
5503 * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5508 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5515 typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5517 typedef enum _Elm_GLView_Mode
5519 ELM_GLVIEW_ALPHA = 1,
5520 ELM_GLVIEW_DEPTH = 2,
5521 ELM_GLVIEW_STENCIL = 4
5525 * Defines a policy for the glview resizing.
5527 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5529 typedef enum _Elm_GLView_Resize_Policy
5531 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
5532 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
5533 } Elm_GLView_Resize_Policy;
5535 typedef enum _Elm_GLView_Render_Policy
5537 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
5538 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
5539 } Elm_GLView_Render_Policy;
5544 * A simple GLView widget that allows GL rendering.
5546 * Signals that you can add callbacks for are:
5552 * Add a new glview to the parent
5554 * @param parent The parent object
5555 * @return The new object or NULL if it cannot be created
5559 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5562 * Sets the size of the glview
5564 * @param obj The glview object
5565 * @param width width of the glview object
5566 * @param height height of the glview object
5570 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5573 * Gets the size of the glview.
5575 * @param obj The glview object
5576 * @param width width of the glview object
5577 * @param height height of the glview object
5579 * Note that this function returns the actual image size of the
5580 * glview. This means that when the scale policy is set to
5581 * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5586 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5589 * Gets the gl api struct for gl rendering
5591 * @param obj The glview object
5592 * @return The api object or NULL if it cannot be created
5596 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5599 * Set the mode of the GLView. Supports Three simple modes.
5601 * @param obj The glview object
5602 * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5603 * @return True if set properly.
5607 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5610 * Set the resize policy for the glview object.
5612 * @param obj The glview object.
5613 * @param policy The scaling policy.
5615 * By default, the resize policy is set to
5616 * ELM_GLVIEW_RESIZE_POLICY_RECREATE. When resize is called it
5617 * destroys the previous surface and recreates the newly specified
5618 * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5619 * however, glview only scales the image object and not the underlying
5624 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5627 * Set the render policy for the glview object.
5629 * @param obj The glview object.
5630 * @param policy The render policy.
5632 * By default, the render policy is set to
5633 * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND. This policy is set such
5634 * that during the render loop, glview is only redrawn if it needs
5635 * to be redrawn. (i.e. When it is visible) If the policy is set to
5636 * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5637 * whether it is visible/need redrawing or not.
5641 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5644 * Set the init function that runs once in the main loop.
5646 * @param obj The glview object.
5647 * @param func The init function to be registered.
5649 * The registered init function gets called once during the render loop.
5653 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5656 * Set the render function that runs in the main loop.
5658 * @param obj The glview object.
5659 * @param func The delete function to be registered.
5661 * The registered del function gets called when GLView object is deleted.
5665 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5668 * Set the resize function that gets called when resize happens.
5670 * @param obj The glview object.
5671 * @param func The resize function to be registered.
5675 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5678 * Set the render function that runs in the main loop.
5680 * @param obj The glview object.
5681 * @param func The render function to be registered.
5685 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5688 * Notifies that there has been changes in the GLView.
5690 * @param obj The glview object.
5694 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5704 * @image html img/widget/box/preview-00.png
5705 * @image latex img/widget/box/preview-00.eps width=\textwidth
5707 * @image html img/box.png
5708 * @image latex img/box.eps width=\textwidth
5710 * A box arranges objects in a linear fashion, governed by a layout function
5711 * that defines the details of this arrangement.
5713 * By default, the box will use an internal function to set the layout to
5714 * a single row, either vertical or horizontal. This layout is affected
5715 * by a number of parameters, such as the homogeneous flag set by
5716 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5717 * elm_box_align_set() and the hints set to each object in the box.
5719 * For this default layout, it's possible to change the orientation with
5720 * elm_box_horizontal_set(). The box will start in the vertical orientation,
5721 * placing its elements ordered from top to bottom. When horizontal is set,
5722 * the order will go from left to right. If the box is set to be
5723 * homogeneous, every object in it will be assigned the same space, that
5724 * of the largest object. Padding can be used to set some spacing between
5725 * the cell given to each object. The alignment of the box, set with
5726 * elm_box_align_set(), determines how the bounding box of all the elements
5727 * will be placed within the space given to the box widget itself.
5729 * The size hints of each object also affect how they are placed and sized
5730 * within the box. evas_object_size_hint_min_set() will give the minimum
5731 * size the object can have, and the box will use it as the basis for all
5732 * latter calculations. Elementary widgets set their own minimum size as
5733 * needed, so there's rarely any need to use it manually.
5735 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5736 * used to tell whether the object will be allocated the minimum size it
5737 * needs or if the space given to it should be expanded. It's important
5738 * to realize that expanding the size given to the object is not the same
5739 * thing as resizing the object. It could very well end being a small
5740 * widget floating in a much larger empty space. If not set, the weight
5741 * for objects will normally be 0.0 for both axis, meaning the widget will
5742 * not be expanded. To take as much space possible, set the weight to
5743 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5745 * Besides how much space each object is allocated, it's possible to control
5746 * how the widget will be placed within that space using
5747 * evas_object_size_hint_align_set(). By default, this value will be 0.5
5748 * for both axis, meaning the object will be centered, but any value from
5749 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5750 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5751 * is -1.0, means the object will be resized to fill the entire space it
5754 * In addition, customized functions to define the layout can be set, which
5755 * allow the application developer to organize the objects within the box
5756 * in any number of ways.
5758 * The special elm_box_layout_transition() function can be used
5759 * to switch from one layout to another, animating the motion of the
5760 * children of the box.
5762 * @note Objects should not be added to box objects using _add() calls.
5764 * Some examples on how to use boxes follow:
5765 * @li @ref box_example_01
5766 * @li @ref box_example_02
5771 * @typedef Elm_Box_Transition
5773 * Opaque handler containing the parameters to perform an animated
5774 * transition of the layout the box uses.
5776 * @see elm_box_transition_new()
5777 * @see elm_box_layout_set()
5778 * @see elm_box_layout_transition()
5780 typedef struct _Elm_Box_Transition Elm_Box_Transition;
5783 * Add a new box to the parent
5785 * By default, the box will be in vertical mode and non-homogeneous.
5787 * @param parent The parent object
5788 * @return The new object or NULL if it cannot be created
5790 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5792 * Set the horizontal orientation
5794 * By default, box object arranges their contents vertically from top to
5796 * By calling this function with @p horizontal as EINA_TRUE, the box will
5797 * become horizontal, arranging contents from left to right.
5799 * @note This flag is ignored if a custom layout function is set.
5801 * @param obj The box object
5802 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5803 * EINA_FALSE = vertical)
5805 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5807 * Get the horizontal orientation
5809 * @param obj The box object
5810 * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5812 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5814 * Set the box to arrange its children homogeneously
5816 * If enabled, homogeneous layout makes all items the same size, according
5817 * to the size of the largest of its children.
5819 * @note This flag is ignored if a custom layout function is set.
5821 * @param obj The box object
5822 * @param homogeneous The homogeneous flag
5824 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5826 * Get whether the box is using homogeneous mode or not
5828 * @param obj The box object
5829 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5831 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5832 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5833 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5835 * Add an object to the beginning of the pack list
5837 * Pack @p subobj into the box @p obj, placing it first in the list of
5838 * children objects. The actual position the object will get on screen
5839 * depends on the layout used. If no custom layout is set, it will be at
5840 * the top or left, depending if the box is vertical or horizontal,
5843 * @param obj The box object
5844 * @param subobj The object to add to the box
5846 * @see elm_box_pack_end()
5847 * @see elm_box_pack_before()
5848 * @see elm_box_pack_after()
5849 * @see elm_box_unpack()
5850 * @see elm_box_unpack_all()
5851 * @see elm_box_clear()
5853 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5855 * Add an object at the end of the pack list
5857 * Pack @p subobj into the box @p obj, placing it last in the list of
5858 * children objects. The actual position the object will get on screen
5859 * depends on the layout used. If no custom layout is set, it will be at
5860 * the bottom or right, depending if the box is vertical or horizontal,
5863 * @param obj The box object
5864 * @param subobj The object to add to the box
5866 * @see elm_box_pack_start()
5867 * @see elm_box_pack_before()
5868 * @see elm_box_pack_after()
5869 * @see elm_box_unpack()
5870 * @see elm_box_unpack_all()
5871 * @see elm_box_clear()
5873 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5875 * Adds an object to the box before the indicated object
5877 * This will add the @p subobj to the box indicated before the object
5878 * indicated with @p before. If @p before is not already in the box, results
5879 * are undefined. Before means either to the left of the indicated object or
5880 * above it depending on orientation.
5882 * @param obj The box object
5883 * @param subobj The object to add to the box
5884 * @param before The object before which to add it
5886 * @see elm_box_pack_start()
5887 * @see elm_box_pack_end()
5888 * @see elm_box_pack_after()
5889 * @see elm_box_unpack()
5890 * @see elm_box_unpack_all()
5891 * @see elm_box_clear()
5893 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5895 * Adds an object to the box after the indicated object
5897 * This will add the @p subobj to the box indicated after the object
5898 * indicated with @p after. If @p after is not already in the box, results
5899 * are undefined. After means either to the right of the indicated object or
5900 * below it depending on orientation.
5902 * @param obj The box object
5903 * @param subobj The object to add to the box
5904 * @param after The object after which to add it
5906 * @see elm_box_pack_start()
5907 * @see elm_box_pack_end()
5908 * @see elm_box_pack_before()
5909 * @see elm_box_unpack()
5910 * @see elm_box_unpack_all()
5911 * @see elm_box_clear()
5913 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5915 * Clear the box of all children
5917 * Remove all the elements contained by the box, deleting the respective
5920 * @param obj The box object
5922 * @see elm_box_unpack()
5923 * @see elm_box_unpack_all()
5925 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5929 * Remove the object given by @p subobj from the box @p obj without
5932 * @param obj The box object
5934 * @see elm_box_unpack_all()
5935 * @see elm_box_clear()
5937 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5939 * Remove all items from the box, without deleting them
5941 * Clear the box from all children, but don't delete the respective objects.
5942 * If no other references of the box children exist, the objects will never
5943 * be deleted, and thus the application will leak the memory. Make sure
5944 * when using this function that you hold a reference to all the objects
5945 * in the box @p obj.
5947 * @param obj The box object
5949 * @see elm_box_clear()
5950 * @see elm_box_unpack()
5952 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5954 * Retrieve a list of the objects packed into the box
5956 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5957 * The order of the list corresponds to the packing order the box uses.
5959 * You must free this list with eina_list_free() once you are done with it.
5961 * @param obj The box object
5963 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5965 * Set the space (padding) between the box's elements.
5967 * Extra space in pixels that will be added between a box child and its
5968 * neighbors after its containing cell has been calculated. This padding
5969 * is set for all elements in the box, besides any possible padding that
5970 * individual elements may have through their size hints.
5972 * @param obj The box object
5973 * @param horizontal The horizontal space between elements
5974 * @param vertical The vertical space between elements
5976 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5978 * Get the space (padding) between the box's elements.
5980 * @param obj The box object
5981 * @param horizontal The horizontal space between elements
5982 * @param vertical The vertical space between elements
5984 * @see elm_box_padding_set()
5986 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5988 * Set the alignment of the whole bouding box of contents.
5990 * Sets how the bounding box containing all the elements of the box, after
5991 * their sizes and position has been calculated, will be aligned within
5992 * the space given for the whole box widget.
5994 * @param obj The box object
5995 * @param horizontal The horizontal alignment of elements
5996 * @param vertical The vertical alignment of elements
5998 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6000 * Get the alignment of the whole bouding box of contents.
6002 * @param obj The box object
6003 * @param horizontal The horizontal alignment of elements
6004 * @param vertical The vertical alignment of elements
6006 * @see elm_box_align_set()
6008 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6011 * Force the box to recalculate its children packing.
6013 * If any children was added or removed, box will not calculate the
6014 * values immediately rather leaving it to the next main loop
6015 * iteration. While this is great as it would save lots of
6016 * recalculation, whenever you need to get the position of a just
6017 * added item you must force recalculate before doing so.
6019 * @param obj The box object.
6021 EAPI void elm_box_recalculate(Evas_Object *obj);
6024 * Set the layout defining function to be used by the box
6026 * Whenever anything changes that requires the box in @p obj to recalculate
6027 * the size and position of its elements, the function @p cb will be called
6028 * to determine what the layout of the children will be.
6030 * Once a custom function is set, everything about the children layout
6031 * is defined by it. The flags set by elm_box_horizontal_set() and
6032 * elm_box_homogeneous_set() no longer have any meaning, and the values
6033 * given by elm_box_padding_set() and elm_box_align_set() are up to this
6034 * layout function to decide if they are used and how. These last two
6035 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6036 * passed to @p cb. The @c Evas_Object the function receives is not the
6037 * Elementary widget, but the internal Evas Box it uses, so none of the
6038 * functions described here can be used on it.
6040 * Any of the layout functions in @c Evas can be used here, as well as the
6041 * special elm_box_layout_transition().
6043 * The final @p data argument received by @p cb is the same @p data passed
6044 * here, and the @p free_data function will be called to free it
6045 * whenever the box is destroyed or another layout function is set.
6047 * Setting @p cb to NULL will revert back to the default layout function.
6049 * @param obj The box object
6050 * @param cb The callback function used for layout
6051 * @param data Data that will be passed to layout function
6052 * @param free_data Function called to free @p data
6054 * @see elm_box_layout_transition()
6056 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);
6058 * Special layout function that animates the transition from one layout to another
6060 * Normally, when switching the layout function for a box, this will be
6061 * reflected immediately on screen on the next render, but it's also
6062 * possible to do this through an animated transition.
6064 * This is done by creating an ::Elm_Box_Transition and setting the box
6065 * layout to this function.
6069 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6070 * evas_object_box_layout_vertical, // start
6071 * NULL, // data for initial layout
6072 * NULL, // free function for initial data
6073 * evas_object_box_layout_horizontal, // end
6074 * NULL, // data for final layout
6075 * NULL, // free function for final data
6076 * anim_end, // will be called when animation ends
6077 * NULL); // data for anim_end function\
6078 * elm_box_layout_set(box, elm_box_layout_transition, t,
6079 * elm_box_transition_free);
6082 * @note This function can only be used with elm_box_layout_set(). Calling
6083 * it directly will not have the expected results.
6085 * @see elm_box_transition_new
6086 * @see elm_box_transition_free
6087 * @see elm_box_layout_set
6089 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6091 * Create a new ::Elm_Box_Transition to animate the switch of layouts
6093 * If you want to animate the change from one layout to another, you need
6094 * to set the layout function of the box to elm_box_layout_transition(),
6095 * passing as user data to it an instance of ::Elm_Box_Transition with the
6096 * necessary information to perform this animation. The free function to
6097 * set for the layout is elm_box_transition_free().
6099 * The parameters to create an ::Elm_Box_Transition sum up to how long
6100 * will it be, in seconds, a layout function to describe the initial point,
6101 * another for the final position of the children and one function to be
6102 * called when the whole animation ends. This last function is useful to
6103 * set the definitive layout for the box, usually the same as the end
6104 * layout for the animation, but could be used to start another transition.
6106 * @param start_layout The layout function that will be used to start the animation
6107 * @param start_layout_data The data to be passed the @p start_layout function
6108 * @param start_layout_free_data Function to free @p start_layout_data
6109 * @param end_layout The layout function that will be used to end the animation
6110 * @param end_layout_free_data The data to be passed the @p end_layout function
6111 * @param end_layout_free_data Function to free @p end_layout_data
6112 * @param transition_end_cb Callback function called when animation ends
6113 * @param transition_end_data Data to be passed to @p transition_end_cb
6114 * @return An instance of ::Elm_Box_Transition
6116 * @see elm_box_transition_new
6117 * @see elm_box_layout_transition
6119 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);
6121 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6123 * This function is mostly useful as the @c free_data parameter in
6124 * elm_box_layout_set() when elm_box_layout_transition().
6126 * @param data The Elm_Box_Transition instance to be freed.
6128 * @see elm_box_transition_new
6129 * @see elm_box_layout_transition
6131 EAPI void elm_box_transition_free(void *data);
6138 * @defgroup Button Button
6140 * @image html img/widget/button/preview-00.png
6141 * @image latex img/widget/button/preview-00.eps
6142 * @image html img/widget/button/preview-01.png
6143 * @image latex img/widget/button/preview-01.eps
6144 * @image html img/widget/button/preview-02.png
6145 * @image latex img/widget/button/preview-02.eps
6147 * This is a push-button. Press it and run some function. It can contain
6148 * a simple label and icon object and it also has an autorepeat feature.
6150 * This widgets emits the following signals:
6151 * @li "clicked": the user clicked the button (press/release).
6152 * @li "repeated": the user pressed the button without releasing it.
6153 * @li "pressed": button was pressed.
6154 * @li "unpressed": button was released after being pressed.
6155 * In all three cases, the @c event parameter of the callback will be
6158 * Also, defined in the default theme, the button has the following styles
6160 * @li default: a normal button.
6161 * @li anchor: Like default, but the button fades away when the mouse is not
6162 * over it, leaving only the text or icon.
6163 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6164 * continuous look across its options.
6165 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6167 * Default contents parts of the button widget that you can use for are:
6168 * @li "elm.swallow.content" - A icon of the button
6170 * Default text parts of the button widget that you can use for are:
6171 * @li "elm.text" - Label of the button
6173 * Follow through a complete example @ref button_example_01 "here".
6177 * Add a new button to the parent's canvas
6179 * @param parent The parent object
6180 * @return The new object or NULL if it cannot be created
6182 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6184 * Set the label used in the button
6186 * The passed @p label can be NULL to clean any existing text in it and
6187 * leave the button as an icon only object.
6189 * @param obj The button object
6190 * @param label The text will be written on the button
6191 * @deprecated use elm_object_text_set() instead.
6193 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6195 * Get the label set for the button
6197 * The string returned is an internal pointer and should not be freed or
6198 * altered. It will also become invalid when the button is destroyed.
6199 * The string returned, if not NULL, is a stringshare, so if you need to
6200 * keep it around even after the button is destroyed, you can use
6201 * eina_stringshare_ref().
6203 * @param obj The button object
6204 * @return The text set to the label, or NULL if nothing is set
6205 * @deprecated use elm_object_text_set() instead.
6207 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6209 * Set the icon used for the button
6211 * Setting a new icon will delete any other that was previously set, making
6212 * any reference to them invalid. If you need to maintain the previous
6213 * object alive, unset it first with elm_button_icon_unset().
6215 * @param obj The button object
6216 * @param icon The icon object for the button
6217 * @deprecated use elm_object_content_set() instead.
6219 EINA_DEPRECATED EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6221 * Get the icon used for the button
6223 * Return the icon object which is set for this widget. If the button is
6224 * destroyed or another icon is set, the returned object will be deleted
6225 * and any reference to it will be invalid.
6227 * @param obj The button object
6228 * @return The icon object that is being used
6230 * @see elm_button_icon_unset()
6232 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6234 * Remove the icon set without deleting it and return the object
6236 * This function drops the reference the button holds of the icon object
6237 * and returns this last object. It is used in case you want to remove any
6238 * icon, or set another one, without deleting the actual object. The button
6239 * will be left without an icon set.
6241 * @param obj The button object
6242 * @return The icon object that was being used
6243 * @deprecated use elm_object_content_unset() instead.
6245 EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6247 * Turn on/off the autorepeat event generated when the button is kept pressed
6249 * When off, no autorepeat is performed and buttons emit a normal @c clicked
6250 * signal when they are clicked.
6252 * When on, keeping a button pressed will continuously emit a @c repeated
6253 * signal until the button is released. The time it takes until it starts
6254 * emitting the signal is given by
6255 * elm_button_autorepeat_initial_timeout_set(), and the time between each
6256 * new emission by elm_button_autorepeat_gap_timeout_set().
6258 * @param obj The button object
6259 * @param on A bool to turn on/off the event
6261 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6263 * Get whether the autorepeat feature is enabled
6265 * @param obj The button object
6266 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6268 * @see elm_button_autorepeat_set()
6270 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6272 * Set the initial timeout before the autorepeat event is generated
6274 * Sets the timeout, in seconds, since the button is pressed until the
6275 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6276 * won't be any delay and the even will be fired the moment the button is
6279 * @param obj The button object
6280 * @param t Timeout in seconds
6282 * @see elm_button_autorepeat_set()
6283 * @see elm_button_autorepeat_gap_timeout_set()
6285 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6287 * Get the initial timeout before the autorepeat event is generated
6289 * @param obj The button object
6290 * @return Timeout in seconds
6292 * @see elm_button_autorepeat_initial_timeout_set()
6294 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6296 * Set the interval between each generated autorepeat event
6298 * After the first @c repeated event is fired, all subsequent ones will
6299 * follow after a delay of @p t seconds for each.
6301 * @param obj The button object
6302 * @param t Interval in seconds
6304 * @see elm_button_autorepeat_initial_timeout_set()
6306 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6308 * Get the interval between each generated autorepeat event
6310 * @param obj The button object
6311 * @return Interval in seconds
6313 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6319 * @defgroup File_Selector_Button File Selector Button
6321 * @image html img/widget/fileselector_button/preview-00.png
6322 * @image latex img/widget/fileselector_button/preview-00.eps
6323 * @image html img/widget/fileselector_button/preview-01.png
6324 * @image latex img/widget/fileselector_button/preview-01.eps
6325 * @image html img/widget/fileselector_button/preview-02.png
6326 * @image latex img/widget/fileselector_button/preview-02.eps
6328 * This is a button that, when clicked, creates an Elementary
6329 * window (or inner window) <b> with a @ref Fileselector "file
6330 * selector widget" within</b>. When a file is chosen, the (inner)
6331 * window is closed and the button emits a signal having the
6332 * selected file as it's @c event_info.
6334 * This widget encapsulates operations on its internal file
6335 * selector on its own API. There is less control over its file
6336 * selector than that one would have instatiating one directly.
6338 * The following styles are available for this button:
6341 * @li @c "hoversel_vertical"
6342 * @li @c "hoversel_vertical_entry"
6344 * Smart callbacks one can register to:
6345 * - @c "file,chosen" - the user has selected a path, whose string
6346 * pointer comes as the @c event_info data (a stringshared
6349 * Here is an example on its usage:
6350 * @li @ref fileselector_button_example
6352 * @see @ref File_Selector_Entry for a similar widget.
6357 * Add a new file selector button widget to the given parent
6358 * Elementary (container) object
6360 * @param parent The parent object
6361 * @return a new file selector button widget handle or @c NULL, on
6364 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6367 * Set the label for a given file selector button widget
6369 * @param obj The file selector button widget
6370 * @param label The text label to be displayed on @p obj
6372 * @deprecated use elm_object_text_set() instead.
6374 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6377 * Get the label set for a given file selector button widget
6379 * @param obj The file selector button widget
6380 * @return The button label
6382 * @deprecated use elm_object_text_set() instead.
6384 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6387 * Set the icon on a given file selector button widget
6389 * @param obj The file selector button widget
6390 * @param icon The icon object for the button
6392 * Once the icon object is set, a previously set one will be
6393 * deleted. If you want to keep the latter, use the
6394 * elm_fileselector_button_icon_unset() function.
6396 * @see elm_fileselector_button_icon_get()
6398 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6401 * Get the icon set for a given file selector button widget
6403 * @param obj The file selector button widget
6404 * @return The icon object currently set on @p obj or @c NULL, if
6407 * @see elm_fileselector_button_icon_set()
6409 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6412 * Unset the icon used in a given file selector button widget
6414 * @param obj The file selector button widget
6415 * @return The icon object that was being used on @p obj or @c
6418 * Unparent and return the icon object which was set for this
6421 * @see elm_fileselector_button_icon_set()
6423 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6426 * Set the title for a given file selector button widget's window
6428 * @param obj The file selector button widget
6429 * @param title The title string
6431 * This will change the window's title, when the file selector pops
6432 * out after a click on the button. Those windows have the default
6433 * (unlocalized) value of @c "Select a file" as titles.
6435 * @note It will only take any effect if the file selector
6436 * button widget is @b not under "inwin mode".
6438 * @see elm_fileselector_button_window_title_get()
6440 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6443 * Get the title set for a given file selector button widget's
6446 * @param obj The file selector button widget
6447 * @return Title of the file selector button's window
6449 * @see elm_fileselector_button_window_title_get() for more details
6451 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6454 * Set the size of a given file selector button widget's window,
6455 * holding the file selector itself.
6457 * @param obj The file selector button widget
6458 * @param width The window's width
6459 * @param height The window's height
6461 * @note it will only take any effect if the file selector button
6462 * widget is @b not under "inwin mode". The default size for the
6463 * window (when applicable) is 400x400 pixels.
6465 * @see elm_fileselector_button_window_size_get()
6467 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6470 * Get the size of a given file selector button widget's window,
6471 * holding the file selector itself.
6473 * @param obj The file selector button widget
6474 * @param width Pointer into which to store the width value
6475 * @param height Pointer into which to store the height value
6477 * @note Use @c NULL pointers on the size values you're not
6478 * interested in: they'll be ignored by the function.
6480 * @see elm_fileselector_button_window_size_set(), for more details
6482 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6485 * Set the initial file system path for a given file selector
6488 * @param obj The file selector button widget
6489 * @param path The path string
6491 * It must be a <b>directory</b> path, which will have the contents
6492 * displayed initially in the file selector's view, when invoked
6493 * from @p obj. The default initial path is the @c "HOME"
6494 * environment variable's value.
6496 * @see elm_fileselector_button_path_get()
6498 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6501 * Get the initial file system path set for a given file selector
6504 * @param obj The file selector button widget
6505 * @return path The path string
6507 * @see elm_fileselector_button_path_set() for more details
6509 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6512 * Enable/disable a tree view in the given file selector button
6513 * widget's internal file selector
6515 * @param obj The file selector button widget
6516 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6519 * This has the same effect as elm_fileselector_expandable_set(),
6520 * but now applied to a file selector button's internal file
6523 * @note There's no way to put a file selector button's internal
6524 * file selector in "grid mode", as one may do with "pure" file
6527 * @see elm_fileselector_expandable_get()
6529 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6532 * Get whether tree view is enabled for the given file selector
6533 * button widget's internal file selector
6535 * @param obj The file selector button widget
6536 * @return @c EINA_TRUE if @p obj widget's internal file selector
6537 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6539 * @see elm_fileselector_expandable_set() for more details
6541 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6544 * Set whether a given file selector button widget's internal file
6545 * selector is to display folders only or the directory contents,
6548 * @param obj The file selector button widget
6549 * @param only @c EINA_TRUE to make @p obj widget's internal file
6550 * selector only display directories, @c EINA_FALSE to make files
6551 * to be displayed in it too
6553 * This has the same effect as elm_fileselector_folder_only_set(),
6554 * but now applied to a file selector button's internal file
6557 * @see elm_fileselector_folder_only_get()
6559 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6562 * Get whether a given file selector button widget's internal file
6563 * selector is displaying folders only or the directory contents,
6566 * @param obj The file selector button widget
6567 * @return @c EINA_TRUE if @p obj widget's internal file
6568 * selector is only displaying directories, @c EINA_FALSE if files
6569 * are being displayed in it too (and on errors)
6571 * @see elm_fileselector_button_folder_only_set() for more details
6573 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6576 * Enable/disable the file name entry box where the user can type
6577 * in a name for a file, in a given file selector button widget's
6578 * internal file selector.
6580 * @param obj The file selector button widget
6581 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6582 * file selector a "saving dialog", @c EINA_FALSE otherwise
6584 * This has the same effect as elm_fileselector_is_save_set(),
6585 * but now applied to a file selector button's internal file
6588 * @see elm_fileselector_is_save_get()
6590 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6593 * Get whether the given file selector button widget's internal
6594 * file selector is in "saving dialog" mode
6596 * @param obj The file selector button widget
6597 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6598 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6601 * @see elm_fileselector_button_is_save_set() for more details
6603 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6606 * Set whether a given file selector button widget's internal file
6607 * selector will raise an Elementary "inner window", instead of a
6608 * dedicated Elementary window. By default, it won't.
6610 * @param obj The file selector button widget
6611 * @param value @c EINA_TRUE to make it use an inner window, @c
6612 * EINA_TRUE to make it use a dedicated window
6614 * @see elm_win_inwin_add() for more information on inner windows
6615 * @see elm_fileselector_button_inwin_mode_get()
6617 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6620 * Get whether a given file selector button widget's internal file
6621 * selector will raise an Elementary "inner window", instead of a
6622 * dedicated Elementary window.
6624 * @param obj The file selector button widget
6625 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6626 * if it will use a dedicated window
6628 * @see elm_fileselector_button_inwin_mode_set() for more details
6630 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6637 * @defgroup File_Selector_Entry File Selector Entry
6639 * @image html img/widget/fileselector_entry/preview-00.png
6640 * @image latex img/widget/fileselector_entry/preview-00.eps
6642 * This is an entry made to be filled with or display a <b>file
6643 * system path string</b>. Besides the entry itself, the widget has
6644 * a @ref File_Selector_Button "file selector button" on its side,
6645 * which will raise an internal @ref Fileselector "file selector widget",
6646 * when clicked, for path selection aided by file system
6649 * This file selector may appear in an Elementary window or in an
6650 * inner window. When a file is chosen from it, the (inner) window
6651 * is closed and the selected file's path string is exposed both as
6652 * an smart event and as the new text on the entry.
6654 * This widget encapsulates operations on its internal file
6655 * selector on its own API. There is less control over its file
6656 * selector than that one would have instatiating one directly.
6658 * Smart callbacks one can register to:
6659 * - @c "changed" - The text within the entry was changed
6660 * - @c "activated" - The entry has had editing finished and
6661 * changes are to be "committed"
6662 * - @c "press" - The entry has been clicked
6663 * - @c "longpressed" - The entry has been clicked (and held) for a
6665 * - @c "clicked" - The entry has been clicked
6666 * - @c "clicked,double" - The entry has been double clicked
6667 * - @c "focused" - The entry has received focus
6668 * - @c "unfocused" - The entry has lost focus
6669 * - @c "selection,paste" - A paste action has occurred on the
6671 * - @c "selection,copy" - A copy action has occurred on the entry
6672 * - @c "selection,cut" - A cut action has occurred on the entry
6673 * - @c "unpressed" - The file selector entry's button was released
6674 * after being pressed.
6675 * - @c "file,chosen" - The user has selected a path via the file
6676 * selector entry's internal file selector, whose string pointer
6677 * comes as the @c event_info data (a stringshared string)
6679 * Here is an example on its usage:
6680 * @li @ref fileselector_entry_example
6682 * @see @ref File_Selector_Button for a similar widget.
6687 * Add a new file selector entry widget to the given parent
6688 * Elementary (container) object
6690 * @param parent The parent object
6691 * @return a new file selector entry widget handle or @c NULL, on
6694 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6697 * Set the label for a given file selector entry widget's button
6699 * @param obj The file selector entry widget
6700 * @param label The text label to be displayed on @p obj widget's
6703 * @deprecated use elm_object_text_set() instead.
6705 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6708 * Get the label set for a given file selector entry widget's button
6710 * @param obj The file selector entry widget
6711 * @return The widget button's label
6713 * @deprecated use elm_object_text_set() instead.
6715 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6718 * Set the icon on a given file selector entry widget's button
6720 * @param obj The file selector entry widget
6721 * @param icon The icon object for the entry's button
6723 * Once the icon object is set, a previously set one will be
6724 * deleted. If you want to keep the latter, use the
6725 * elm_fileselector_entry_button_icon_unset() function.
6727 * @see elm_fileselector_entry_button_icon_get()
6729 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6732 * Get the icon set for a given file selector entry widget's button
6734 * @param obj The file selector entry widget
6735 * @return The icon object currently set on @p obj widget's button
6736 * or @c NULL, if none is
6738 * @see elm_fileselector_entry_button_icon_set()
6740 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6743 * Unset the icon used in a given file selector entry widget's
6746 * @param obj The file selector entry widget
6747 * @return The icon object that was being used on @p obj widget's
6748 * button or @c NULL, on errors
6750 * Unparent and return the icon object which was set for this
6753 * @see elm_fileselector_entry_button_icon_set()
6755 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6758 * Set the title for a given file selector entry widget's window
6760 * @param obj The file selector entry widget
6761 * @param title The title string
6763 * This will change the window's title, when the file selector pops
6764 * out after a click on the entry's button. Those windows have the
6765 * default (unlocalized) value of @c "Select a file" as titles.
6767 * @note It will only take any effect if the file selector
6768 * entry widget is @b not under "inwin mode".
6770 * @see elm_fileselector_entry_window_title_get()
6772 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6775 * Get the title set for a given file selector entry widget's
6778 * @param obj The file selector entry widget
6779 * @return Title of the file selector entry's window
6781 * @see elm_fileselector_entry_window_title_get() for more details
6783 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6786 * Set the size of a given file selector entry widget's window,
6787 * holding the file selector itself.
6789 * @param obj The file selector entry widget
6790 * @param width The window's width
6791 * @param height The window's height
6793 * @note it will only take any effect if the file selector entry
6794 * widget is @b not under "inwin mode". The default size for the
6795 * window (when applicable) is 400x400 pixels.
6797 * @see elm_fileselector_entry_window_size_get()
6799 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6802 * Get the size of a given file selector entry widget's window,
6803 * holding the file selector itself.
6805 * @param obj The file selector entry widget
6806 * @param width Pointer into which to store the width value
6807 * @param height Pointer into which to store the height value
6809 * @note Use @c NULL pointers on the size values you're not
6810 * interested in: they'll be ignored by the function.
6812 * @see elm_fileselector_entry_window_size_set(), for more details
6814 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6817 * Set the initial file system path and the entry's path string for
6818 * a given file selector entry widget
6820 * @param obj The file selector entry widget
6821 * @param path The path string
6823 * It must be a <b>directory</b> path, which will have the contents
6824 * displayed initially in the file selector's view, when invoked
6825 * from @p obj. The default initial path is the @c "HOME"
6826 * environment variable's value.
6828 * @see elm_fileselector_entry_path_get()
6830 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6833 * Get the entry's path string for a given file selector entry
6836 * @param obj The file selector entry widget
6837 * @return path The path string
6839 * @see elm_fileselector_entry_path_set() for more details
6841 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6844 * Enable/disable a tree view in the given file selector entry
6845 * widget's internal file selector
6847 * @param obj The file selector entry widget
6848 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6851 * This has the same effect as elm_fileselector_expandable_set(),
6852 * but now applied to a file selector entry's internal file
6855 * @note There's no way to put a file selector entry's internal
6856 * file selector in "grid mode", as one may do with "pure" file
6859 * @see elm_fileselector_expandable_get()
6861 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6864 * Get whether tree view is enabled for the given file selector
6865 * entry widget's internal file selector
6867 * @param obj The file selector entry widget
6868 * @return @c EINA_TRUE if @p obj widget's internal file selector
6869 * is in tree view, @c EINA_FALSE otherwise (and or errors)
6871 * @see elm_fileselector_expandable_set() for more details
6873 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6876 * Set whether a given file selector entry widget's internal file
6877 * selector is to display folders only or the directory contents,
6880 * @param obj The file selector entry widget
6881 * @param only @c EINA_TRUE to make @p obj widget's internal file
6882 * selector only display directories, @c EINA_FALSE to make files
6883 * to be displayed in it too
6885 * This has the same effect as elm_fileselector_folder_only_set(),
6886 * but now applied to a file selector entry's internal file
6889 * @see elm_fileselector_folder_only_get()
6891 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6894 * Get whether a given file selector entry widget's internal file
6895 * selector is displaying folders only or the directory contents,
6898 * @param obj The file selector entry widget
6899 * @return @c EINA_TRUE if @p obj widget's internal file
6900 * selector is only displaying directories, @c EINA_FALSE if files
6901 * are being displayed in it too (and on errors)
6903 * @see elm_fileselector_entry_folder_only_set() for more details
6905 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6908 * Enable/disable the file name entry box where the user can type
6909 * in a name for a file, in a given file selector entry widget's
6910 * internal file selector.
6912 * @param obj The file selector entry widget
6913 * @param is_save @c EINA_TRUE to make @p obj widget's internal
6914 * file selector a "saving dialog", @c EINA_FALSE otherwise
6916 * This has the same effect as elm_fileselector_is_save_set(),
6917 * but now applied to a file selector entry's internal file
6920 * @see elm_fileselector_is_save_get()
6922 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6925 * Get whether the given file selector entry widget's internal
6926 * file selector is in "saving dialog" mode
6928 * @param obj The file selector entry widget
6929 * @return @c EINA_TRUE, if @p obj widget's internal file selector
6930 * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6933 * @see elm_fileselector_entry_is_save_set() for more details
6935 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6938 * Set whether a given file selector entry widget's internal file
6939 * selector will raise an Elementary "inner window", instead of a
6940 * dedicated Elementary window. By default, it won't.
6942 * @param obj The file selector entry widget
6943 * @param value @c EINA_TRUE to make it use an inner window, @c
6944 * EINA_TRUE to make it use a dedicated window
6946 * @see elm_win_inwin_add() for more information on inner windows
6947 * @see elm_fileselector_entry_inwin_mode_get()
6949 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6952 * Get whether a given file selector entry widget's internal file
6953 * selector will raise an Elementary "inner window", instead of a
6954 * dedicated Elementary window.
6956 * @param obj The file selector entry widget
6957 * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6958 * if it will use a dedicated window
6960 * @see elm_fileselector_entry_inwin_mode_set() for more details
6962 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6965 * Set the initial file system path for a given file selector entry
6968 * @param obj The file selector entry widget
6969 * @param path The path string
6971 * It must be a <b>directory</b> path, which will have the contents
6972 * displayed initially in the file selector's view, when invoked
6973 * from @p obj. The default initial path is the @c "HOME"
6974 * environment variable's value.
6976 * @see elm_fileselector_entry_path_get()
6978 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6981 * Get the parent directory's path to the latest file selection on
6982 * a given filer selector entry widget
6984 * @param obj The file selector object
6985 * @return The (full) path of the directory of the last selection
6986 * on @p obj widget, a @b stringshared string
6988 * @see elm_fileselector_entry_path_set()
6990 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6997 * @defgroup Scroller Scroller
6999 * A scroller holds a single object and "scrolls it around". This means that
7000 * it allows the user to use a scrollbar (or a finger) to drag the viewable
7001 * region around, allowing to move through a much larger object that is
7002 * contained in the scroller. The scroller will always have a small minimum
7003 * size by default as it won't be limited by the contents of the scroller.
7005 * Signals that you can add callbacks for are:
7006 * @li "edge,left" - the left edge of the content has been reached
7007 * @li "edge,right" - the right edge of the content has been reached
7008 * @li "edge,top" - the top edge of the content has been reached
7009 * @li "edge,bottom" - the bottom edge of the content has been reached
7010 * @li "scroll" - the content has been scrolled (moved)
7011 * @li "scroll,anim,start" - scrolling animation has started
7012 * @li "scroll,anim,stop" - scrolling animation has stopped
7013 * @li "scroll,drag,start" - dragging the contents around has started
7014 * @li "scroll,drag,stop" - dragging the contents around has stopped
7015 * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7018 * @note When Elemementary is in embedded mode the scrollbars will not be
7019 * dragable, they appear merely as indicators of how much has been scrolled.
7020 * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7021 * fingerscroll) won't work.
7023 * To set/get/unset the content of the panel, you can use
7024 * elm_object_content_set/get/unset APIs.
7025 * Once the content object is set, a previously set one will be deleted.
7026 * If you want to keep that old content object, use the
7027 * elm_object_content_unset() function
7029 * In @ref tutorial_scroller you'll find an example of how to use most of
7034 * @brief Type that controls when scrollbars should appear.
7036 * @see elm_scroller_policy_set()
7038 typedef enum _Elm_Scroller_Policy
7040 ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7041 ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7042 ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7043 ELM_SCROLLER_POLICY_LAST
7044 } Elm_Scroller_Policy;
7046 * @brief Add a new scroller to the parent
7048 * @param parent The parent object
7049 * @return The new object or NULL if it cannot be created
7051 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7053 * @brief Set the content of the scroller widget (the object to be scrolled around).
7055 * @param obj The scroller object
7056 * @param content The new content object
7058 * Once the content object is set, a previously set one will be deleted.
7059 * If you want to keep that old content object, use the
7060 * elm_scroller_content_unset() function.
7061 * @deprecated See elm_object_content_set()
7063 EINA_DEPRECATED EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7065 * @brief Get the content of the scroller widget
7067 * @param obj The slider object
7068 * @return The content that is being used
7070 * Return the content object which is set for this widget
7072 * @see elm_scroller_content_set()
7073 * @deprecated use elm_object_content_get() instead.
7075 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7077 * @brief Unset the content of the scroller widget
7079 * @param obj The slider object
7080 * @return The content that was being used
7082 * Unparent and return the content object which was set for this widget
7084 * @see elm_scroller_content_set()
7085 * @deprecated use elm_object_content_unset() instead.
7087 EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7089 * @brief Set custom theme elements for the scroller
7091 * @param obj The scroller object
7092 * @param widget The widget name to use (default is "scroller")
7093 * @param base The base name to use (default is "base")
7095 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7097 * @brief Make the scroller minimum size limited to the minimum size of the content
7099 * @param obj The scroller object
7100 * @param w Enable limiting minimum size horizontally
7101 * @param h Enable limiting minimum size vertically
7103 * By default the scroller will be as small as its design allows,
7104 * irrespective of its content. This will make the scroller minimum size the
7105 * right size horizontally and/or vertically to perfectly fit its content in
7108 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7110 * @brief Show a specific virtual region within the scroller content object
7112 * @param obj The scroller object
7113 * @param x X coordinate of the region
7114 * @param y Y coordinate of the region
7115 * @param w Width of the region
7116 * @param h Height of the region
7118 * This will ensure all (or part if it does not fit) of the designated
7119 * region in the virtual content object (0, 0 starting at the top-left of the
7120 * virtual content object) is shown within the scroller.
7122 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);
7124 * @brief Set the scrollbar visibility policy
7126 * @param obj The scroller object
7127 * @param policy_h Horizontal scrollbar policy
7128 * @param policy_v Vertical scrollbar policy
7130 * This sets the scrollbar visibility policy for the given scroller.
7131 * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7132 * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7133 * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7134 * respectively for the horizontal and vertical scrollbars.
7136 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7138 * @brief Gets scrollbar visibility policy
7140 * @param obj The scroller object
7141 * @param policy_h Horizontal scrollbar policy
7142 * @param policy_v Vertical scrollbar policy
7144 * @see elm_scroller_policy_set()
7146 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7148 * @brief Get the currently visible content region
7150 * @param obj The scroller object
7151 * @param x X coordinate of the region
7152 * @param y Y coordinate of the region
7153 * @param w Width of the region
7154 * @param h Height of the region
7156 * This gets the current region in the content object that is visible through
7157 * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7158 * w, @p h values pointed to.
7160 * @note All coordinates are relative to the content.
7162 * @see elm_scroller_region_show()
7164 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);
7166 * @brief Get the size of the content object
7168 * @param obj The scroller object
7169 * @param w Width of the content object.
7170 * @param h Height of the content object.
7172 * This gets the size of the content object of the scroller.
7174 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7176 * @brief Set bouncing behavior
7178 * @param obj The scroller object
7179 * @param h_bounce Allow bounce horizontally
7180 * @param v_bounce Allow bounce vertically
7182 * When scrolling, the scroller may "bounce" when reaching an edge of the
7183 * content object. This is a visual way to indicate the end has been reached.
7184 * This is enabled by default for both axis. This API will set if it is enabled
7185 * for the given axis with the boolean parameters for each axis.
7187 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7189 * @brief Get the bounce behaviour
7191 * @param obj The Scroller object
7192 * @param h_bounce Will the scroller bounce horizontally or not
7193 * @param v_bounce Will the scroller bounce vertically or not
7195 * @see elm_scroller_bounce_set()
7197 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7199 * @brief Set scroll page size relative to viewport size.
7201 * @param obj The scroller object
7202 * @param h_pagerel The horizontal page relative size
7203 * @param v_pagerel The vertical page relative size
7205 * The scroller is capable of limiting scrolling by the user to "pages". That
7206 * is to jump by and only show a "whole page" at a time as if the continuous
7207 * area of the scroller content is split into page sized pieces. This sets
7208 * the size of a page relative to the viewport of the scroller. 1.0 is "1
7209 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7210 * axis. This is mutually exclusive with page size
7211 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7212 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7213 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7216 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7218 * @brief Set scroll page size.
7220 * @param obj The scroller object
7221 * @param h_pagesize The horizontal page size
7222 * @param v_pagesize The vertical page size
7224 * This sets the page size to an absolute fixed value, with 0 turning it off
7227 * @see elm_scroller_page_relative_set()
7229 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7231 * @brief Get scroll current page number.
7233 * @param obj The scroller object
7234 * @param h_pagenumber The horizontal page number
7235 * @param v_pagenumber The vertical page number
7237 * The page number starts from 0. 0 is the first page.
7238 * Current page means the page which meets the top-left of the viewport.
7239 * If there are two or more pages in the viewport, it returns the number of the page
7240 * which meets the top-left of the viewport.
7242 * @see elm_scroller_last_page_get()
7243 * @see elm_scroller_page_show()
7244 * @see elm_scroller_page_brint_in()
7246 EAPI void elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7248 * @brief Get scroll last page number.
7250 * @param obj The scroller object
7251 * @param h_pagenumber The horizontal page number
7252 * @param v_pagenumber The vertical page number
7254 * The page number starts from 0. 0 is the first page.
7255 * This returns the last page number among the pages.
7257 * @see elm_scroller_current_page_get()
7258 * @see elm_scroller_page_show()
7259 * @see elm_scroller_page_brint_in()
7261 EAPI void elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7263 * Show a specific virtual region within the scroller content object by page number.
7265 * @param obj The scroller object
7266 * @param h_pagenumber The horizontal page number
7267 * @param v_pagenumber The vertical page number
7269 * 0, 0 of the indicated page is located at the top-left of the viewport.
7270 * This will jump to the page directly without animation.
7275 * sc = elm_scroller_add(win);
7276 * elm_scroller_content_set(sc, content);
7277 * elm_scroller_page_relative_set(sc, 1, 0);
7278 * elm_scroller_current_page_get(sc, &h_page, &v_page);
7279 * elm_scroller_page_show(sc, h_page + 1, v_page);
7282 * @see elm_scroller_page_bring_in()
7284 EAPI void elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7286 * Show a specific virtual region within the scroller content object by page number.
7288 * @param obj The scroller object
7289 * @param h_pagenumber The horizontal page number
7290 * @param v_pagenumber The vertical page number
7292 * 0, 0 of the indicated page is located at the top-left of the viewport.
7293 * This will slide to the page with animation.
7298 * sc = elm_scroller_add(win);
7299 * elm_scroller_content_set(sc, content);
7300 * elm_scroller_page_relative_set(sc, 1, 0);
7301 * elm_scroller_last_page_get(sc, &h_page, &v_page);
7302 * elm_scroller_page_bring_in(sc, h_page, v_page);
7305 * @see elm_scroller_page_show()
7307 EAPI void elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7309 * @brief Show a specific virtual region within the scroller content object.
7311 * @param obj The scroller object
7312 * @param x X coordinate of the region
7313 * @param y Y coordinate of the region
7314 * @param w Width of the region
7315 * @param h Height of the region
7317 * This will ensure all (or part if it does not fit) of the designated
7318 * region in the virtual content object (0, 0 starting at the top-left of the
7319 * virtual content object) is shown within the scroller. Unlike
7320 * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7321 * to this location (if configuration in general calls for transitions). It
7322 * may not jump immediately to the new location and make take a while and
7323 * show other content along the way.
7325 * @see elm_scroller_region_show()
7327 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);
7329 * @brief Set event propagation on a scroller
7331 * @param obj The scroller object
7332 * @param propagation If propagation is enabled or not
7334 * This enables or disabled event propagation from the scroller content to
7335 * the scroller and its parent. By default event propagation is disabled.
7337 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7339 * @brief Get event propagation for a scroller
7341 * @param obj The scroller object
7342 * @return The propagation state
7344 * This gets the event propagation for a scroller.
7346 * @see elm_scroller_propagate_events_set()
7348 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7350 * @brief Set scrolling gravity on a scroller
7352 * @param obj The scroller object
7353 * @param x The scrolling horizontal gravity
7354 * @param y The scrolling vertical gravity
7356 * The gravity, defines how the scroller will adjust its view
7357 * when the size of the scroller contents increase.
7359 * The scroller will adjust the view to glue itself as follows.
7361 * x=0.0, for showing the left most region of the content.
7362 * x=1.0, for showing the right most region of the content.
7363 * y=0.0, for showing the bottom most region of the content.
7364 * y=1.0, for showing the top most region of the content.
7366 * Default values for x and y are 0.0
7368 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7370 * @brief Get scrolling gravity values for a scroller
7372 * @param obj The scroller object
7373 * @param x The scrolling horizontal gravity
7374 * @param y The scrolling vertical gravity
7376 * This gets gravity values for a scroller.
7378 * @see elm_scroller_gravity_set()
7381 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7387 * @defgroup Label Label
7389 * @image html img/widget/label/preview-00.png
7390 * @image latex img/widget/label/preview-00.eps
7392 * @brief Widget to display text, with simple html-like markup.
7394 * The Label widget @b doesn't allow text to overflow its boundaries, if the
7395 * text doesn't fit the geometry of the label it will be ellipsized or be
7396 * cut. Elementary provides several themes for this widget:
7397 * @li default - No animation
7398 * @li marker - Centers the text in the label and make it bold by default
7399 * @li slide_long - The entire text appears from the right of the screen and
7400 * slides until it disappears in the left of the screen(reappering on the
7402 * @li slide_short - The text appears in the left of the label and slides to
7403 * the right to show the overflow. When all of the text has been shown the
7404 * position is reset.
7405 * @li slide_bounce - The text appears in the left of the label and slides to
7406 * the right to show the overflow. When all of the text has been shown the
7407 * animation reverses, moving the text to the left.
7409 * Custom themes can of course invent new markup tags and style them any way
7412 * The following signals may be emitted by the label widget:
7413 * @li "language,changed": The program's language changed.
7415 * See @ref tutorial_label for a demonstration of how to use a label widget.
7419 * @brief Add a new label to the parent
7421 * @param parent The parent object
7422 * @return The new object or NULL if it cannot be created
7424 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7426 * @brief Set the label on the label object
7428 * @param obj The label object
7429 * @param label The label will be used on the label object
7430 * @deprecated See elm_object_text_set()
7432 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 */
7434 * @brief Get the label used on the label object
7436 * @param obj The label object
7437 * @return The string inside the label
7438 * @deprecated See elm_object_text_get()
7440 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7442 * @brief Set the wrapping behavior of the label
7444 * @param obj The label object
7445 * @param wrap To wrap text or not
7447 * By default no wrapping is done. Possible values for @p wrap are:
7448 * @li ELM_WRAP_NONE - No wrapping
7449 * @li ELM_WRAP_CHAR - wrap between characters
7450 * @li ELM_WRAP_WORD - wrap between words
7451 * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7453 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7455 * @brief Get the wrapping behavior of the label
7457 * @param obj The label object
7460 * @see elm_label_line_wrap_set()
7462 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7464 * @brief Set wrap width of the label
7466 * @param obj The label object
7467 * @param w The wrap width in pixels at a minimum where words need to wrap
7469 * This function sets the maximum width size hint of the label.
7471 * @warning This is only relevant if the label is inside a container.
7473 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7475 * @brief Get wrap width of the label
7477 * @param obj The label object
7478 * @return The wrap width in pixels at a minimum where words need to wrap
7480 * @see elm_label_wrap_width_set()
7482 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7484 * @brief Set wrap height of the label
7486 * @param obj The label object
7487 * @param h The wrap height in pixels at a minimum where words need to wrap
7489 * This function sets the maximum height size hint of the label.
7491 * @warning This is only relevant if the label is inside a container.
7493 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7495 * @brief get wrap width of the label
7497 * @param obj The label object
7498 * @return The wrap height in pixels at a minimum where words need to wrap
7500 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7502 * @brief Set the font size on the label object.
7504 * @param obj The label object
7505 * @param size font size
7507 * @warning NEVER use this. It is for hyper-special cases only. use styles
7508 * instead. e.g. "big", "medium", "small" - or better name them by use:
7509 * "title", "footnote", "quote" etc.
7511 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7513 * @brief Set the text color on the label object
7515 * @param obj The label object
7516 * @param r Red property background color of The label object
7517 * @param g Green property background color of The label object
7518 * @param b Blue property background color of The label object
7519 * @param a Alpha property background color of The label object
7521 * @warning NEVER use this. It is for hyper-special cases only. use styles
7522 * instead. e.g. "big", "medium", "small" - or better name them by use:
7523 * "title", "footnote", "quote" etc.
7525 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);
7527 * @brief Set the text align on the label object
7529 * @param obj The label object
7530 * @param align align mode ("left", "center", "right")
7532 * @warning NEVER use this. It is for hyper-special cases only. use styles
7533 * instead. e.g. "big", "medium", "small" - or better name them by use:
7534 * "title", "footnote", "quote" etc.
7536 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7538 * @brief Set background color of the label
7540 * @param obj The label object
7541 * @param r Red property background color of The label object
7542 * @param g Green property background color of The label object
7543 * @param b Blue property background color of The label object
7544 * @param a Alpha property background alpha of The label object
7546 * @warning NEVER use this. It is for hyper-special cases only. use styles
7547 * instead. e.g. "big", "medium", "small" - or better name them by use:
7548 * "title", "footnote", "quote" etc.
7550 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);
7552 * @brief Set the ellipsis behavior of the label
7554 * @param obj The label object
7555 * @param ellipsis To ellipsis text or not
7557 * If set to true and the text doesn't fit in the label an ellipsis("...")
7558 * will be shown at the end of the widget.
7560 * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7561 * choosen wrap method was ELM_WRAP_WORD.
7563 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7565 * @brief Set the text slide of the label
7567 * @param obj The label object
7568 * @param slide To start slide or stop
7570 * If set to true, the text of the label will slide/scroll through the length of
7573 * @warning This only works with the themes "slide_short", "slide_long" and
7576 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7578 * @brief Get the text slide mode of the label
7580 * @param obj The label object
7581 * @return slide slide mode value
7583 * @see elm_label_slide_set()
7585 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7587 * @brief Set the slide duration(speed) of the label
7589 * @param obj The label object
7590 * @return The duration in seconds in moving text from slide begin position
7591 * to slide end position
7593 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7595 * @brief Get the slide duration(speed) of the label
7597 * @param obj The label object
7598 * @return The duration time in moving text from slide begin position to slide end position
7600 * @see elm_label_slide_duration_set()
7602 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7608 * @defgroup Toggle Toggle
7610 * @image html img/widget/toggle/preview-00.png
7611 * @image latex img/widget/toggle/preview-00.eps
7613 * @brief A toggle is a slider which can be used to toggle between
7614 * two values. It has two states: on and off.
7616 * This widget is deprecated. Please use elm_check_add() instead using the
7617 * toggle style like:
7620 * obj = elm_check_add(parent);
7621 * elm_object_style_set(obj, "toggle");
7622 * elm_object_text_part_set(obj, "on", "ON");
7623 * elm_object_text_part_set(obj, "off", "OFF");
7626 * Signals that you can add callbacks for are:
7627 * @li "changed" - Whenever the toggle value has been changed. Is not called
7628 * until the toggle is released by the cursor (assuming it
7629 * has been triggered by the cursor in the first place).
7631 * @ref tutorial_toggle show how to use a toggle.
7635 * @brief Add a toggle to @p parent.
7637 * @param parent The parent object
7639 * @return The toggle object
7641 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7643 * @brief Sets the label to be displayed with the toggle.
7645 * @param obj The toggle object
7646 * @param label The label to be displayed
7648 * @deprecated use elm_object_text_set() instead.
7650 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7652 * @brief Gets the label of the toggle
7654 * @param obj toggle object
7655 * @return The label of the toggle
7657 * @deprecated use elm_object_text_get() instead.
7659 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7661 * @brief Set the icon used for the toggle
7663 * @param obj The toggle object
7664 * @param icon The icon object for the button
7666 * Once the icon object is set, a previously set one will be deleted
7667 * If you want to keep that old content object, use the
7668 * elm_toggle_icon_unset() function.
7670 * @deprecated use elm_object_content_set() instead.
7672 EINA_DEPRECATED EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7674 * @brief Get the icon used for the toggle
7676 * @param obj The toggle object
7677 * @return The icon object that is being used
7679 * Return the icon object which is set for this widget.
7681 * @see elm_toggle_icon_set()
7683 * @deprecated use elm_object_content_get() instead.
7685 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7687 * @brief Unset the icon used for the toggle
7689 * @param obj The toggle object
7690 * @return The icon object that was being used
7692 * Unparent and return the icon object which was set for this widget.
7694 * @see elm_toggle_icon_set()
7696 * @deprecated use elm_object_content_unset() instead.
7698 EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7700 * @brief Sets the labels to be associated with the on and off states of the toggle.
7702 * @param obj The toggle object
7703 * @param onlabel The label displayed when the toggle is in the "on" state
7704 * @param offlabel The label displayed when the toggle is in the "off" state
7706 * @deprecated use elm_object_text_part_set() for "on" and "off" parts
7709 EINA_DEPRECATED EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7711 * @brief Gets the labels associated with the on and off states of the
7714 * @param obj The toggle object
7715 * @param onlabel A char** to place the onlabel of @p obj into
7716 * @param offlabel A char** to place the offlabel of @p obj into
7718 * @deprecated use elm_object_text_part_get() for "on" and "off" parts
7721 EINA_DEPRECATED EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7723 * @brief Sets the state of the toggle to @p state.
7725 * @param obj The toggle object
7726 * @param state The state of @p obj
7728 * @deprecated use elm_check_state_set() instead.
7730 EINA_DEPRECATED EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7732 * @brief Gets the state of the toggle to @p state.
7734 * @param obj The toggle object
7735 * @return The state of @p obj
7737 * @deprecated use elm_check_state_get() instead.
7739 EINA_DEPRECATED EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7741 * @brief Sets the state pointer of the toggle to @p statep.
7743 * @param obj The toggle object
7744 * @param statep The state pointer of @p obj
7746 * @deprecated use elm_check_state_pointer_set() instead.
7748 EINA_DEPRECATED EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7754 * @defgroup Frame Frame
7756 * @image html img/widget/frame/preview-00.png
7757 * @image latex img/widget/frame/preview-00.eps
7759 * @brief Frame is a widget that holds some content and has a title.
7761 * The default look is a frame with a title, but Frame supports multple
7769 * @li outdent_bottom
7771 * Of all this styles only default shows the title. Frame emits no signals.
7773 * Default contents parts of the frame widget that you can use for are:
7774 * @li "elm.swallow.content" - A content of the frame
7776 * Default text parts of the frame widget that you can use for are:
7777 * @li "elm.text" - Label of the frame
7779 * For a detailed example see the @ref tutorial_frame.
7784 * @brief Add a new frame to the parent
7786 * @param parent The parent object
7787 * @return The new object or NULL if it cannot be created
7789 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7791 * @brief Set the frame label
7793 * @param obj The frame object
7794 * @param label The label of this frame object
7796 * @deprecated use elm_object_text_set() instead.
7798 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7800 * @brief Get the frame label
7802 * @param obj The frame object
7804 * @return The label of this frame objet or NULL if unable to get frame
7806 * @deprecated use elm_object_text_get() instead.
7808 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7810 * @brief Set the content of the frame widget
7812 * Once the content object is set, a previously set one will be deleted.
7813 * If you want to keep that old content object, use the
7814 * elm_frame_content_unset() function.
7816 * @param obj The frame object
7817 * @param content The content will be filled in this frame object
7819 EINA_DEPRECATED EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7821 * @brief Get the content of the frame widget
7823 * Return the content object which is set for this widget
7825 * @param obj The frame object
7826 * @return The content that is being used
7828 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7830 * @brief Unset the content of the frame widget
7832 * Unparent and return the content object which was set for this widget
7834 * @param obj The frame object
7835 * @return The content that was being used
7837 EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7843 * @defgroup Table Table
7845 * A container widget to arrange other widgets in a table where items can
7846 * also span multiple columns or rows - even overlap (and then be raised or
7847 * lowered accordingly to adjust stacking if they do overlap).
7849 * For a Table widget the row/column count is not fixed.
7850 * The table widget adjusts itself when subobjects are added to it dynamically.
7852 * The followin are examples of how to use a table:
7853 * @li @ref tutorial_table_01
7854 * @li @ref tutorial_table_02
7859 * @brief Add a new table to the parent
7861 * @param parent The parent object
7862 * @return The new object or NULL if it cannot be created
7864 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7866 * @brief Set the homogeneous layout in the table
7868 * @param obj The layout object
7869 * @param homogeneous A boolean to set if the layout is homogeneous in the
7870 * table (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7872 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7874 * @brief Get the current table homogeneous mode.
7876 * @param obj The table object
7877 * @return A boolean to indicating if the layout is homogeneous in the table
7878 * (EINA_TRUE = homogeneous, EINA_FALSE = no homogeneous)
7880 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7882 * @warning <b>Use elm_table_homogeneous_set() instead</b>
7884 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7886 * @warning <b>Use elm_table_homogeneous_get() instead</b>
7888 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7890 * @brief Set padding between cells.
7892 * @param obj The layout object.
7893 * @param horizontal set the horizontal padding.
7894 * @param vertical set the vertical padding.
7896 * Default value is 0.
7898 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7900 * @brief Get padding between cells.
7902 * @param obj The layout object.
7903 * @param horizontal set the horizontal padding.
7904 * @param vertical set the vertical padding.
7906 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7908 * @brief Add a subobject on the table with the coordinates passed
7910 * @param obj The table object
7911 * @param subobj The subobject to be added to the table
7912 * @param x Row number
7913 * @param y Column number
7917 * @note All positioning inside the table is relative to rows and columns, so
7918 * a value of 0 for x and y, means the top left cell of the table, and a
7919 * value of 1 for w and h means @p subobj only takes that 1 cell.
7921 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7923 * @brief Remove child from table.
7925 * @param obj The table object
7926 * @param subobj The subobject
7928 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7930 * @brief Faster way to remove all child objects from a table object.
7932 * @param obj The table object
7933 * @param clear If true, will delete children, else just remove from table.
7935 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7937 * @brief Set the packing location of an existing child of the table
7939 * @param subobj The subobject to be modified in the table
7940 * @param x Row number
7941 * @param y Column number
7945 * Modifies the position of an object already in the table.
7947 * @note All positioning inside the table is relative to rows and columns, so
7948 * a value of 0 for x and y, means the top left cell of the table, and a
7949 * value of 1 for w and h means @p subobj only takes that 1 cell.
7951 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7953 * @brief Get the packing location of an existing child of the table
7955 * @param subobj The subobject to be modified in the table
7956 * @param x Row number
7957 * @param y Column number
7961 * @see elm_table_pack_set()
7963 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7968 /* TEMPORARY: DOCS WILL BE FILLED IN WITH CNP/SED */
7969 typedef struct Elm_Gen_Item Elm_Gen_Item;
7970 typedef struct _Elm_Gen_Item_Class Elm_Gen_Item_Class;
7971 typedef struct _Elm_Gen_Item_Class_Func Elm_Gen_Item_Class_Func; /**< Class functions for gen item classes. */
7972 typedef char *(*Elm_Gen_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gen item classes. */
7973 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. */
7974 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. */
7975 typedef void (*Elm_Gen_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gen item classes. */
7976 struct _Elm_Gen_Item_Class
7978 const char *item_style;
7979 struct _Elm_Gen_Item_Class_Func
7981 Elm_Gen_Item_Label_Get_Cb label_get;
7982 Elm_Gen_Item_Content_Get_Cb content_get;
7983 Elm_Gen_Item_State_Get_Cb state_get;
7984 Elm_Gen_Item_Del_Cb del;
7987 EAPI void elm_gen_clear(Evas_Object *obj);
7988 EAPI void elm_gen_item_selected_set(Elm_Gen_Item *it, Eina_Bool selected);
7989 EAPI Eina_Bool elm_gen_item_selected_get(const Elm_Gen_Item *it);
7990 EAPI void elm_gen_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
7991 EAPI Eina_Bool elm_gen_always_select_mode_get(const Evas_Object *obj);
7992 EAPI void elm_gen_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
7993 EAPI Eina_Bool elm_gen_no_select_mode_get(const Evas_Object *obj);
7994 EAPI void elm_gen_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
7995 EAPI void elm_gen_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
7996 EAPI void elm_gen_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
7997 EAPI void elm_gen_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
7998 EAPI void elm_gen_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
7999 EAPI void elm_gen_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8000 EAPI void elm_gen_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8001 EAPI void elm_gen_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8002 EAPI void elm_gen_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8003 EAPI Elm_Gen_Item *elm_gen_first_item_get(const Evas_Object *obj);
8004 EAPI Elm_Gen_Item *elm_gen_last_item_get(const Evas_Object *obj);
8005 EAPI Elm_Gen_Item *elm_gen_item_next_get(const Elm_Gen_Item *it);
8006 EAPI Elm_Gen_Item *elm_gen_item_prev_get(const Elm_Gen_Item *it);
8007 EAPI Evas_Object *elm_gen_item_widget_get(const Elm_Gen_Item *it);
8010 * @defgroup Gengrid Gengrid (Generic grid)
8012 * This widget aims to position objects in a grid layout while
8013 * actually creating and rendering only the visible ones, using the
8014 * same idea as the @ref Genlist "genlist": the user defines a @b
8015 * class for each item, specifying functions that will be called at
8016 * object creation, deletion, etc. When those items are selected by
8017 * the user, a callback function is issued. Users may interact with
8018 * a gengrid via the mouse (by clicking on items to select them and
8019 * clicking on the grid's viewport and swiping to pan the whole
8020 * view) or via the keyboard, navigating through item with the
8023 * @section Gengrid_Layouts Gengrid layouts
8025 * Gengrid may layout its items in one of two possible layouts:
8029 * When in "horizontal mode", items will be placed in @b columns,
8030 * from top to bottom and, when the space for a column is filled,
8031 * another one is started on the right, thus expanding the grid
8032 * horizontally, making for horizontal scrolling. When in "vertical
8033 * mode" , though, items will be placed in @b rows, from left to
8034 * right and, when the space for a row is filled, another one is
8035 * started below, thus expanding the grid vertically (and making
8036 * for vertical scrolling).
8038 * @section Gengrid_Items Gengrid items
8040 * An item in a gengrid can have 0 or more text labels (they can be
8041 * regular text or textblock Evas objects - that's up to the style
8042 * to determine), 0 or more icons (which are simply objects
8043 * swallowed into the gengrid item's theming Edje object) and 0 or
8044 * more <b>boolean states</b>, which have the behavior left to the
8045 * user to define. The Edje part names for each of these properties
8046 * will be looked up, in the theme file for the gengrid, under the
8047 * Edje (string) data items named @c "labels", @c "icons" and @c
8048 * "states", respectively. For each of those properties, if more
8049 * than one part is provided, they must have names listed separated
8050 * by spaces in the data fields. For the default gengrid item
8051 * theme, we have @b one label part (@c "elm.text"), @b two icon
8052 * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8055 * A gengrid item may be at one of several styles. Elementary
8056 * provides one by default - "default", but this can be extended by
8057 * system or application custom themes/overlays/extensions (see
8058 * @ref Theme "themes" for more details).
8060 * @section Gengrid_Item_Class Gengrid item classes
8062 * In order to have the ability to add and delete items on the fly,
8063 * gengrid implements a class (callback) system where the
8064 * application provides a structure with information about that
8065 * type of item (gengrid may contain multiple different items with
8066 * different classes, states and styles). Gengrid will call the
8067 * functions in this struct (methods) when an item is "realized"
8068 * (i.e., created dynamically, while the user is scrolling the
8069 * grid). All objects will simply be deleted when no longer needed
8070 * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8071 * contains the following members:
8072 * - @c item_style - This is a constant string and simply defines
8073 * the name of the item style. It @b must be specified and the
8074 * default should be @c "default".
8075 * - @c func.label_get - This function is called when an item
8076 * object is actually created. The @c data parameter will point to
8077 * the same data passed to elm_gengrid_item_append() and related
8078 * item creation functions. The @c obj parameter is the gengrid
8079 * object itself, while the @c part one is the name string of one
8080 * of the existing text parts in the Edje group implementing the
8081 * item's theme. This function @b must return a strdup'()ed string,
8082 * as the caller will free() it when done. See
8083 * #Elm_Gengrid_Item_Label_Get_Cb.
8084 * - @c func.content_get - This function is called when an item object
8085 * is actually created. The @c data parameter will point to the
8086 * same data passed to elm_gengrid_item_append() and related item
8087 * creation functions. The @c obj parameter is the gengrid object
8088 * itself, while the @c part one is the name string of one of the
8089 * existing (content) swallow parts in the Edje group implementing the
8090 * item's theme. It must return @c NULL, when no content is desired,
8091 * or a valid object handle, otherwise. The object will be deleted
8092 * by the gengrid on its deletion or when the item is "unrealized".
8093 * See #Elm_Gengrid_Item_Content_Get_Cb.
8094 * - @c func.state_get - This function is called when an item
8095 * object is actually created. The @c data parameter will point to
8096 * the same data passed to elm_gengrid_item_append() and related
8097 * item creation functions. The @c obj parameter is the gengrid
8098 * object itself, while the @c part one is the name string of one
8099 * of the state parts in the Edje group implementing the item's
8100 * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8101 * true/on. Gengrids will emit a signal to its theming Edje object
8102 * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8103 * "source" arguments, respectively, when the state is true (the
8104 * default is false), where @c XXX is the name of the (state) part.
8105 * See #Elm_Gengrid_Item_State_Get_Cb.
8106 * - @c func.del - This is called when elm_gengrid_item_del() is
8107 * called on an item or elm_gengrid_clear() is called on the
8108 * gengrid. This is intended for use when gengrid items are
8109 * deleted, so any data attached to the item (e.g. its data
8110 * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8112 * @section Gengrid_Usage_Hints Usage hints
8114 * If the user wants to have multiple items selected at the same
8115 * time, elm_gengrid_multi_select_set() will permit it. If the
8116 * gengrid is single-selection only (the default), then
8117 * elm_gengrid_select_item_get() will return the selected item or
8118 * @c NULL, if none is selected. If the gengrid is under
8119 * multi-selection, then elm_gengrid_selected_items_get() will
8120 * return a list (that is only valid as long as no items are
8121 * modified (added, deleted, selected or unselected) of child items
8124 * If an item changes (internal (boolean) state, label or content
8125 * changes), then use elm_gengrid_item_update() to have gengrid
8126 * update the item with the new state. A gengrid will re-"realize"
8127 * the item, thus calling the functions in the
8128 * #Elm_Gengrid_Item_Class set for that item.
8130 * To programmatically (un)select an item, use
8131 * elm_gengrid_item_selected_set(). To get its selected state use
8132 * elm_gengrid_item_selected_get(). To make an item disabled
8133 * (unable to be selected and appear differently) use
8134 * elm_gengrid_item_disabled_set() to set this and
8135 * elm_gengrid_item_disabled_get() to get the disabled state.
8137 * Grid cells will only have their selection smart callbacks called
8138 * when firstly getting selected. Any further clicks will do
8139 * nothing, unless you enable the "always select mode", with
8140 * elm_gengrid_always_select_mode_set(), thus making every click to
8141 * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8142 * turn off the ability to select items entirely in the widget and
8143 * they will neither appear selected nor call the selection smart
8146 * Remember that you can create new styles and add your own theme
8147 * augmentation per application with elm_theme_extension_add(). If
8148 * you absolutely must have a specific style that overrides any
8149 * theme the user or system sets up you can use
8150 * elm_theme_overlay_add() to add such a file.
8152 * @section Gengrid_Smart_Events Gengrid smart events
8154 * Smart events that you can add callbacks for are:
8155 * - @c "activated" - The user has double-clicked or pressed
8156 * (enter|return|spacebar) on an item. The @c event_info parameter
8157 * is the gengrid item that was activated.
8158 * - @c "clicked,double" - The user has double-clicked an item.
8159 * The @c event_info parameter is the gengrid item that was double-clicked.
8160 * - @c "longpressed" - This is called when the item is pressed for a certain
8161 * amount of time. By default it's 1 second.
8162 * - @c "selected" - The user has made an item selected. The
8163 * @c event_info parameter is the gengrid item that was selected.
8164 * - @c "unselected" - The user has made an item unselected. The
8165 * @c event_info parameter is the gengrid item that was unselected.
8166 * - @c "realized" - This is called when the item in the gengrid
8167 * has its implementing Evas object instantiated, de facto. @c
8168 * event_info is the gengrid item that was created. The object
8169 * may be deleted at any time, so it is highly advised to the
8170 * caller @b not to use the object pointer returned from
8171 * elm_gengrid_item_object_get(), because it may point to freed
8173 * - @c "unrealized" - This is called when the implementing Evas
8174 * object for this item is deleted. @c event_info is the gengrid
8175 * item that was deleted.
8176 * - @c "changed" - Called when an item is added, removed, resized
8177 * or moved and when the gengrid is resized or gets "horizontal"
8179 * - @c "scroll,anim,start" - This is called when scrolling animation has
8181 * - @c "scroll,anim,stop" - This is called when scrolling animation has
8183 * - @c "drag,start,up" - Called when the item in the gengrid has
8184 * been dragged (not scrolled) up.
8185 * - @c "drag,start,down" - Called when the item in the gengrid has
8186 * been dragged (not scrolled) down.
8187 * - @c "drag,start,left" - Called when the item in the gengrid has
8188 * been dragged (not scrolled) left.
8189 * - @c "drag,start,right" - Called when the item in the gengrid has
8190 * been dragged (not scrolled) right.
8191 * - @c "drag,stop" - Called when the item in the gengrid has
8192 * stopped being dragged.
8193 * - @c "drag" - Called when the item in the gengrid is being
8195 * - @c "scroll" - called when the content has been scrolled
8197 * - @c "scroll,drag,start" - called when dragging the content has
8199 * - @c "scroll,drag,stop" - called when dragging the content has
8201 * - @c "edge,top" - This is called when the gengrid is scrolled until
8203 * - @c "edge,bottom" - This is called when the gengrid is scrolled
8204 * until the bottom edge.
8205 * - @c "edge,left" - This is called when the gengrid is scrolled
8206 * until the left edge.
8207 * - @c "edge,right" - This is called when the gengrid is scrolled
8208 * until the right edge.
8210 * List of gengrid examples:
8211 * @li @ref gengrid_example
8215 * @addtogroup Gengrid
8219 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8220 #define Elm_Gengrid_Item_Class Elm_Gen_Item_Class
8221 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8222 #define Elm_Gengrid_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
8223 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8224 typedef char *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
8225 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. */
8226 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. */
8227 typedef void (*Elm_Gengrid_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
8230 * @struct _Elm_Gengrid_Item_Class
8232 * Gengrid item class definition. See @ref Gengrid_Item_Class for
8235 struct _Elm_Gengrid_Item_Class
8237 const char *item_style;
8238 struct _Elm_Gengrid_Item_Class_Func
8240 Elm_Gengrid_Item_Label_Get_Cb label_get;
8241 Elm_Gengrid_Item_Content_Get_Cb content_get;
8242 Elm_Gengrid_Item_State_Get_Cb state_get;
8243 Elm_Gengrid_Item_Del_Cb del;
8245 }; /**< #Elm_Gengrid_Item_Class member definitions */
8246 #define Elm_Gengrid_Item_Class_Func Elm_Gen_Item_Class_Func
8248 * Add a new gengrid widget to the given parent Elementary
8249 * (container) object
8251 * @param parent The parent object
8252 * @return a new gengrid widget handle or @c NULL, on errors
8254 * This function inserts a new gengrid widget on the canvas.
8256 * @see elm_gengrid_item_size_set()
8257 * @see elm_gengrid_group_item_size_set()
8258 * @see elm_gengrid_horizontal_set()
8259 * @see elm_gengrid_item_append()
8260 * @see elm_gengrid_item_del()
8261 * @see elm_gengrid_clear()
8265 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8268 * Set the size for the items of a given gengrid widget
8270 * @param obj The gengrid object.
8271 * @param w The items' width.
8272 * @param h The items' height;
8274 * A gengrid, after creation, has still no information on the size
8275 * to give to each of its cells. So, you most probably will end up
8276 * with squares one @ref Fingers "finger" wide, the default
8277 * size. Use this function to force a custom size for you items,
8278 * making them as big as you wish.
8280 * @see elm_gengrid_item_size_get()
8284 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8287 * Get the size set for the items of a given gengrid widget
8289 * @param obj The gengrid object.
8290 * @param w Pointer to a variable where to store the items' width.
8291 * @param h Pointer to a variable where to store the items' height.
8293 * @note Use @c NULL pointers on the size values you're not
8294 * interested in: they'll be ignored by the function.
8296 * @see elm_gengrid_item_size_get() for more details
8300 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8303 * Set the size for the group items of a given gengrid widget
8305 * @param obj The gengrid object.
8306 * @param w The group items' width.
8307 * @param h The group items' height;
8309 * A gengrid, after creation, has still no information on the size
8310 * to give to each of its cells. So, you most probably will end up
8311 * with squares one @ref Fingers "finger" wide, the default
8312 * size. Use this function to force a custom size for you group items,
8313 * making them as big as you wish.
8315 * @see elm_gengrid_group_item_size_get()
8319 EAPI void elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8322 * Get the size set for the group items of a given gengrid widget
8324 * @param obj The gengrid object.
8325 * @param w Pointer to a variable where to store the group items' width.
8326 * @param h Pointer to a variable where to store the group items' height.
8328 * @note Use @c NULL pointers on the size values you're not
8329 * interested in: they'll be ignored by the function.
8331 * @see elm_gengrid_group_item_size_get() for more details
8335 EAPI void elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8338 * Set the items grid's alignment within a given gengrid widget
8340 * @param obj The gengrid object.
8341 * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8342 * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8344 * This sets the alignment of the whole grid of items of a gengrid
8345 * within its given viewport. By default, those values are both
8346 * 0.5, meaning that the gengrid will have its items grid placed
8347 * exactly in the middle of its viewport.
8349 * @note If given alignment values are out of the cited ranges,
8350 * they'll be changed to the nearest boundary values on the valid
8353 * @see elm_gengrid_align_get()
8357 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8360 * Get the items grid's alignment values within a given gengrid
8363 * @param obj The gengrid object.
8364 * @param align_x Pointer to a variable where to store the
8365 * horizontal alignment.
8366 * @param align_y Pointer to a variable where to store the vertical
8369 * @note Use @c NULL pointers on the alignment values you're not
8370 * interested in: they'll be ignored by the function.
8372 * @see elm_gengrid_align_set() for more details
8376 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8379 * Set whether a given gengrid widget is or not able have items
8382 * @param obj The gengrid object
8383 * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8384 * @c EINA_FALSE to turn it off
8386 * If a gengrid is set to allow reordering, a click held for more
8387 * than 0.5 over a given item will highlight it specially,
8388 * signalling the gengrid has entered the reordering state. From
8389 * that time on, the user will be able to, while still holding the
8390 * mouse button down, move the item freely in the gengrid's
8391 * viewport, replacing to said item to the locations it goes to.
8392 * The replacements will be animated and, whenever the user
8393 * releases the mouse button, the item being replaced gets a new
8394 * definitive place in the grid.
8396 * @see elm_gengrid_reorder_mode_get()
8400 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8403 * Get whether a given gengrid widget is or not able have items
8406 * @param obj The gengrid object
8407 * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8410 * @see elm_gengrid_reorder_mode_set() for more details
8414 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8417 * Append a new item in a given gengrid widget.
8419 * @param obj The gengrid object.
8420 * @param gic The item class for the item.
8421 * @param data The item data.
8422 * @param func Convenience function called when the item is
8424 * @param func_data Data to be passed to @p func.
8425 * @return A handle to the item added or @c NULL, on errors.
8427 * This adds an item to the beginning of the gengrid.
8429 * @see elm_gengrid_item_prepend()
8430 * @see elm_gengrid_item_insert_before()
8431 * @see elm_gengrid_item_insert_after()
8432 * @see elm_gengrid_item_del()
8436 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);
8439 * Prepend a new item in a given gengrid widget.
8441 * @param obj The gengrid object.
8442 * @param gic The item class for the item.
8443 * @param data The item data.
8444 * @param func Convenience function called when the item is
8446 * @param func_data Data to be passed to @p func.
8447 * @return A handle to the item added or @c NULL, on errors.
8449 * This adds an item to the end of the gengrid.
8451 * @see elm_gengrid_item_append()
8452 * @see elm_gengrid_item_insert_before()
8453 * @see elm_gengrid_item_insert_after()
8454 * @see elm_gengrid_item_del()
8458 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);
8461 * Insert an item before another in a gengrid widget
8463 * @param obj The gengrid object.
8464 * @param gic The item class for the item.
8465 * @param data The item data.
8466 * @param relative The item to place this new one before.
8467 * @param func Convenience function called when the item is
8469 * @param func_data Data to be passed to @p func.
8470 * @return A handle to the item added or @c NULL, on errors.
8472 * This inserts an item before another in the gengrid.
8474 * @see elm_gengrid_item_append()
8475 * @see elm_gengrid_item_prepend()
8476 * @see elm_gengrid_item_insert_after()
8477 * @see elm_gengrid_item_del()
8481 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);
8484 * Insert an item after another in a gengrid widget
8486 * @param obj The gengrid object.
8487 * @param gic The item class for the item.
8488 * @param data The item data.
8489 * @param relative The item to place this new one after.
8490 * @param func Convenience function called when the item is
8492 * @param func_data Data to be passed to @p func.
8493 * @return A handle to the item added or @c NULL, on errors.
8495 * This inserts an item after another in the gengrid.
8497 * @see elm_gengrid_item_append()
8498 * @see elm_gengrid_item_prepend()
8499 * @see elm_gengrid_item_insert_after()
8500 * @see elm_gengrid_item_del()
8504 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);
8507 * Insert an item in a gengrid widget using a user-defined sort function.
8509 * @param obj The gengrid object.
8510 * @param gic The item class for the item.
8511 * @param data The item data.
8512 * @param comp User defined comparison function that defines the sort order based on
8513 * Elm_Gen_Item and its data param.
8514 * @param func Convenience function called when the item is selected.
8515 * @param func_data Data to be passed to @p func.
8516 * @return A handle to the item added or @c NULL, on errors.
8518 * This inserts an item in the gengrid based on user defined comparison function.
8520 * @see elm_gengrid_item_append()
8521 * @see elm_gengrid_item_prepend()
8522 * @see elm_gengrid_item_insert_after()
8523 * @see elm_gengrid_item_del()
8524 * @see elm_gengrid_item_direct_sorted_insert()
8528 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);
8531 * Insert an item in a gengrid widget using a user-defined sort function.
8533 * @param obj The gengrid object.
8534 * @param gic The item class for the item.
8535 * @param data The item data.
8536 * @param comp User defined comparison function that defines the sort order based on
8538 * @param func Convenience function called when the item is selected.
8539 * @param func_data Data to be passed to @p func.
8540 * @return A handle to the item added or @c NULL, on errors.
8542 * This inserts an item in the gengrid based on user defined comparison function.
8544 * @see elm_gengrid_item_append()
8545 * @see elm_gengrid_item_prepend()
8546 * @see elm_gengrid_item_insert_after()
8547 * @see elm_gengrid_item_del()
8548 * @see elm_gengrid_item_sorted_insert()
8552 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);
8555 * Set whether items on a given gengrid widget are to get their
8556 * selection callbacks issued for @b every subsequent selection
8557 * click on them or just for the first click.
8559 * @param obj The gengrid object
8560 * @param always_select @c EINA_TRUE to make items "always
8561 * selected", @c EINA_FALSE, otherwise
8563 * By default, grid items will only call their selection callback
8564 * function when firstly getting selected, any subsequent further
8565 * clicks will do nothing. With this call, you make those
8566 * subsequent clicks also to issue the selection callbacks.
8568 * @note <b>Double clicks</b> will @b always be reported on items.
8570 * @see elm_gengrid_always_select_mode_get()
8574 EINA_DEPRECATED EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8577 * Get whether items on a given gengrid widget have their selection
8578 * callbacks issued for @b every subsequent selection click on them
8579 * or just for the first click.
8581 * @param obj The gengrid object.
8582 * @return @c EINA_TRUE if the gengrid items are "always selected",
8583 * @c EINA_FALSE, otherwise
8585 * @see elm_gengrid_always_select_mode_set() for more details
8589 EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8592 * Set whether items on a given gengrid widget can be selected or not.
8594 * @param obj The gengrid object
8595 * @param no_select @c EINA_TRUE to make items selectable,
8596 * @c EINA_FALSE otherwise
8598 * This will make items in @p obj selectable or not. In the latter
8599 * case, any user interaction on the gengrid items will neither make
8600 * them appear selected nor them call their selection callback
8603 * @see elm_gengrid_no_select_mode_get()
8607 EINA_DEPRECATED EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8610 * Get whether items on a given gengrid widget can be selected or
8613 * @param obj The gengrid object
8614 * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8617 * @see elm_gengrid_no_select_mode_set() for more details
8621 EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8624 * Enable or disable multi-selection in a given gengrid widget
8626 * @param obj The gengrid object.
8627 * @param multi @c EINA_TRUE, to enable multi-selection,
8628 * @c EINA_FALSE to disable it.
8630 * Multi-selection is the ability to have @b more than one
8631 * item selected, on a given gengrid, simultaneously. When it is
8632 * enabled, a sequence of clicks on different items will make them
8633 * all selected, progressively. A click on an already selected item
8634 * will unselect it. If interacting via the keyboard,
8635 * multi-selection is enabled while holding the "Shift" key.
8637 * @note By default, multi-selection is @b disabled on gengrids
8639 * @see elm_gengrid_multi_select_get()
8643 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8646 * Get whether multi-selection is enabled or disabled for a given
8649 * @param obj The gengrid object.
8650 * @return @c EINA_TRUE, if multi-selection is enabled, @c
8651 * EINA_FALSE otherwise
8653 * @see elm_gengrid_multi_select_set() for more details
8657 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8660 * Enable or disable bouncing effect for a given gengrid widget
8662 * @param obj The gengrid object
8663 * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8664 * @c EINA_FALSE to disable it
8665 * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8666 * @c EINA_FALSE to disable it
8668 * The bouncing effect occurs whenever one reaches the gengrid's
8669 * edge's while panning it -- it will scroll past its limits a
8670 * little bit and return to the edge again, in a animated for,
8673 * @note By default, gengrids have bouncing enabled on both axis
8675 * @see elm_gengrid_bounce_get()
8679 EINA_DEPRECATED EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8682 * Get whether bouncing effects are enabled or disabled, for a
8683 * given gengrid widget, on each axis
8685 * @param obj The gengrid object
8686 * @param h_bounce Pointer to a variable where to store the
8687 * horizontal bouncing flag.
8688 * @param v_bounce Pointer to a variable where to store the
8689 * vertical bouncing flag.
8691 * @see elm_gengrid_bounce_set() for more details
8695 EINA_DEPRECATED EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8698 * Set a given gengrid widget's scrolling page size, relative to
8699 * its viewport size.
8701 * @param obj The gengrid object
8702 * @param h_pagerel The horizontal page (relative) size
8703 * @param v_pagerel The vertical page (relative) size
8705 * The gengrid's scroller is capable of binding scrolling by the
8706 * user to "pages". It means that, while scrolling and, specially
8707 * after releasing the mouse button, the grid will @b snap to the
8708 * nearest displaying page's area. When page sizes are set, the
8709 * grid's continuous content area is split into (equal) page sized
8712 * This function sets the size of a page <b>relatively to the
8713 * viewport dimensions</b> of the gengrid, for each axis. A value
8714 * @c 1.0 means "the exact viewport's size", in that axis, while @c
8715 * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8716 * a viewport". Sane usable values are, than, between @c 0.0 and @c
8717 * 1.0. Values beyond those will make it behave behave
8718 * inconsistently. If you only want one axis to snap to pages, use
8719 * the value @c 0.0 for the other one.
8721 * There is a function setting page size values in @b absolute
8722 * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8723 * is mutually exclusive to this one.
8725 * @see elm_gengrid_page_relative_get()
8729 EINA_DEPRECATED EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8732 * Get a given gengrid widget's scrolling page size, relative to
8733 * its viewport size.
8735 * @param obj The gengrid object
8736 * @param h_pagerel Pointer to a variable where to store the
8737 * horizontal page (relative) size
8738 * @param v_pagerel Pointer to a variable where to store the
8739 * vertical page (relative) size
8741 * @see elm_gengrid_page_relative_set() for more details
8745 EINA_DEPRECATED EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8748 * Set a given gengrid widget's scrolling page size
8750 * @param obj The gengrid object
8751 * @param h_pagerel The horizontal page size, in pixels
8752 * @param v_pagerel The vertical page size, in pixels
8754 * The gengrid's scroller is capable of binding scrolling by the
8755 * user to "pages". It means that, while scrolling and, specially
8756 * after releasing the mouse button, the grid will @b snap to the
8757 * nearest displaying page's area. When page sizes are set, the
8758 * grid's continuous content area is split into (equal) page sized
8761 * This function sets the size of a page of the gengrid, in pixels,
8762 * for each axis. Sane usable values are, between @c 0 and the
8763 * dimensions of @p obj, for each axis. Values beyond those will
8764 * make it behave behave inconsistently. If you only want one axis
8765 * to snap to pages, use the value @c 0 for the other one.
8767 * There is a function setting page size values in @b relative
8768 * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8769 * use is mutually exclusive to this one.
8773 EINA_DEPRECATED EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8776 * @brief Get gengrid current page number.
8778 * @param obj The gengrid object
8779 * @param h_pagenumber The horizontal page number
8780 * @param v_pagenumber The vertical page number
8782 * The page number starts from 0. 0 is the first page.
8783 * Current page means the page which meet the top-left of the viewport.
8784 * If there are two or more pages in the viewport, it returns the number of page
8785 * which meet the top-left of the viewport.
8787 * @see elm_gengrid_last_page_get()
8788 * @see elm_gengrid_page_show()
8789 * @see elm_gengrid_page_brint_in()
8791 EINA_DEPRECATED EAPI void elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8794 * @brief Get scroll last page number.
8796 * @param obj The gengrid object
8797 * @param h_pagenumber The horizontal page number
8798 * @param v_pagenumber The vertical page number
8800 * The page number starts from 0. 0 is the first page.
8801 * This returns the last page number among the pages.
8803 * @see elm_gengrid_current_page_get()
8804 * @see elm_gengrid_page_show()
8805 * @see elm_gengrid_page_brint_in()
8807 EINA_DEPRECATED EAPI void elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8810 * Show a specific virtual region within the gengrid content object by page number.
8812 * @param obj The gengrid object
8813 * @param h_pagenumber The horizontal page number
8814 * @param v_pagenumber The vertical page number
8816 * 0, 0 of the indicated page is located at the top-left of the viewport.
8817 * This will jump to the page directly without animation.
8822 * sc = elm_gengrid_add(win);
8823 * elm_gengrid_content_set(sc, content);
8824 * elm_gengrid_page_relative_set(sc, 1, 0);
8825 * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8826 * elm_gengrid_page_show(sc, h_page + 1, v_page);
8829 * @see elm_gengrid_page_bring_in()
8831 EINA_DEPRECATED EAPI void elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8834 * Show a specific virtual region within the gengrid content object by page number.
8836 * @param obj The gengrid object
8837 * @param h_pagenumber The horizontal page number
8838 * @param v_pagenumber The vertical page number
8840 * 0, 0 of the indicated page is located at the top-left of the viewport.
8841 * This will slide to the page with animation.
8846 * sc = elm_gengrid_add(win);
8847 * elm_gengrid_content_set(sc, content);
8848 * elm_gengrid_page_relative_set(sc, 1, 0);
8849 * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8850 * elm_gengrid_page_bring_in(sc, h_page, v_page);
8853 * @see elm_gengrid_page_show()
8855 EINA_DEPRECATED EAPI void elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8858 * Set the direction in which a given gengrid widget will expand while
8859 * placing its items.
8861 * @param obj The gengrid object.
8862 * @param setting @c EINA_TRUE to make the gengrid expand
8863 * horizontally, @c EINA_FALSE to expand vertically.
8865 * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8866 * in @b columns, from top to bottom and, when the space for a
8867 * column is filled, another one is started on the right, thus
8868 * expanding the grid horizontally. When in "vertical mode"
8869 * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8870 * to right and, when the space for a row is filled, another one is
8871 * started below, thus expanding the grid vertically.
8873 * @see elm_gengrid_horizontal_get()
8877 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8880 * Get for what direction a given gengrid widget will expand while
8881 * placing its items.
8883 * @param obj The gengrid object.
8884 * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8885 * @c EINA_FALSE if it's set to expand vertically.
8887 * @see elm_gengrid_horizontal_set() for more detais
8891 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8894 * Get the first item in a given gengrid widget
8896 * @param obj The gengrid object
8897 * @return The first item's handle or @c NULL, if there are no
8898 * items in @p obj (and on errors)
8900 * This returns the first item in the @p obj's internal list of
8903 * @see elm_gengrid_last_item_get()
8907 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8910 * Get the last item in a given gengrid widget
8912 * @param obj The gengrid object
8913 * @return The last item's handle or @c NULL, if there are no
8914 * items in @p obj (and on errors)
8916 * This returns the last item in the @p obj's internal list of
8919 * @see elm_gengrid_first_item_get()
8923 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8926 * Get the @b next item in a gengrid widget's internal list of items,
8927 * given a handle to one of those items.
8929 * @param item The gengrid item to fetch next from
8930 * @return The item after @p item, or @c NULL if there's none (and
8933 * This returns the item placed after the @p item, on the container
8936 * @see elm_gengrid_item_prev_get()
8940 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8943 * Get the @b previous item in a gengrid widget's internal list of items,
8944 * given a handle to one of those items.
8946 * @param item The gengrid item to fetch previous from
8947 * @return The item before @p item, or @c NULL if there's none (and
8950 * This returns the item placed before the @p item, on the container
8953 * @see elm_gengrid_item_next_get()
8957 EINA_DEPRECATED EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8960 * Get the gengrid object's handle which contains a given gengrid
8963 * @param item The item to fetch the container from
8964 * @return The gengrid (parent) object
8966 * This returns the gengrid object itself that an item belongs to.
8970 EINA_DEPRECATED EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8973 * Remove a gengrid item from its parent, deleting it.
8975 * @param item The item to be removed.
8976 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8978 * @see elm_gengrid_clear(), to remove all items in a gengrid at
8983 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8986 * Update the contents of a given gengrid item
8988 * @param item The gengrid item
8990 * This updates an item by calling all the item class functions
8991 * again to get the contents, labels and states. Use this when the
8992 * original item data has changed and you want the changes to be
8997 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9000 * Get the Gengrid Item class for the given Gengrid Item.
9002 * @param item The gengrid item
9004 * This returns the Gengrid_Item_Class for the given item. It can be used to examine
9005 * the function pointers and item_style.
9009 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9012 * Get the Gengrid Item class for the given Gengrid Item.
9014 * This sets the Gengrid_Item_Class for the given item. It can be used to examine
9015 * the function pointers and item_style.
9017 * @param item The gengrid item
9018 * @param gic The gengrid item class describing the function pointers and the item style.
9022 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
9025 * Return the data associated to a given gengrid item
9027 * @param item The gengrid item.
9028 * @return the data associated with this item.
9030 * This returns the @c data value passed on the
9031 * elm_gengrid_item_append() and related item addition calls.
9033 * @see elm_gengrid_item_append()
9034 * @see elm_gengrid_item_data_set()
9038 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9041 * Set the data associated with a given gengrid item
9043 * @param item The gengrid item
9044 * @param data The data pointer to set on it
9046 * This @b overrides the @c data value passed on the
9047 * elm_gengrid_item_append() and related item addition calls. This
9048 * function @b won't call elm_gengrid_item_update() automatically,
9049 * so you'd issue it afterwards if you want to have the item
9050 * updated to reflect the new data.
9052 * @see elm_gengrid_item_data_get()
9053 * @see elm_gengrid_item_update()
9057 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9060 * Get a given gengrid item's position, relative to the whole
9061 * gengrid's grid area.
9063 * @param item The Gengrid item.
9064 * @param x Pointer to variable to store the item's <b>row number</b>.
9065 * @param y Pointer to variable to store the item's <b>column number</b>.
9067 * This returns the "logical" position of the item within the
9068 * gengrid. For example, @c (0, 1) would stand for first row,
9073 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9076 * Set whether a given gengrid item is selected or not
9078 * @param item The gengrid item
9079 * @param selected Use @c EINA_TRUE, to make it selected, @c
9080 * EINA_FALSE to make it unselected
9082 * This sets the selected state of an item. If multi-selection is
9083 * not enabled on the containing gengrid and @p selected is @c
9084 * EINA_TRUE, any other previously selected items will get
9085 * unselected in favor of this new one.
9087 * @see elm_gengrid_item_selected_get()
9091 EINA_DEPRECATED EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9094 * Get whether a given gengrid item is selected or not
9096 * @param item The gengrid item
9097 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9099 * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9101 * @see elm_gengrid_item_selected_set() for more details
9105 EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9108 * Get the real Evas object created to implement the view of a
9109 * given gengrid item
9111 * @param item The gengrid item.
9112 * @return the Evas object implementing this item's view.
9114 * This returns the actual Evas object used to implement the
9115 * specified gengrid item's view. This may be @c NULL, as it may
9116 * not have been created or may have been deleted, at any time, by
9117 * the gengrid. <b>Do not modify this object</b> (move, resize,
9118 * show, hide, etc.), as the gengrid is controlling it. This
9119 * function is for querying, emitting custom signals or hooking
9120 * lower level callbacks for events on that object. Do not delete
9121 * this object under any circumstances.
9123 * @see elm_gengrid_item_data_get()
9127 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9130 * Show the portion of a gengrid's internal grid containing a given
9131 * item, @b immediately.
9133 * @param item The item to display
9135 * This causes gengrid to @b redraw its viewport's contents to the
9136 * region contining the given @p item item, if it is not fully
9139 * @see elm_gengrid_item_bring_in()
9143 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9146 * Animatedly bring in, to the visible area of a gengrid, a given
9149 * @param item The gengrid item to display
9151 * This causes gengrid to jump to the given @p item and show
9152 * it (by scrolling), if it is not fully visible. This will use
9153 * animation to do so and take a period of time to complete.
9155 * @see elm_gengrid_item_show()
9159 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9162 * Set whether a given gengrid item is disabled or not.
9164 * @param item The gengrid item
9165 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9166 * to enable it back.
9168 * A disabled item cannot be selected or unselected. It will also
9169 * change its appearance, to signal the user it's disabled.
9171 * @see elm_gengrid_item_disabled_get()
9175 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9178 * Get whether a given gengrid item is disabled or not.
9180 * @param item The gengrid item
9181 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9184 * @see elm_gengrid_item_disabled_set() for more details
9188 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9191 * Set the text to be shown in a given gengrid item's tooltips.
9193 * @param item The gengrid item
9194 * @param text The text to set in the content
9196 * This call will setup the text to be used as tooltip to that item
9197 * (analogous to elm_object_tooltip_text_set(), but being item
9198 * tooltips with higher precedence than object tooltips). It can
9199 * have only one tooltip at a time, so any previous tooltip data
9204 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9207 * Set the content to be shown in a given gengrid item's tooltip
9209 * @param item The gengrid item.
9210 * @param func The function returning the tooltip contents.
9211 * @param data What to provide to @a func as callback data/context.
9212 * @param del_cb Called when data is not needed anymore, either when
9213 * another callback replaces @p func, the tooltip is unset with
9214 * elm_gengrid_item_tooltip_unset() or the owner @p item
9215 * dies. This callback receives as its first parameter the
9216 * given @p data, being @c event_info the item handle.
9218 * This call will setup the tooltip's contents to @p item
9219 * (analogous to elm_object_tooltip_content_cb_set(), but being
9220 * item tooltips with higher precedence than object tooltips). It
9221 * can have only one tooltip at a time, so any previous tooltip
9222 * content will get removed. @p func (with @p data) will be called
9223 * every time Elementary needs to show the tooltip and it should
9224 * return a valid Evas object, which will be fully managed by the
9225 * tooltip system, getting deleted when the tooltip is gone.
9229 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);
9232 * Unset a tooltip from a given gengrid item
9234 * @param item gengrid item to remove a previously set tooltip from.
9236 * This call removes any tooltip set on @p item. The callback
9237 * provided as @c del_cb to
9238 * elm_gengrid_item_tooltip_content_cb_set() will be called to
9239 * notify it is not used anymore (and have resources cleaned, if
9242 * @see elm_gengrid_item_tooltip_content_cb_set()
9246 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9249 * Set a different @b style for a given gengrid item's tooltip.
9251 * @param item gengrid item with tooltip set
9252 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9253 * "default", @c "transparent", etc)
9255 * Tooltips can have <b>alternate styles</b> to be displayed on,
9256 * which are defined by the theme set on Elementary. This function
9257 * works analogously as elm_object_tooltip_style_set(), but here
9258 * applied only to gengrid item objects. The default style for
9259 * tooltips is @c "default".
9261 * @note before you set a style you should define a tooltip with
9262 * elm_gengrid_item_tooltip_content_cb_set() or
9263 * elm_gengrid_item_tooltip_text_set()
9265 * @see elm_gengrid_item_tooltip_style_get()
9269 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9272 * Get the style set a given gengrid item's tooltip.
9274 * @param item gengrid item with tooltip already set on.
9275 * @return style the theme style in use, which defaults to
9276 * "default". If the object does not have a tooltip set,
9277 * then @c NULL is returned.
9279 * @see elm_gengrid_item_tooltip_style_set() for more details
9283 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9285 * @brief Disable size restrictions on an object's tooltip
9286 * @param item The tooltip's anchor object
9287 * @param disable If EINA_TRUE, size restrictions are disabled
9288 * @return EINA_FALSE on failure, EINA_TRUE on success
9290 * This function allows a tooltip to expand beyond its parant window's canvas.
9291 * It will instead be limited only by the size of the display.
9293 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9295 * @brief Retrieve size restriction state of an object's tooltip
9296 * @param item The tooltip's anchor object
9297 * @return If EINA_TRUE, size restrictions are disabled
9299 * This function returns whether a tooltip is allowed to expand beyond
9300 * its parant window's canvas.
9301 * It will instead be limited only by the size of the display.
9303 EAPI Eina_Bool elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9305 * Set the type of mouse pointer/cursor decoration to be shown,
9306 * when the mouse pointer is over the given gengrid widget item
9308 * @param item gengrid item to customize cursor on
9309 * @param cursor the cursor type's name
9311 * This function works analogously as elm_object_cursor_set(), but
9312 * here the cursor's changing area is restricted to the item's
9313 * area, and not the whole widget's. Note that that item cursors
9314 * have precedence over widget cursors, so that a mouse over @p
9315 * item will always show cursor @p type.
9317 * If this function is called twice for an object, a previously set
9318 * cursor will be unset on the second call.
9320 * @see elm_object_cursor_set()
9321 * @see elm_gengrid_item_cursor_get()
9322 * @see elm_gengrid_item_cursor_unset()
9326 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9329 * Get the type of mouse pointer/cursor decoration set to be shown,
9330 * when the mouse pointer is over the given gengrid widget item
9332 * @param item gengrid item with custom cursor set
9333 * @return the cursor type's name or @c NULL, if no custom cursors
9334 * were set to @p item (and on errors)
9336 * @see elm_object_cursor_get()
9337 * @see elm_gengrid_item_cursor_set() for more details
9338 * @see elm_gengrid_item_cursor_unset()
9342 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9345 * Unset any custom mouse pointer/cursor decoration set to be
9346 * shown, when the mouse pointer is over the given gengrid widget
9347 * item, thus making it show the @b default cursor again.
9349 * @param item a gengrid item
9351 * Use this call to undo any custom settings on this item's cursor
9352 * decoration, bringing it back to defaults (no custom style set).
9354 * @see elm_object_cursor_unset()
9355 * @see elm_gengrid_item_cursor_set() for more details
9359 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9362 * Set a different @b style for a given custom cursor set for a
9365 * @param item gengrid item with custom cursor set
9366 * @param style the <b>theme style</b> to use (e.g. @c "default",
9367 * @c "transparent", etc)
9369 * This function only makes sense when one is using custom mouse
9370 * cursor decorations <b>defined in a theme file</b> , which can
9371 * have, given a cursor name/type, <b>alternate styles</b> on
9372 * it. It works analogously as elm_object_cursor_style_set(), but
9373 * here applied only to gengrid item objects.
9375 * @warning Before you set a cursor style you should have defined a
9376 * custom cursor previously on the item, with
9377 * elm_gengrid_item_cursor_set()
9379 * @see elm_gengrid_item_cursor_engine_only_set()
9380 * @see elm_gengrid_item_cursor_style_get()
9384 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9387 * Get the current @b style set for a given gengrid item's custom
9390 * @param item gengrid item with custom cursor set.
9391 * @return style the cursor style in use. If the object does not
9392 * have a cursor set, then @c NULL is returned.
9394 * @see elm_gengrid_item_cursor_style_set() for more details
9398 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9401 * Set if the (custom) cursor for a given gengrid item should be
9402 * searched in its theme, also, or should only rely on the
9405 * @param item item with custom (custom) cursor already set on
9406 * @param engine_only Use @c EINA_TRUE to have cursors looked for
9407 * only on those provided by the rendering engine, @c EINA_FALSE to
9408 * have them searched on the widget's theme, as well.
9410 * @note This call is of use only if you've set a custom cursor
9411 * for gengrid items, with elm_gengrid_item_cursor_set().
9413 * @note By default, cursors will only be looked for between those
9414 * provided by the rendering engine.
9418 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9421 * Get if the (custom) cursor for a given gengrid item is being
9422 * searched in its theme, also, or is only relying on the rendering
9425 * @param item a gengrid item
9426 * @return @c EINA_TRUE, if cursors are being looked for only on
9427 * those provided by the rendering engine, @c EINA_FALSE if they
9428 * are being searched on the widget's theme, as well.
9430 * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9434 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9437 * Remove all items from a given gengrid widget
9439 * @param obj The gengrid object.
9441 * This removes (and deletes) all items in @p obj, leaving it
9444 * @see elm_gengrid_item_del(), to remove just one item.
9448 EINA_DEPRECATED EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9451 * Get the selected item in a given gengrid widget
9453 * @param obj The gengrid object.
9454 * @return The selected item's handleor @c NULL, if none is
9455 * selected at the moment (and on errors)
9457 * This returns the selected item in @p obj. If multi selection is
9458 * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9459 * the first item in the list is selected, which might not be very
9460 * useful. For that case, see elm_gengrid_selected_items_get().
9464 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9467 * Get <b>a list</b> of selected items in a given gengrid
9469 * @param obj The gengrid object.
9470 * @return The list of selected items or @c NULL, if none is
9471 * selected at the moment (and on errors)
9473 * This returns a list of the selected items, in the order that
9474 * they appear in the grid. This list is only valid as long as no
9475 * more items are selected or unselected (or unselected implictly
9476 * by deletion). The list contains #Elm_Gengrid_Item pointers as
9479 * @see elm_gengrid_selected_item_get()
9483 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9490 * @defgroup Clock Clock
9492 * @image html img/widget/clock/preview-00.png
9493 * @image latex img/widget/clock/preview-00.eps
9495 * This is a @b digital clock widget. In its default theme, it has a
9496 * vintage "flipping numbers clock" appearance, which will animate
9497 * sheets of individual algarisms individually as time goes by.
9499 * A newly created clock will fetch system's time (already
9500 * considering local time adjustments) to start with, and will tick
9501 * accondingly. It may or may not show seconds.
9503 * Clocks have an @b edition mode. When in it, the sheets will
9504 * display extra arrow indications on the top and bottom and the
9505 * user may click on them to raise or lower the time values. After
9506 * it's told to exit edition mode, it will keep ticking with that
9507 * new time set (it keeps the difference from local time).
9509 * Also, when under edition mode, user clicks on the cited arrows
9510 * which are @b held for some time will make the clock to flip the
9511 * sheet, thus editing the time, continuosly and automatically for
9512 * the user. The interval between sheet flips will keep growing in
9513 * time, so that it helps the user to reach a time which is distant
9516 * The time display is, by default, in military mode (24h), but an
9517 * am/pm indicator may be optionally shown, too, when it will
9520 * Smart callbacks one can register to:
9521 * - "changed" - the clock's user changed the time
9523 * Here is an example on its usage:
9524 * @li @ref clock_example
9533 * Identifiers for which clock digits should be editable, when a
9534 * clock widget is in edition mode. Values may be ORed together to
9535 * make a mask, naturally.
9537 * @see elm_clock_edit_set()
9538 * @see elm_clock_digit_edit_set()
9540 typedef enum _Elm_Clock_Digedit
9542 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9543 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9544 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
9545 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9546 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
9547 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9548 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
9549 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
9550 } Elm_Clock_Digedit;
9553 * Add a new clock widget to the given parent Elementary
9554 * (container) object
9556 * @param parent The parent object
9557 * @return a new clock widget handle or @c NULL, on errors
9559 * This function inserts a new clock widget on the canvas.
9563 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9566 * Set a clock widget's time, programmatically
9568 * @param obj The clock widget object
9569 * @param hrs The hours to set
9570 * @param min The minutes to set
9571 * @param sec The secondes to set
9573 * This function updates the time that is showed by the clock
9576 * Values @b must be set within the following ranges:
9577 * - 0 - 23, for hours
9578 * - 0 - 59, for minutes
9579 * - 0 - 59, for seconds,
9581 * even if the clock is not in "military" mode.
9583 * @warning The behavior for values set out of those ranges is @b
9588 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9591 * Get a clock widget's time values
9593 * @param obj The clock object
9594 * @param[out] hrs Pointer to the variable to get the hours value
9595 * @param[out] min Pointer to the variable to get the minutes value
9596 * @param[out] sec Pointer to the variable to get the seconds value
9598 * This function gets the time set for @p obj, returning
9599 * it on the variables passed as the arguments to function
9601 * @note Use @c NULL pointers on the time values you're not
9602 * interested in: they'll be ignored by the function.
9606 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9609 * Set whether a given clock widget is under <b>edition mode</b> or
9610 * under (default) displaying-only mode.
9612 * @param obj The clock object
9613 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9614 * put it back to "displaying only" mode
9616 * This function makes a clock's time to be editable or not <b>by
9617 * user interaction</b>. When in edition mode, clocks @b stop
9618 * ticking, until one brings them back to canonical mode. The
9619 * elm_clock_digit_edit_set() function will influence which digits
9620 * of the clock will be editable. By default, all of them will be
9621 * (#ELM_CLOCK_NONE).
9623 * @note am/pm sheets, if being shown, will @b always be editable
9624 * under edition mode.
9626 * @see elm_clock_edit_get()
9630 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9633 * Retrieve whether a given clock widget is under <b>edition
9634 * mode</b> or under (default) displaying-only mode.
9636 * @param obj The clock object
9637 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9640 * This function retrieves whether the clock's time can be edited
9641 * or not by user interaction.
9643 * @see elm_clock_edit_set() for more details
9647 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9650 * Set what digits of the given clock widget should be editable
9651 * when in edition mode.
9653 * @param obj The clock object
9654 * @param digedit Bit mask indicating the digits to be editable
9655 * (values in #Elm_Clock_Digedit).
9657 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9658 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9661 * @see elm_clock_digit_edit_get()
9665 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9668 * Retrieve what digits of the given clock widget should be
9669 * editable when in edition mode.
9671 * @param obj The clock object
9672 * @return Bit mask indicating the digits to be editable
9673 * (values in #Elm_Clock_Digedit).
9675 * @see elm_clock_digit_edit_set() for more details
9679 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9682 * Set if the given clock widget must show hours in military or
9685 * @param obj The clock object
9686 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9689 * This function sets if the clock must show hours in military or
9690 * am/pm mode. In some countries like Brazil the military mode
9691 * (00-24h-format) is used, in opposition to the USA, where the
9692 * am/pm mode is more commonly used.
9694 * @see elm_clock_show_am_pm_get()
9698 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9701 * Get if the given clock widget shows hours in military or am/pm
9704 * @param obj The clock object
9705 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9708 * This function gets if the clock shows hours in military or am/pm
9711 * @see elm_clock_show_am_pm_set() for more details
9715 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9718 * Set if the given clock widget must show time with seconds or not
9720 * @param obj The clock object
9721 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9723 * This function sets if the given clock must show or not elapsed
9724 * seconds. By default, they are @b not shown.
9726 * @see elm_clock_show_seconds_get()
9730 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9733 * Get whether the given clock widget is showing time with seconds
9736 * @param obj The clock object
9737 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9739 * This function gets whether @p obj is showing or not the elapsed
9742 * @see elm_clock_show_seconds_set()
9746 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9749 * Set the interval on time updates for an user mouse button hold
9750 * on clock widgets' time edition.
9752 * @param obj The clock object
9753 * @param interval The (first) interval value in seconds
9755 * This interval value is @b decreased while the user holds the
9756 * mouse pointer either incrementing or decrementing a given the
9757 * clock digit's value.
9759 * This helps the user to get to a given time distant from the
9760 * current one easier/faster, as it will start to flip quicker and
9761 * quicker on mouse button holds.
9763 * The calculation for the next flip interval value, starting from
9764 * the one set with this call, is the previous interval divided by
9765 * 1.05, so it decreases a little bit.
9767 * The default starting interval value for automatic flips is
9770 * @see elm_clock_interval_get()
9774 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9777 * Get the interval on time updates for an user mouse button hold
9778 * on clock widgets' time edition.
9780 * @param obj The clock object
9781 * @return The (first) interval value, in seconds, set on it
9783 * @see elm_clock_interval_set() for more details
9787 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9794 * @defgroup Layout Layout
9796 * @image html img/widget/layout/preview-00.png
9797 * @image latex img/widget/layout/preview-00.eps width=\textwidth
9799 * @image html img/layout-predefined.png
9800 * @image latex img/layout-predefined.eps width=\textwidth
9802 * This is a container widget that takes a standard Edje design file and
9803 * wraps it very thinly in a widget.
9805 * An Edje design (theme) file has a very wide range of possibilities to
9806 * describe the behavior of elements added to the Layout. Check out the Edje
9807 * documentation and the EDC reference to get more information about what can
9808 * be done with Edje.
9810 * Just like @ref List, @ref Box, and other container widgets, any
9811 * object added to the Layout will become its child, meaning that it will be
9812 * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9814 * The Layout widget can contain as many Contents, Boxes or Tables as
9815 * described in its theme file. For instance, objects can be added to
9816 * different Tables by specifying the respective Table part names. The same
9817 * is valid for Content and Box.
9819 * The objects added as child of the Layout will behave as described in the
9820 * part description where they were added. There are 3 possible types of
9821 * parts where a child can be added:
9823 * @section secContent Content (SWALLOW part)
9825 * Only one object can be added to the @c SWALLOW part (but you still can
9826 * have many @c SWALLOW parts and one object on each of them). Use the @c
9827 * elm_object_content_set/get/unset functions to set, retrieve and unset
9828 * objects as content of the @c SWALLOW. After being set to this part, the
9829 * object size, position, visibility, clipping and other description
9830 * properties will be totally controled by the description of the given part
9831 * (inside the Edje theme file).
9833 * One can use @c evas_object_size_hint_* functions on the child to have some
9834 * kind of control over its behavior, but the resulting behavior will still
9835 * depend heavily on the @c SWALLOW part description.
9837 * The Edje theme also can change the part description, based on signals or
9838 * scripts running inside the theme. This change can also be animated. All of
9839 * this will affect the child object set as content accordingly. The object
9840 * size will be changed if the part size is changed, it will animate move if
9841 * the part is moving, and so on.
9843 * The following picture demonstrates a Layout widget with a child object
9844 * added to its @c SWALLOW:
9846 * @image html layout_swallow.png
9847 * @image latex layout_swallow.eps width=\textwidth
9849 * @section secBox Box (BOX part)
9851 * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9852 * allows one to add objects to the box and have them distributed along its
9853 * area, accordingly to the specified @a layout property (now by @a layout we
9854 * mean the chosen layouting design of the Box, not the Layout widget
9857 * A similar effect for having a box with its position, size and other things
9858 * controled by the Layout theme would be to create an Elementary @ref Box
9859 * widget and add it as a Content in the @c SWALLOW part.
9861 * The main difference of using the Layout Box is that its behavior, the box
9862 * properties like layouting format, padding, align, etc. will be all
9863 * controled by the theme. This means, for example, that a signal could be
9864 * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9865 * handled the signal by changing the box padding, or align, or both. Using
9866 * the Elementary @ref Box widget is not necessarily harder or easier, it
9867 * just depends on the circunstances and requirements.
9869 * The Layout Box can be used through the @c elm_layout_box_* set of
9872 * The following picture demonstrates a Layout widget with many child objects
9873 * added to its @c BOX part:
9875 * @image html layout_box.png
9876 * @image latex layout_box.eps width=\textwidth
9878 * @section secTable Table (TABLE part)
9880 * Just like the @ref secBox, the Layout Table is very similar to the
9881 * Elementary @ref Table widget. It allows one to add objects to the Table
9882 * specifying the row and column where the object should be added, and any
9883 * column or row span if necessary.
9885 * Again, we could have this design by adding a @ref Table widget to the @c
9886 * SWALLOW part using elm_object_content_part_set(). The same difference happens
9887 * here when choosing to use the Layout Table (a @c TABLE part) instead of
9888 * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9890 * The Layout Table can be used through the @c elm_layout_table_* set of
9893 * The following picture demonstrates a Layout widget with many child objects
9894 * added to its @c TABLE part:
9896 * @image html layout_table.png
9897 * @image latex layout_table.eps width=\textwidth
9899 * @section secPredef Predefined Layouts
9901 * Another interesting thing about the Layout widget is that it offers some
9902 * predefined themes that come with the default Elementary theme. These
9903 * themes can be set by the call elm_layout_theme_set(), and provide some
9904 * basic functionality depending on the theme used.
9906 * Most of them already send some signals, some already provide a toolbar or
9907 * back and next buttons.
9909 * These are available predefined theme layouts. All of them have class = @c
9910 * layout, group = @c application, and style = one of the following options:
9912 * @li @c toolbar-content - application with toolbar and main content area
9913 * @li @c toolbar-content-back - application with toolbar and main content
9914 * area with a back button and title area
9915 * @li @c toolbar-content-back-next - application with toolbar and main
9916 * content area with a back and next buttons and title area
9917 * @li @c content-back - application with a main content area with a back
9918 * button and title area
9919 * @li @c content-back-next - application with a main content area with a
9920 * back and next buttons and title area
9921 * @li @c toolbar-vbox - application with toolbar and main content area as a
9923 * @li @c toolbar-table - application with toolbar and main content area as a
9926 * @section secExamples Examples
9928 * Some examples of the Layout widget can be found here:
9929 * @li @ref layout_example_01
9930 * @li @ref layout_example_02
9931 * @li @ref layout_example_03
9932 * @li @ref layout_example_edc
9937 * Add a new layout to the parent
9939 * @param parent The parent object
9940 * @return The new object or NULL if it cannot be created
9942 * @see elm_layout_file_set()
9943 * @see elm_layout_theme_set()
9947 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9949 * Set the file that will be used as layout
9951 * @param obj The layout object
9952 * @param file The path to file (edj) that will be used as layout
9953 * @param group The group that the layout belongs in edje file
9955 * @return (1 = success, 0 = error)
9959 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9961 * Set the edje group from the elementary theme that will be used as layout
9963 * @param obj The layout object
9964 * @param clas the clas of the group
9965 * @param group the group
9966 * @param style the style to used
9968 * @return (1 = success, 0 = error)
9972 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9974 * Set the layout content.
9976 * @param obj The layout object
9977 * @param swallow The swallow part name in the edje file
9978 * @param content The child that will be added in this layout object
9980 * Once the content object is set, a previously set one will be deleted.
9981 * If you want to keep that old content object, use the
9982 * elm_object_content_part_unset() function.
9984 * @note In an Edje theme, the part used as a content container is called @c
9985 * SWALLOW. This is why the parameter name is called @p swallow, but it is
9986 * expected to be a part name just like the second parameter of
9987 * elm_layout_box_append().
9989 * @see elm_layout_box_append()
9990 * @see elm_object_content_part_get()
9991 * @see elm_object_content_part_unset()
9996 EINA_DEPRECATED EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9998 * Get the child object in the given content part.
10000 * @param obj The layout object
10001 * @param swallow The SWALLOW part to get its content
10003 * @return The swallowed object or NULL if none or an error occurred
10005 * @see elm_object_content_part_set()
10009 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10011 * Unset the layout content.
10013 * @param obj The layout object
10014 * @param swallow The swallow part name in the edje file
10015 * @return The content that was being used
10017 * Unparent and return the content object which was set for this part.
10019 * @see elm_object_content_part_set()
10023 EINA_DEPRECATED EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10025 * Set the text of the given part
10027 * @param obj The layout object
10028 * @param part The TEXT part where to set the text
10029 * @param text The text to set
10032 * @deprecated use elm_object_text_* instead.
10034 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
10036 * Get the text set in the given part
10038 * @param obj The layout object
10039 * @param part The TEXT part to retrieve the text off
10041 * @return The text set in @p part
10044 * @deprecated use elm_object_text_* instead.
10046 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
10048 * Append child to layout box part.
10050 * @param obj the layout object
10051 * @param part the box part to which the object will be appended.
10052 * @param child the child object to append to box.
10054 * Once the object is appended, it will become child of the layout. Its
10055 * lifetime will be bound to the layout, whenever the layout dies the child
10056 * will be deleted automatically. One should use elm_layout_box_remove() to
10057 * make this layout forget about the object.
10059 * @see elm_layout_box_prepend()
10060 * @see elm_layout_box_insert_before()
10061 * @see elm_layout_box_insert_at()
10062 * @see elm_layout_box_remove()
10066 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10068 * Prepend child to layout box part.
10070 * @param obj the layout object
10071 * @param part the box part to prepend.
10072 * @param child the child object to prepend to box.
10074 * Once the object is prepended, it will become child of the layout. Its
10075 * lifetime will be bound to the layout, whenever the layout dies the child
10076 * will be deleted automatically. One should use elm_layout_box_remove() to
10077 * make this layout forget about the object.
10079 * @see elm_layout_box_append()
10080 * @see elm_layout_box_insert_before()
10081 * @see elm_layout_box_insert_at()
10082 * @see elm_layout_box_remove()
10086 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10088 * Insert child to layout box part before a reference object.
10090 * @param obj the layout object
10091 * @param part the box part to insert.
10092 * @param child the child object to insert into box.
10093 * @param reference another reference object to insert before in box.
10095 * Once the object is inserted, it will become child of the layout. Its
10096 * lifetime will be bound to the layout, whenever the layout dies the child
10097 * will be deleted automatically. One should use elm_layout_box_remove() to
10098 * make this layout forget about the object.
10100 * @see elm_layout_box_append()
10101 * @see elm_layout_box_prepend()
10102 * @see elm_layout_box_insert_before()
10103 * @see elm_layout_box_remove()
10107 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10109 * Insert child to layout box part at a given position.
10111 * @param obj the layout object
10112 * @param part the box part to insert.
10113 * @param child the child object to insert into box.
10114 * @param pos the numeric position >=0 to insert the child.
10116 * Once the object is inserted, it will become child of the layout. Its
10117 * lifetime will be bound to the layout, whenever the layout dies the child
10118 * will be deleted automatically. One should use elm_layout_box_remove() to
10119 * make this layout forget about the object.
10121 * @see elm_layout_box_append()
10122 * @see elm_layout_box_prepend()
10123 * @see elm_layout_box_insert_before()
10124 * @see elm_layout_box_remove()
10128 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10130 * Remove a child of the given part box.
10132 * @param obj The layout object
10133 * @param part The box part name to remove child.
10134 * @param child The object to remove from box.
10135 * @return The object that was being used, or NULL if not found.
10137 * The object will be removed from the box part and its lifetime will
10138 * not be handled by the layout anymore. This is equivalent to
10139 * elm_object_content_part_unset() for box.
10141 * @see elm_layout_box_append()
10142 * @see elm_layout_box_remove_all()
10146 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10148 * Remove all child of the given part box.
10150 * @param obj The layout object
10151 * @param part The box part name to remove child.
10152 * @param clear If EINA_TRUE, then all objects will be deleted as
10153 * well, otherwise they will just be removed and will be
10154 * dangling on the canvas.
10156 * The objects will be removed from the box part and their lifetime will
10157 * not be handled by the layout anymore. This is equivalent to
10158 * elm_layout_box_remove() for all box children.
10160 * @see elm_layout_box_append()
10161 * @see elm_layout_box_remove()
10165 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10167 * Insert child to layout table part.
10169 * @param obj the layout object
10170 * @param part the box part to pack child.
10171 * @param child_obj the child object to pack into table.
10172 * @param col the column to which the child should be added. (>= 0)
10173 * @param row the row to which the child should be added. (>= 0)
10174 * @param colspan how many columns should be used to store this object. (>=
10176 * @param rowspan how many rows should be used to store this object. (>= 1)
10178 * Once the object is inserted, it will become child of the table. Its
10179 * lifetime will be bound to the layout, and whenever the layout dies the
10180 * child will be deleted automatically. One should use
10181 * elm_layout_table_remove() to make this layout forget about the object.
10183 * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10184 * more space than a single cell. For instance, the following code:
10186 * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10189 * Would result in an object being added like the following picture:
10191 * @image html layout_colspan.png
10192 * @image latex layout_colspan.eps width=\textwidth
10194 * @see elm_layout_table_unpack()
10195 * @see elm_layout_table_clear()
10199 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);
10201 * Unpack (remove) a child of the given part table.
10203 * @param obj The layout object
10204 * @param part The table part name to remove child.
10205 * @param child_obj The object to remove from table.
10206 * @return The object that was being used, or NULL if not found.
10208 * The object will be unpacked from the table part and its lifetime
10209 * will not be handled by the layout anymore. This is equivalent to
10210 * elm_object_content_part_unset() for table.
10212 * @see elm_layout_table_pack()
10213 * @see elm_layout_table_clear()
10217 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10219 * Remove all child of the given part table.
10221 * @param obj The layout object
10222 * @param part The table part name to remove child.
10223 * @param clear If EINA_TRUE, then all objects will be deleted as
10224 * well, otherwise they will just be removed and will be
10225 * dangling on the canvas.
10227 * The objects will be removed from the table part and their lifetime will
10228 * not be handled by the layout anymore. This is equivalent to
10229 * elm_layout_table_unpack() for all table children.
10231 * @see elm_layout_table_pack()
10232 * @see elm_layout_table_unpack()
10236 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10238 * Get the edje layout
10240 * @param obj The layout object
10242 * @return A Evas_Object with the edje layout settings loaded
10243 * with function elm_layout_file_set
10245 * This returns the edje object. It is not expected to be used to then
10246 * swallow objects via edje_object_part_swallow() for example. Use
10247 * elm_object_content_part_set() instead so child object handling and sizing is
10250 * @note This function should only be used if you really need to call some
10251 * low level Edje function on this edje object. All the common stuff (setting
10252 * text, emitting signals, hooking callbacks to signals, etc.) can be done
10253 * with proper elementary functions.
10255 * @see elm_object_signal_callback_add()
10256 * @see elm_object_signal_emit()
10257 * @see elm_object_text_part_set()
10258 * @see elm_object_content_part_set()
10259 * @see elm_layout_box_append()
10260 * @see elm_layout_table_pack()
10261 * @see elm_layout_data_get()
10265 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10267 * Get the edje data from the given layout
10269 * @param obj The layout object
10270 * @param key The data key
10272 * @return The edje data string
10274 * This function fetches data specified inside the edje theme of this layout.
10275 * This function return NULL if data is not found.
10277 * In EDC this comes from a data block within the group block that @p
10278 * obj was loaded from. E.g.
10285 * item: "key1" "value1";
10286 * item: "key2" "value2";
10294 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10298 * @param obj The layout object
10300 * Manually forces a sizing re-evaluation. This is useful when the minimum
10301 * size required by the edje theme of this layout has changed. The change on
10302 * the minimum size required by the edje theme is not immediately reported to
10303 * the elementary layout, so one needs to call this function in order to tell
10304 * the widget (layout) that it needs to reevaluate its own size.
10306 * The minimum size of the theme is calculated based on minimum size of
10307 * parts, the size of elements inside containers like box and table, etc. All
10308 * of this can change due to state changes, and that's when this function
10309 * should be called.
10311 * Also note that a standard signal of "size,eval" "elm" emitted from the
10312 * edje object will cause this to happen too.
10316 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10319 * Sets a specific cursor for an edje part.
10321 * @param obj The layout object.
10322 * @param part_name a part from loaded edje group.
10323 * @param cursor cursor name to use, see Elementary_Cursor.h
10325 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10326 * part not exists or it has "mouse_events: 0".
10330 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10333 * Get the cursor to be shown when mouse is over an edje part
10335 * @param obj The layout object.
10336 * @param part_name a part from loaded edje group.
10337 * @return the cursor name.
10341 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10344 * Unsets a cursor previously set with elm_layout_part_cursor_set().
10346 * @param obj The layout object.
10347 * @param part_name a part from loaded edje group, that had a cursor set
10348 * with elm_layout_part_cursor_set().
10352 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10355 * Sets a specific cursor style for an edje part.
10357 * @param obj The layout object.
10358 * @param part_name a part from loaded edje group.
10359 * @param style the theme style to use (default, transparent, ...)
10361 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10362 * part not exists or it did not had a cursor set.
10366 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10369 * Gets a specific cursor style for an edje part.
10371 * @param obj The layout object.
10372 * @param part_name a part from loaded edje group.
10374 * @return the theme style in use, defaults to "default". If the
10375 * object does not have a cursor set, then NULL is returned.
10379 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10382 * Sets if the cursor set should be searched on the theme or should use
10383 * the provided by the engine, only.
10385 * @note before you set if should look on theme you should define a
10386 * cursor with elm_layout_part_cursor_set(). By default it will only
10387 * look for cursors provided by the engine.
10389 * @param obj The layout object.
10390 * @param part_name a part from loaded edje group.
10391 * @param engine_only if cursors should be just provided by the engine
10392 * or should also search on widget's theme as well
10394 * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10395 * part not exists or it did not had a cursor set.
10399 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);
10402 * Gets a specific cursor engine_only for an edje part.
10404 * @param obj The layout object.
10405 * @param part_name a part from loaded edje group.
10407 * @return whenever the cursor is just provided by engine or also from theme.
10411 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10414 * @def elm_layout_icon_set
10415 * Convienience macro to set the icon object in a layout that follows the
10416 * Elementary naming convention for its parts.
10420 #define elm_layout_icon_set(_ly, _obj) \
10423 elm_object_content_part_set((_ly), "elm.swallow.icon", (_obj)); \
10424 if ((_obj)) sig = "elm,state,icon,visible"; \
10425 else sig = "elm,state,icon,hidden"; \
10426 elm_object_signal_emit((_ly), sig, "elm"); \
10430 * @def elm_layout_icon_get
10431 * Convienience macro to get the icon object from a layout that follows the
10432 * Elementary naming convention for its parts.
10436 #define elm_layout_icon_get(_ly) \
10437 elm_object_content_part_get((_ly), "elm.swallow.icon")
10440 * @def elm_layout_end_set
10441 * Convienience macro to set the end object in a layout that follows the
10442 * Elementary naming convention for its parts.
10446 #define elm_layout_end_set(_ly, _obj) \
10449 elm_object_content_part_set((_ly), "elm.swallow.end", (_obj)); \
10450 if ((_obj)) sig = "elm,state,end,visible"; \
10451 else sig = "elm,state,end,hidden"; \
10452 elm_object_signal_emit((_ly), sig, "elm"); \
10456 * @def elm_layout_end_get
10457 * Convienience macro to get the end object in a layout that follows the
10458 * Elementary naming convention for its parts.
10462 #define elm_layout_end_get(_ly) \
10463 elm_object_content_part_get((_ly), "elm.swallow.end")
10466 * @def elm_layout_label_set
10467 * Convienience macro to set the label in a layout that follows the
10468 * Elementary naming convention for its parts.
10471 * @deprecated use elm_object_text_* instead.
10473 #define elm_layout_label_set(_ly, _txt) \
10474 elm_layout_text_set((_ly), "elm.text", (_txt))
10477 * @def elm_layout_label_get
10478 * Convenience macro to get the label in a layout that follows the
10479 * Elementary naming convention for its parts.
10482 * @deprecated use elm_object_text_* instead.
10484 #define elm_layout_label_get(_ly) \
10485 elm_layout_text_get((_ly), "elm.text")
10487 /* smart callbacks called:
10488 * "theme,changed" - when elm theme is changed.
10492 * @defgroup Notify Notify
10494 * @image html img/widget/notify/preview-00.png
10495 * @image latex img/widget/notify/preview-00.eps
10497 * Display a container in a particular region of the parent(top, bottom,
10498 * etc). A timeout can be set to automatically hide the notify. This is so
10499 * that, after an evas_object_show() on a notify object, if a timeout was set
10500 * on it, it will @b automatically get hidden after that time.
10502 * Signals that you can add callbacks for are:
10503 * @li "timeout" - when timeout happens on notify and it's hidden
10504 * @li "block,clicked" - when a click outside of the notify happens
10506 * Default contents parts of the notify widget that you can use for are:
10507 * @li "elm.swallow.content" - A content of the notify
10509 * @ref tutorial_notify show usage of the API.
10514 * @brief Possible orient values for notify.
10516 * This values should be used in conjunction to elm_notify_orient_set() to
10517 * set the position in which the notify should appear(relative to its parent)
10518 * and in conjunction with elm_notify_orient_get() to know where the notify
10521 typedef enum _Elm_Notify_Orient
10523 ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10524 ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10525 ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10526 ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10527 ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10528 ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10529 ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10530 ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10531 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10532 ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10533 } Elm_Notify_Orient;
10535 * @brief Add a new notify to the parent
10537 * @param parent The parent object
10538 * @return The new object or NULL if it cannot be created
10540 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10542 * @brief Set the content of the notify widget
10544 * @param obj The notify object
10545 * @param content The content will be filled in this notify object
10547 * Once the content object is set, a previously set one will be deleted. If
10548 * you want to keep that old content object, use the
10549 * elm_notify_content_unset() function.
10551 EINA_DEPRECATED EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10553 * @brief Unset the content of the notify widget
10555 * @param obj The notify object
10556 * @return The content that was being used
10558 * Unparent and return the content object which was set for this widget
10560 * @see elm_notify_content_set()
10562 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10564 * @brief Return the content of the notify widget
10566 * @param obj The notify object
10567 * @return The content that is being used
10569 * @see elm_notify_content_set()
10571 EINA_DEPRECATED EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10573 * @brief Set the notify parent
10575 * @param obj The notify object
10576 * @param content The new parent
10578 * Once the parent object is set, a previously set one will be disconnected
10581 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10583 * @brief Get the notify parent
10585 * @param obj The notify object
10586 * @return The parent
10588 * @see elm_notify_parent_set()
10590 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10592 * @brief Set the orientation
10594 * @param obj The notify object
10595 * @param orient The new orientation
10597 * Sets the position in which the notify will appear in its parent.
10599 * @see @ref Elm_Notify_Orient for possible values.
10601 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10603 * @brief Return the orientation
10604 * @param obj The notify object
10605 * @return The orientation of the notification
10607 * @see elm_notify_orient_set()
10608 * @see Elm_Notify_Orient
10610 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10612 * @brief Set the time interval after which the notify window is going to be
10615 * @param obj The notify object
10616 * @param time The timeout in seconds
10618 * This function sets a timeout and starts the timer controlling when the
10619 * notify is hidden. Since calling evas_object_show() on a notify restarts
10620 * the timer controlling when the notify is hidden, setting this before the
10621 * notify is shown will in effect mean starting the timer when the notify is
10624 * @note Set a value <= 0.0 to disable a running timer.
10626 * @note If the value > 0.0 and the notify is previously visible, the
10627 * timer will be started with this value, canceling any running timer.
10629 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10631 * @brief Return the timeout value (in seconds)
10632 * @param obj the notify object
10634 * @see elm_notify_timeout_set()
10636 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10638 * @brief Sets whether events should be passed to by a click outside
10641 * @param obj The notify object
10642 * @param repeats EINA_TRUE Events are repeats, else no
10644 * When true if the user clicks outside the window the events will be caught
10645 * by the others widgets, else the events are blocked.
10647 * @note The default value is EINA_TRUE.
10649 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10651 * @brief Return true if events are repeat below the notify object
10652 * @param obj the notify object
10654 * @see elm_notify_repeat_events_set()
10656 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10662 * @defgroup Hover Hover
10664 * @image html img/widget/hover/preview-00.png
10665 * @image latex img/widget/hover/preview-00.eps
10667 * A Hover object will hover over its @p parent object at the @p target
10668 * location. Anything in the background will be given a darker coloring to
10669 * indicate that the hover object is on top (at the default theme). When the
10670 * hover is clicked it is dismissed(hidden), if the contents of the hover are
10671 * clicked that @b doesn't cause the hover to be dismissed.
10673 * A Hover object has two parents. One parent that owns it during creation
10674 * and the other parent being the one over which the hover object spans.
10677 * @note The hover object will take up the entire space of @p target
10680 * Elementary has the following styles for the hover widget:
10684 * @li hoversel_vertical
10686 * The following are the available position for content:
10698 * Signals that you can add callbacks for are:
10699 * @li "clicked" - the user clicked the empty space in the hover to dismiss
10700 * @li "smart,changed" - a content object placed under the "smart"
10701 * policy was replaced to a new slot direction.
10703 * See @ref tutorial_hover for more information.
10707 typedef enum _Elm_Hover_Axis
10709 ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10710 ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10711 ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10712 ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10715 * @brief Adds a hover object to @p parent
10717 * @param parent The parent object
10718 * @return The hover object or NULL if one could not be created
10720 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10722 * @brief Sets the target object for the hover.
10724 * @param obj The hover object
10725 * @param target The object to center the hover onto. The hover
10727 * This function will cause the hover to be centered on the target object.
10729 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10731 * @brief Gets the target object for the hover.
10733 * @param obj The hover object
10734 * @param parent The object to locate the hover over.
10736 * @see elm_hover_target_set()
10738 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10740 * @brief Sets the parent object for the hover.
10742 * @param obj The hover object
10743 * @param parent The object to locate the hover over.
10745 * This function will cause the hover to take up the entire space that the
10746 * parent object fills.
10748 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10750 * @brief Gets the parent object for the hover.
10752 * @param obj The hover object
10753 * @return The parent object to locate the hover over.
10755 * @see elm_hover_parent_set()
10757 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10759 * @brief Sets the content of the hover object and the direction in which it
10762 * @param obj The hover object
10763 * @param swallow The direction that the object will be displayed
10764 * at. Accepted values are "left", "top-left", "top", "top-right",
10765 * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10767 * @param content The content to place at @p swallow
10769 * Once the content object is set for a given direction, a previously
10770 * set one (on the same direction) will be deleted. If you want to
10771 * keep that old content object, use the elm_hover_content_unset()
10774 * All directions may have contents at the same time, except for
10775 * "smart". This is a special placement hint and its use case
10776 * independs of the calculations coming from
10777 * elm_hover_best_content_location_get(). Its use is for cases when
10778 * one desires only one hover content, but with a dinamic special
10779 * placement within the hover area. The content's geometry, whenever
10780 * it changes, will be used to decide on a best location not
10781 * extrapolating the hover's parent object view to show it in (still
10782 * being the hover's target determinant of its medium part -- move and
10783 * resize it to simulate finger sizes, for example). If one of the
10784 * directions other than "smart" are used, a previously content set
10785 * using it will be deleted, and vice-versa.
10787 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10789 * @brief Get the content of the hover object, in a given direction.
10791 * Return the content object which was set for this widget in the
10792 * @p swallow direction.
10794 * @param obj The hover object
10795 * @param swallow The direction that the object was display at.
10796 * @return The content that was being used
10798 * @see elm_hover_content_set()
10800 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10802 * @brief Unset the content of the hover object, in a given direction.
10804 * Unparent and return the content object set at @p swallow direction.
10806 * @param obj The hover object
10807 * @param swallow The direction that the object was display at.
10808 * @return The content that was being used.
10810 * @see elm_hover_content_set()
10812 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10814 * @brief Returns the best swallow location for content in the hover.
10816 * @param obj The hover object
10817 * @param pref_axis The preferred orientation axis for the hover object to use
10818 * @return The edje location to place content into the hover or @c
10821 * Best is defined here as the location at which there is the most available
10824 * @p pref_axis may be one of
10825 * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10826 * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10827 * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10828 * - @c ELM_HOVER_AXIS_BOTH -- both
10830 * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10831 * nescessarily be along the horizontal axis("left" or "right"). If
10832 * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10833 * be along the vertical axis("top" or "bottom"). Chossing
10834 * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10835 * returned position may be in either axis.
10837 * @see elm_hover_content_set()
10839 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10846 * @defgroup Entry Entry
10848 * @image html img/widget/entry/preview-00.png
10849 * @image latex img/widget/entry/preview-00.eps width=\textwidth
10850 * @image html img/widget/entry/preview-01.png
10851 * @image latex img/widget/entry/preview-01.eps width=\textwidth
10852 * @image html img/widget/entry/preview-02.png
10853 * @image latex img/widget/entry/preview-02.eps width=\textwidth
10854 * @image html img/widget/entry/preview-03.png
10855 * @image latex img/widget/entry/preview-03.eps width=\textwidth
10857 * An entry is a convenience widget which shows a box that the user can
10858 * enter text into. Entries by default don't scroll, so they grow to
10859 * accomodate the entire text, resizing the parent window as needed. This
10860 * can be changed with the elm_entry_scrollable_set() function.
10862 * They can also be single line or multi line (the default) and when set
10863 * to multi line mode they support text wrapping in any of the modes
10864 * indicated by #Elm_Wrap_Type.
10866 * Other features include password mode, filtering of inserted text with
10867 * elm_entry_text_filter_append() and related functions, inline "items" and
10868 * formatted markup text.
10870 * @section entry-markup Formatted text
10872 * The markup tags supported by the Entry are defined by the theme, but
10873 * even when writing new themes or extensions it's a good idea to stick to
10874 * a sane default, to maintain coherency and avoid application breakages.
10875 * Currently defined by the default theme are the following tags:
10876 * @li \<br\>: Inserts a line break.
10877 * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10879 * @li \<tab\>: Inserts a tab.
10880 * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10882 * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10883 * @li \<link\>...\</link\>: Underlines the enclosed text.
10884 * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10886 * @section entry-special Special markups
10888 * Besides those used to format text, entries support two special markup
10889 * tags used to insert clickable portions of text or items inlined within
10892 * @subsection entry-anchors Anchors
10894 * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10895 * \</a\> tags and an event will be generated when this text is clicked,
10899 * This text is outside <a href=anc-01>but this one is an anchor</a>
10902 * The @c href attribute in the opening tag gives the name that will be
10903 * used to identify the anchor and it can be any valid utf8 string.
10905 * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10906 * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10907 * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10908 * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10911 * @subsection entry-items Items
10913 * Inlined in the text, any other @c Evas_Object can be inserted by using
10914 * \<item\> tags this way:
10917 * <item size=16x16 vsize=full href=emoticon/haha></item>
10920 * Just like with anchors, the @c href identifies each item, but these need,
10921 * in addition, to indicate their size, which is done using any one of
10922 * @c size, @c absize or @c relsize attributes. These attributes take their
10923 * value in the WxH format, where W is the width and H the height of the
10926 * @li absize: Absolute pixel size for the item. Whatever value is set will
10927 * be the item's size regardless of any scale value the object may have
10928 * been set to. The final line height will be adjusted to fit larger items.
10929 * @li size: Similar to @c absize, but it's adjusted to the scale value set
10931 * @li relsize: Size is adjusted for the item to fit within the current
10934 * Besides their size, items are specificed a @c vsize value that affects
10935 * how their final size and position are calculated. The possible values
10937 * @li ascent: Item will be placed within the line's baseline and its
10938 * ascent. That is, the height between the line where all characters are
10939 * positioned and the highest point in the line. For @c size and @c absize
10940 * items, the descent value will be added to the total line height to make
10941 * them fit. @c relsize items will be adjusted to fit within this space.
10942 * @li full: Items will be placed between the descent and ascent, or the
10943 * lowest point in the line and its highest.
10945 * The next image shows different configurations of items and how they
10946 * are the previously mentioned options affect their sizes. In all cases,
10947 * the green line indicates the ascent, blue for the baseline and red for
10950 * @image html entry_item.png
10951 * @image latex entry_item.eps width=\textwidth
10953 * And another one to show how size differs from absize. In the first one,
10954 * the scale value is set to 1.0, while the second one is using one of 2.0.
10956 * @image html entry_item_scale.png
10957 * @image latex entry_item_scale.eps width=\textwidth
10959 * After the size for an item is calculated, the entry will request an
10960 * object to place in its space. For this, the functions set with
10961 * elm_entry_item_provider_append() and related functions will be called
10962 * in order until one of them returns a @c non-NULL value. If no providers
10963 * are available, or all of them return @c NULL, then the entry falls back
10964 * to one of the internal defaults, provided the name matches with one of
10967 * All of the following are currently supported:
10970 * - emoticon/angry-shout
10971 * - emoticon/crazy-laugh
10972 * - emoticon/evil-laugh
10974 * - emoticon/goggle-smile
10975 * - emoticon/grumpy
10976 * - emoticon/grumpy-smile
10977 * - emoticon/guilty
10978 * - emoticon/guilty-smile
10980 * - emoticon/half-smile
10981 * - emoticon/happy-panting
10983 * - emoticon/indifferent
10985 * - emoticon/knowing-grin
10987 * - emoticon/little-bit-sorry
10988 * - emoticon/love-lots
10990 * - emoticon/minimal-smile
10991 * - emoticon/not-happy
10992 * - emoticon/not-impressed
10994 * - emoticon/opensmile
10997 * - emoticon/squint-laugh
10998 * - emoticon/surprised
10999 * - emoticon/suspicious
11000 * - emoticon/tongue-dangling
11001 * - emoticon/tongue-poke
11003 * - emoticon/unhappy
11004 * - emoticon/very-sorry
11007 * - emoticon/worried
11010 * Alternatively, an item may reference an image by its path, using
11011 * the URI form @c file:///path/to/an/image.png and the entry will then
11012 * use that image for the item.
11014 * @section entry-files Loading and saving files
11016 * Entries have convinience functions to load text from a file and save
11017 * changes back to it after a short delay. The automatic saving is enabled
11018 * by default, but can be disabled with elm_entry_autosave_set() and files
11019 * can be loaded directly as plain text or have any markup in them
11020 * recognized. See elm_entry_file_set() for more details.
11022 * @section entry-signals Emitted signals
11024 * This widget emits the following signals:
11026 * @li "changed": The text within the entry was changed.
11027 * @li "changed,user": The text within the entry was changed because of user interaction.
11028 * @li "activated": The enter key was pressed on a single line entry.
11029 * @li "press": A mouse button has been pressed on the entry.
11030 * @li "longpressed": A mouse button has been pressed and held for a couple
11032 * @li "clicked": The entry has been clicked (mouse press and release).
11033 * @li "clicked,double": The entry has been double clicked.
11034 * @li "clicked,triple": The entry has been triple clicked.
11035 * @li "focused": The entry has received focus.
11036 * @li "unfocused": The entry has lost focus.
11037 * @li "selection,paste": A paste of the clipboard contents was requested.
11038 * @li "selection,copy": A copy of the selected text into the clipboard was
11040 * @li "selection,cut": A cut of the selected text into the clipboard was
11042 * @li "selection,start": A selection has begun and no previous selection
11044 * @li "selection,changed": The current selection has changed.
11045 * @li "selection,cleared": The current selection has been cleared.
11046 * @li "cursor,changed": The cursor has changed position.
11047 * @li "anchor,clicked": An anchor has been clicked. The event_info
11048 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11049 * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
11050 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11051 * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
11052 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11053 * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
11054 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11055 * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
11056 * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11057 * @li "preedit,changed": The preedit string has changed.
11058 * @li "language,changed": Program language changed.
11060 * @section entry-examples
11062 * An overview of the Entry API can be seen in @ref entry_example_01
11067 * @typedef Elm_Entry_Anchor_Info
11069 * The info sent in the callback for the "anchor,clicked" signals emitted
11072 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11074 * @struct _Elm_Entry_Anchor_Info
11076 * The info sent in the callback for the "anchor,clicked" signals emitted
11079 struct _Elm_Entry_Anchor_Info
11081 const char *name; /**< The name of the anchor, as stated in its href */
11082 int button; /**< The mouse button used to click on it */
11083 Evas_Coord x, /**< Anchor geometry, relative to canvas */
11084 y, /**< Anchor geometry, relative to canvas */
11085 w, /**< Anchor geometry, relative to canvas */
11086 h; /**< Anchor geometry, relative to canvas */
11089 * @typedef Elm_Entry_Filter_Cb
11090 * This callback type is used by entry filters to modify text.
11091 * @param data The data specified as the last param when adding the filter
11092 * @param entry The entry object
11093 * @param text A pointer to the location of the text being filtered. This data can be modified,
11094 * but any additional allocations must be managed by the user.
11095 * @see elm_entry_text_filter_append
11096 * @see elm_entry_text_filter_prepend
11098 typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11101 * This adds an entry to @p parent object.
11103 * By default, entries are:
11107 * @li autosave is enabled
11109 * @param parent The parent object
11110 * @return The new object or NULL if it cannot be created
11112 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11114 * Sets the entry to single line mode.
11116 * In single line mode, entries don't ever wrap when the text reaches the
11117 * edge, and instead they keep growing horizontally. Pressing the @c Enter
11118 * key will generate an @c "activate" event instead of adding a new line.
11120 * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11121 * and pressing enter will break the text into a different line
11122 * without generating any events.
11124 * @param obj The entry object
11125 * @param single_line If true, the text in the entry
11126 * will be on a single line.
11128 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11130 * Gets whether the entry is set to be single line.
11132 * @param obj The entry object
11133 * @return single_line If true, the text in the entry is set to display
11134 * on a single line.
11136 * @see elm_entry_single_line_set()
11138 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11140 * Sets the entry to password mode.
11142 * In password mode, entries are implicitly single line and the display of
11143 * any text in them is replaced with asterisks (*).
11145 * @param obj The entry object
11146 * @param password If true, password mode is enabled.
11148 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11150 * Gets whether the entry is set to password mode.
11152 * @param obj The entry object
11153 * @return If true, the entry is set to display all characters
11154 * as asterisks (*).
11156 * @see elm_entry_password_set()
11158 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11160 * This sets the text displayed within the entry to @p entry.
11162 * @param obj The entry object
11163 * @param entry The text to be displayed
11165 * @deprecated Use elm_object_text_set() instead.
11166 * @note Using this function bypasses text filters
11168 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11170 * This returns the text currently shown in object @p entry.
11171 * See also elm_entry_entry_set().
11173 * @param obj The entry object
11174 * @return The currently displayed text or NULL on failure
11176 * @deprecated Use elm_object_text_get() instead.
11178 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11180 * Appends @p entry to the text of the entry.
11182 * Adds the text in @p entry to the end of any text already present in the
11185 * The appended text is subject to any filters set for the widget.
11187 * @param obj The entry object
11188 * @param entry The text to be displayed
11190 * @see elm_entry_text_filter_append()
11192 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11194 * Gets whether the entry is empty.
11196 * Empty means no text at all. If there are any markup tags, like an item
11197 * tag for which no provider finds anything, and no text is displayed, this
11198 * function still returns EINA_FALSE.
11200 * @param obj The entry object
11201 * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11203 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11205 * Gets any selected text within the entry.
11207 * If there's any selected text in the entry, this function returns it as
11208 * a string in markup format. NULL is returned if no selection exists or
11209 * if an error occurred.
11211 * The returned value points to an internal string and should not be freed
11212 * or modified in any way. If the @p entry object is deleted or its
11213 * contents are changed, the returned pointer should be considered invalid.
11215 * @param obj The entry object
11216 * @return The selected text within the entry or NULL on failure
11218 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11220 * Inserts the given text into the entry at the current cursor position.
11222 * This inserts text at the cursor position as if it was typed
11223 * by the user (note that this also allows markup which a user
11224 * can't just "type" as it would be converted to escaped text, so this
11225 * call can be used to insert things like emoticon items or bold push/pop
11226 * tags, other font and color change tags etc.)
11228 * If any selection exists, it will be replaced by the inserted text.
11230 * The inserted text is subject to any filters set for the widget.
11232 * @param obj The entry object
11233 * @param entry The text to insert
11235 * @see elm_entry_text_filter_append()
11237 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11239 * Set the line wrap type to use on multi-line entries.
11241 * Sets the wrap type used by the entry to any of the specified in
11242 * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11243 * line (without inserting a line break or paragraph separator) when it
11244 * reaches the far edge of the widget.
11246 * Note that this only makes sense for multi-line entries. A widget set
11247 * to be single line will never wrap.
11249 * @param obj The entry object
11250 * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11252 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11254 * Gets the wrap mode the entry was set to use.
11256 * @param obj The entry object
11257 * @return Wrap type
11259 * @see also elm_entry_line_wrap_set()
11261 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11263 * Sets if the entry is to be editable or not.
11265 * By default, entries are editable and when focused, any text input by the
11266 * user will be inserted at the current cursor position. But calling this
11267 * function with @p editable as EINA_FALSE will prevent the user from
11268 * inputting text into the entry.
11270 * The only way to change the text of a non-editable entry is to use
11271 * elm_object_text_set(), elm_entry_entry_insert() and other related
11274 * @param obj The entry object
11275 * @param editable If EINA_TRUE, user input will be inserted in the entry,
11276 * if not, the entry is read-only and no user input is allowed.
11278 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11280 * Gets whether the entry is editable or not.
11282 * @param obj The entry object
11283 * @return If true, the entry is editable by the user.
11284 * If false, it is not editable by the user
11286 * @see elm_entry_editable_set()
11288 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11290 * This drops any existing text selection within the entry.
11292 * @param obj The entry object
11294 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11296 * This selects all text within the entry.
11298 * @param obj The entry object
11300 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11302 * This moves the cursor one place to the right within the entry.
11304 * @param obj The entry object
11305 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11307 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11309 * This moves the cursor one place to the left within the entry.
11311 * @param obj The entry object
11312 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11314 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11316 * This moves the cursor one line up within the entry.
11318 * @param obj The entry object
11319 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11321 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11323 * This moves the cursor one line down within the entry.
11325 * @param obj The entry object
11326 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11328 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11330 * This moves the cursor to the beginning of the entry.
11332 * @param obj The entry object
11334 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11336 * This moves the cursor to the end of the entry.
11338 * @param obj The entry object
11340 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11342 * This moves the cursor to the beginning of the current line.
11344 * @param obj The entry object
11346 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11348 * This moves the cursor to the end of the current line.
11350 * @param obj The entry object
11352 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11354 * This begins a selection within the entry as though
11355 * the user were holding down the mouse button to make a selection.
11357 * @param obj The entry object
11359 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11361 * This ends a selection within the entry as though
11362 * the user had just released the mouse button while making a selection.
11364 * @param obj The entry object
11366 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11368 * Gets whether a format node exists at the current cursor position.
11370 * A format node is anything that defines how the text is rendered. It can
11371 * be a visible format node, such as a line break or a paragraph separator,
11372 * or an invisible one, such as bold begin or end tag.
11373 * This function returns whether any format node exists at the current
11376 * @param obj The entry object
11377 * @return EINA_TRUE if the current cursor position contains a format node,
11378 * EINA_FALSE otherwise.
11380 * @see elm_entry_cursor_is_visible_format_get()
11382 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11384 * Gets if the current cursor position holds a visible format node.
11386 * @param obj The entry object
11387 * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11388 * if it's an invisible one or no format exists.
11390 * @see elm_entry_cursor_is_format_get()
11392 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11394 * Gets the character pointed by the cursor at its current position.
11396 * This function returns a string with the utf8 character stored at the
11397 * current cursor position.
11398 * Only the text is returned, any format that may exist will not be part
11399 * of the return value.
11401 * @param obj The entry object
11402 * @return The text pointed by the cursors.
11404 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11406 * This function returns the geometry of the cursor.
11408 * It's useful if you want to draw something on the cursor (or where it is),
11409 * or for example in the case of scrolled entry where you want to show the
11412 * @param obj The entry object
11413 * @param x returned geometry
11414 * @param y returned geometry
11415 * @param w returned geometry
11416 * @param h returned geometry
11417 * @return EINA_TRUE upon success, EINA_FALSE upon failure
11419 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);
11421 * Sets the cursor position in the entry to the given value
11423 * The value in @p pos is the index of the character position within the
11424 * contents of the string as returned by elm_entry_cursor_pos_get().
11426 * @param obj The entry object
11427 * @param pos The position of the cursor
11429 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11431 * Retrieves the current position of the cursor in the entry
11433 * @param obj The entry object
11434 * @return The cursor position
11436 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11438 * This executes a "cut" action on the selected text in the entry.
11440 * @param obj The entry object
11442 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11444 * This executes a "copy" action on the selected text in the entry.
11446 * @param obj The entry object
11448 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11450 * This executes a "paste" action in the entry.
11452 * @param obj The entry object
11454 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11456 * This clears and frees the items in a entry's contextual (longpress)
11459 * @param obj The entry object
11461 * @see elm_entry_context_menu_item_add()
11463 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11465 * This adds an item to the entry's contextual menu.
11467 * A longpress on an entry will make the contextual menu show up, if this
11468 * hasn't been disabled with elm_entry_context_menu_disabled_set().
11469 * By default, this menu provides a few options like enabling selection mode,
11470 * which is useful on embedded devices that need to be explicit about it,
11471 * and when a selection exists it also shows the copy and cut actions.
11473 * With this function, developers can add other options to this menu to
11474 * perform any action they deem necessary.
11476 * @param obj The entry object
11477 * @param label The item's text label
11478 * @param icon_file The item's icon file
11479 * @param icon_type The item's icon type
11480 * @param func The callback to execute when the item is clicked
11481 * @param data The data to associate with the item for related functions
11483 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);
11485 * This disables the entry's contextual (longpress) menu.
11487 * @param obj The entry object
11488 * @param disabled If true, the menu is disabled
11490 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11492 * This returns whether the entry's contextual (longpress) menu is
11495 * @param obj The entry object
11496 * @return If true, the menu is disabled
11498 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11500 * This appends a custom item provider to the list for that entry
11502 * This appends the given callback. The list is walked from beginning to end
11503 * with each function called given the item href string in the text. If the
11504 * function returns an object handle other than NULL (it should create an
11505 * object to do this), then this object is used to replace that item. If
11506 * not the next provider is called until one provides an item object, or the
11507 * default provider in entry does.
11509 * @param obj The entry object
11510 * @param func The function called to provide the item object
11511 * @param data The data passed to @p func
11513 * @see @ref entry-items
11515 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);
11517 * This prepends a custom item provider to the list for that entry
11519 * This prepends the given callback. See elm_entry_item_provider_append() for
11522 * @param obj The entry object
11523 * @param func The function called to provide the item object
11524 * @param data The data passed to @p func
11526 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);
11528 * This removes a custom item provider to the list for that entry
11530 * This removes the given callback. See elm_entry_item_provider_append() for
11533 * @param obj The entry object
11534 * @param func The function called to provide the item object
11535 * @param data The data passed to @p func
11537 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);
11539 * Append a filter function for text inserted in the entry
11541 * Append the given callback to the list. This functions will be called
11542 * whenever any text is inserted into the entry, with the text to be inserted
11543 * as a parameter. The callback function is free to alter the text in any way
11544 * it wants, but it must remember to free the given pointer and update it.
11545 * If the new text is to be discarded, the function can free it and set its
11546 * text parameter to NULL. This will also prevent any following filters from
11549 * @param obj The entry object
11550 * @param func The function to use as text filter
11551 * @param data User data to pass to @p func
11553 EAPI void elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11555 * Prepend a filter function for text insdrted in the entry
11557 * Prepend the given callback to the list. See elm_entry_text_filter_append()
11558 * for more information
11560 * @param obj The entry object
11561 * @param func The function to use as text filter
11562 * @param data User data to pass to @p func
11564 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11566 * Remove a filter from the list
11568 * Removes the given callback from the filter list. See
11569 * elm_entry_text_filter_append() for more information.
11571 * @param obj The entry object
11572 * @param func The filter function to remove
11573 * @param data The user data passed when adding the function
11575 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11577 * This converts a markup (HTML-like) string into UTF-8.
11579 * The returned string is a malloc'ed buffer and it should be freed when
11580 * not needed anymore.
11582 * @param s The string (in markup) to be converted
11583 * @return The converted string (in UTF-8). It should be freed.
11585 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11587 * This converts a UTF-8 string into markup (HTML-like).
11589 * The returned string is a malloc'ed buffer and it should be freed when
11590 * not needed anymore.
11592 * @param s The string (in UTF-8) to be converted
11593 * @return The converted string (in markup). It should be freed.
11595 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11597 * This sets the file (and implicitly loads it) for the text to display and
11598 * then edit. All changes are written back to the file after a short delay if
11599 * the entry object is set to autosave (which is the default).
11601 * If the entry had any other file set previously, any changes made to it
11602 * will be saved if the autosave feature is enabled, otherwise, the file
11603 * will be silently discarded and any non-saved changes will be lost.
11605 * @param obj The entry object
11606 * @param file The path to the file to load and save
11607 * @param format The file format
11609 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11611 * Gets the file being edited by the entry.
11613 * This function can be used to retrieve any file set on the entry for
11614 * edition, along with the format used to load and save it.
11616 * @param obj The entry object
11617 * @param file The path to the file to load and save
11618 * @param format The file format
11620 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11622 * This function writes any changes made to the file set with
11623 * elm_entry_file_set()
11625 * @param obj The entry object
11627 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11629 * This sets the entry object to 'autosave' the loaded text file or not.
11631 * @param obj The entry object
11632 * @param autosave Autosave the loaded file or not
11634 * @see elm_entry_file_set()
11636 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11638 * This gets the entry object's 'autosave' status.
11640 * @param obj The entry object
11641 * @return Autosave the loaded file or not
11643 * @see elm_entry_file_set()
11645 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11647 * Control pasting of text and images for the widget.
11649 * Normally the entry allows both text and images to be pasted. By setting
11650 * textonly to be true, this prevents images from being pasted.
11652 * Note this only changes the behaviour of text.
11654 * @param obj The entry object
11655 * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11656 * text+image+other.
11658 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11660 * Getting elm_entry text paste/drop mode.
11662 * In textonly mode, only text may be pasted or dropped into the widget.
11664 * @param obj The entry object
11665 * @return If the widget only accepts text from pastes.
11667 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11669 * Enable or disable scrolling in entry
11671 * Normally the entry is not scrollable unless you enable it with this call.
11673 * @param obj The entry object
11674 * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11676 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11678 * Get the scrollable state of the entry
11680 * Normally the entry is not scrollable. This gets the scrollable state
11681 * of the entry. See elm_entry_scrollable_set() for more information.
11683 * @param obj The entry object
11684 * @return The scrollable state
11686 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
11688 * This sets a widget to be displayed to the left of a scrolled entry.
11690 * @param obj The scrolled entry object
11691 * @param icon The widget to display on the left side of the scrolled
11694 * @note A previously set widget will be destroyed.
11695 * @note If the object being set does not have minimum size hints set,
11696 * it won't get properly displayed.
11698 * @see elm_entry_end_set()
11700 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11702 * Gets the leftmost widget of the scrolled entry. This object is
11703 * owned by the scrolled entry and should not be modified.
11705 * @param obj The scrolled entry object
11706 * @return the left widget inside the scroller
11708 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11710 * Unset the leftmost widget of the scrolled entry, unparenting and
11713 * @param obj The scrolled entry object
11714 * @return the previously set icon sub-object of this entry, on
11717 * @see elm_entry_icon_set()
11719 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11721 * Sets the visibility of the left-side widget of the scrolled entry,
11722 * set by elm_entry_icon_set().
11724 * @param obj The scrolled entry object
11725 * @param setting EINA_TRUE if the object should be displayed,
11726 * EINA_FALSE if not.
11728 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11730 * This sets a widget to be displayed to the end of a scrolled entry.
11732 * @param obj The scrolled entry object
11733 * @param end The widget to display on the right side of the scrolled
11736 * @note A previously set widget will be destroyed.
11737 * @note If the object being set does not have minimum size hints set,
11738 * it won't get properly displayed.
11740 * @see elm_entry_icon_set
11742 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11744 * Gets the endmost widget of the scrolled entry. This object is owned
11745 * by the scrolled entry and should not be modified.
11747 * @param obj The scrolled entry object
11748 * @return the right widget inside the scroller
11750 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11752 * Unset the endmost widget of the scrolled entry, unparenting and
11755 * @param obj The scrolled entry object
11756 * @return the previously set icon sub-object of this entry, on
11759 * @see elm_entry_icon_set()
11761 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11763 * Sets the visibility of the end widget of the scrolled entry, set by
11764 * elm_entry_end_set().
11766 * @param obj The scrolled entry object
11767 * @param setting EINA_TRUE if the object should be displayed,
11768 * EINA_FALSE if not.
11770 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11772 * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11775 * Setting an entry to single-line mode with elm_entry_single_line_set()
11776 * will automatically disable the display of scrollbars when the entry
11777 * moves inside its scroller.
11779 * @param obj The scrolled entry object
11780 * @param h The horizontal scrollbar policy to apply
11781 * @param v The vertical scrollbar policy to apply
11783 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11785 * This enables/disables bouncing within the entry.
11787 * This function sets whether the entry will bounce when scrolling reaches
11788 * the end of the contained entry.
11790 * @param obj The scrolled entry object
11791 * @param h The horizontal bounce state
11792 * @param v The vertical bounce state
11794 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11796 * Get the bounce mode
11798 * @param obj The Entry object
11799 * @param h_bounce Allow bounce horizontally
11800 * @param v_bounce Allow bounce vertically
11802 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11804 /* pre-made filters for entries */
11806 * @typedef Elm_Entry_Filter_Limit_Size
11808 * Data for the elm_entry_filter_limit_size() entry filter.
11810 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11812 * @struct _Elm_Entry_Filter_Limit_Size
11814 * Data for the elm_entry_filter_limit_size() entry filter.
11816 struct _Elm_Entry_Filter_Limit_Size
11818 int max_char_count; /**< The maximum number of characters allowed. */
11819 int max_byte_count; /**< The maximum number of bytes allowed*/
11822 * Filter inserted text based on user defined character and byte limits
11824 * Add this filter to an entry to limit the characters that it will accept
11825 * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11826 * The funtion works on the UTF-8 representation of the string, converting
11827 * it from the set markup, thus not accounting for any format in it.
11829 * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11830 * it as data when setting the filter. In it, it's possible to set limits
11831 * by character count or bytes (any of them is disabled if 0), and both can
11832 * be set at the same time. In that case, it first checks for characters,
11835 * The function will cut the inserted text in order to allow only the first
11836 * number of characters that are still allowed. The cut is made in
11837 * characters, even when limiting by bytes, in order to always contain
11838 * valid ones and avoid half unicode characters making it in.
11840 * This filter, like any others, does not apply when setting the entry text
11841 * directly with elm_object_text_set() (or the deprecated
11842 * elm_entry_entry_set()).
11844 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11846 * @typedef Elm_Entry_Filter_Accept_Set
11848 * Data for the elm_entry_filter_accept_set() entry filter.
11850 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11852 * @struct _Elm_Entry_Filter_Accept_Set
11854 * Data for the elm_entry_filter_accept_set() entry filter.
11856 struct _Elm_Entry_Filter_Accept_Set
11858 const char *accepted; /**< Set of characters accepted in the entry. */
11859 const char *rejected; /**< Set of characters rejected from the entry. */
11862 * Filter inserted text based on accepted or rejected sets of characters
11864 * Add this filter to an entry to restrict the set of accepted characters
11865 * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11866 * This structure contains both accepted and rejected sets, but they are
11867 * mutually exclusive.
11869 * The @c accepted set takes preference, so if it is set, the filter will
11870 * only work based on the accepted characters, ignoring anything in the
11871 * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11873 * In both cases, the function filters by matching utf8 characters to the
11874 * raw markup text, so it can be used to remove formatting tags.
11876 * This filter, like any others, does not apply when setting the entry text
11877 * directly with elm_object_text_set() (or the deprecated
11878 * elm_entry_entry_set()).
11880 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11882 * Set the input panel layout of the entry
11884 * @param obj The entry object
11885 * @param layout layout type
11887 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11889 * Get the input panel layout of the entry
11891 * @param obj The entry object
11892 * @return layout type
11894 * @see elm_entry_input_panel_layout_set
11896 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11898 * Set the autocapitalization type on the immodule.
11900 * @param obj The entry object
11901 * @param autocapital_type The type of autocapitalization
11903 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11905 * Retrieve the autocapitalization type on the immodule.
11907 * @param obj The entry object
11908 * @return autocapitalization type
11910 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11912 * Sets the attribute to show the input panel automatically.
11914 * @param obj The entry object
11915 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
11917 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
11919 * Retrieve the attribute to show the input panel automatically.
11921 * @param obj The entry object
11922 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
11924 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11930 /* composite widgets - these basically put together basic widgets above
11931 * in convenient packages that do more than basic stuff */
11935 * @defgroup Anchorview Anchorview
11937 * @image html img/widget/anchorview/preview-00.png
11938 * @image latex img/widget/anchorview/preview-00.eps
11940 * Anchorview is for displaying text that contains markup with anchors
11941 * like <c>\<a href=1234\>something\</\></c> in it.
11943 * Besides being styled differently, the anchorview widget provides the
11944 * necessary functionality so that clicking on these anchors brings up a
11945 * popup with user defined content such as "call", "add to contacts" or
11946 * "open web page". This popup is provided using the @ref Hover widget.
11948 * This widget is very similar to @ref Anchorblock, so refer to that
11949 * widget for an example. The only difference Anchorview has is that the
11950 * widget is already provided with scrolling functionality, so if the
11951 * text set to it is too large to fit in the given space, it will scroll,
11952 * whereas the @ref Anchorblock widget will keep growing to ensure all the
11953 * text can be displayed.
11955 * This widget emits the following signals:
11956 * @li "anchor,clicked": will be called when an anchor is clicked. The
11957 * @p event_info parameter on the callback will be a pointer of type
11958 * ::Elm_Entry_Anchorview_Info.
11960 * See @ref Anchorblock for an example on how to use both of them.
11969 * @typedef Elm_Entry_Anchorview_Info
11971 * The info sent in the callback for "anchor,clicked" signals emitted by
11972 * the Anchorview widget.
11974 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11976 * @struct _Elm_Entry_Anchorview_Info
11978 * The info sent in the callback for "anchor,clicked" signals emitted by
11979 * the Anchorview widget.
11981 struct _Elm_Entry_Anchorview_Info
11983 const char *name; /**< Name of the anchor, as indicated in its href
11985 int button; /**< The mouse button used to click on it */
11986 Evas_Object *hover; /**< The hover object to use for the popup */
11988 Evas_Coord x, y, w, h;
11989 } anchor, /**< Geometry selection of text used as anchor */
11990 hover_parent; /**< Geometry of the object used as parent by the
11992 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
11993 for content on the left side of
11994 the hover. Before calling the
11995 callback, the widget will make the
11996 necessary calculations to check
11997 which sides are fit to be set with
11998 content, based on the position the
11999 hover is activated and its distance
12000 to the edges of its parent object
12002 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12003 the right side of the hover.
12004 See @ref hover_left */
12005 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12006 of the hover. See @ref hover_left */
12007 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12008 below the hover. See @ref
12012 * Add a new Anchorview object
12014 * @param parent The parent object
12015 * @return The new object or NULL if it cannot be created
12017 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12019 * Set the text to show in the anchorview
12021 * Sets the text of the anchorview to @p text. This text can include markup
12022 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
12023 * text that will be specially styled and react to click events, ended with
12024 * either of \</a\> or \</\>. When clicked, the anchor will emit an
12025 * "anchor,clicked" signal that you can attach a callback to with
12026 * evas_object_smart_callback_add(). The name of the anchor given in the
12027 * event info struct will be the one set in the href attribute, in this
12028 * case, anchorname.
12030 * Other markup can be used to style the text in different ways, but it's
12031 * up to the style defined in the theme which tags do what.
12032 * @deprecated use elm_object_text_set() instead.
12034 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12036 * Get the markup text set for the anchorview
12038 * Retrieves the text set on the anchorview, with markup tags included.
12040 * @param obj The anchorview object
12041 * @return The markup text set or @c NULL if nothing was set or an error
12043 * @deprecated use elm_object_text_set() instead.
12045 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12047 * Set the parent of the hover popup
12049 * Sets the parent object to use by the hover created by the anchorview
12050 * when an anchor is clicked. See @ref Hover for more details on this.
12051 * If no parent is set, the same anchorview object will be used.
12053 * @param obj The anchorview object
12054 * @param parent The object to use as parent for the hover
12056 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12058 * Get the parent of the hover popup
12060 * Get the object used as parent for the hover created by the anchorview
12061 * widget. See @ref Hover for more details on this.
12063 * @param obj The anchorview object
12064 * @return The object used as parent for the hover, NULL if none is set.
12066 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12068 * Set the style that the hover should use
12070 * When creating the popup hover, anchorview will request that it's
12071 * themed according to @p style.
12073 * @param obj The anchorview object
12074 * @param style The style to use for the underlying hover
12076 * @see elm_object_style_set()
12078 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12080 * Get the style that the hover should use
12082 * Get the style the hover created by anchorview will use.
12084 * @param obj The anchorview object
12085 * @return The style to use by the hover. NULL means the default is used.
12087 * @see elm_object_style_set()
12089 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12091 * Ends the hover popup in the anchorview
12093 * When an anchor is clicked, the anchorview widget will create a hover
12094 * object to use as a popup with user provided content. This function
12095 * terminates this popup, returning the anchorview to its normal state.
12097 * @param obj The anchorview object
12099 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12101 * Set bouncing behaviour when the scrolled content reaches an edge
12103 * Tell the internal scroller object whether it should bounce or not
12104 * when it reaches the respective edges for each axis.
12106 * @param obj The anchorview object
12107 * @param h_bounce Whether to bounce or not in the horizontal axis
12108 * @param v_bounce Whether to bounce or not in the vertical axis
12110 * @see elm_scroller_bounce_set()
12112 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12114 * Get the set bouncing behaviour of the internal scroller
12116 * Get whether the internal scroller should bounce when the edge of each
12117 * axis is reached scrolling.
12119 * @param obj The anchorview object
12120 * @param h_bounce Pointer where to store the bounce state of the horizontal
12122 * @param v_bounce Pointer where to store the bounce state of the vertical
12125 * @see elm_scroller_bounce_get()
12127 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12129 * Appends a custom item provider to the given anchorview
12131 * Appends the given function to the list of items providers. This list is
12132 * called, one function at a time, with the given @p data pointer, the
12133 * anchorview object and, in the @p item parameter, the item name as
12134 * referenced in its href string. Following functions in the list will be
12135 * called in order until one of them returns something different to NULL,
12136 * which should be an Evas_Object which will be used in place of the item
12139 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12140 * href=item/name\>\</item\>
12142 * @param obj The anchorview object
12143 * @param func The function to add to the list of providers
12144 * @param data User data that will be passed to the callback function
12146 * @see elm_entry_item_provider_append()
12148 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);
12150 * Prepend a custom item provider to the given anchorview
12152 * Like elm_anchorview_item_provider_append(), but it adds the function
12153 * @p func to the beginning of the list, instead of the end.
12155 * @param obj The anchorview object
12156 * @param func The function to add to the list of providers
12157 * @param data User data that will be passed to the callback function
12159 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);
12161 * Remove a custom item provider from the list of the given anchorview
12163 * Removes the function and data pairing that matches @p func and @p data.
12164 * That is, unless the same function and same user data are given, the
12165 * function will not be removed from the list. This allows us to add the
12166 * same callback several times, with different @p data pointers and be
12167 * able to remove them later without conflicts.
12169 * @param obj The anchorview object
12170 * @param func The function to remove from the list
12171 * @param data The data matching the function to remove from the list
12173 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);
12180 * @defgroup Anchorblock Anchorblock
12182 * @image html img/widget/anchorblock/preview-00.png
12183 * @image latex img/widget/anchorblock/preview-00.eps
12185 * Anchorblock is for displaying text that contains markup with anchors
12186 * like <c>\<a href=1234\>something\</\></c> in it.
12188 * Besides being styled differently, the anchorblock widget provides the
12189 * necessary functionality so that clicking on these anchors brings up a
12190 * popup with user defined content such as "call", "add to contacts" or
12191 * "open web page". This popup is provided using the @ref Hover widget.
12193 * This widget emits the following signals:
12194 * @li "anchor,clicked": will be called when an anchor is clicked. The
12195 * @p event_info parameter on the callback will be a pointer of type
12196 * ::Elm_Entry_Anchorblock_Info.
12202 * Since examples are usually better than plain words, we might as well
12203 * try @ref tutorial_anchorblock_example "one".
12206 * @addtogroup Anchorblock
12210 * @typedef Elm_Entry_Anchorblock_Info
12212 * The info sent in the callback for "anchor,clicked" signals emitted by
12213 * the Anchorblock widget.
12215 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12217 * @struct _Elm_Entry_Anchorblock_Info
12219 * The info sent in the callback for "anchor,clicked" signals emitted by
12220 * the Anchorblock widget.
12222 struct _Elm_Entry_Anchorblock_Info
12224 const char *name; /**< Name of the anchor, as indicated in its href
12226 int button; /**< The mouse button used to click on it */
12227 Evas_Object *hover; /**< The hover object to use for the popup */
12229 Evas_Coord x, y, w, h;
12230 } anchor, /**< Geometry selection of text used as anchor */
12231 hover_parent; /**< Geometry of the object used as parent by the
12233 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
12234 for content on the left side of
12235 the hover. Before calling the
12236 callback, the widget will make the
12237 necessary calculations to check
12238 which sides are fit to be set with
12239 content, based on the position the
12240 hover is activated and its distance
12241 to the edges of its parent object
12243 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
12244 the right side of the hover.
12245 See @ref hover_left */
12246 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
12247 of the hover. See @ref hover_left */
12248 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
12249 below the hover. See @ref
12253 * Add a new Anchorblock object
12255 * @param parent The parent object
12256 * @return The new object or NULL if it cannot be created
12258 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12260 * Set the text to show in the anchorblock
12262 * Sets the text of the anchorblock to @p text. This text can include markup
12263 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12264 * of text that will be specially styled and react to click events, ended
12265 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12266 * "anchor,clicked" signal that you can attach a callback to with
12267 * evas_object_smart_callback_add(). The name of the anchor given in the
12268 * event info struct will be the one set in the href attribute, in this
12269 * case, anchorname.
12271 * Other markup can be used to style the text in different ways, but it's
12272 * up to the style defined in the theme which tags do what.
12273 * @deprecated use elm_object_text_set() instead.
12275 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12277 * Get the markup text set for the anchorblock
12279 * Retrieves the text set on the anchorblock, with markup tags included.
12281 * @param obj The anchorblock object
12282 * @return The markup text set or @c NULL if nothing was set or an error
12284 * @deprecated use elm_object_text_set() instead.
12286 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12288 * Set the parent of the hover popup
12290 * Sets the parent object to use by the hover created by the anchorblock
12291 * when an anchor is clicked. See @ref Hover for more details on this.
12293 * @param obj The anchorblock object
12294 * @param parent The object to use as parent for the hover
12296 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12298 * Get the parent of the hover popup
12300 * Get the object used as parent for the hover created by the anchorblock
12301 * widget. See @ref Hover for more details on this.
12302 * If no parent is set, the same anchorblock object will be used.
12304 * @param obj The anchorblock object
12305 * @return The object used as parent for the hover, NULL if none is set.
12307 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12309 * Set the style that the hover should use
12311 * When creating the popup hover, anchorblock will request that it's
12312 * themed according to @p style.
12314 * @param obj The anchorblock object
12315 * @param style The style to use for the underlying hover
12317 * @see elm_object_style_set()
12319 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12321 * Get the style that the hover should use
12323 * Get the style, the hover created by anchorblock will use.
12325 * @param obj The anchorblock object
12326 * @return The style to use by the hover. NULL means the default is used.
12328 * @see elm_object_style_set()
12330 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12332 * Ends the hover popup in the anchorblock
12334 * When an anchor is clicked, the anchorblock widget will create a hover
12335 * object to use as a popup with user provided content. This function
12336 * terminates this popup, returning the anchorblock to its normal state.
12338 * @param obj The anchorblock object
12340 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12342 * Appends a custom item provider to the given anchorblock
12344 * Appends the given function to the list of items providers. This list is
12345 * called, one function at a time, with the given @p data pointer, the
12346 * anchorblock object and, in the @p item parameter, the item name as
12347 * referenced in its href string. Following functions in the list will be
12348 * called in order until one of them returns something different to NULL,
12349 * which should be an Evas_Object which will be used in place of the item
12352 * Items in the markup text take the form \<item relsize=16x16 vsize=full
12353 * href=item/name\>\</item\>
12355 * @param obj The anchorblock object
12356 * @param func The function to add to the list of providers
12357 * @param data User data that will be passed to the callback function
12359 * @see elm_entry_item_provider_append()
12361 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);
12363 * Prepend a custom item provider to the given anchorblock
12365 * Like elm_anchorblock_item_provider_append(), but it adds the function
12366 * @p func to the beginning of the list, instead of the end.
12368 * @param obj The anchorblock object
12369 * @param func The function to add to the list of providers
12370 * @param data User data that will be passed to the callback function
12372 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);
12374 * Remove a custom item provider from the list of the given anchorblock
12376 * Removes the function and data pairing that matches @p func and @p data.
12377 * That is, unless the same function and same user data are given, the
12378 * function will not be removed from the list. This allows us to add the
12379 * same callback several times, with different @p data pointers and be
12380 * able to remove them later without conflicts.
12382 * @param obj The anchorblock object
12383 * @param func The function to remove from the list
12384 * @param data The data matching the function to remove from the list
12386 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);
12392 * @defgroup Bubble Bubble
12394 * @image html img/widget/bubble/preview-00.png
12395 * @image latex img/widget/bubble/preview-00.eps
12396 * @image html img/widget/bubble/preview-01.png
12397 * @image latex img/widget/bubble/preview-01.eps
12398 * @image html img/widget/bubble/preview-02.png
12399 * @image latex img/widget/bubble/preview-02.eps
12401 * @brief The Bubble is a widget to show text similar to how speech is
12402 * represented in comics.
12404 * The bubble widget contains 5 important visual elements:
12405 * @li The frame is a rectangle with rounded edjes and an "arrow".
12406 * @li The @p icon is an image to which the frame's arrow points to.
12407 * @li The @p label is a text which appears to the right of the icon if the
12408 * corner is "top_left" or "bottom_left" and is right aligned to the frame
12410 * @li The @p info is a text which appears to the right of the label. Info's
12411 * font is of a ligther color than label.
12412 * @li The @p content is an evas object that is shown inside the frame.
12414 * The position of the arrow, icon, label and info depends on which corner is
12415 * selected. The four available corners are:
12416 * @li "top_left" - Default
12418 * @li "bottom_left"
12419 * @li "bottom_right"
12421 * Signals that you can add callbacks for are:
12422 * @li "clicked" - This is called when a user has clicked the bubble.
12424 * For an example of using a buble see @ref bubble_01_example_page "this".
12429 * Add a new bubble to the parent
12431 * @param parent The parent object
12432 * @return The new object or NULL if it cannot be created
12434 * This function adds a text bubble to the given parent evas object.
12436 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12438 * Set the label of the bubble
12440 * @param obj The bubble object
12441 * @param label The string to set in the label
12443 * This function sets the title of the bubble. Where this appears depends on
12444 * the selected corner.
12445 * @deprecated use elm_object_text_set() instead.
12447 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12449 * Get the label of the bubble
12451 * @param obj The bubble object
12452 * @return The string of set in the label
12454 * This function gets the title of the bubble.
12455 * @deprecated use elm_object_text_get() instead.
12457 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12459 * Set the info of the bubble
12461 * @param obj The bubble object
12462 * @param info The given info about the bubble
12464 * This function sets the info of the bubble. Where this appears depends on
12465 * the selected corner.
12466 * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12468 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12470 * Get the info of the bubble
12472 * @param obj The bubble object
12474 * @return The "info" string of the bubble
12476 * This function gets the info text.
12477 * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12479 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12481 * Set the content to be shown in the bubble
12483 * Once the content object is set, a previously set one will be deleted.
12484 * If you want to keep the old content object, use the
12485 * elm_bubble_content_unset() function.
12487 * @param obj The bubble object
12488 * @param content The given content of the bubble
12490 * This function sets the content shown on the middle of the bubble.
12492 EINA_DEPRECATED EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12494 * Get the content shown in the bubble
12496 * Return the content object which is set for this widget.
12498 * @param obj The bubble object
12499 * @return The content that is being used
12501 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12503 * Unset the content shown in the bubble
12505 * Unparent and return the content object which was set for this widget.
12507 * @param obj The bubble object
12508 * @return The content that was being used
12510 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12512 * Set the icon of the bubble
12514 * Once the icon object is set, a previously set one will be deleted.
12515 * If you want to keep the old content object, use the
12516 * elm_icon_content_unset() function.
12518 * @param obj The bubble object
12519 * @param icon The given icon for the bubble
12521 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12523 * Get the icon of the bubble
12525 * @param obj The bubble object
12526 * @return The icon for the bubble
12528 * This function gets the icon shown on the top left of bubble.
12530 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12532 * Unset the icon of the bubble
12534 * Unparent and return the icon object which was set for this widget.
12536 * @param obj The bubble object
12537 * @return The icon that was being used
12539 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12541 * Set the corner of the bubble
12543 * @param obj The bubble object.
12544 * @param corner The given corner for the bubble.
12546 * This function sets the corner of the bubble. The corner will be used to
12547 * determine where the arrow in the frame points to and where label, icon and
12550 * Possible values for corner are:
12551 * @li "top_left" - Default
12553 * @li "bottom_left"
12554 * @li "bottom_right"
12556 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12558 * Get the corner of the bubble
12560 * @param obj The bubble object.
12561 * @return The given corner for the bubble.
12563 * This function gets the selected corner of the bubble.
12565 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12571 * @defgroup Photo Photo
12573 * For displaying the photo of a person (contact). Simple, yet
12574 * with a very specific purpose.
12576 * Signals that you can add callbacks for are:
12578 * "clicked" - This is called when a user has clicked the photo
12579 * "drag,start" - Someone started dragging the image out of the object
12580 * "drag,end" - Dragged item was dropped (somewhere)
12586 * Add a new photo to the parent
12588 * @param parent The parent object
12589 * @return The new object or NULL if it cannot be created
12593 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12596 * Set the file that will be used as photo
12598 * @param obj The photo object
12599 * @param file The path to file that will be used as photo
12601 * @return (1 = success, 0 = error)
12605 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12608 * Set the file that will be used as thumbnail in the photo.
12610 * @param obj The photo object.
12611 * @param file The path to file that will be used as thumb.
12612 * @param group The key used in case of an EET file.
12616 EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12619 * Set the size that will be used on the photo
12621 * @param obj The photo object
12622 * @param size The size that the photo will be
12626 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12629 * Set if the photo should be completely visible or not.
12631 * @param obj The photo object
12632 * @param fill if true the photo will be completely visible
12636 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12639 * Set editability of the photo.
12641 * An editable photo can be dragged to or from, and can be cut or
12642 * pasted too. Note that pasting an image or dropping an item on
12643 * the image will delete the existing content.
12645 * @param obj The photo object.
12646 * @param set To set of clear editablity.
12648 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12654 /* gesture layer */
12656 * @defgroup Elm_Gesture_Layer Gesture Layer
12657 * Gesture Layer Usage:
12659 * Use Gesture Layer to detect gestures.
12660 * The advantage is that you don't have to implement
12661 * gesture detection, just set callbacks of gesture state.
12662 * By using gesture layer we make standard interface.
12664 * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12665 * with a parent object parameter.
12666 * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12667 * call. Usually with same object as target (2nd parameter).
12669 * Now you need to tell gesture layer what gestures you follow.
12670 * This is done with @ref elm_gesture_layer_cb_set call.
12671 * By setting the callback you actually saying to gesture layer:
12672 * I would like to know when the gesture @ref Elm_Gesture_Types
12673 * switches to state @ref Elm_Gesture_State.
12675 * Next, you need to implement the actual action that follows the input
12676 * in your callback.
12678 * Note that if you like to stop being reported about a gesture, just set
12679 * all callbacks referring this gesture to NULL.
12680 * (again with @ref elm_gesture_layer_cb_set)
12682 * The information reported by gesture layer to your callback is depending
12683 * on @ref Elm_Gesture_Types:
12684 * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12685 * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12686 * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12688 * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12689 * @ref ELM_GESTURE_MOMENTUM.
12691 * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12692 * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12693 * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12694 * Note that we consider a flick as a line-gesture that should be completed
12695 * in flick-time-limit as defined in @ref Config.
12697 * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12699 * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12702 * Gesture Layer Tweaks:
12704 * Note that line, flick, gestures can start without the need to remove fingers from surface.
12705 * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12707 * Setting glayer_continues_enable to false in @ref Config will change this behavior
12708 * so gesture starts when user touches (a *DOWN event) touch-surface
12709 * and ends when no fingers touches surface (a *UP event).
12713 * @enum _Elm_Gesture_Types
12714 * Enum of supported gesture types.
12715 * @ingroup Elm_Gesture_Layer
12717 enum _Elm_Gesture_Types
12719 ELM_GESTURE_FIRST = 0,
12721 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12722 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12723 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12724 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12726 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12728 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12729 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12731 ELM_GESTURE_ZOOM, /**< Zoom */
12732 ELM_GESTURE_ROTATE, /**< Rotate */
12738 * @typedef Elm_Gesture_Types
12739 * gesture types enum
12740 * @ingroup Elm_Gesture_Layer
12742 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12745 * @enum _Elm_Gesture_State
12746 * Enum of gesture states.
12747 * @ingroup Elm_Gesture_Layer
12749 enum _Elm_Gesture_State
12751 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12752 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
12753 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
12754 ELM_GESTURE_STATE_END, /**< Gesture completed */
12755 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
12759 * @typedef Elm_Gesture_State
12760 * gesture states enum
12761 * @ingroup Elm_Gesture_Layer
12763 typedef enum _Elm_Gesture_State Elm_Gesture_State;
12766 * @struct _Elm_Gesture_Taps_Info
12767 * Struct holds taps info for user
12768 * @ingroup Elm_Gesture_Layer
12770 struct _Elm_Gesture_Taps_Info
12772 Evas_Coord x, y; /**< Holds center point between fingers */
12773 unsigned int n; /**< Number of fingers tapped */
12774 unsigned int timestamp; /**< event timestamp */
12778 * @typedef Elm_Gesture_Taps_Info
12779 * holds taps info for user
12780 * @ingroup Elm_Gesture_Layer
12782 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12785 * @struct _Elm_Gesture_Momentum_Info
12786 * Struct holds momentum info for user
12787 * x1 and y1 are not necessarily in sync
12788 * x1 holds x value of x direction starting point
12789 * and same holds for y1.
12790 * This is noticeable when doing V-shape movement
12791 * @ingroup Elm_Gesture_Layer
12793 struct _Elm_Gesture_Momentum_Info
12794 { /* Report line ends, timestamps, and momentum computed */
12795 Evas_Coord x1; /**< Final-swipe direction starting point on X */
12796 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12797 Evas_Coord x2; /**< Final-swipe direction ending point on X */
12798 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
12800 unsigned int tx; /**< Timestamp of start of final x-swipe */
12801 unsigned int ty; /**< Timestamp of start of final y-swipe */
12803 Evas_Coord mx; /**< Momentum on X */
12804 Evas_Coord my; /**< Momentum on Y */
12806 unsigned int n; /**< Number of fingers */
12810 * @typedef Elm_Gesture_Momentum_Info
12811 * holds momentum info for user
12812 * @ingroup Elm_Gesture_Layer
12814 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12817 * @struct _Elm_Gesture_Line_Info
12818 * Struct holds line info for user
12819 * @ingroup Elm_Gesture_Layer
12821 struct _Elm_Gesture_Line_Info
12822 { /* Report line ends, timestamps, and momentum computed */
12823 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12824 /* FIXME should be radians, bot degrees */
12825 double angle; /**< Angle (direction) of lines */
12829 * @typedef Elm_Gesture_Line_Info
12830 * Holds line info for user
12831 * @ingroup Elm_Gesture_Layer
12833 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12836 * @struct _Elm_Gesture_Zoom_Info
12837 * Struct holds zoom info for user
12838 * @ingroup Elm_Gesture_Layer
12840 struct _Elm_Gesture_Zoom_Info
12842 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12843 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12844 double zoom; /**< Zoom value: 1.0 means no zoom */
12845 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12849 * @typedef Elm_Gesture_Zoom_Info
12850 * Holds zoom info for user
12851 * @ingroup Elm_Gesture_Layer
12853 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12856 * @struct _Elm_Gesture_Rotate_Info
12857 * Struct holds rotation info for user
12858 * @ingroup Elm_Gesture_Layer
12860 struct _Elm_Gesture_Rotate_Info
12862 Evas_Coord x, y; /**< Holds zoom center point reported to user */
12863 Evas_Coord radius; /**< Holds radius between fingers reported to user */
12864 double base_angle; /**< Holds start-angle */
12865 double angle; /**< Rotation value: 0.0 means no rotation */
12866 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12870 * @typedef Elm_Gesture_Rotate_Info
12871 * Holds rotation info for user
12872 * @ingroup Elm_Gesture_Layer
12874 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12877 * @typedef Elm_Gesture_Event_Cb
12878 * User callback used to stream gesture info from gesture layer
12879 * @param data user data
12880 * @param event_info gesture report info
12881 * Returns a flag field to be applied on the causing event.
12882 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12883 * upon the event, in an irreversible way.
12885 * @ingroup Elm_Gesture_Layer
12887 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12890 * Use function to set callbacks to be notified about
12891 * change of state of gesture.
12892 * When a user registers a callback with this function
12893 * this means this gesture has to be tested.
12895 * When ALL callbacks for a gesture are set to NULL
12896 * it means user isn't interested in gesture-state
12897 * and it will not be tested.
12899 * @param obj Pointer to gesture-layer.
12900 * @param idx The gesture you would like to track its state.
12901 * @param cb callback function pointer.
12902 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12903 * @param data user info to be sent to callback (usually, Smart Data)
12905 * @ingroup Elm_Gesture_Layer
12907 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);
12910 * Call this function to get repeat-events settings.
12912 * @param obj Pointer to gesture-layer.
12914 * @return repeat events settings.
12915 * @see elm_gesture_layer_hold_events_set()
12916 * @ingroup Elm_Gesture_Layer
12918 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12921 * This function called in order to make gesture-layer repeat events.
12922 * Set this of you like to get the raw events only if gestures were not detected.
12923 * Clear this if you like gesture layer to fwd events as testing gestures.
12925 * @param obj Pointer to gesture-layer.
12926 * @param r Repeat: TRUE/FALSE
12928 * @ingroup Elm_Gesture_Layer
12930 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12933 * This function sets step-value for zoom action.
12934 * Set step to any positive value.
12935 * Cancel step setting by setting to 0.0
12937 * @param obj Pointer to gesture-layer.
12938 * @param s new zoom step value.
12940 * @ingroup Elm_Gesture_Layer
12942 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12945 * This function sets step-value for rotate action.
12946 * Set step to any positive value.
12947 * Cancel step setting by setting to 0.0
12949 * @param obj Pointer to gesture-layer.
12950 * @param s new roatate step value.
12952 * @ingroup Elm_Gesture_Layer
12954 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12957 * This function called to attach gesture-layer to an Evas_Object.
12958 * @param obj Pointer to gesture-layer.
12959 * @param t Pointer to underlying object (AKA Target)
12961 * @return TRUE, FALSE on success, failure.
12963 * @ingroup Elm_Gesture_Layer
12965 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12968 * Call this function to construct a new gesture-layer object.
12969 * This does not activate the gesture layer. You have to
12970 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12972 * @param parent the parent object.
12974 * @return Pointer to new gesture-layer object.
12976 * @ingroup Elm_Gesture_Layer
12978 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12981 * @defgroup Thumb Thumb
12983 * @image html img/widget/thumb/preview-00.png
12984 * @image latex img/widget/thumb/preview-00.eps
12986 * A thumb object is used for displaying the thumbnail of an image or video.
12987 * You must have compiled Elementary with Ethumb_Client support and the DBus
12988 * service must be present and auto-activated in order to have thumbnails to
12991 * Once the thumbnail object becomes visible, it will check if there is a
12992 * previously generated thumbnail image for the file set on it. If not, it
12993 * will start generating this thumbnail.
12995 * Different config settings will cause different thumbnails to be generated
12996 * even on the same file.
12998 * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12999 * Ethumb documentation to change this path, and to see other configuration
13002 * Signals that you can add callbacks for are:
13004 * - "clicked" - This is called when a user has clicked the thumb without dragging
13006 * - "clicked,double" - This is called when a user has double-clicked the thumb.
13007 * - "press" - This is called when a user has pressed down the thumb.
13008 * - "generate,start" - The thumbnail generation started.
13009 * - "generate,stop" - The generation process stopped.
13010 * - "generate,error" - The generation failed.
13011 * - "load,error" - The thumbnail image loading failed.
13013 * available styles:
13017 * An example of use of thumbnail:
13019 * - @ref thumb_example_01
13023 * @addtogroup Thumb
13028 * @enum _Elm_Thumb_Animation_Setting
13029 * @typedef Elm_Thumb_Animation_Setting
13031 * Used to set if a video thumbnail is animating or not.
13035 typedef enum _Elm_Thumb_Animation_Setting
13037 ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13038 ELM_THUMB_ANIMATION_LOOP, /**< Keep playing animation until stop is requested */
13039 ELM_THUMB_ANIMATION_STOP, /**< Stop playing the animation */
13040 ELM_THUMB_ANIMATION_LAST
13041 } Elm_Thumb_Animation_Setting;
13044 * Add a new thumb object to the parent.
13046 * @param parent The parent object.
13047 * @return The new object or NULL if it cannot be created.
13049 * @see elm_thumb_file_set()
13050 * @see elm_thumb_ethumb_client_get()
13054 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13056 * Reload thumbnail if it was generated before.
13058 * @param obj The thumb object to reload
13060 * This is useful if the ethumb client configuration changed, like its
13061 * size, aspect or any other property one set in the handle returned
13062 * by elm_thumb_ethumb_client_get().
13064 * If the options didn't change, the thumbnail won't be generated again, but
13065 * the old one will still be used.
13067 * @see elm_thumb_file_set()
13071 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13073 * Set the file that will be used as thumbnail.
13075 * @param obj The thumb object.
13076 * @param file The path to file that will be used as thumb.
13077 * @param key The key used in case of an EET file.
13079 * The file can be an image or a video (in that case, acceptable extensions are:
13080 * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13081 * function elm_thumb_animate().
13083 * @see elm_thumb_file_get()
13084 * @see elm_thumb_reload()
13085 * @see elm_thumb_animate()
13089 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13091 * Get the image or video path and key used to generate the thumbnail.
13093 * @param obj The thumb object.
13094 * @param file Pointer to filename.
13095 * @param key Pointer to key.
13097 * @see elm_thumb_file_set()
13098 * @see elm_thumb_path_get()
13102 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13104 * Get the path and key to the image or video generated by ethumb.
13106 * One just need to make sure that the thumbnail was generated before getting
13107 * its path; otherwise, the path will be NULL. One way to do that is by asking
13108 * for the path when/after the "generate,stop" smart callback is called.
13110 * @param obj The thumb object.
13111 * @param file Pointer to thumb path.
13112 * @param key Pointer to thumb key.
13114 * @see elm_thumb_file_get()
13118 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13120 * Set the animation state for the thumb object. If its content is an animated
13121 * video, you may start/stop the animation or tell it to play continuously and
13124 * @param obj The thumb object.
13125 * @param setting The animation setting.
13127 * @see elm_thumb_file_set()
13131 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13133 * Get the animation state for the thumb object.
13135 * @param obj The thumb object.
13136 * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13139 * @see elm_thumb_animate_set()
13143 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13145 * Get the ethumb_client handle so custom configuration can be made.
13147 * @return Ethumb_Client instance or NULL.
13149 * This must be called before the objects are created to be sure no object is
13150 * visible and no generation started.
13152 * Example of usage:
13155 * #include <Elementary.h>
13156 * #ifndef ELM_LIB_QUICKLAUNCH
13158 * elm_main(int argc, char **argv)
13160 * Ethumb_Client *client;
13162 * elm_need_ethumb();
13166 * client = elm_thumb_ethumb_client_get();
13169 * ERR("could not get ethumb_client");
13172 * ethumb_client_size_set(client, 100, 100);
13173 * ethumb_client_crop_align_set(client, 0.5, 0.5);
13176 * // Create elm_thumb objects here
13186 * @note There's only one client handle for Ethumb, so once a configuration
13187 * change is done to it, any other request for thumbnails (for any thumbnail
13188 * object) will use that configuration. Thus, this configuration is global.
13192 EAPI void *elm_thumb_ethumb_client_get(void);
13194 * Get the ethumb_client connection state.
13196 * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13199 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
13201 * Make the thumbnail 'editable'.
13203 * @param obj Thumb object.
13204 * @param set Turn on or off editability. Default is @c EINA_FALSE.
13206 * This means the thumbnail is a valid drag target for drag and drop, and can be
13207 * cut or pasted too.
13209 * @see elm_thumb_editable_get()
13213 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13215 * Make the thumbnail 'editable'.
13217 * @param obj Thumb object.
13218 * @return Editability.
13220 * This means the thumbnail is a valid drag target for drag and drop, and can be
13221 * cut or pasted too.
13223 * @see elm_thumb_editable_set()
13227 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13234 * @defgroup Web Web
13236 * @image html img/widget/web/preview-00.png
13237 * @image latex img/widget/web/preview-00.eps
13239 * A web object is used for displaying web pages (HTML/CSS/JS)
13240 * using WebKit-EFL. You must have compiled Elementary with
13243 * Signals that you can add callbacks for are:
13244 * @li "download,request": A file download has been requested. Event info is
13245 * a pointer to a Elm_Web_Download
13246 * @li "editorclient,contents,changed": Editor client's contents changed
13247 * @li "editorclient,selection,changed": Editor client's selection changed
13248 * @li "frame,created": A new frame was created. Event info is an
13249 * Evas_Object which can be handled with WebKit's ewk_frame API
13250 * @li "icon,received": An icon was received by the main frame
13251 * @li "inputmethod,changed": Input method changed. Event info is an
13252 * Eina_Bool indicating whether it's enabled or not
13253 * @li "js,windowobject,clear": JS window object has been cleared
13254 * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13255 * is a char *link[2], where the first string contains the URL the link
13256 * points to, and the second one the title of the link
13257 * @li "link,hover,out": Mouse cursor left the link
13258 * @li "load,document,finished": Loading of a document finished. Event info
13259 * is the frame that finished loading
13260 * @li "load,error": Load failed. Event info is a pointer to
13261 * Elm_Web_Frame_Load_Error
13262 * @li "load,finished": Load finished. Event info is NULL on success, on
13263 * error it's a pointer to Elm_Web_Frame_Load_Error
13264 * @li "load,newwindow,show": A new window was created and is ready to be
13266 * @li "load,progress": Overall load progress. Event info is a pointer to
13267 * a double containing a value between 0.0 and 1.0
13268 * @li "load,provisional": Started provisional load
13269 * @li "load,started": Loading of a document started
13270 * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13271 * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13272 * the menubar is visible, or EINA_FALSE in case it's not
13273 * @li "menubar,visible,set": Informs menubar visibility. Event info is
13274 * an Eina_Bool indicating the visibility
13275 * @li "popup,created": A dropdown widget was activated, requesting its
13276 * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13277 * @li "popup,willdelete": The web object is ready to destroy the popup
13278 * object created. Event info is a pointer to Elm_Web_Menu
13279 * @li "ready": Page is fully loaded
13280 * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13281 * info is a pointer to Eina_Bool where the visibility state should be set
13282 * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13283 * is an Eina_Bool with the visibility state set
13284 * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13285 * a string with the new text
13286 * @li "statusbar,visible,get": Queries visibility of the status bar.
13287 * Event info is a pointer to Eina_Bool where the visibility state should be
13289 * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13290 * an Eina_Bool with the visibility value
13291 * @li "title,changed": Title of the main frame changed. Event info is a
13292 * string with the new title
13293 * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13294 * is a pointer to Eina_Bool where the visibility state should be set
13295 * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13296 * info is an Eina_Bool with the visibility state
13297 * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13298 * a string with the text to show
13299 * @li "uri,changed": URI of the main frame changed. Event info is a string
13301 * @li "view,resized": The web object internal's view changed sized
13302 * @li "windows,close,request": A JavaScript request to close the current
13303 * window was requested
13304 * @li "zoom,animated,end": Animated zoom finished
13306 * available styles:
13309 * An example of use of web:
13311 * - @ref web_example_01 TBD
13320 * Structure used to report load errors.
13322 * Load errors are reported as signal by elm_web. All the strings are
13323 * temporary references and should @b not be used after the signal
13324 * callback returns. If it's required, make copies with strdup() or
13325 * eina_stringshare_add() (they are not even guaranteed to be
13326 * stringshared, so must use eina_stringshare_add() and not
13327 * eina_stringshare_ref()).
13329 typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13331 * Structure used to report load errors.
13333 * Load errors are reported as signal by elm_web. All the strings are
13334 * temporary references and should @b not be used after the signal
13335 * callback returns. If it's required, make copies with strdup() or
13336 * eina_stringshare_add() (they are not even guaranteed to be
13337 * stringshared, so must use eina_stringshare_add() and not
13338 * eina_stringshare_ref()).
13340 struct _Elm_Web_Frame_Load_Error
13342 int code; /**< Numeric error code */
13343 Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13344 const char *domain; /**< Error domain name */
13345 const char *description; /**< Error description (already localized) */
13346 const char *failing_url; /**< The URL that failed to load */
13347 Evas_Object *frame; /**< Frame object that produced the error */
13351 * The possibles types that the items in a menu can be
13353 typedef enum _Elm_Web_Menu_Item_Type
13355 ELM_WEB_MENU_SEPARATOR,
13356 ELM_WEB_MENU_GROUP,
13357 ELM_WEB_MENU_OPTION
13358 } Elm_Web_Menu_Item_Type;
13361 * Structure describing the items in a menu
13363 typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13365 * Structure describing the items in a menu
13367 struct _Elm_Web_Menu_Item
13369 const char *text; /**< The text for the item */
13370 Elm_Web_Menu_Item_Type type; /**< The type of the item */
13374 * Structure describing the menu of a popup
13376 * This structure will be passed as the @c event_info for the "popup,create"
13377 * signal, which is emitted when a dropdown menu is opened. Users wanting
13378 * to handle these popups by themselves should listen to this signal and
13379 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13380 * property as @c EINA_FALSE means that the user will not handle the popup
13381 * and the default implementation will be used.
13383 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13384 * will be emitted to notify the user that it can destroy any objects and
13385 * free all data related to it.
13387 * @see elm_web_popup_selected_set()
13388 * @see elm_web_popup_destroy()
13390 typedef struct _Elm_Web_Menu Elm_Web_Menu;
13392 * Structure describing the menu of a popup
13394 * This structure will be passed as the @c event_info for the "popup,create"
13395 * signal, which is emitted when a dropdown menu is opened. Users wanting
13396 * to handle these popups by themselves should listen to this signal and
13397 * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13398 * property as @c EINA_FALSE means that the user will not handle the popup
13399 * and the default implementation will be used.
13401 * When the popup is ready to be dismissed, a "popup,willdelete" signal
13402 * will be emitted to notify the user that it can destroy any objects and
13403 * free all data related to it.
13405 * @see elm_web_popup_selected_set()
13406 * @see elm_web_popup_destroy()
13408 struct _Elm_Web_Menu
13410 Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13411 int x; /**< The X position of the popup, relative to the elm_web object */
13412 int y; /**< The Y position of the popup, relative to the elm_web object */
13413 int width; /**< Width of the popup menu */
13414 int height; /**< Height of the popup menu */
13416 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. */
13419 typedef struct _Elm_Web_Download Elm_Web_Download;
13420 struct _Elm_Web_Download
13426 * Types of zoom available.
13428 typedef enum _Elm_Web_Zoom_Mode
13430 ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13431 ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13432 ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13433 ELM_WEB_ZOOM_MODE_LAST
13434 } Elm_Web_Zoom_Mode;
13436 * Opaque handler containing the features (such as statusbar, menubar, etc)
13437 * that are to be set on a newly requested window.
13439 typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13441 * Callback type for the create_window hook.
13443 * The function parameters are:
13444 * @li @p data User data pointer set when setting the hook function
13445 * @li @p obj The elm_web object requesting the new window
13446 * @li @p js Set to @c EINA_TRUE if the request was originated from
13447 * JavaScript. @c EINA_FALSE otherwise.
13448 * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13449 * the features requested for the new window.
13451 * The returned value of the function should be the @c elm_web widget where
13452 * the request will be loaded. That is, if a new window or tab is created,
13453 * the elm_web widget in it should be returned, and @b NOT the window
13455 * Returning @c NULL should cancel the request.
13457 * @see elm_web_window_create_hook_set()
13459 typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13461 * Callback type for the JS alert hook.
13463 * The function parameters are:
13464 * @li @p data User data pointer set when setting the hook function
13465 * @li @p obj The elm_web object requesting the new window
13466 * @li @p message The message to show in the alert dialog
13468 * The function should return the object representing the alert dialog.
13469 * Elm_Web will run a second main loop to handle the dialog and normal
13470 * flow of the application will be restored when the object is deleted, so
13471 * the user should handle the popup properly in order to delete the object
13472 * when the action is finished.
13473 * If the function returns @c NULL the popup will be ignored.
13475 * @see elm_web_dialog_alert_hook_set()
13477 typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13479 * Callback type for the JS confirm hook.
13481 * The function parameters are:
13482 * @li @p data User data pointer set when setting the hook function
13483 * @li @p obj The elm_web object requesting the new window
13484 * @li @p message The message to show in the confirm dialog
13485 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13486 * the user selected @c Ok, @c EINA_FALSE otherwise.
13488 * The function should return the object representing the confirm dialog.
13489 * Elm_Web will run a second main loop to handle the dialog and normal
13490 * flow of the application will be restored when the object is deleted, so
13491 * the user should handle the popup properly in order to delete the object
13492 * when the action is finished.
13493 * If the function returns @c NULL the popup will be ignored.
13495 * @see elm_web_dialog_confirm_hook_set()
13497 typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13499 * Callback type for the JS prompt hook.
13501 * The function parameters are:
13502 * @li @p data User data pointer set when setting the hook function
13503 * @li @p obj The elm_web object requesting the new window
13504 * @li @p message The message to show in the prompt dialog
13505 * @li @p def_value The default value to present the user in the entry
13506 * @li @p value Pointer where to store the value given by the user. Must
13507 * be a malloc'ed string or @c NULL if the user cancelled the popup.
13508 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13509 * the user selected @c Ok, @c EINA_FALSE otherwise.
13511 * The function should return the object representing the prompt dialog.
13512 * Elm_Web will run a second main loop to handle the dialog and normal
13513 * flow of the application will be restored when the object is deleted, so
13514 * the user should handle the popup properly in order to delete the object
13515 * when the action is finished.
13516 * If the function returns @c NULL the popup will be ignored.
13518 * @see elm_web_dialog_prompt_hook_set()
13520 typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13522 * Callback type for the JS file selector hook.
13524 * The function parameters are:
13525 * @li @p data User data pointer set when setting the hook function
13526 * @li @p obj The elm_web object requesting the new window
13527 * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13528 * @li @p accept_types Mime types accepted
13529 * @li @p selected Pointer where to store the list of malloc'ed strings
13530 * containing the path to each file selected. Must be @c NULL if the file
13531 * dialog is cancelled
13532 * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13533 * the user selected @c Ok, @c EINA_FALSE otherwise.
13535 * The function should return the object representing the file selector
13537 * Elm_Web will run a second main loop to handle the dialog and normal
13538 * flow of the application will be restored when the object is deleted, so
13539 * the user should handle the popup properly in order to delete the object
13540 * when the action is finished.
13541 * If the function returns @c NULL the popup will be ignored.
13543 * @see elm_web_dialog_file selector_hook_set()
13545 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);
13547 * Callback type for the JS console message hook.
13549 * When a console message is added from JavaScript, any set function to the
13550 * console message hook will be called for the user to handle. There is no
13551 * default implementation of this hook.
13553 * The function parameters are:
13554 * @li @p data User data pointer set when setting the hook function
13555 * @li @p obj The elm_web object that originated the message
13556 * @li @p message The message sent
13557 * @li @p line_number The line number
13558 * @li @p source_id Source id
13560 * @see elm_web_console_message_hook_set()
13562 typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13564 * Add a new web object to the parent.
13566 * @param parent The parent object.
13567 * @return The new object or NULL if it cannot be created.
13569 * @see elm_web_uri_set()
13570 * @see elm_web_webkit_view_get()
13572 EAPI Evas_Object *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13575 * Get internal ewk_view object from web object.
13577 * Elementary may not provide some low level features of EWebKit,
13578 * instead of cluttering the API with proxy methods we opted to
13579 * return the internal reference. Be careful using it as it may
13580 * interfere with elm_web behavior.
13582 * @param obj The web object.
13583 * @return The internal ewk_view object or NULL if it does not
13584 * exist. (Failure to create or Elementary compiled without
13587 * @see elm_web_add()
13589 EAPI Evas_Object *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13592 * Sets the function to call when a new window is requested
13594 * This hook will be called when a request to create a new window is
13595 * issued from the web page loaded.
13596 * There is no default implementation for this feature, so leaving this
13597 * unset or passing @c NULL in @p func will prevent new windows from
13600 * @param obj The web object where to set the hook function
13601 * @param func The hook function to be called when a window is requested
13602 * @param data User data
13604 EAPI void elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13606 * Sets the function to call when an alert dialog
13608 * This hook will be called when a JavaScript alert dialog is requested.
13609 * If no function is set or @c NULL is passed in @p func, the default
13610 * implementation will take place.
13612 * @param obj The web object where to set the hook function
13613 * @param func The callback function to be used
13614 * @param data User data
13616 * @see elm_web_inwin_mode_set()
13618 EAPI void elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13620 * Sets the function to call when an confirm dialog
13622 * This hook will be called when a JavaScript confirm dialog is requested.
13623 * If no function is set or @c NULL is passed in @p func, the default
13624 * implementation will take place.
13626 * @param obj The web object where to set the hook function
13627 * @param func The callback function to be used
13628 * @param data User data
13630 * @see elm_web_inwin_mode_set()
13632 EAPI void elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13634 * Sets the function to call when an prompt dialog
13636 * This hook will be called when a JavaScript prompt dialog is requested.
13637 * If no function is set or @c NULL is passed in @p func, the default
13638 * implementation will take place.
13640 * @param obj The web object where to set the hook function
13641 * @param func The callback function to be used
13642 * @param data User data
13644 * @see elm_web_inwin_mode_set()
13646 EAPI void elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13648 * Sets the function to call when an file selector dialog
13650 * This hook will be called when a JavaScript file selector dialog is
13652 * If no function is set or @c NULL is passed in @p func, the default
13653 * implementation will take place.
13655 * @param obj The web object where to set the hook function
13656 * @param func The callback function to be used
13657 * @param data User data
13659 * @see elm_web_inwin_mode_set()
13661 EAPI void elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13663 * Sets the function to call when a console message is emitted from JS
13665 * This hook will be called when a console message is emitted from
13666 * JavaScript. There is no default implementation for this feature.
13668 * @param obj The web object where to set the hook function
13669 * @param func The callback function to be used
13670 * @param data User data
13672 EAPI void elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13674 * Gets the status of the tab propagation
13676 * @param obj The web object to query
13677 * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13679 * @see elm_web_tab_propagate_set()
13681 EAPI Eina_Bool elm_web_tab_propagate_get(const Evas_Object *obj);
13683 * Sets whether to use tab propagation
13685 * If tab propagation is enabled, whenever the user presses the Tab key,
13686 * Elementary will handle it and switch focus to the next widget.
13687 * The default value is disabled, where WebKit will handle the Tab key to
13688 * cycle focus though its internal objects, jumping to the next widget
13689 * only when that cycle ends.
13691 * @param obj The web object
13692 * @param propagate Whether to propagate Tab keys to Elementary or not
13694 EAPI void elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13696 * Sets the URI for the web object
13698 * It must be a full URI, with resource included, in the form
13699 * http://www.enlightenment.org or file:///tmp/something.html
13701 * @param obj The web object
13702 * @param uri The URI to set
13703 * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13705 EAPI Eina_Bool elm_web_uri_set(Evas_Object *obj, const char *uri);
13707 * Gets the current URI for the object
13709 * The returned string must not be freed and is guaranteed to be
13712 * @param obj The web object
13713 * @return A stringshared internal string with the current URI, or NULL on
13716 EAPI const char *elm_web_uri_get(const Evas_Object *obj);
13718 * Gets the current title
13720 * The returned string must not be freed and is guaranteed to be
13723 * @param obj The web object
13724 * @return A stringshared internal string with the current title, or NULL on
13727 EAPI const char *elm_web_title_get(const Evas_Object *obj);
13729 * Sets the background color to be used by the web object
13731 * This is the color that will be used by default when the loaded page
13732 * does not set it's own. Color values are pre-multiplied.
13734 * @param obj The web object
13735 * @param r Red component
13736 * @param g Green component
13737 * @param b Blue component
13738 * @param a Alpha component
13740 EAPI void elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13742 * Gets the background color to be used by the web object
13744 * This is the color that will be used by default when the loaded page
13745 * does not set it's own. Color values are pre-multiplied.
13747 * @param obj The web object
13748 * @param r Red component
13749 * @param g Green component
13750 * @param b Blue component
13751 * @param a Alpha component
13753 EAPI void elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13755 * Gets a copy of the currently selected text
13757 * The string returned must be freed by the user when it's done with it.
13759 * @param obj The web object
13760 * @return A newly allocated string, or NULL if nothing is selected or an
13763 EAPI char *elm_view_selection_get(const Evas_Object *obj);
13765 * Tells the web object which index in the currently open popup was selected
13767 * When the user handles the popup creation from the "popup,created" signal,
13768 * it needs to tell the web object which item was selected by calling this
13769 * function with the index corresponding to the item.
13771 * @param obj The web object
13772 * @param index The index selected
13774 * @see elm_web_popup_destroy()
13776 EAPI void elm_web_popup_selected_set(Evas_Object *obj, int index);
13778 * Dismisses an open dropdown popup
13780 * When the popup from a dropdown widget is to be dismissed, either after
13781 * selecting an option or to cancel it, this function must be called, which
13782 * will later emit an "popup,willdelete" signal to notify the user that
13783 * any memory and objects related to this popup can be freed.
13785 * @param obj The web object
13786 * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13787 * if there was no menu to destroy
13789 EAPI Eina_Bool elm_web_popup_destroy(Evas_Object *obj);
13791 * Searches the given string in a document.
13793 * @param obj The web object where to search the text
13794 * @param string String to search
13795 * @param case_sensitive If search should be case sensitive or not
13796 * @param forward If search is from cursor and on or backwards
13797 * @param wrap If search should wrap at the end
13799 * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13802 EAPI Eina_Bool elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13804 * Marks matches of the given string in a document.
13806 * @param obj The web object where to search text
13807 * @param string String to match
13808 * @param case_sensitive If match should be case sensitive or not
13809 * @param highlight If matches should be highlighted
13810 * @param limit Maximum amount of matches, or zero to unlimited
13812 * @return number of matched @a string
13814 EAPI unsigned int elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13816 * Clears all marked matches in the document
13818 * @param obj The web object
13820 * @return EINA_TRUE on success, EINA_FALSE otherwise
13822 EAPI Eina_Bool elm_web_text_matches_unmark_all(Evas_Object *obj);
13824 * Sets whether to highlight the matched marks
13826 * If enabled, marks set with elm_web_text_matches_mark() will be
13829 * @param obj The web object
13830 * @param highlight Whether to highlight the marks or not
13832 * @return EINA_TRUE on success, EINA_FALSE otherwise
13834 EAPI Eina_Bool elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13836 * Gets whether highlighting marks is enabled
13838 * @param The web object
13840 * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13843 EAPI Eina_Bool elm_web_text_matches_highlight_get(const Evas_Object *obj);
13845 * Gets the overall loading progress of the page
13847 * Returns the estimated loading progress of the page, with a value between
13848 * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13849 * included in the page.
13851 * @param The web object
13853 * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13856 EAPI double elm_web_load_progress_get(const Evas_Object *obj);
13858 * Stops loading the current page
13860 * Cancels the loading of the current page in the web object. This will
13861 * cause a "load,error" signal to be emitted, with the is_cancellation
13862 * flag set to EINA_TRUE.
13864 * @param obj The web object
13866 * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13868 EAPI Eina_Bool elm_web_stop(Evas_Object *obj);
13870 * Requests a reload of the current document in the object
13872 * @param obj The web object
13874 * @return EINA_TRUE on success, EINA_FALSE otherwise
13876 EAPI Eina_Bool elm_web_reload(Evas_Object *obj);
13878 * Requests a reload of the current document, avoiding any existing caches
13880 * @param obj The web object
13882 * @return EINA_TRUE on success, EINA_FALSE otherwise
13884 EAPI Eina_Bool elm_web_reload_full(Evas_Object *obj);
13886 * Goes back one step in the browsing history
13888 * This is equivalent to calling elm_web_object_navigate(obj, -1);
13890 * @param obj The web object
13892 * @return EINA_TRUE on success, EINA_FALSE otherwise
13894 * @see elm_web_history_enable_set()
13895 * @see elm_web_back_possible()
13896 * @see elm_web_forward()
13897 * @see elm_web_navigate()
13899 EAPI Eina_Bool elm_web_back(Evas_Object *obj);
13901 * Goes forward one step in the browsing history
13903 * This is equivalent to calling elm_web_object_navigate(obj, 1);
13905 * @param obj The web object
13907 * @return EINA_TRUE on success, EINA_FALSE otherwise
13909 * @see elm_web_history_enable_set()
13910 * @see elm_web_forward_possible()
13911 * @see elm_web_back()
13912 * @see elm_web_navigate()
13914 EAPI Eina_Bool elm_web_forward(Evas_Object *obj);
13916 * Jumps the given number of steps in the browsing history
13918 * The @p steps value can be a negative integer to back in history, or a
13919 * positive to move forward.
13921 * @param obj The web object
13922 * @param steps The number of steps to jump
13924 * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13925 * history exists to jump the given number of steps
13927 * @see elm_web_history_enable_set()
13928 * @see elm_web_navigate_possible()
13929 * @see elm_web_back()
13930 * @see elm_web_forward()
13932 EAPI Eina_Bool elm_web_navigate(Evas_Object *obj, int steps);
13934 * Queries whether it's possible to go back in history
13936 * @param obj The web object
13938 * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13941 EAPI Eina_Bool elm_web_back_possible(Evas_Object *obj);
13943 * Queries whether it's possible to go forward in history
13945 * @param obj The web object
13947 * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13950 EAPI Eina_Bool elm_web_forward_possible(Evas_Object *obj);
13952 * Queries whether it's possible to jump the given number of steps
13954 * The @p steps value can be a negative integer to back in history, or a
13955 * positive to move forward.
13957 * @param obj The web object
13958 * @param steps The number of steps to check for
13960 * @return EINA_TRUE if enough history exists to perform the given jump,
13961 * EINA_FALSE otherwise
13963 EAPI Eina_Bool elm_web_navigate_possible(Evas_Object *obj, int steps);
13965 * Gets whether browsing history is enabled for the given object
13967 * @param obj The web object
13969 * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13971 EAPI Eina_Bool elm_web_history_enable_get(const Evas_Object *obj);
13973 * Enables or disables the browsing history
13975 * @param obj The web object
13976 * @param enable Whether to enable or disable the browsing history
13978 EAPI void elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13980 * Sets the zoom level of the web object
13982 * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
13983 * values meaning zoom in and lower meaning zoom out. This function will
13984 * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
13985 * is ::ELM_WEB_ZOOM_MODE_MANUAL.
13987 * @param obj The web object
13988 * @param zoom The zoom level to set
13990 EAPI void elm_web_zoom_set(Evas_Object *obj, double zoom);
13992 * Gets the current zoom level set on the web object
13994 * Note that this is the zoom level set on the web object and not that
13995 * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
13996 * the two zoom levels should match, but for the other two modes the
13997 * Webkit zoom is calculated internally to match the chosen mode without
13998 * changing the zoom level set for the web object.
14000 * @param obj The web object
14002 * @return The zoom level set on the object
14004 EAPI double elm_web_zoom_get(const Evas_Object *obj);
14006 * Sets the zoom mode to use
14008 * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
14009 * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
14011 * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
14012 * with the elm_web_zoom_set() function.
14013 * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14014 * make sure the entirety of the web object's contents are shown.
14015 * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14016 * fit the contents in the web object's size, without leaving any space
14019 * @param obj The web object
14020 * @param mode The mode to set
14022 EAPI void elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
14024 * Gets the currently set zoom mode
14026 * @param obj The web object
14028 * @return The current zoom mode set for the object, or
14029 * ::ELM_WEB_ZOOM_MODE_LAST on error
14031 EAPI Elm_Web_Zoom_Mode elm_web_zoom_mode_get(const Evas_Object *obj);
14033 * Shows the given region in the web object
14035 * @param obj The web object
14036 * @param x The x coordinate of the region to show
14037 * @param y The y coordinate of the region to show
14038 * @param w The width of the region to show
14039 * @param h The height of the region to show
14041 EAPI void elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14043 * Brings in the region to the visible area
14045 * Like elm_web_region_show(), but it animates the scrolling of the object
14048 * @param obj The web object
14049 * @param x The x coordinate of the region to show
14050 * @param y The y coordinate of the region to show
14051 * @param w The width of the region to show
14052 * @param h The height of the region to show
14054 EAPI void elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
14056 * Sets the default dialogs to use an Inwin instead of a normal window
14058 * If set, then the default implementation for the JavaScript dialogs and
14059 * file selector will be opened in an Inwin. Otherwise they will use a
14060 * normal separated window.
14062 * @param obj The web object
14063 * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
14065 EAPI void elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
14067 * Gets whether Inwin mode is set for the current object
14069 * @param obj The web object
14071 * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
14073 EAPI Eina_Bool elm_web_inwin_mode_get(const Evas_Object *obj);
14075 EAPI void elm_web_window_features_ref(Elm_Web_Window_Features *wf);
14076 EAPI void elm_web_window_features_unref(Elm_Web_Window_Features *wf);
14077 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);
14078 EAPI void elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14085 * @defgroup Hoversel Hoversel
14087 * @image html img/widget/hoversel/preview-00.png
14088 * @image latex img/widget/hoversel/preview-00.eps
14090 * A hoversel is a button that pops up a list of items (automatically
14091 * choosing the direction to display) that have a label and, optionally, an
14092 * icon to select from. It is a convenience widget to avoid the need to do
14093 * all the piecing together yourself. It is intended for a small number of
14094 * items in the hoversel menu (no more than 8), though is capable of many
14097 * Signals that you can add callbacks for are:
14098 * "clicked" - the user clicked the hoversel button and popped up the sel
14099 * "selected" - an item in the hoversel list is selected. event_info is the item
14100 * "dismissed" - the hover is dismissed
14102 * See @ref tutorial_hoversel for an example.
14105 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14107 * @brief Add a new Hoversel object
14109 * @param parent The parent object
14110 * @return The new object or NULL if it cannot be created
14112 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14114 * @brief This sets the hoversel to expand horizontally.
14116 * @param obj The hoversel object
14117 * @param horizontal If true, the hover will expand horizontally to the
14120 * @note The initial button will display horizontally regardless of this
14123 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14125 * @brief This returns whether the hoversel is set to expand horizontally.
14127 * @param obj The hoversel object
14128 * @return If true, the hover will expand horizontally to the right.
14130 * @see elm_hoversel_horizontal_set()
14132 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14134 * @brief Set the Hover parent
14136 * @param obj The hoversel object
14137 * @param parent The parent to use
14139 * Sets the hover parent object, the area that will be darkened when the
14140 * hoversel is clicked. Should probably be the window that the hoversel is
14141 * in. See @ref Hover objects for more information.
14143 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14145 * @brief Get the Hover parent
14147 * @param obj The hoversel object
14148 * @return The used parent
14150 * Gets the hover parent object.
14152 * @see elm_hoversel_hover_parent_set()
14154 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14156 * @brief Set the hoversel button label
14158 * @param obj The hoversel object
14159 * @param label The label text.
14161 * This sets the label of the button that is always visible (before it is
14162 * clicked and expanded).
14164 * @deprecated elm_object_text_set()
14166 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14168 * @brief Get the hoversel button label
14170 * @param obj The hoversel object
14171 * @return The label text.
14173 * @deprecated elm_object_text_get()
14175 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14177 * @brief Set the icon of the hoversel button
14179 * @param obj The hoversel object
14180 * @param icon The icon object
14182 * Sets the icon of the button that is always visible (before it is clicked
14183 * and expanded). Once the icon object is set, a previously set one will be
14184 * deleted, if you want to keep that old content object, use the
14185 * elm_hoversel_icon_unset() function.
14187 * @see elm_object_content_set() for the button widget
14189 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14191 * @brief Get the icon of the hoversel button
14193 * @param obj The hoversel object
14194 * @return The icon object
14196 * Get the icon of the button that is always visible (before it is clicked
14197 * and expanded). Also see elm_object_content_get() for the button widget.
14199 * @see elm_hoversel_icon_set()
14201 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14203 * @brief Get and unparent the icon of the hoversel button
14205 * @param obj The hoversel object
14206 * @return The icon object that was being used
14208 * Unparent and return the icon of the button that is always visible
14209 * (before it is clicked and expanded).
14211 * @see elm_hoversel_icon_set()
14212 * @see elm_object_content_unset() for the button widget
14214 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14216 * @brief This triggers the hoversel popup from code, the same as if the user
14217 * had clicked the button.
14219 * @param obj The hoversel object
14221 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14223 * @brief This dismisses the hoversel popup as if the user had clicked
14224 * outside the hover.
14226 * @param obj The hoversel object
14228 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14230 * @brief Returns whether the hoversel is expanded.
14232 * @param obj The hoversel object
14233 * @return This will return EINA_TRUE if the hoversel is expanded or
14234 * EINA_FALSE if it is not expanded.
14236 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14238 * @brief This will remove all the children items from the hoversel.
14240 * @param obj The hoversel object
14242 * @warning Should @b not be called while the hoversel is active; use
14243 * elm_hoversel_expanded_get() to check first.
14245 * @see elm_hoversel_item_del_cb_set()
14246 * @see elm_hoversel_item_del()
14248 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14250 * @brief Get the list of items within the given hoversel.
14252 * @param obj The hoversel object
14253 * @return Returns a list of Elm_Hoversel_Item*
14255 * @see elm_hoversel_item_add()
14257 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14259 * @brief Add an item to the hoversel button
14261 * @param obj The hoversel object
14262 * @param label The text label to use for the item (NULL if not desired)
14263 * @param icon_file An image file path on disk to use for the icon or standard
14264 * icon name (NULL if not desired)
14265 * @param icon_type The icon type if relevant
14266 * @param func Convenience function to call when this item is selected
14267 * @param data Data to pass to item-related functions
14268 * @return A handle to the item added.
14270 * This adds an item to the hoversel to show when it is clicked. Note: if you
14271 * need to use an icon from an edje file then use
14272 * elm_hoversel_item_icon_set() right after the this function, and set
14273 * icon_file to NULL here.
14275 * For more information on what @p icon_file and @p icon_type are see the
14276 * @ref Icon "icon documentation".
14278 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);
14280 * @brief Delete an item from the hoversel
14282 * @param item The item to delete
14284 * This deletes the item from the hoversel (should not be called while the
14285 * hoversel is active; use elm_hoversel_expanded_get() to check first).
14287 * @see elm_hoversel_item_add()
14288 * @see elm_hoversel_item_del_cb_set()
14290 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14292 * @brief Set the function to be called when an item from the hoversel is
14295 * @param item The item to set the callback on
14296 * @param func The function called
14298 * That function will receive these parameters:
14299 * @li void *item_data
14300 * @li Evas_Object *the_item_object
14301 * @li Elm_Hoversel_Item *the_object_struct
14303 * @see elm_hoversel_item_add()
14305 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14307 * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14308 * that will be passed to associated function callbacks.
14310 * @param item The item to get the data from
14311 * @return The data pointer set with elm_hoversel_item_add()
14313 * @see elm_hoversel_item_add()
14315 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14317 * @brief This returns the label text of the given hoversel item.
14319 * @param item The item to get the label
14320 * @return The label text of the hoversel item
14322 * @see elm_hoversel_item_add()
14324 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14326 * @brief This sets the icon for the given hoversel item.
14328 * @param item The item to set the icon
14329 * @param icon_file An image file path on disk to use for the icon or standard
14331 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14332 * to NULL if the icon is not an edje file
14333 * @param icon_type The icon type
14335 * The icon can be loaded from the standard set, from an image file, or from
14338 * @see elm_hoversel_item_add()
14340 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);
14342 * @brief Get the icon object of the hoversel item
14344 * @param item The item to get the icon from
14345 * @param icon_file The image file path on disk used for the icon or standard
14347 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14348 * if the icon is not an edje file
14349 * @param icon_type The icon type
14351 * @see elm_hoversel_item_icon_set()
14352 * @see elm_hoversel_item_add()
14354 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);
14360 * @defgroup Toolbar Toolbar
14361 * @ingroup Elementary
14363 * @image html img/widget/toolbar/preview-00.png
14364 * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14366 * @image html img/toolbar.png
14367 * @image latex img/toolbar.eps width=\textwidth
14369 * A toolbar is a widget that displays a list of items inside
14370 * a box. It can be scrollable, show a menu with items that don't fit
14371 * to toolbar size or even crop them.
14373 * Only one item can be selected at a time.
14375 * Items can have multiple states, or show menus when selected by the user.
14377 * Smart callbacks one can listen to:
14378 * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14379 * - "language,changed" - when the program language changes
14381 * Available styles for it:
14383 * - @c "transparent" - no background or shadow, just show the content
14385 * List of examples:
14386 * @li @ref toolbar_example_01
14387 * @li @ref toolbar_example_02
14388 * @li @ref toolbar_example_03
14392 * @addtogroup Toolbar
14397 * @enum _Elm_Toolbar_Shrink_Mode
14398 * @typedef Elm_Toolbar_Shrink_Mode
14400 * Set toolbar's items display behavior, it can be scrollabel,
14401 * show a menu with exceeding items, or simply hide them.
14403 * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14406 * Values <b> don't </b> work as bitmask, only one can be choosen.
14408 * @see elm_toolbar_mode_shrink_set()
14409 * @see elm_toolbar_mode_shrink_get()
14413 typedef enum _Elm_Toolbar_Shrink_Mode
14415 ELM_TOOLBAR_SHRINK_NONE, /**< Set toolbar minimun size to fit all the items. */
14416 ELM_TOOLBAR_SHRINK_HIDE, /**< Hide exceeding items. */
14417 ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14418 ELM_TOOLBAR_SHRINK_MENU, /**< Inserts a button to pop up a menu with exceeding items. */
14419 ELM_TOOLBAR_SHRINK_LAST /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14420 } Elm_Toolbar_Shrink_Mode;
14422 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(). */
14424 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(). */
14427 * Add a new toolbar widget to the given parent Elementary
14428 * (container) object.
14430 * @param parent The parent object.
14431 * @return a new toolbar widget handle or @c NULL, on errors.
14433 * This function inserts a new toolbar widget on the canvas.
14437 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14440 * Set the icon size, in pixels, to be used by toolbar items.
14442 * @param obj The toolbar object
14443 * @param icon_size The icon size in pixels
14445 * @note Default value is @c 32. It reads value from elm config.
14447 * @see elm_toolbar_icon_size_get()
14451 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14454 * Get the icon size, in pixels, to be used by toolbar items.
14456 * @param obj The toolbar object.
14457 * @return The icon size in pixels.
14459 * @see elm_toolbar_icon_size_set() for details.
14463 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14466 * Sets icon lookup order, for toolbar items' icons.
14468 * @param obj The toolbar object.
14469 * @param order The icon lookup order.
14471 * Icons added before calling this function will not be affected.
14472 * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14474 * @see elm_toolbar_icon_order_lookup_get()
14478 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14481 * Gets the icon lookup order.
14483 * @param obj The toolbar object.
14484 * @return The icon lookup order.
14486 * @see elm_toolbar_icon_order_lookup_set() for details.
14490 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14493 * Set whether the toolbar should always have an item selected.
14495 * @param obj The toolbar object.
14496 * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14499 * This will cause the toolbar to always have an item selected, and clicking
14500 * the selected item will not cause a selected event to be emitted. Enabling this mode
14501 * will immediately select the first toolbar item.
14503 * Always-selected is disabled by default.
14505 * @see elm_toolbar_always_select_mode_get().
14509 EAPI void elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14512 * Get whether the toolbar should always have an item selected.
14514 * @param obj The toolbar object.
14515 * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14516 * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14518 * @see elm_toolbar_always_select_mode_set() for details.
14522 EAPI Eina_Bool elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14525 * Set whether the toolbar items' should be selected by the user or not.
14527 * @param obj The toolbar object.
14528 * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14531 * This will turn off the ability to select items entirely and they will
14532 * neither appear selected nor emit selected signals. The clicked
14533 * callback function will still be called.
14535 * Selection is enabled by default.
14537 * @see elm_toolbar_no_select_mode_get().
14541 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14544 * Set whether the toolbar items' should be selected by the user or not.
14546 * @param obj The toolbar object.
14547 * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14548 * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14550 * @see elm_toolbar_no_select_mode_set() for details.
14554 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14557 * Append item to the toolbar.
14559 * @param obj The toolbar object.
14560 * @param icon A string with icon name or the absolute path of an image file.
14561 * @param label The label of the item.
14562 * @param func The function to call when the item is clicked.
14563 * @param data The data to associate with the item for related callbacks.
14564 * @return The created item or @c NULL upon failure.
14566 * A new item will be created and appended to the toolbar, i.e., will
14567 * be set as @b last item.
14569 * Items created with this method can be deleted with
14570 * elm_toolbar_item_del().
14572 * Associated @p data can be properly freed when item is deleted if a
14573 * callback function is set with elm_toolbar_item_del_cb_set().
14575 * If a function is passed as argument, it will be called everytime this item
14576 * is selected, i.e., the user clicks over an unselected item.
14577 * If such function isn't needed, just passing
14578 * @c NULL as @p func is enough. The same should be done for @p data.
14580 * Toolbar will load icon image from fdo or current theme.
14581 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14582 * If an absolute path is provided it will load it direct from a file.
14584 * @see elm_toolbar_item_icon_set()
14585 * @see elm_toolbar_item_del()
14586 * @see elm_toolbar_item_del_cb_set()
14590 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);
14593 * Prepend item to the toolbar.
14595 * @param obj The toolbar object.
14596 * @param icon A string with icon name or the absolute path of an image file.
14597 * @param label The label of the item.
14598 * @param func The function to call when the item is clicked.
14599 * @param data The data to associate with the item for related callbacks.
14600 * @return The created item or @c NULL upon failure.
14602 * A new item will be created and prepended to the toolbar, i.e., will
14603 * be set as @b first item.
14605 * Items created with this method can be deleted with
14606 * elm_toolbar_item_del().
14608 * Associated @p data can be properly freed when item is deleted if a
14609 * callback function is set with elm_toolbar_item_del_cb_set().
14611 * If a function is passed as argument, it will be called everytime this item
14612 * is selected, i.e., the user clicks over an unselected item.
14613 * If such function isn't needed, just passing
14614 * @c NULL as @p func is enough. The same should be done for @p data.
14616 * Toolbar will load icon image from fdo or current theme.
14617 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14618 * If an absolute path is provided it will load it direct from a file.
14620 * @see elm_toolbar_item_icon_set()
14621 * @see elm_toolbar_item_del()
14622 * @see elm_toolbar_item_del_cb_set()
14626 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);
14629 * Insert a new item into the toolbar object before item @p before.
14631 * @param obj The toolbar object.
14632 * @param before The toolbar item to insert before.
14633 * @param icon A string with icon name or the absolute path of an image file.
14634 * @param label The label of the item.
14635 * @param func The function to call when the item is clicked.
14636 * @param data The data to associate with the item for related callbacks.
14637 * @return The created item or @c NULL upon failure.
14639 * A new item will be created and added to the toolbar. Its position in
14640 * this toolbar will be just before item @p before.
14642 * Items created with this method can be deleted with
14643 * elm_toolbar_item_del().
14645 * Associated @p data can be properly freed when item is deleted if a
14646 * callback function is set with elm_toolbar_item_del_cb_set().
14648 * If a function is passed as argument, it will be called everytime this item
14649 * is selected, i.e., the user clicks over an unselected item.
14650 * If such function isn't needed, just passing
14651 * @c NULL as @p func is enough. The same should be done for @p data.
14653 * Toolbar will load icon image from fdo or current theme.
14654 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14655 * If an absolute path is provided it will load it direct from a file.
14657 * @see elm_toolbar_item_icon_set()
14658 * @see elm_toolbar_item_del()
14659 * @see elm_toolbar_item_del_cb_set()
14663 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);
14666 * Insert a new item into the toolbar object after item @p after.
14668 * @param obj The toolbar object.
14669 * @param after The toolbar item to insert after.
14670 * @param icon A string with icon name or the absolute path of an image file.
14671 * @param label The label of the item.
14672 * @param func The function to call when the item is clicked.
14673 * @param data The data to associate with the item for related callbacks.
14674 * @return The created item or @c NULL upon failure.
14676 * A new item will be created and added to the toolbar. Its position in
14677 * this toolbar will be just after item @p after.
14679 * Items created with this method can be deleted with
14680 * elm_toolbar_item_del().
14682 * Associated @p data can be properly freed when item is deleted if a
14683 * callback function is set with elm_toolbar_item_del_cb_set().
14685 * If a function is passed as argument, it will be called everytime this item
14686 * is selected, i.e., the user clicks over an unselected item.
14687 * If such function isn't needed, just passing
14688 * @c NULL as @p func is enough. The same should be done for @p data.
14690 * Toolbar will load icon image from fdo or current theme.
14691 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14692 * If an absolute path is provided it will load it direct from a file.
14694 * @see elm_toolbar_item_icon_set()
14695 * @see elm_toolbar_item_del()
14696 * @see elm_toolbar_item_del_cb_set()
14700 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);
14703 * Get the first item in the given toolbar widget's list of
14706 * @param obj The toolbar object
14707 * @return The first item or @c NULL, if it has no items (and on
14710 * @see elm_toolbar_item_append()
14711 * @see elm_toolbar_last_item_get()
14715 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14718 * Get the last item in the given toolbar widget's list of
14721 * @param obj The toolbar object
14722 * @return The last item or @c NULL, if it has no items (and on
14725 * @see elm_toolbar_item_prepend()
14726 * @see elm_toolbar_first_item_get()
14730 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14733 * Get the item after @p item in toolbar.
14735 * @param item The toolbar item.
14736 * @return The item after @p item, or @c NULL if none or on failure.
14738 * @note If it is the last item, @c NULL will be returned.
14740 * @see elm_toolbar_item_append()
14744 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14747 * Get the item before @p item in toolbar.
14749 * @param item The toolbar item.
14750 * @return The item before @p item, or @c NULL if none or on failure.
14752 * @note If it is the first item, @c NULL will be returned.
14754 * @see elm_toolbar_item_prepend()
14758 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14761 * Get the toolbar object from an item.
14763 * @param item The item.
14764 * @return The toolbar object.
14766 * This returns the toolbar object itself that an item belongs to.
14770 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14773 * Set the priority of a toolbar item.
14775 * @param item The toolbar item.
14776 * @param priority The item priority. The default is zero.
14778 * This is used only when the toolbar shrink mode is set to
14779 * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14780 * When space is less than required, items with low priority
14781 * will be removed from the toolbar and added to a dynamically-created menu,
14782 * while items with higher priority will remain on the toolbar,
14783 * with the same order they were added.
14785 * @see elm_toolbar_item_priority_get()
14789 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14792 * Get the priority of a toolbar item.
14794 * @param item The toolbar item.
14795 * @return The @p item priority, or @c 0 on failure.
14797 * @see elm_toolbar_item_priority_set() for details.
14801 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14804 * Get the label of item.
14806 * @param item The item of toolbar.
14807 * @return The label of item.
14809 * The return value is a pointer to the label associated to @p item when
14810 * it was created, with function elm_toolbar_item_append() or similar,
14812 * with function elm_toolbar_item_label_set. If no label
14813 * was passed as argument, it will return @c NULL.
14815 * @see elm_toolbar_item_label_set() for more details.
14816 * @see elm_toolbar_item_append()
14820 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14823 * Set the label of item.
14825 * @param item The item of toolbar.
14826 * @param text The label of item.
14828 * The label to be displayed by the item.
14829 * Label will be placed at icons bottom (if set).
14831 * If a label was passed as argument on item creation, with function
14832 * elm_toolbar_item_append() or similar, it will be already
14833 * displayed by the item.
14835 * @see elm_toolbar_item_label_get()
14836 * @see elm_toolbar_item_append()
14840 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14843 * Return the data associated with a given toolbar widget item.
14845 * @param item The toolbar widget item handle.
14846 * @return The data associated with @p item.
14848 * @see elm_toolbar_item_data_set()
14852 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14855 * Set the data associated with a given toolbar widget item.
14857 * @param item The toolbar widget item handle.
14858 * @param data The new data pointer to set to @p item.
14860 * This sets new item data on @p item.
14862 * @warning The old data pointer won't be touched by this function, so
14863 * the user had better to free that old data himself/herself.
14867 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14870 * Returns a pointer to a toolbar item by its label.
14872 * @param obj The toolbar object.
14873 * @param label The label of the item to find.
14875 * @return The pointer to the toolbar item matching @p label or @c NULL
14880 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14883 * Get whether the @p item is selected or not.
14885 * @param item The toolbar item.
14886 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14887 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14889 * @see elm_toolbar_selected_item_set() for details.
14890 * @see elm_toolbar_item_selected_get()
14894 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14897 * Set the selected state of an item.
14899 * @param item The toolbar item
14900 * @param selected The selected state
14902 * This sets the selected state of the given item @p it.
14903 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14905 * If a new item is selected the previosly selected will be unselected.
14906 * Previoulsy selected item can be get with function
14907 * elm_toolbar_selected_item_get().
14909 * Selected items will be highlighted.
14911 * @see elm_toolbar_item_selected_get()
14912 * @see elm_toolbar_selected_item_get()
14916 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14919 * Get the selected item.
14921 * @param obj The toolbar object.
14922 * @return The selected toolbar item.
14924 * The selected item can be unselected with function
14925 * elm_toolbar_item_selected_set().
14927 * The selected item always will be highlighted on toolbar.
14929 * @see elm_toolbar_selected_items_get()
14933 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14936 * Set the icon associated with @p item.
14938 * @param obj The parent of this item.
14939 * @param item The toolbar item.
14940 * @param icon A string with icon name or the absolute path of an image file.
14942 * Toolbar will load icon image from fdo or current theme.
14943 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14944 * If an absolute path is provided it will load it direct from a file.
14946 * @see elm_toolbar_icon_order_lookup_set()
14947 * @see elm_toolbar_icon_order_lookup_get()
14951 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14954 * Get the string used to set the icon of @p item.
14956 * @param item The toolbar item.
14957 * @return The string associated with the icon object.
14959 * @see elm_toolbar_item_icon_set() for details.
14963 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14966 * Get the object of @p item.
14968 * @param item The toolbar item.
14969 * @return The object
14973 EAPI Evas_Object *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14976 * Get the icon object of @p item.
14978 * @param item The toolbar item.
14979 * @return The icon object
14981 * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14985 EAPI Evas_Object *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14988 * Set the icon associated with @p item to an image in a binary buffer.
14990 * @param item The toolbar item.
14991 * @param img The binary data that will be used as an image
14992 * @param size The size of binary data @p img
14993 * @param format Optional format of @p img to pass to the image loader
14994 * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
14996 * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
14998 * @note The icon image set by this function can be changed by
14999 * elm_toolbar_item_icon_set().
15003 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);
15006 * Delete them item from the toolbar.
15008 * @param item The item of toolbar to be deleted.
15010 * @see elm_toolbar_item_append()
15011 * @see elm_toolbar_item_del_cb_set()
15015 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15018 * Set the function called when a toolbar item is freed.
15020 * @param item The item to set the callback on.
15021 * @param func The function called.
15023 * If there is a @p func, then it will be called prior item's memory release.
15024 * That will be called with the following arguments:
15026 * @li item's Evas object;
15029 * This way, a data associated to a toolbar item could be properly freed.
15033 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15036 * Get a value whether toolbar item is disabled or not.
15038 * @param item The item.
15039 * @return The disabled state.
15041 * @see elm_toolbar_item_disabled_set() for more details.
15045 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15048 * Sets the disabled/enabled state of a toolbar item.
15050 * @param item The item.
15051 * @param disabled The disabled state.
15053 * A disabled item cannot be selected or unselected. It will also
15054 * change its appearance (generally greyed out). This sets the
15055 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15060 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15063 * Set or unset item as a separator.
15065 * @param item The toolbar item.
15066 * @param setting @c EINA_TRUE to set item @p item as separator or
15067 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15069 * Items aren't set as separator by default.
15071 * If set as separator it will display separator theme, so won't display
15074 * @see elm_toolbar_item_separator_get()
15078 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
15081 * Get a value whether item is a separator or not.
15083 * @param item The toolbar item.
15084 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15085 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15087 * @see elm_toolbar_item_separator_set() for details.
15091 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15094 * Set the shrink state of toolbar @p obj.
15096 * @param obj The toolbar object.
15097 * @param shrink_mode Toolbar's items display behavior.
15099 * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15100 * but will enforce a minimun size so all the items will fit, won't scroll
15101 * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15102 * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15103 * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15107 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15110 * Get the shrink mode of toolbar @p obj.
15112 * @param obj The toolbar object.
15113 * @return Toolbar's items display behavior.
15115 * @see elm_toolbar_mode_shrink_set() for details.
15119 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15122 * Enable/disable homogenous mode.
15124 * @param obj The toolbar object
15125 * @param homogeneous Assume the items within the toolbar are of the
15126 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15128 * This will enable the homogeneous mode where items are of the same size.
15129 * @see elm_toolbar_homogeneous_get()
15133 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15136 * Get whether the homogenous mode is enabled.
15138 * @param obj The toolbar object.
15139 * @return Assume the items within the toolbar are of the same height
15140 * and width (EINA_TRUE = on, EINA_FALSE = off).
15142 * @see elm_toolbar_homogeneous_set()
15146 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15149 * Enable/disable homogenous mode.
15151 * @param obj The toolbar object
15152 * @param homogeneous Assume the items within the toolbar are of the
15153 * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15155 * This will enable the homogeneous mode where items are of the same size.
15156 * @see elm_toolbar_homogeneous_get()
15158 * @deprecated use elm_toolbar_homogeneous_set() instead.
15162 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
15165 * Get whether the homogenous mode is enabled.
15167 * @param obj The toolbar object.
15168 * @return Assume the items within the toolbar are of the same height
15169 * and width (EINA_TRUE = on, EINA_FALSE = off).
15171 * @see elm_toolbar_homogeneous_set()
15172 * @deprecated use elm_toolbar_homogeneous_get() instead.
15176 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15179 * Set the parent object of the toolbar items' menus.
15181 * @param obj The toolbar object.
15182 * @param parent The parent of the menu objects.
15184 * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15186 * For more details about setting the parent for toolbar menus, see
15187 * elm_menu_parent_set().
15189 * @see elm_menu_parent_set() for details.
15190 * @see elm_toolbar_item_menu_set() for details.
15194 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15197 * Get the parent object of the toolbar items' menus.
15199 * @param obj The toolbar object.
15200 * @return The parent of the menu objects.
15202 * @see elm_toolbar_menu_parent_set() for details.
15206 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15209 * Set the alignment of the items.
15211 * @param obj The toolbar object.
15212 * @param align The new alignment, a float between <tt> 0.0 </tt>
15213 * and <tt> 1.0 </tt>.
15215 * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15216 * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15219 * Centered items by default.
15221 * @see elm_toolbar_align_get()
15225 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15228 * Get the alignment of the items.
15230 * @param obj The toolbar object.
15231 * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15234 * @see elm_toolbar_align_set() for details.
15238 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15241 * Set whether the toolbar item opens a menu.
15243 * @param item The toolbar item.
15244 * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15246 * A toolbar item can be set to be a menu, using this function.
15248 * Once it is set to be a menu, it can be manipulated through the
15249 * menu-like function elm_toolbar_menu_parent_set() and the other
15250 * elm_menu functions, using the Evas_Object @c menu returned by
15251 * elm_toolbar_item_menu_get().
15253 * So, items to be displayed in this item's menu should be added with
15254 * elm_menu_item_add().
15256 * The following code exemplifies the most basic usage:
15258 * tb = elm_toolbar_add(win)
15259 * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15260 * elm_toolbar_item_menu_set(item, EINA_TRUE);
15261 * elm_toolbar_menu_parent_set(tb, win);
15262 * menu = elm_toolbar_item_menu_get(item);
15263 * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15264 * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15268 * @see elm_toolbar_item_menu_get()
15272 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15275 * Get toolbar item's menu.
15277 * @param item The toolbar item.
15278 * @return Item's menu object or @c NULL on failure.
15280 * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15281 * this function will set it.
15283 * @see elm_toolbar_item_menu_set() for details.
15287 EAPI Evas_Object *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15290 * Add a new state to @p item.
15292 * @param item The item.
15293 * @param icon A string with icon name or the absolute path of an image file.
15294 * @param label The label of the new state.
15295 * @param func The function to call when the item is clicked when this
15296 * state is selected.
15297 * @param data The data to associate with the state.
15298 * @return The toolbar item state, or @c NULL upon failure.
15300 * Toolbar will load icon image from fdo or current theme.
15301 * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15302 * If an absolute path is provided it will load it direct from a file.
15304 * States created with this function can be removed with
15305 * elm_toolbar_item_state_del().
15307 * @see elm_toolbar_item_state_del()
15308 * @see elm_toolbar_item_state_sel()
15309 * @see elm_toolbar_item_state_get()
15313 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);
15316 * Delete a previoulsy added state to @p item.
15318 * @param item The toolbar item.
15319 * @param state The state to be deleted.
15320 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15322 * @see elm_toolbar_item_state_add()
15324 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15327 * Set @p state as the current state of @p it.
15329 * @param it The item.
15330 * @param state The state to use.
15331 * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15333 * If @p state is @c NULL, it won't select any state and the default item's
15334 * icon and label will be used. It's the same behaviour than
15335 * elm_toolbar_item_state_unser().
15337 * @see elm_toolbar_item_state_unset()
15341 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15344 * Unset the state of @p it.
15346 * @param it The item.
15348 * The default icon and label from this item will be displayed.
15350 * @see elm_toolbar_item_state_set() for more details.
15354 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15357 * Get the current state of @p it.
15359 * @param item The item.
15360 * @return The selected state or @c NULL if none is selected or on failure.
15362 * @see elm_toolbar_item_state_set() for details.
15363 * @see elm_toolbar_item_state_unset()
15364 * @see elm_toolbar_item_state_add()
15368 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15371 * Get the state after selected state in toolbar's @p item.
15373 * @param it The toolbar item to change state.
15374 * @return The state after current state, or @c NULL on failure.
15376 * If last state is selected, this function will return first state.
15378 * @see elm_toolbar_item_state_set()
15379 * @see elm_toolbar_item_state_add()
15383 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15386 * Get the state before selected state in toolbar's @p item.
15388 * @param it The toolbar item to change state.
15389 * @return The state before current state, or @c NULL on failure.
15391 * If first state is selected, this function will return last state.
15393 * @see elm_toolbar_item_state_set()
15394 * @see elm_toolbar_item_state_add()
15398 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15401 * Set the text to be shown in a given toolbar item's tooltips.
15403 * @param item Target item.
15404 * @param text The text to set in the content.
15406 * Setup the text as tooltip to object. The item can have only one tooltip,
15407 * so any previous tooltip data - set with this function or
15408 * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15410 * @see elm_object_tooltip_text_set() for more details.
15414 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15417 * Set the content to be shown in the tooltip item.
15419 * Setup the tooltip to item. The item can have only one tooltip,
15420 * so any previous tooltip data is removed. @p func(with @p data) will
15421 * be called every time that need show the tooltip and it should
15422 * return a valid Evas_Object. This object is then managed fully by
15423 * tooltip system and is deleted when the tooltip is gone.
15425 * @param item the toolbar item being attached a tooltip.
15426 * @param func the function used to create the tooltip contents.
15427 * @param data what to provide to @a func as callback data/context.
15428 * @param del_cb called when data is not needed anymore, either when
15429 * another callback replaces @a func, the tooltip is unset with
15430 * elm_toolbar_item_tooltip_unset() or the owner @a item
15431 * dies. This callback receives as the first parameter the
15432 * given @a data, and @c event_info is the item.
15434 * @see elm_object_tooltip_content_cb_set() for more details.
15438 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);
15441 * Unset tooltip from item.
15443 * @param item toolbar item to remove previously set tooltip.
15445 * Remove tooltip from item. The callback provided as del_cb to
15446 * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15447 * it is not used anymore.
15449 * @see elm_object_tooltip_unset() for more details.
15450 * @see elm_toolbar_item_tooltip_content_cb_set()
15454 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15457 * Sets a different style for this item tooltip.
15459 * @note before you set a style you should define a tooltip with
15460 * elm_toolbar_item_tooltip_content_cb_set() or
15461 * elm_toolbar_item_tooltip_text_set()
15463 * @param item toolbar item with tooltip already set.
15464 * @param style the theme style to use (default, transparent, ...)
15466 * @see elm_object_tooltip_style_set() for more details.
15470 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15473 * Get the style for this item tooltip.
15475 * @param item toolbar item with tooltip already set.
15476 * @return style the theme style in use, defaults to "default". If the
15477 * object does not have a tooltip set, then NULL is returned.
15479 * @see elm_object_tooltip_style_get() for more details.
15480 * @see elm_toolbar_item_tooltip_style_set()
15484 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15487 * Set the type of mouse pointer/cursor decoration to be shown,
15488 * when the mouse pointer is over the given toolbar widget item
15490 * @param item toolbar item to customize cursor on
15491 * @param cursor the cursor type's name
15493 * This function works analogously as elm_object_cursor_set(), but
15494 * here the cursor's changing area is restricted to the item's
15495 * area, and not the whole widget's. Note that that item cursors
15496 * have precedence over widget cursors, so that a mouse over an
15497 * item with custom cursor set will always show @b that cursor.
15499 * If this function is called twice for an object, a previously set
15500 * cursor will be unset on the second call.
15502 * @see elm_object_cursor_set()
15503 * @see elm_toolbar_item_cursor_get()
15504 * @see elm_toolbar_item_cursor_unset()
15508 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15511 * Get the type of mouse pointer/cursor decoration set to be shown,
15512 * when the mouse pointer is over the given toolbar widget item
15514 * @param item toolbar item with custom cursor set
15515 * @return the cursor type's name or @c NULL, if no custom cursors
15516 * were set to @p item (and on errors)
15518 * @see elm_object_cursor_get()
15519 * @see elm_toolbar_item_cursor_set()
15520 * @see elm_toolbar_item_cursor_unset()
15524 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15527 * Unset any custom mouse pointer/cursor decoration set to be
15528 * shown, when the mouse pointer is over the given toolbar widget
15529 * item, thus making it show the @b default cursor again.
15531 * @param item a toolbar item
15533 * Use this call to undo any custom settings on this item's cursor
15534 * decoration, bringing it back to defaults (no custom style set).
15536 * @see elm_object_cursor_unset()
15537 * @see elm_toolbar_item_cursor_set()
15541 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15544 * Set a different @b style for a given custom cursor set for a
15547 * @param item toolbar item with custom cursor set
15548 * @param style the <b>theme style</b> to use (e.g. @c "default",
15549 * @c "transparent", etc)
15551 * This function only makes sense when one is using custom mouse
15552 * cursor decorations <b>defined in a theme file</b>, which can have,
15553 * given a cursor name/type, <b>alternate styles</b> on it. It
15554 * works analogously as elm_object_cursor_style_set(), but here
15555 * applyed only to toolbar item objects.
15557 * @warning Before you set a cursor style you should have definen a
15558 * custom cursor previously on the item, with
15559 * elm_toolbar_item_cursor_set()
15561 * @see elm_toolbar_item_cursor_engine_only_set()
15562 * @see elm_toolbar_item_cursor_style_get()
15566 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15569 * Get the current @b style set for a given toolbar item's custom
15572 * @param item toolbar item with custom cursor set.
15573 * @return style the cursor style in use. If the object does not
15574 * have a cursor set, then @c NULL is returned.
15576 * @see elm_toolbar_item_cursor_style_set() for more details
15580 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15583 * Set if the (custom)cursor for a given toolbar item should be
15584 * searched in its theme, also, or should only rely on the
15585 * rendering engine.
15587 * @param item item with custom (custom) cursor already set on
15588 * @param engine_only Use @c EINA_TRUE to have cursors looked for
15589 * only on those provided by the rendering engine, @c EINA_FALSE to
15590 * have them searched on the widget's theme, as well.
15592 * @note This call is of use only if you've set a custom cursor
15593 * for toolbar items, with elm_toolbar_item_cursor_set().
15595 * @note By default, cursors will only be looked for between those
15596 * provided by the rendering engine.
15600 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15603 * Get if the (custom) cursor for a given toolbar item is being
15604 * searched in its theme, also, or is only relying on the rendering
15607 * @param item a toolbar item
15608 * @return @c EINA_TRUE, if cursors are being looked for only on
15609 * those provided by the rendering engine, @c EINA_FALSE if they
15610 * are being searched on the widget's theme, as well.
15612 * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15616 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15619 * Change a toolbar's orientation
15620 * @param obj The toolbar object
15621 * @param vertical If @c EINA_TRUE, the toolbar is vertical
15622 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15624 * @deprecated use elm_toolbar_horizontal_set() instead.
15626 EINA_DEPRECATED EAPI void elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15629 * Change a toolbar's orientation
15630 * @param obj The toolbar object
15631 * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15632 * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15635 EAPI void elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15638 * Get a toolbar's orientation
15639 * @param obj The toolbar object
15640 * @return If @c EINA_TRUE, the toolbar is vertical
15641 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15643 * @deprecated use elm_toolbar_horizontal_get() instead.
15645 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15648 * Get a toolbar's orientation
15649 * @param obj The toolbar object
15650 * @return If @c EINA_TRUE, the toolbar is horizontal
15651 * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15654 EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15660 * @defgroup Tooltips Tooltips
15662 * The Tooltip is an (internal, for now) smart object used to show a
15663 * content in a frame on mouse hover of objects(or widgets), with
15664 * tips/information about them.
15669 EAPI double elm_tooltip_delay_get(void);
15670 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
15671 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15672 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15673 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15674 EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15675 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15676 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);
15677 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15678 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15679 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15680 EAPI Eina_Bool elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
15681 EAPI Eina_Bool elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
15688 * @defgroup Cursors Cursors
15690 * The Elementary cursor is an internal smart object used to
15691 * customize the mouse cursor displayed over objects (or
15692 * widgets). In the most common scenario, the cursor decoration
15693 * comes from the graphical @b engine Elementary is running
15694 * on. Those engines may provide different decorations for cursors,
15695 * and Elementary provides functions to choose them (think of X11
15696 * cursors, as an example).
15698 * There's also the possibility of, besides using engine provided
15699 * cursors, also use ones coming from Edje theming files. Both
15700 * globally and per widget, Elementary makes it possible for one to
15701 * make the cursors lookup to be held on engines only or on
15702 * Elementary's theme file, too. To set cursor's hot spot,
15703 * two data items should be added to cursor's theme: "hot_x" and
15704 * "hot_y", that are the offset from upper-left corner of the cursor
15705 * (coordinates 0,0).
15711 * Set the cursor to be shown when mouse is over the object
15713 * Set the cursor that will be displayed when mouse is over the
15714 * object. The object can have only one cursor set to it, so if
15715 * this function is called twice for an object, the previous set
15717 * If using X cursors, a definition of all the valid cursor names
15718 * is listed on Elementary_Cursors.h. If an invalid name is set
15719 * the default cursor will be used.
15721 * @param obj the object being set a cursor.
15722 * @param cursor the cursor name to be used.
15726 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15729 * Get the cursor to be shown when mouse is over the object
15731 * @param obj an object with cursor already set.
15732 * @return the cursor name.
15736 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15739 * Unset cursor for object
15741 * Unset cursor for object, and set the cursor to default if the mouse
15742 * was over this object.
15744 * @param obj Target object
15745 * @see elm_object_cursor_set()
15749 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15752 * Sets a different style for this object cursor.
15754 * @note before you set a style you should define a cursor with
15755 * elm_object_cursor_set()
15757 * @param obj an object with cursor already set.
15758 * @param style the theme style to use (default, transparent, ...)
15762 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15765 * Get the style for this object cursor.
15767 * @param obj an object with cursor already set.
15768 * @return style the theme style in use, defaults to "default". If the
15769 * object does not have a cursor set, then NULL is returned.
15773 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15776 * Set if the cursor set should be searched on the theme or should use
15777 * the provided by the engine, only.
15779 * @note before you set if should look on theme you should define a cursor
15780 * with elm_object_cursor_set(). By default it will only look for cursors
15781 * provided by the engine.
15783 * @param obj an object with cursor already set.
15784 * @param engine_only boolean to define it cursors should be looked only
15785 * between the provided by the engine or searched on widget's theme as well.
15789 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15792 * Get the cursor engine only usage for this object cursor.
15794 * @param obj an object with cursor already set.
15795 * @return engine_only boolean to define it cursors should be
15796 * looked only between the provided by the engine or searched on
15797 * widget's theme as well. If the object does not have a cursor
15798 * set, then EINA_FALSE is returned.
15802 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15805 * Get the configured cursor engine only usage
15807 * This gets the globally configured exclusive usage of engine cursors.
15809 * @return 1 if only engine cursors should be used
15812 EAPI int elm_cursor_engine_only_get(void);
15815 * Set the configured cursor engine only usage
15817 * This sets the globally configured exclusive usage of engine cursors.
15818 * It won't affect cursors set before changing this value.
15820 * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15821 * look for them on theme before.
15822 * @return EINA_TRUE if value is valid and setted (0 or 1)
15825 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
15832 * @defgroup Menu Menu
15834 * @image html img/widget/menu/preview-00.png
15835 * @image latex img/widget/menu/preview-00.eps
15837 * A menu is a list of items displayed above its parent. When the menu is
15838 * showing its parent is darkened. Each item can have a sub-menu. The menu
15839 * object can be used to display a menu on a right click event, in a toolbar,
15842 * Signals that you can add callbacks for are:
15843 * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15844 * event_info is NULL.
15846 * @see @ref tutorial_menu
15849 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15851 * @brief Add a new menu to the parent
15853 * @param parent The parent object.
15854 * @return The new object or NULL if it cannot be created.
15856 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15858 * @brief Set the parent for the given menu widget
15860 * @param obj The menu object.
15861 * @param parent The new parent.
15863 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15865 * @brief Get the parent for the given menu widget
15867 * @param obj The menu object.
15868 * @return The parent.
15870 * @see elm_menu_parent_set()
15872 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15874 * @brief Move the menu to a new position
15876 * @param obj The menu object.
15877 * @param x The new position.
15878 * @param y The new position.
15880 * Sets the top-left position of the menu to (@p x,@p y).
15882 * @note @p x and @p y coordinates are relative to parent.
15884 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15886 * @brief Close a opened menu
15888 * @param obj the menu object
15891 * Hides the menu and all it's sub-menus.
15893 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15895 * @brief Returns a list of @p item's items.
15897 * @param obj The menu object
15898 * @return An Eina_List* of @p item's items
15900 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15902 * @brief Get the Evas_Object of an Elm_Menu_Item
15904 * @param item The menu item object.
15905 * @return The edje object containing the swallowed content
15907 * @warning Don't manipulate this object!
15909 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15911 * @brief Add an item at the end of the given menu widget
15913 * @param obj The menu object.
15914 * @param parent The parent menu item (optional)
15915 * @param icon A icon display on the item. The icon will be destryed by the menu.
15916 * @param label The label of the item.
15917 * @param func Function called when the user select the item.
15918 * @param data Data sent by the callback.
15919 * @return Returns the new item.
15921 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);
15923 * @brief Add an object swallowed in an item at the end of the given menu
15926 * @param obj The menu object.
15927 * @param parent The parent menu item (optional)
15928 * @param subobj The object to swallow
15929 * @param func Function called when the user select the item.
15930 * @param data Data sent by the callback.
15931 * @return Returns the new item.
15933 * Add an evas object as an item to the menu.
15935 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);
15937 * @brief Set the label of a menu item
15939 * @param item The menu item object.
15940 * @param label The label to set for @p item
15942 * @warning Don't use this funcion on items created with
15943 * elm_menu_item_add_object() or elm_menu_item_separator_add().
15945 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15947 * @brief Get the label of a menu item
15949 * @param item The menu item object.
15950 * @return The label of @p item
15952 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15954 * @brief Set the icon of a menu item to the standard icon with name @p icon
15956 * @param item The menu item object.
15957 * @param icon The icon object to set for the content of @p item
15959 * Once this icon is set, any previously set icon will be deleted.
15961 EAPI void elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15963 * @brief Get the string representation from the icon of a menu item
15965 * @param item The menu item object.
15966 * @return The string representation of @p item's icon or NULL
15968 * @see elm_menu_item_object_icon_name_set()
15970 EAPI const char *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15972 * @brief Set the content object of a menu item
15974 * @param item The menu item object
15975 * @param The content object or NULL
15976 * @return EINA_TRUE on success, else EINA_FALSE
15978 * Use this function to change the object swallowed by a menu item, deleting
15979 * any previously swallowed object.
15981 EAPI Eina_Bool elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
15983 * @brief Get the content object of a menu item
15985 * @param item The menu item object
15986 * @return The content object or NULL
15987 * @note If @p item was added with elm_menu_item_add_object, this
15988 * function will return the object passed, else it will return the
15991 * @see elm_menu_item_object_content_set()
15993 EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15995 * @brief Set the selected state of @p item.
15997 * @param item The menu item object.
15998 * @param selected The selected/unselected state of the item
16000 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16002 * @brief Get the selected state of @p item.
16004 * @param item The menu item object.
16005 * @return The selected/unselected state of the item
16007 * @see elm_menu_item_selected_set()
16009 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16011 * @brief Set the disabled state of @p item.
16013 * @param item The menu item object.
16014 * @param disabled The enabled/disabled state of the item
16016 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16018 * @brief Get the disabled state of @p item.
16020 * @param item The menu item object.
16021 * @return The enabled/disabled state of the item
16023 * @see elm_menu_item_disabled_set()
16025 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16027 * @brief Add a separator item to menu @p obj under @p parent.
16029 * @param obj The menu object
16030 * @param parent The item to add the separator under
16031 * @return The created item or NULL on failure
16033 * This is item is a @ref Separator.
16035 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
16037 * @brief Returns whether @p item is a separator.
16039 * @param item The item to check
16040 * @return If true, @p item is a separator
16042 * @see elm_menu_item_separator_add()
16044 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16046 * @brief Deletes an item from the menu.
16048 * @param item The item to delete.
16050 * @see elm_menu_item_add()
16052 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16054 * @brief Set the function called when a menu item is deleted.
16056 * @param item The item to set the callback on
16057 * @param func The function called
16059 * @see elm_menu_item_add()
16060 * @see elm_menu_item_del()
16062 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16064 * @brief Returns the data associated with menu item @p item.
16066 * @param item The item
16067 * @return The data associated with @p item or NULL if none was set.
16069 * This is the data set with elm_menu_add() or elm_menu_item_data_set().
16071 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16073 * @brief Sets the data to be associated with menu item @p item.
16075 * @param item The item
16076 * @param data The data to be associated with @p item
16078 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
16080 * @brief Returns a list of @p item's subitems.
16082 * @param item The item
16083 * @return An Eina_List* of @p item's subitems
16085 * @see elm_menu_add()
16087 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16089 * @brief Get the position of a menu item
16091 * @param item The menu item
16092 * @return The item's index
16094 * This function returns the index position of a menu item in a menu.
16095 * For a sub-menu, this number is relative to the first item in the sub-menu.
16097 * @note Index values begin with 0
16099 EAPI unsigned int elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16101 * @brief @brief Return a menu item's owner menu
16103 * @param item The menu item
16104 * @return The menu object owning @p item, or NULL on failure
16106 * Use this function to get the menu object owning an item.
16108 EAPI Evas_Object *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16110 * @brief Get the selected item in the menu
16112 * @param obj The menu object
16113 * @return The selected item, or NULL if none
16115 * @see elm_menu_item_selected_get()
16116 * @see elm_menu_item_selected_set()
16118 EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16120 * @brief Get the last item in the menu
16122 * @param obj The menu object
16123 * @return The last item, or NULL if none
16125 EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16127 * @brief Get the first item in the menu
16129 * @param obj The menu object
16130 * @return The first item, or NULL if none
16132 EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16134 * @brief Get the next item in the menu.
16136 * @param item The menu item object.
16137 * @return The item after it, or NULL if none
16139 EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16141 * @brief Get the previous item in the menu.
16143 * @param item The menu item object.
16144 * @return The item before it, or NULL if none
16146 EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16152 * @defgroup List List
16153 * @ingroup Elementary
16155 * @image html img/widget/list/preview-00.png
16156 * @image latex img/widget/list/preview-00.eps width=\textwidth
16158 * @image html img/list.png
16159 * @image latex img/list.eps width=\textwidth
16161 * A list widget is a container whose children are displayed vertically or
16162 * horizontally, in order, and can be selected.
16163 * The list can accept only one or multiple items selection. Also has many
16164 * modes of items displaying.
16166 * A list is a very simple type of list widget. For more robust
16167 * lists, @ref Genlist should probably be used.
16169 * Smart callbacks one can listen to:
16170 * - @c "activated" - The user has double-clicked or pressed
16171 * (enter|return|spacebar) on an item. The @c event_info parameter
16172 * is the item that was activated.
16173 * - @c "clicked,double" - The user has double-clicked an item.
16174 * The @c event_info parameter is the item that was double-clicked.
16175 * - "selected" - when the user selected an item
16176 * - "unselected" - when the user unselected an item
16177 * - "longpressed" - an item in the list is long-pressed
16178 * - "edge,top" - the list is scrolled until the top edge
16179 * - "edge,bottom" - the list is scrolled until the bottom edge
16180 * - "edge,left" - the list is scrolled until the left edge
16181 * - "edge,right" - the list is scrolled until the right edge
16182 * - "language,changed" - the program's language changed
16184 * Available styles for it:
16187 * List of examples:
16188 * @li @ref list_example_01
16189 * @li @ref list_example_02
16190 * @li @ref list_example_03
16199 * @enum _Elm_List_Mode
16200 * @typedef Elm_List_Mode
16202 * Set list's resize behavior, transverse axis scroll and
16203 * items cropping. See each mode's description for more details.
16205 * @note Default value is #ELM_LIST_SCROLL.
16207 * Values <b> don't </b> work as bitmask, only one can be choosen.
16209 * @see elm_list_mode_set()
16210 * @see elm_list_mode_get()
16214 typedef enum _Elm_List_Mode
16216 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. */
16217 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). */
16218 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. */
16219 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. */
16220 ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16223 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(). */
16226 * Add a new list widget to the given parent Elementary
16227 * (container) object.
16229 * @param parent The parent object.
16230 * @return a new list widget handle or @c NULL, on errors.
16232 * This function inserts a new list widget on the canvas.
16236 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16241 * @param obj The list object
16243 * @note Call before running show() on the list object.
16244 * @warning If not called, it won't display the list properly.
16247 * li = elm_list_add(win);
16248 * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16249 * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16251 * evas_object_show(li);
16256 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16259 * Enable or disable multiple items selection on the list object.
16261 * @param obj The list object
16262 * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16265 * Disabled by default. If disabled, the user can select a single item of
16266 * the list each time. Selected items are highlighted on list.
16267 * If enabled, many items can be selected.
16269 * If a selected item is selected again, it will be unselected.
16271 * @see elm_list_multi_select_get()
16275 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16278 * Get a value whether multiple items selection is enabled or not.
16280 * @see elm_list_multi_select_set() for details.
16282 * @param obj The list object.
16283 * @return @c EINA_TRUE means multiple items selection is enabled.
16284 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16285 * @c EINA_FALSE is returned.
16289 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16292 * Set which mode to use for the list object.
16294 * @param obj The list object
16295 * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16296 * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16298 * Set list's resize behavior, transverse axis scroll and
16299 * items cropping. See each mode's description for more details.
16301 * @note Default value is #ELM_LIST_SCROLL.
16303 * Only one can be set, if a previous one was set, it will be changed
16304 * by the new mode set. Bitmask won't work as well.
16306 * @see elm_list_mode_get()
16310 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16313 * Get the mode the list is at.
16315 * @param obj The list object
16316 * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16317 * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16319 * @note see elm_list_mode_set() for more information.
16323 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16326 * Enable or disable horizontal mode on the list object.
16328 * @param obj The list object.
16329 * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16330 * disable it, i.e., to enable vertical mode.
16332 * @note Vertical mode is set by default.
16334 * On horizontal mode items are displayed on list from left to right,
16335 * instead of from top to bottom. Also, the list will scroll horizontally.
16336 * Each item will presents left icon on top and right icon, or end, at
16339 * @see elm_list_horizontal_get()
16343 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16346 * Get a value whether horizontal mode is enabled or not.
16348 * @param obj The list object.
16349 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16350 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16351 * @c EINA_FALSE is returned.
16353 * @see elm_list_horizontal_set() for details.
16357 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16360 * Enable or disable always select mode on the list object.
16362 * @param obj The list object
16363 * @param always_select @c EINA_TRUE to enable always select mode or
16364 * @c EINA_FALSE to disable it.
16366 * @note Always select mode is disabled by default.
16368 * Default behavior of list items is to only call its callback function
16369 * the first time it's pressed, i.e., when it is selected. If a selected
16370 * item is pressed again, and multi-select is disabled, it won't call
16371 * this function (if multi-select is enabled it will unselect the item).
16373 * If always select is enabled, it will call the callback function
16374 * everytime a item is pressed, so it will call when the item is selected,
16375 * and again when a selected item is pressed.
16377 * @see elm_list_always_select_mode_get()
16378 * @see elm_list_multi_select_set()
16382 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16385 * Get a value whether always select mode is enabled or not, meaning that
16386 * an item will always call its callback function, even if already selected.
16388 * @param obj The list object
16389 * @return @c EINA_TRUE means horizontal mode selection is enabled.
16390 * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16391 * @c EINA_FALSE is returned.
16393 * @see elm_list_always_select_mode_set() for details.
16397 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16400 * Set bouncing behaviour when the scrolled content reaches an edge.
16402 * Tell the internal scroller object whether it should bounce or not
16403 * when it reaches the respective edges for each axis.
16405 * @param obj The list object
16406 * @param h_bounce Whether to bounce or not in the horizontal axis.
16407 * @param v_bounce Whether to bounce or not in the vertical axis.
16409 * @see elm_scroller_bounce_set()
16413 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16416 * Get the bouncing behaviour of the internal scroller.
16418 * Get whether the internal scroller should bounce when the edge of each
16419 * axis is reached scrolling.
16421 * @param obj The list object.
16422 * @param h_bounce Pointer where to store the bounce state of the horizontal
16424 * @param v_bounce Pointer where to store the bounce state of the vertical
16427 * @see elm_scroller_bounce_get()
16428 * @see elm_list_bounce_set()
16432 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16435 * Set the scrollbar policy.
16437 * @param obj The list object
16438 * @param policy_h Horizontal scrollbar policy.
16439 * @param policy_v Vertical scrollbar policy.
16441 * This sets the scrollbar visibility policy for the given scroller.
16442 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16443 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16444 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16445 * This applies respectively for the horizontal and vertical scrollbars.
16447 * The both are disabled by default, i.e., are set to
16448 * #ELM_SCROLLER_POLICY_OFF.
16452 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16455 * Get the scrollbar policy.
16457 * @see elm_list_scroller_policy_get() for details.
16459 * @param obj The list object.
16460 * @param policy_h Pointer where to store horizontal scrollbar policy.
16461 * @param policy_v Pointer where to store vertical scrollbar policy.
16465 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);
16468 * Append a new item to the list object.
16470 * @param obj The list object.
16471 * @param label The label of the list item.
16472 * @param icon The icon object to use for the left side of the item. An
16473 * icon can be any Evas object, but usually it is an icon created
16474 * with elm_icon_add().
16475 * @param end The icon object to use for the right side of the item. An
16476 * icon can be any Evas object.
16477 * @param func The function to call when the item is clicked.
16478 * @param data The data to associate with the item for related callbacks.
16480 * @return The created item or @c NULL upon failure.
16482 * A new item will be created and appended to the list, i.e., will
16483 * be set as @b last item.
16485 * Items created with this method can be deleted with
16486 * elm_list_item_del().
16488 * Associated @p data can be properly freed when item is deleted if a
16489 * callback function is set with elm_list_item_del_cb_set().
16491 * If a function is passed as argument, it will be called everytime this item
16492 * is selected, i.e., the user clicks over an unselected item.
16493 * If always select is enabled it will call this function every time
16494 * user clicks over an item (already selected or not).
16495 * If such function isn't needed, just passing
16496 * @c NULL as @p func is enough. The same should be done for @p data.
16498 * Simple example (with no function callback or data associated):
16500 * li = elm_list_add(win);
16501 * ic = elm_icon_add(win);
16502 * elm_icon_file_set(ic, "path/to/image", NULL);
16503 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16504 * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16506 * evas_object_show(li);
16509 * @see elm_list_always_select_mode_set()
16510 * @see elm_list_item_del()
16511 * @see elm_list_item_del_cb_set()
16512 * @see elm_list_clear()
16513 * @see elm_icon_add()
16517 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);
16520 * Prepend a new item to the list object.
16522 * @param obj The list object.
16523 * @param label The label of the list item.
16524 * @param icon The icon object to use for the left side of the item. An
16525 * icon can be any Evas object, but usually it is an icon created
16526 * with elm_icon_add().
16527 * @param end The icon object to use for the right side of the item. An
16528 * icon can be any Evas object.
16529 * @param func The function to call when the item is clicked.
16530 * @param data The data to associate with the item for related callbacks.
16532 * @return The created item or @c NULL upon failure.
16534 * A new item will be created and prepended to the list, i.e., will
16535 * be set as @b first item.
16537 * Items created with this method can be deleted with
16538 * elm_list_item_del().
16540 * Associated @p data can be properly freed when item is deleted if a
16541 * callback function is set with elm_list_item_del_cb_set().
16543 * If a function is passed as argument, it will be called everytime this item
16544 * is selected, i.e., the user clicks over an unselected item.
16545 * If always select is enabled it will call this function every time
16546 * user clicks over an item (already selected or not).
16547 * If such function isn't needed, just passing
16548 * @c NULL as @p func is enough. The same should be done for @p data.
16550 * @see elm_list_item_append() for a simple code example.
16551 * @see elm_list_always_select_mode_set()
16552 * @see elm_list_item_del()
16553 * @see elm_list_item_del_cb_set()
16554 * @see elm_list_clear()
16555 * @see elm_icon_add()
16559 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);
16562 * Insert a new item into the list object before item @p before.
16564 * @param obj The list object.
16565 * @param before The list item to insert before.
16566 * @param label The label of the list item.
16567 * @param icon The icon object to use for the left side of the item. An
16568 * icon can be any Evas object, but usually it is an icon created
16569 * with elm_icon_add().
16570 * @param end The icon object to use for the right side of the item. An
16571 * icon can be any Evas object.
16572 * @param func The function to call when the item is clicked.
16573 * @param data The data to associate with the item for related callbacks.
16575 * @return The created item or @c NULL upon failure.
16577 * A new item will be created and added to the list. Its position in
16578 * this list will be just before item @p before.
16580 * Items created with this method can be deleted with
16581 * elm_list_item_del().
16583 * Associated @p data can be properly freed when item is deleted if a
16584 * callback function is set with elm_list_item_del_cb_set().
16586 * If a function is passed as argument, it will be called everytime this item
16587 * is selected, i.e., the user clicks over an unselected item.
16588 * If always select is enabled it will call this function every time
16589 * user clicks over an item (already selected or not).
16590 * If such function isn't needed, just passing
16591 * @c NULL as @p func is enough. The same should be done for @p data.
16593 * @see elm_list_item_append() for a simple code example.
16594 * @see elm_list_always_select_mode_set()
16595 * @see elm_list_item_del()
16596 * @see elm_list_item_del_cb_set()
16597 * @see elm_list_clear()
16598 * @see elm_icon_add()
16602 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);
16605 * Insert a new item into the list object after item @p after.
16607 * @param obj The list object.
16608 * @param after The list item to insert after.
16609 * @param label The label of the list item.
16610 * @param icon The icon object to use for the left side of the item. An
16611 * icon can be any Evas object, but usually it is an icon created
16612 * with elm_icon_add().
16613 * @param end The icon object to use for the right side of the item. An
16614 * icon can be any Evas object.
16615 * @param func The function to call when the item is clicked.
16616 * @param data The data to associate with the item for related callbacks.
16618 * @return The created item or @c NULL upon failure.
16620 * A new item will be created and added to the list. Its position in
16621 * this list will be just after item @p after.
16623 * Items created with this method can be deleted with
16624 * elm_list_item_del().
16626 * Associated @p data can be properly freed when item is deleted if a
16627 * callback function is set with elm_list_item_del_cb_set().
16629 * If a function is passed as argument, it will be called everytime this item
16630 * is selected, i.e., the user clicks over an unselected item.
16631 * If always select is enabled it will call this function every time
16632 * user clicks over an item (already selected or not).
16633 * If such function isn't needed, just passing
16634 * @c NULL as @p func is enough. The same should be done for @p data.
16636 * @see elm_list_item_append() for a simple code example.
16637 * @see elm_list_always_select_mode_set()
16638 * @see elm_list_item_del()
16639 * @see elm_list_item_del_cb_set()
16640 * @see elm_list_clear()
16641 * @see elm_icon_add()
16645 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);
16648 * Insert a new item into the sorted list object.
16650 * @param obj The list object.
16651 * @param label The label of the list item.
16652 * @param icon The icon object to use for the left side of the item. An
16653 * icon can be any Evas object, but usually it is an icon created
16654 * with elm_icon_add().
16655 * @param end The icon object to use for the right side of the item. An
16656 * icon can be any Evas object.
16657 * @param func The function to call when the item is clicked.
16658 * @param data The data to associate with the item for related callbacks.
16659 * @param cmp_func The comparing function to be used to sort list
16660 * items <b>by #Elm_List_Item item handles</b>. This function will
16661 * receive two items and compare them, returning a non-negative integer
16662 * if the second item should be place after the first, or negative value
16663 * if should be placed before.
16665 * @return The created item or @c NULL upon failure.
16667 * @note This function inserts values into a list object assuming it was
16668 * sorted and the result will be sorted.
16670 * A new item will be created and added to the list. Its position in
16671 * this list will be found comparing the new item with previously inserted
16672 * items using function @p cmp_func.
16674 * Items created with this method can be deleted with
16675 * elm_list_item_del().
16677 * Associated @p data can be properly freed when item is deleted if a
16678 * callback function is set with elm_list_item_del_cb_set().
16680 * If a function is passed as argument, it will be called everytime this item
16681 * is selected, i.e., the user clicks over an unselected item.
16682 * If always select is enabled it will call this function every time
16683 * user clicks over an item (already selected or not).
16684 * If such function isn't needed, just passing
16685 * @c NULL as @p func is enough. The same should be done for @p data.
16687 * @see elm_list_item_append() for a simple code example.
16688 * @see elm_list_always_select_mode_set()
16689 * @see elm_list_item_del()
16690 * @see elm_list_item_del_cb_set()
16691 * @see elm_list_clear()
16692 * @see elm_icon_add()
16696 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);
16699 * Remove all list's items.
16701 * @param obj The list object
16703 * @see elm_list_item_del()
16704 * @see elm_list_item_append()
16708 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16711 * Get a list of all the list items.
16713 * @param obj The list object
16714 * @return An @c Eina_List of list items, #Elm_List_Item,
16715 * or @c NULL on failure.
16717 * @see elm_list_item_append()
16718 * @see elm_list_item_del()
16719 * @see elm_list_clear()
16723 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16726 * Get the selected item.
16728 * @param obj The list object.
16729 * @return The selected list item.
16731 * The selected item can be unselected with function
16732 * elm_list_item_selected_set().
16734 * The selected item always will be highlighted on list.
16736 * @see elm_list_selected_items_get()
16740 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16743 * Return a list of the currently selected list items.
16745 * @param obj The list object.
16746 * @return An @c Eina_List of list items, #Elm_List_Item,
16747 * or @c NULL on failure.
16749 * Multiple items can be selected if multi select is enabled. It can be
16750 * done with elm_list_multi_select_set().
16752 * @see elm_list_selected_item_get()
16753 * @see elm_list_multi_select_set()
16757 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16760 * Set the selected state of an item.
16762 * @param item The list item
16763 * @param selected The selected state
16765 * This sets the selected state of the given item @p it.
16766 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16768 * If a new item is selected the previosly selected will be unselected,
16769 * unless multiple selection is enabled with elm_list_multi_select_set().
16770 * Previoulsy selected item can be get with function
16771 * elm_list_selected_item_get().
16773 * Selected items will be highlighted.
16775 * @see elm_list_item_selected_get()
16776 * @see elm_list_selected_item_get()
16777 * @see elm_list_multi_select_set()
16781 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16784 * Get whether the @p item is selected or not.
16786 * @param item The list item.
16787 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16788 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16790 * @see elm_list_selected_item_set() for details.
16791 * @see elm_list_item_selected_get()
16795 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16798 * Set or unset item as a separator.
16800 * @param it The list item.
16801 * @param setting @c EINA_TRUE to set item @p it as separator or
16802 * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16804 * Items aren't set as separator by default.
16806 * If set as separator it will display separator theme, so won't display
16809 * @see elm_list_item_separator_get()
16813 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16816 * Get a value whether item is a separator or not.
16818 * @see elm_list_item_separator_set() for details.
16820 * @param it The list item.
16821 * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16822 * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16826 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16829 * Show @p item in the list view.
16831 * @param item The list item to be shown.
16833 * It won't animate list until item is visible. If such behavior is wanted,
16834 * use elm_list_bring_in() intead.
16838 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16841 * Bring in the given item to list view.
16843 * @param item The item.
16845 * This causes list to jump to the given item @p item and show it
16846 * (by scrolling), if it is not fully visible.
16848 * This may use animation to do so and take a period of time.
16850 * If animation isn't wanted, elm_list_item_show() can be used.
16854 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16857 * Delete them item from the list.
16859 * @param item The item of list to be deleted.
16861 * If deleting all list items is required, elm_list_clear()
16862 * should be used instead of getting items list and deleting each one.
16864 * @see elm_list_clear()
16865 * @see elm_list_item_append()
16866 * @see elm_list_item_del_cb_set()
16870 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16873 * Set the function called when a list item is freed.
16875 * @param item The item to set the callback on
16876 * @param func The function called
16878 * If there is a @p func, then it will be called prior item's memory release.
16879 * That will be called with the following arguments:
16881 * @li item's Evas object;
16884 * This way, a data associated to a list item could be properly freed.
16888 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16891 * Get the data associated to the item.
16893 * @param item The list item
16894 * @return The data associated to @p item
16896 * The return value is a pointer to data associated to @p item when it was
16897 * created, with function elm_list_item_append() or similar. If no data
16898 * was passed as argument, it will return @c NULL.
16900 * @see elm_list_item_append()
16904 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16907 * Get the left side icon associated to the item.
16909 * @param item The list item
16910 * @return The left side icon associated to @p item
16912 * The return value is a pointer to the icon associated to @p item when
16914 * created, with function elm_list_item_append() or similar, or later
16915 * with function elm_list_item_icon_set(). If no icon
16916 * was passed as argument, it will return @c NULL.
16918 * @see elm_list_item_append()
16919 * @see elm_list_item_icon_set()
16923 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16926 * Set the left side icon associated to the item.
16928 * @param item The list item
16929 * @param icon The left side icon object to associate with @p item
16931 * The icon object to use at left side of the item. An
16932 * icon can be any Evas object, but usually it is an icon created
16933 * with elm_icon_add().
16935 * Once the icon object is set, a previously set one will be deleted.
16936 * @warning Setting the same icon for two items will cause the icon to
16937 * dissapear from the first item.
16939 * If an icon was passed as argument on item creation, with function
16940 * elm_list_item_append() or similar, it will be already
16941 * associated to the item.
16943 * @see elm_list_item_append()
16944 * @see elm_list_item_icon_get()
16948 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16951 * Get the right side icon associated to the item.
16953 * @param item The list item
16954 * @return The right side icon associated to @p item
16956 * The return value is a pointer to the icon associated to @p item when
16958 * created, with function elm_list_item_append() or similar, or later
16959 * with function elm_list_item_icon_set(). If no icon
16960 * was passed as argument, it will return @c NULL.
16962 * @see elm_list_item_append()
16963 * @see elm_list_item_icon_set()
16967 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16970 * Set the right side icon associated to the item.
16972 * @param item The list item
16973 * @param end The right side icon object to associate with @p item
16975 * The icon object to use at right side of the item. An
16976 * icon can be any Evas object, but usually it is an icon created
16977 * with elm_icon_add().
16979 * Once the icon object is set, a previously set one will be deleted.
16980 * @warning Setting the same icon for two items will cause the icon to
16981 * dissapear from the first item.
16983 * If an icon was passed as argument on item creation, with function
16984 * elm_list_item_append() or similar, it will be already
16985 * associated to the item.
16987 * @see elm_list_item_append()
16988 * @see elm_list_item_end_get()
16992 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
16995 * Gets the base object of the item.
16997 * @param item The list item
16998 * @return The base object associated with @p item
17000 * Base object is the @c Evas_Object that represents that item.
17004 EAPI Evas_Object *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17005 EINA_DEPRECATED EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17008 * Get the label of item.
17010 * @param item The item of list.
17011 * @return The label of item.
17013 * The return value is a pointer to the label associated to @p item when
17014 * it was created, with function elm_list_item_append(), or later
17015 * with function elm_list_item_label_set. If no label
17016 * was passed as argument, it will return @c NULL.
17018 * @see elm_list_item_label_set() for more details.
17019 * @see elm_list_item_append()
17023 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17026 * Set the label of item.
17028 * @param item The item of list.
17029 * @param text The label of item.
17031 * The label to be displayed by the item.
17032 * Label will be placed between left and right side icons (if set).
17034 * If a label was passed as argument on item creation, with function
17035 * elm_list_item_append() or similar, it will be already
17036 * displayed by the item.
17038 * @see elm_list_item_label_get()
17039 * @see elm_list_item_append()
17043 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17047 * Get the item before @p it in list.
17049 * @param it The list item.
17050 * @return The item before @p it, or @c NULL if none or on failure.
17052 * @note If it is the first item, @c NULL will be returned.
17054 * @see elm_list_item_append()
17055 * @see elm_list_items_get()
17059 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17062 * Get the item after @p it in list.
17064 * @param it The list item.
17065 * @return The item after @p it, or @c NULL if none or on failure.
17067 * @note If it is the last item, @c NULL will be returned.
17069 * @see elm_list_item_append()
17070 * @see elm_list_items_get()
17074 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17077 * Sets the disabled/enabled state of a list item.
17079 * @param it The item.
17080 * @param disabled The disabled state.
17082 * A disabled item cannot be selected or unselected. It will also
17083 * change its appearance (generally greyed out). This sets the
17084 * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
17089 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17092 * Get a value whether list item is disabled or not.
17094 * @param it The item.
17095 * @return The disabled state.
17097 * @see elm_list_item_disabled_set() for more details.
17101 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17104 * Set the text to be shown in a given list item's tooltips.
17106 * @param item Target item.
17107 * @param text The text to set in the content.
17109 * Setup the text as tooltip to object. The item can have only one tooltip,
17110 * so any previous tooltip data - set with this function or
17111 * elm_list_item_tooltip_content_cb_set() - is removed.
17113 * @see elm_object_tooltip_text_set() for more details.
17117 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17121 * @brief Disable size restrictions on an object's tooltip
17122 * @param item The tooltip's anchor object
17123 * @param disable If EINA_TRUE, size restrictions are disabled
17124 * @return EINA_FALSE on failure, EINA_TRUE on success
17126 * This function allows a tooltip to expand beyond its parant window's canvas.
17127 * It will instead be limited only by the size of the display.
17129 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17131 * @brief Retrieve size restriction state of an object's tooltip
17132 * @param obj The tooltip's anchor object
17133 * @return If EINA_TRUE, size restrictions are disabled
17135 * This function returns whether a tooltip is allowed to expand beyond
17136 * its parant window's canvas.
17137 * It will instead be limited only by the size of the display.
17139 EAPI Eina_Bool elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17142 * Set the content to be shown in the tooltip item.
17144 * Setup the tooltip to item. The item can have only one tooltip,
17145 * so any previous tooltip data is removed. @p func(with @p data) will
17146 * be called every time that need show the tooltip and it should
17147 * return a valid Evas_Object. This object is then managed fully by
17148 * tooltip system and is deleted when the tooltip is gone.
17150 * @param item the list item being attached a tooltip.
17151 * @param func the function used to create the tooltip contents.
17152 * @param data what to provide to @a func as callback data/context.
17153 * @param del_cb called when data is not needed anymore, either when
17154 * another callback replaces @a func, the tooltip is unset with
17155 * elm_list_item_tooltip_unset() or the owner @a item
17156 * dies. This callback receives as the first parameter the
17157 * given @a data, and @c event_info is the item.
17159 * @see elm_object_tooltip_content_cb_set() for more details.
17163 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);
17166 * Unset tooltip from item.
17168 * @param item list item to remove previously set tooltip.
17170 * Remove tooltip from item. The callback provided as del_cb to
17171 * elm_list_item_tooltip_content_cb_set() will be called to notify
17172 * it is not used anymore.
17174 * @see elm_object_tooltip_unset() for more details.
17175 * @see elm_list_item_tooltip_content_cb_set()
17179 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17182 * Sets a different style for this item tooltip.
17184 * @note before you set a style you should define a tooltip with
17185 * elm_list_item_tooltip_content_cb_set() or
17186 * elm_list_item_tooltip_text_set()
17188 * @param item list item with tooltip already set.
17189 * @param style the theme style to use (default, transparent, ...)
17191 * @see elm_object_tooltip_style_set() for more details.
17195 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17198 * Get the style for this item tooltip.
17200 * @param item list item with tooltip already set.
17201 * @return style the theme style in use, defaults to "default". If the
17202 * object does not have a tooltip set, then NULL is returned.
17204 * @see elm_object_tooltip_style_get() for more details.
17205 * @see elm_list_item_tooltip_style_set()
17209 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17212 * Set the type of mouse pointer/cursor decoration to be shown,
17213 * when the mouse pointer is over the given list widget item
17215 * @param item list item to customize cursor on
17216 * @param cursor the cursor type's name
17218 * This function works analogously as elm_object_cursor_set(), but
17219 * here the cursor's changing area is restricted to the item's
17220 * area, and not the whole widget's. Note that that item cursors
17221 * have precedence over widget cursors, so that a mouse over an
17222 * item with custom cursor set will always show @b that cursor.
17224 * If this function is called twice for an object, a previously set
17225 * cursor will be unset on the second call.
17227 * @see elm_object_cursor_set()
17228 * @see elm_list_item_cursor_get()
17229 * @see elm_list_item_cursor_unset()
17233 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17236 * Get the type of mouse pointer/cursor decoration set to be shown,
17237 * when the mouse pointer is over the given list widget item
17239 * @param item list item with custom cursor set
17240 * @return the cursor type's name or @c NULL, if no custom cursors
17241 * were set to @p item (and on errors)
17243 * @see elm_object_cursor_get()
17244 * @see elm_list_item_cursor_set()
17245 * @see elm_list_item_cursor_unset()
17249 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17252 * Unset any custom mouse pointer/cursor decoration set to be
17253 * shown, when the mouse pointer is over the given list widget
17254 * item, thus making it show the @b default cursor again.
17256 * @param item a list item
17258 * Use this call to undo any custom settings on this item's cursor
17259 * decoration, bringing it back to defaults (no custom style set).
17261 * @see elm_object_cursor_unset()
17262 * @see elm_list_item_cursor_set()
17266 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17269 * Set a different @b style for a given custom cursor set for a
17272 * @param item list item with custom cursor set
17273 * @param style the <b>theme style</b> to use (e.g. @c "default",
17274 * @c "transparent", etc)
17276 * This function only makes sense when one is using custom mouse
17277 * cursor decorations <b>defined in a theme file</b>, which can have,
17278 * given a cursor name/type, <b>alternate styles</b> on it. It
17279 * works analogously as elm_object_cursor_style_set(), but here
17280 * applyed only to list item objects.
17282 * @warning Before you set a cursor style you should have definen a
17283 * custom cursor previously on the item, with
17284 * elm_list_item_cursor_set()
17286 * @see elm_list_item_cursor_engine_only_set()
17287 * @see elm_list_item_cursor_style_get()
17291 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17294 * Get the current @b style set for a given list item's custom
17297 * @param item list item with custom cursor set.
17298 * @return style the cursor style in use. If the object does not
17299 * have a cursor set, then @c NULL is returned.
17301 * @see elm_list_item_cursor_style_set() for more details
17305 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17308 * Set if the (custom)cursor for a given list item should be
17309 * searched in its theme, also, or should only rely on the
17310 * rendering engine.
17312 * @param item item with custom (custom) cursor already set on
17313 * @param engine_only Use @c EINA_TRUE to have cursors looked for
17314 * only on those provided by the rendering engine, @c EINA_FALSE to
17315 * have them searched on the widget's theme, as well.
17317 * @note This call is of use only if you've set a custom cursor
17318 * for list items, with elm_list_item_cursor_set().
17320 * @note By default, cursors will only be looked for between those
17321 * provided by the rendering engine.
17325 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17328 * Get if the (custom) cursor for a given list item is being
17329 * searched in its theme, also, or is only relying on the rendering
17332 * @param item a list item
17333 * @return @c EINA_TRUE, if cursors are being looked for only on
17334 * those provided by the rendering engine, @c EINA_FALSE if they
17335 * are being searched on the widget's theme, as well.
17337 * @see elm_list_item_cursor_engine_only_set(), for more details
17341 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17348 * @defgroup Slider Slider
17349 * @ingroup Elementary
17351 * @image html img/widget/slider/preview-00.png
17352 * @image latex img/widget/slider/preview-00.eps width=\textwidth
17354 * The slider adds a dragable “slider” widget for selecting the value of
17355 * something within a range.
17357 * A slider can be horizontal or vertical. It can contain an Icon and has a
17358 * primary label as well as a units label (that is formatted with floating
17359 * point values and thus accepts a printf-style format string, like
17360 * “%1.2f units”. There is also an indicator string that may be somewhere
17361 * else (like on the slider itself) that also accepts a format string like
17362 * units. Label, Icon Unit and Indicator strings/objects are optional.
17364 * A slider may be inverted which means values invert, with high vales being
17365 * on the left or top and low values on the right or bottom (as opposed to
17366 * normally being low on the left or top and high on the bottom and right).
17368 * The slider should have its minimum and maximum values set by the
17369 * application with elm_slider_min_max_set() and value should also be set by
17370 * the application before use with elm_slider_value_set(). The span of the
17371 * slider is its length (horizontally or vertically). This will be scaled by
17372 * the object or applications scaling factor. At any point code can query the
17373 * slider for its value with elm_slider_value_get().
17375 * Smart callbacks one can listen to:
17376 * - "changed" - Whenever the slider value is changed by the user.
17377 * - "slider,drag,start" - dragging the slider indicator around has started.
17378 * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17379 * - "delay,changed" - A short time after the value is changed by the user.
17380 * This will be called only when the user stops dragging for
17381 * a very short period or when they release their
17382 * finger/mouse, so it avoids possibly expensive reactions to
17383 * the value change.
17385 * Available styles for it:
17388 * Default contents parts of the slider widget that you can use for are:
17389 * @li "elm.swallow.icon" - A icon of the slider
17390 * @li "elm.swallow.end" - A end part content of the slider
17392 * Here is an example on its usage:
17393 * @li @ref slider_example
17396 #define ELM_SLIDER_CONTENT_ICON "elm.swallow.icon"
17397 #define ELM_SLIDER_CONTENT_END "elm.swallow.end"
17400 * @addtogroup Slider
17405 * Add a new slider widget to the given parent Elementary
17406 * (container) object.
17408 * @param parent The parent object.
17409 * @return a new slider widget handle or @c NULL, on errors.
17411 * This function inserts a new slider widget on the canvas.
17415 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17418 * Set the label of a given slider widget
17420 * @param obj The progress bar object
17421 * @param label The text label string, in UTF-8
17424 * @deprecated use elm_object_text_set() instead.
17426 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17429 * Get the label of a given slider widget
17431 * @param obj The progressbar object
17432 * @return The text label string, in UTF-8
17435 * @deprecated use elm_object_text_get() instead.
17437 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17440 * Set the icon object of the slider object.
17442 * @param obj The slider object.
17443 * @param icon The icon object.
17445 * On horizontal mode, icon is placed at left, and on vertical mode,
17448 * @note Once the icon object is set, a previously set one will be deleted.
17449 * If you want to keep that old content object, use the
17450 * elm_slider_icon_unset() function.
17452 * @warning If the object being set does not have minimum size hints set,
17453 * it won't get properly displayed.
17456 * @deprecated use elm_object_content_set() instead.
17458 EINA_DEPRECATED EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17461 * Unset an icon set on a given slider widget.
17463 * @param obj The slider object.
17464 * @return The icon object that was being used, if any was set, or
17465 * @c NULL, otherwise (and on errors).
17467 * On horizontal mode, icon is placed at left, and on vertical mode,
17470 * This call will unparent and return the icon object which was set
17471 * for this widget, previously, on success.
17473 * @see elm_slider_icon_set() for more details
17474 * @see elm_slider_icon_get()
17475 * @deprecated use elm_object_content_unset() instead.
17479 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17482 * Retrieve the icon object set for a given slider widget.
17484 * @param obj The slider object.
17485 * @return The icon object's handle, if @p obj had one set, or @c NULL,
17486 * otherwise (and on errors).
17488 * On horizontal mode, icon is placed at left, and on vertical mode,
17491 * @see elm_slider_icon_set() for more details
17492 * @see elm_slider_icon_unset()
17494 * @deprecated use elm_object_content_set() instead.
17498 EINA_DEPRECATED EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17501 * Set the end object of the slider object.
17503 * @param obj The slider object.
17504 * @param end The end object.
17506 * On horizontal mode, end is placed at left, and on vertical mode,
17507 * placed at bottom.
17509 * @note Once the icon object is set, a previously set one will be deleted.
17510 * If you want to keep that old content object, use the
17511 * elm_slider_end_unset() function.
17513 * @warning If the object being set does not have minimum size hints set,
17514 * it won't get properly displayed.
17516 * @deprecated use elm_object_content_part_set(obj, "elm.swallow.end", end) instead.
17520 EINA_DEPRECATED EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17523 * Unset an end object set on a given slider widget.
17525 * @param obj The slider object.
17526 * @return The end object that was being used, if any was set, or
17527 * @c NULL, otherwise (and on errors).
17529 * On horizontal mode, end is placed at left, and on vertical mode,
17530 * placed at bottom.
17532 * This call will unparent and return the icon object which was set
17533 * for this widget, previously, on success.
17535 * @see elm_slider_end_set() for more details.
17536 * @see elm_slider_end_get()
17538 * @deprecated use elm_object_content_part_unset(obj, "elm.swallow.end") instead.
17542 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17545 * Retrieve the end object set for a given slider widget.
17547 * @param obj The slider object.
17548 * @return The end object's handle, if @p obj had one set, or @c NULL,
17549 * otherwise (and on errors).
17551 * On horizontal mode, icon is placed at right, and on vertical mode,
17552 * placed at bottom.
17554 * @see elm_slider_end_set() for more details.
17555 * @see elm_slider_end_unset()
17559 EINA_DEPRECATED EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17562 * Set the (exact) length of the bar region of a given slider widget.
17564 * @param obj The slider object.
17565 * @param size The length of the slider's bar region.
17567 * This sets the minimum width (when in horizontal mode) or height
17568 * (when in vertical mode) of the actual bar area of the slider
17569 * @p obj. This in turn affects the object's minimum size. Use
17570 * this when you're not setting other size hints expanding on the
17571 * given direction (like weight and alignment hints) and you would
17572 * like it to have a specific size.
17574 * @note Icon, end, label, indicator and unit text around @p obj
17575 * will require their
17576 * own space, which will make @p obj to require more the @p size,
17579 * @see elm_slider_span_size_get()
17583 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17586 * Get the length set for the bar region of a given slider widget
17588 * @param obj The slider object.
17589 * @return The length of the slider's bar region.
17591 * If that size was not set previously, with
17592 * elm_slider_span_size_set(), this call will return @c 0.
17596 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17599 * Set the format string for the unit label.
17601 * @param obj The slider object.
17602 * @param format The format string for the unit display.
17604 * Unit label is displayed all the time, if set, after slider's bar.
17605 * In horizontal mode, at right and in vertical mode, at bottom.
17607 * If @c NULL, unit label won't be visible. If not it sets the format
17608 * string for the label text. To the label text is provided a floating point
17609 * value, so the label text can display up to 1 floating point value.
17610 * Note that this is optional.
17612 * Use a format string such as "%1.2f meters" for example, and it will
17613 * display values like: "3.14 meters" for a value equal to 3.14159.
17615 * Default is unit label disabled.
17617 * @see elm_slider_indicator_format_get()
17621 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17624 * Get the unit label format of the slider.
17626 * @param obj The slider object.
17627 * @return The unit label format string in UTF-8.
17629 * Unit label is displayed all the time, if set, after slider's bar.
17630 * In horizontal mode, at right and in vertical mode, at bottom.
17632 * @see elm_slider_unit_format_set() for more
17633 * information on how this works.
17637 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17640 * Set the format string for the indicator label.
17642 * @param obj The slider object.
17643 * @param indicator The format string for the indicator display.
17645 * The slider may display its value somewhere else then unit label,
17646 * for example, above the slider knob that is dragged around. This function
17647 * sets the format string used for this.
17649 * If @c NULL, indicator label won't be visible. If not it sets the format
17650 * string for the label text. To the label text is provided a floating point
17651 * value, so the label text can display up to 1 floating point value.
17652 * Note that this is optional.
17654 * Use a format string such as "%1.2f meters" for example, and it will
17655 * display values like: "3.14 meters" for a value equal to 3.14159.
17657 * Default is indicator label disabled.
17659 * @see elm_slider_indicator_format_get()
17663 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17666 * Get the indicator label format of the slider.
17668 * @param obj The slider object.
17669 * @return The indicator label format string in UTF-8.
17671 * The slider may display its value somewhere else then unit label,
17672 * for example, above the slider knob that is dragged around. This function
17673 * gets the format string used for this.
17675 * @see elm_slider_indicator_format_set() for more
17676 * information on how this works.
17680 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17683 * Set the format function pointer for the indicator label
17685 * @param obj The slider object.
17686 * @param func The indicator format function.
17687 * @param free_func The freeing function for the format string.
17689 * Set the callback function to format the indicator string.
17691 * @see elm_slider_indicator_format_set() for more info on how this works.
17695 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);
17698 * Set the format function pointer for the units label
17700 * @param obj The slider object.
17701 * @param func The units format function.
17702 * @param free_func The freeing function for the format string.
17704 * Set the callback function to format the indicator string.
17706 * @see elm_slider_units_format_set() for more info on how this works.
17710 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);
17713 * Set the orientation of a given slider widget.
17715 * @param obj The slider object.
17716 * @param horizontal Use @c EINA_TRUE to make @p obj to be
17717 * @b horizontal, @c EINA_FALSE to make it @b vertical.
17719 * Use this function to change how your slider is to be
17720 * disposed: vertically or horizontally.
17722 * By default it's displayed horizontally.
17724 * @see elm_slider_horizontal_get()
17728 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17731 * Retrieve the orientation of a given slider widget
17733 * @param obj The slider object.
17734 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17735 * @c EINA_FALSE if it's @b vertical (and on errors).
17737 * @see elm_slider_horizontal_set() for more details.
17741 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17744 * Set the minimum and maximum values for the slider.
17746 * @param obj The slider object.
17747 * @param min The minimum value.
17748 * @param max The maximum value.
17750 * Define the allowed range of values to be selected by the user.
17752 * If actual value is less than @p min, it will be updated to @p min. If it
17753 * is bigger then @p max, will be updated to @p max. Actual value can be
17754 * get with elm_slider_value_get().
17756 * By default, min is equal to 0.0, and max is equal to 1.0.
17758 * @warning Maximum must be greater than minimum, otherwise behavior
17761 * @see elm_slider_min_max_get()
17765 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17768 * Get the minimum and maximum values of the slider.
17770 * @param obj The slider object.
17771 * @param min Pointer where to store the minimum value.
17772 * @param max Pointer where to store the maximum value.
17774 * @note If only one value is needed, the other pointer can be passed
17777 * @see elm_slider_min_max_set() for details.
17781 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17784 * Set the value the slider displays.
17786 * @param obj The slider object.
17787 * @param val The value to be displayed.
17789 * Value will be presented on the unit label following format specified with
17790 * elm_slider_unit_format_set() and on indicator with
17791 * elm_slider_indicator_format_set().
17793 * @warning The value must to be between min and max values. This values
17794 * are set by elm_slider_min_max_set().
17796 * @see elm_slider_value_get()
17797 * @see elm_slider_unit_format_set()
17798 * @see elm_slider_indicator_format_set()
17799 * @see elm_slider_min_max_set()
17803 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17806 * Get the value displayed by the spinner.
17808 * @param obj The spinner object.
17809 * @return The value displayed.
17811 * @see elm_spinner_value_set() for details.
17815 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17818 * Invert a given slider widget's displaying values order
17820 * @param obj The slider object.
17821 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17822 * @c EINA_FALSE to bring it back to default, non-inverted values.
17824 * A slider may be @b inverted, in which state it gets its
17825 * values inverted, with high vales being on the left or top and
17826 * low values on the right or bottom, as opposed to normally have
17827 * the low values on the former and high values on the latter,
17828 * respectively, for horizontal and vertical modes.
17830 * @see elm_slider_inverted_get()
17834 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17837 * Get whether a given slider widget's displaying values are
17840 * @param obj The slider object.
17841 * @return @c EINA_TRUE, if @p obj has inverted values,
17842 * @c EINA_FALSE otherwise (and on errors).
17844 * @see elm_slider_inverted_set() for more details.
17848 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17851 * Set whether to enlarge slider indicator (augmented knob) or not.
17853 * @param obj The slider object.
17854 * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17855 * let the knob always at default size.
17857 * By default, indicator will be bigger while dragged by the user.
17859 * @warning It won't display values set with
17860 * elm_slider_indicator_format_set() if you disable indicator.
17864 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17867 * Get whether a given slider widget's enlarging indicator or not.
17869 * @param obj The slider object.
17870 * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17871 * @c EINA_FALSE otherwise (and on errors).
17873 * @see elm_slider_indicator_show_set() for details.
17877 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17884 * @addtogroup Actionslider Actionslider
17886 * @image html img/widget/actionslider/preview-00.png
17887 * @image latex img/widget/actionslider/preview-00.eps
17889 * An actionslider is a switcher for 2 or 3 labels with customizable magnet
17890 * properties. The user drags and releases the indicator, to choose a label.
17892 * Labels occupy the following positions.
17897 * Positions can be enabled or disabled.
17899 * Magnets can be set on the above positions.
17901 * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
17903 * @note By default all positions are set as enabled.
17905 * Signals that you can add callbacks for are:
17907 * "selected" - when user selects an enabled position (the label is passed
17910 * "pos_changed" - when the indicator reaches any of the positions("left",
17911 * "right" or "center").
17913 * See an example of actionslider usage @ref actionslider_example_page "here"
17916 typedef enum _Elm_Actionslider_Pos
17918 ELM_ACTIONSLIDER_NONE = 0,
17919 ELM_ACTIONSLIDER_LEFT = 1 << 0,
17920 ELM_ACTIONSLIDER_CENTER = 1 << 1,
17921 ELM_ACTIONSLIDER_RIGHT = 1 << 2,
17922 ELM_ACTIONSLIDER_ALL = (1 << 3) -1
17923 } Elm_Actionslider_Pos;
17926 * Add a new actionslider to the parent.
17928 * @param parent The parent object
17929 * @return The new actionslider object or NULL if it cannot be created
17931 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17933 * Set actionslider labels.
17935 * @param obj The actionslider object
17936 * @param left_label The label to be set on the left.
17937 * @param center_label The label to be set on the center.
17938 * @param right_label The label to be set on the right.
17939 * @deprecated use elm_object_text_set() instead.
17941 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);
17943 * Get actionslider labels.
17945 * @param obj The actionslider object
17946 * @param left_label A char** to place the left_label of @p obj into.
17947 * @param center_label A char** to place the center_label of @p obj into.
17948 * @param right_label A char** to place the right_label of @p obj into.
17949 * @deprecated use elm_object_text_set() instead.
17951 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);
17953 * Get actionslider selected label.
17955 * @param obj The actionslider object
17956 * @return The selected label
17958 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17960 * Set actionslider indicator position.
17962 * @param obj The actionslider object.
17963 * @param pos The position of the indicator.
17965 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17967 * Get actionslider indicator position.
17969 * @param obj The actionslider object.
17970 * @return The position of the indicator.
17972 EAPI Elm_Actionslider_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17974 * Set actionslider magnet position. To make multiple positions magnets @c or
17975 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
17977 * @param obj The actionslider object.
17978 * @param pos Bit mask indicating the magnet positions.
17980 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17982 * Get actionslider magnet position.
17984 * @param obj The actionslider object.
17985 * @return The positions with magnet property.
17987 EAPI Elm_Actionslider_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17989 * Set actionslider enabled position. To set multiple positions as enabled @c or
17990 * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
17992 * @note All the positions are enabled by default.
17994 * @param obj The actionslider object.
17995 * @param pos Bit mask indicating the enabled positions.
17997 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17999 * Get actionslider enabled position.
18001 * @param obj The actionslider object.
18002 * @return The enabled positions.
18004 EAPI Elm_Actionslider_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18006 * Set the label used on the indicator.
18008 * @param obj The actionslider object
18009 * @param label The label to be set on the indicator.
18010 * @deprecated use elm_object_text_set() instead.
18012 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18014 * Get the label used on the indicator object.
18016 * @param obj The actionslider object
18017 * @return The indicator label
18018 * @deprecated use elm_object_text_get() instead.
18020 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
18026 * @defgroup Genlist Genlist
18028 * @image html img/widget/genlist/preview-00.png
18029 * @image latex img/widget/genlist/preview-00.eps
18030 * @image html img/genlist.png
18031 * @image latex img/genlist.eps
18033 * This widget aims to have more expansive list than the simple list in
18034 * Elementary that could have more flexible items and allow many more entries
18035 * while still being fast and low on memory usage. At the same time it was
18036 * also made to be able to do tree structures. But the price to pay is more
18037 * complexity when it comes to usage. If all you want is a simple list with
18038 * icons and a single label, use the normal @ref List object.
18040 * Genlist has a fairly large API, mostly because it's relatively complex,
18041 * trying to be both expansive, powerful and efficient. First we will begin
18042 * an overview on the theory behind genlist.
18044 * @section Genlist_Item_Class Genlist item classes - creating items
18046 * In order to have the ability to add and delete items on the fly, genlist
18047 * implements a class (callback) system where the application provides a
18048 * structure with information about that type of item (genlist may contain
18049 * multiple different items with different classes, states and styles).
18050 * Genlist will call the functions in this struct (methods) when an item is
18051 * "realized" (i.e., created dynamically, while the user is scrolling the
18052 * grid). All objects will simply be deleted when no longer needed with
18053 * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
18054 * following members:
18055 * - @c item_style - This is a constant string and simply defines the name
18056 * of the item style. It @b must be specified and the default should be @c
18059 * - @c func - A struct with pointers to functions that will be called when
18060 * an item is going to be actually created. All of them receive a @c data
18061 * parameter that will point to the same data passed to
18062 * elm_genlist_item_append() and related item creation functions, and a @c
18063 * obj parameter that points to the genlist object itself.
18065 * The function pointers inside @c func are @c label_get, @c icon_get, @c
18066 * state_get and @c del. The 3 first functions also receive a @c part
18067 * parameter described below. A brief description of these functions follows:
18069 * - @c label_get - The @c part parameter is the name string of one of the
18070 * existing text parts in the Edje group implementing the item's theme.
18071 * This function @b must return a strdup'()ed string, as the caller will
18072 * free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
18073 * - @c content_get - The @c part parameter is the name string of one of the
18074 * existing (content) swallow parts in the Edje group implementing the item's
18075 * theme. It must return @c NULL, when no content is desired, or a valid
18076 * object handle, otherwise. The object will be deleted by the genlist on
18077 * its deletion or when the item is "unrealized". See
18078 * #Elm_Genlist_Item_Icon_Get_Cb.
18079 * - @c func.state_get - The @c part parameter is the name string of one of
18080 * the state parts in the Edje group implementing the item's theme. Return
18081 * @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18082 * emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18083 * and @c "elm" as "emission" and "source" arguments, respectively, when
18084 * the state is true (the default is false), where @c XXX is the name of
18085 * the (state) part. See #Elm_Genlist_Item_State_Get_Cb.
18086 * - @c func.del - This is intended for use when genlist items are deleted,
18087 * so any data attached to the item (e.g. its data parameter on creation)
18088 * can be deleted. See #Elm_Genlist_Item_Del_Cb.
18090 * available item styles:
18092 * - default_style - The text part is a textblock
18094 * @image html img/widget/genlist/preview-04.png
18095 * @image latex img/widget/genlist/preview-04.eps
18099 * @image html img/widget/genlist/preview-01.png
18100 * @image latex img/widget/genlist/preview-01.eps
18102 * - icon_top_text_bottom
18104 * @image html img/widget/genlist/preview-02.png
18105 * @image latex img/widget/genlist/preview-02.eps
18109 * @image html img/widget/genlist/preview-03.png
18110 * @image latex img/widget/genlist/preview-03.eps
18112 * @section Genlist_Items Structure of items
18114 * An item in a genlist can have 0 or more text labels (they can be regular
18115 * text or textblock Evas objects - that's up to the style to determine), 0
18116 * or more contents (which are simply objects swallowed into the genlist item's
18117 * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18118 * behavior left to the user to define. The Edje part names for each of
18119 * these properties will be looked up, in the theme file for the genlist,
18120 * under the Edje (string) data items named @c "labels", @c "contents" and @c
18121 * "states", respectively. For each of those properties, if more than one
18122 * part is provided, they must have names listed separated by spaces in the
18123 * data fields. For the default genlist item theme, we have @b one label
18124 * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18125 * "elm.swallow.end") and @b no state parts.
18127 * A genlist item may be at one of several styles. Elementary provides one
18128 * by default - "default", but this can be extended by system or application
18129 * custom themes/overlays/extensions (see @ref Theme "themes" for more
18132 * @section Genlist_Manipulation Editing and Navigating
18134 * Items can be added by several calls. All of them return a @ref
18135 * Elm_Genlist_Item handle that is an internal member inside the genlist.
18136 * They all take a data parameter that is meant to be used for a handle to
18137 * the applications internal data (eg the struct with the original item
18138 * data). The parent parameter is the parent genlist item this belongs to if
18139 * it is a tree or an indexed group, and NULL if there is no parent. The
18140 * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18141 * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18142 * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18143 * that is able to expand and have child items. If ELM_GENLIST_ITEM_GROUP
18144 * is set then this item is group index item that is displayed at the top
18145 * until the next group comes. The func parameter is a convenience callback
18146 * that is called when the item is selected and the data parameter will be
18147 * the func_data parameter, obj be the genlist object and event_info will be
18148 * the genlist item.
18150 * elm_genlist_item_append() adds an item to the end of the list, or if
18151 * there is a parent, to the end of all the child items of the parent.
18152 * elm_genlist_item_prepend() is the same but adds to the beginning of
18153 * the list or children list. elm_genlist_item_insert_before() inserts at
18154 * item before another item and elm_genlist_item_insert_after() inserts after
18155 * the indicated item.
18157 * The application can clear the list with elm_genlist_clear() which deletes
18158 * all the items in the list and elm_genlist_item_del() will delete a specific
18159 * item. elm_genlist_item_subitems_clear() will clear all items that are
18160 * children of the indicated parent item.
18162 * To help inspect list items you can jump to the item at the top of the list
18163 * with elm_genlist_first_item_get() which will return the item pointer, and
18164 * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18165 * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18166 * and previous items respectively relative to the indicated item. Using
18167 * these calls you can walk the entire item list/tree. Note that as a tree
18168 * the items are flattened in the list, so elm_genlist_item_parent_get() will
18169 * let you know which item is the parent (and thus know how to skip them if
18172 * @section Genlist_Muti_Selection Multi-selection
18174 * If the application wants multiple items to be able to be selected,
18175 * elm_genlist_multi_select_set() can enable this. If the list is
18176 * single-selection only (the default), then elm_genlist_selected_item_get()
18177 * will return the selected item, if any, or NULL I none is selected. If the
18178 * list is multi-select then elm_genlist_selected_items_get() will return a
18179 * list (that is only valid as long as no items are modified (added, deleted,
18180 * selected or unselected)).
18182 * @section Genlist_Usage_Hints Usage hints
18184 * There are also convenience functions. elm_genlist_item_genlist_get() will
18185 * return the genlist object the item belongs to. elm_genlist_item_show()
18186 * will make the scroller scroll to show that specific item so its visible.
18187 * elm_genlist_item_data_get() returns the data pointer set by the item
18188 * creation functions.
18190 * If an item changes (state of boolean changes, label or contents change),
18191 * then use elm_genlist_item_update() to have genlist update the item with
18192 * the new state. Genlist will re-realize the item thus call the functions
18193 * in the _Elm_Genlist_Item_Class for that item.
18195 * To programmatically (un)select an item use elm_genlist_item_selected_set().
18196 * To get its selected state use elm_genlist_item_selected_get(). Similarly
18197 * to expand/contract an item and get its expanded state, use
18198 * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18199 * again to make an item disabled (unable to be selected and appear
18200 * differently) use elm_genlist_item_disabled_set() to set this and
18201 * elm_genlist_item_disabled_get() to get the disabled state.
18203 * In general to indicate how the genlist should expand items horizontally to
18204 * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18205 * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18206 * mode means that if items are too wide to fit, the scroller will scroll
18207 * horizontally. Otherwise items are expanded to fill the width of the
18208 * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18209 * to the viewport width and limited to that size. This can be combined with
18210 * a different style that uses edjes' ellipsis feature (cutting text off like
18213 * Items will only call their selection func and callback when first becoming
18214 * selected. Any further clicks will do nothing, unless you enable always
18215 * select with elm_genlist_always_select_mode_set(). This means even if
18216 * selected, every click will make the selected callbacks be called.
18217 * elm_genlist_no_select_mode_set() will turn off the ability to select
18218 * items entirely and they will neither appear selected nor call selected
18219 * callback functions.
18221 * Remember that you can create new styles and add your own theme augmentation
18222 * per application with elm_theme_extension_add(). If you absolutely must
18223 * have a specific style that overrides any theme the user or system sets up
18224 * you can use elm_theme_overlay_add() to add such a file.
18226 * @section Genlist_Implementation Implementation
18228 * Evas tracks every object you create. Every time it processes an event
18229 * (mouse move, down, up etc.) it needs to walk through objects and find out
18230 * what event that affects. Even worse every time it renders display updates,
18231 * in order to just calculate what to re-draw, it needs to walk through many
18232 * many many objects. Thus, the more objects you keep active, the more
18233 * overhead Evas has in just doing its work. It is advisable to keep your
18234 * active objects to the minimum working set you need. Also remember that
18235 * object creation and deletion carries an overhead, so there is a
18236 * middle-ground, which is not easily determined. But don't keep massive lists
18237 * of objects you can't see or use. Genlist does this with list objects. It
18238 * creates and destroys them dynamically as you scroll around. It groups them
18239 * into blocks so it can determine the visibility etc. of a whole block at
18240 * once as opposed to having to walk the whole list. This 2-level list allows
18241 * for very large numbers of items to be in the list (tests have used up to
18242 * 2,000,000 items). Also genlist employs a queue for adding items. As items
18243 * may be different sizes, every item added needs to be calculated as to its
18244 * size and thus this presents a lot of overhead on populating the list, this
18245 * genlist employs a queue. Any item added is queued and spooled off over
18246 * time, actually appearing some time later, so if your list has many members
18247 * you may find it takes a while for them to all appear, with your process
18248 * consuming a lot of CPU while it is busy spooling.
18250 * Genlist also implements a tree structure, but it does so with callbacks to
18251 * the application, with the application filling in tree structures when
18252 * requested (allowing for efficient building of a very deep tree that could
18253 * even be used for file-management). See the above smart signal callbacks for
18256 * @section Genlist_Smart_Events Genlist smart events
18258 * Signals that you can add callbacks for are:
18259 * - @c "activated" - The user has double-clicked or pressed
18260 * (enter|return|spacebar) on an item. The @c event_info parameter is the
18261 * item that was activated.
18262 * - @c "clicked,double" - The user has double-clicked an item. The @c
18263 * event_info parameter is the item that was double-clicked.
18264 * - @c "selected" - This is called when a user has made an item selected.
18265 * The event_info parameter is the genlist item that was selected.
18266 * - @c "unselected" - This is called when a user has made an item
18267 * unselected. The event_info parameter is the genlist item that was
18269 * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18270 * called and the item is now meant to be expanded. The event_info
18271 * parameter is the genlist item that was indicated to expand. It is the
18272 * job of this callback to then fill in the child items.
18273 * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18274 * called and the item is now meant to be contracted. The event_info
18275 * parameter is the genlist item that was indicated to contract. It is the
18276 * job of this callback to then delete the child items.
18277 * - @c "expand,request" - This is called when a user has indicated they want
18278 * to expand a tree branch item. The callback should decide if the item can
18279 * expand (has any children) and then call elm_genlist_item_expanded_set()
18280 * appropriately to set the state. The event_info parameter is the genlist
18281 * item that was indicated to expand.
18282 * - @c "contract,request" - This is called when a user has indicated they
18283 * want to contract a tree branch item. The callback should decide if the
18284 * item can contract (has any children) and then call
18285 * elm_genlist_item_expanded_set() appropriately to set the state. The
18286 * event_info parameter is the genlist item that was indicated to contract.
18287 * - @c "realized" - This is called when the item in the list is created as a
18288 * real evas object. event_info parameter is the genlist item that was
18289 * created. The object may be deleted at any time, so it is up to the
18290 * caller to not use the object pointer from elm_genlist_item_object_get()
18291 * in a way where it may point to freed objects.
18292 * - @c "unrealized" - This is called just before an item is unrealized.
18293 * After this call content objects provided will be deleted and the item
18294 * object itself delete or be put into a floating cache.
18295 * - @c "drag,start,up" - This is called when the item in the list has been
18296 * dragged (not scrolled) up.
18297 * - @c "drag,start,down" - This is called when the item in the list has been
18298 * dragged (not scrolled) down.
18299 * - @c "drag,start,left" - This is called when the item in the list has been
18300 * dragged (not scrolled) left.
18301 * - @c "drag,start,right" - This is called when the item in the list has
18302 * been dragged (not scrolled) right.
18303 * - @c "drag,stop" - This is called when the item in the list has stopped
18305 * - @c "drag" - This is called when the item in the list is being dragged.
18306 * - @c "longpressed" - This is called when the item is pressed for a certain
18307 * amount of time. By default it's 1 second.
18308 * - @c "scroll,anim,start" - This is called when scrolling animation has
18310 * - @c "scroll,anim,stop" - This is called when scrolling animation has
18312 * - @c "scroll,drag,start" - This is called when dragging the content has
18314 * - @c "scroll,drag,stop" - This is called when dragging the content has
18316 * - @c "edge,top" - This is called when the genlist is scrolled until
18318 * - @c "edge,bottom" - This is called when the genlist is scrolled
18319 * until the bottom edge.
18320 * - @c "edge,left" - This is called when the genlist is scrolled
18321 * until the left edge.
18322 * - @c "edge,right" - This is called when the genlist is scrolled
18323 * until the right edge.
18324 * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18326 * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18328 * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18330 * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18332 * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18333 * pinched out. "- @c multi,pinch,in" - This is called when the genlist is
18334 * multi-touch pinched in.
18335 * - @c "swipe" - This is called when the genlist is swiped.
18336 * - @c "moved" - This is called when a genlist item is moved.
18337 * - @c "language,changed" - This is called when the program's language is
18340 * @section Genlist_Examples Examples
18342 * Here is a list of examples that use the genlist, trying to show some of
18343 * its capabilities:
18344 * - @ref genlist_example_01
18345 * - @ref genlist_example_02
18346 * - @ref genlist_example_03
18347 * - @ref genlist_example_04
18348 * - @ref genlist_example_05
18352 * @addtogroup Genlist
18357 * @enum _Elm_Genlist_Item_Flags
18358 * @typedef Elm_Genlist_Item_Flags
18360 * Defines if the item is of any special type (has subitems or it's the
18361 * index of a group), or is just a simple item.
18365 typedef enum _Elm_Genlist_Item_Flags
18367 ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18368 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18369 ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18370 } Elm_Genlist_Item_Flags;
18371 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class; /**< Genlist item class definition structs */
18372 #define Elm_Genlist_Item_Class Elm_Gen_Item_Class
18373 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18374 #define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18375 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
18376 typedef char *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
18377 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. */
18378 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. */
18379 typedef void (*Elm_Genlist_Item_Del_Cb) (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
18382 * @struct _Elm_Genlist_Item_Class
18384 * Genlist item class definition structs.
18386 * This struct contains the style and fetching functions that will define the
18387 * contents of each item.
18389 * @see @ref Genlist_Item_Class
18391 struct _Elm_Genlist_Item_Class
18393 const char *item_style; /**< style of this class. */
18394 struct Elm_Genlist_Item_Class_Func
18396 Elm_Genlist_Item_Label_Get_Cb label_get; /**< Label fetching class function for genlist item classes.*/
18397 Elm_Genlist_Item_Content_Get_Cb content_get; /**< Content fetching class function for genlist item classes. */
18398 Elm_Genlist_Item_State_Get_Cb state_get; /**< State fetching class function for genlist item classes. */
18399 Elm_Genlist_Item_Del_Cb del; /**< Deletion class function for genlist item classes. */
18402 #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18404 * Add a new genlist widget to the given parent Elementary
18405 * (container) object
18407 * @param parent The parent object
18408 * @return a new genlist widget handle or @c NULL, on errors
18410 * This function inserts a new genlist widget on the canvas.
18412 * @see elm_genlist_item_append()
18413 * @see elm_genlist_item_del()
18414 * @see elm_genlist_clear()
18418 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18420 * Remove all items from a given genlist widget.
18422 * @param obj The genlist object
18424 * This removes (and deletes) all items in @p obj, leaving it empty.
18426 * @see elm_genlist_item_del(), to remove just one item.
18430 EINA_DEPRECATED EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18432 * Enable or disable multi-selection in the genlist
18434 * @param obj The genlist object
18435 * @param multi Multi-select enable/disable. Default is disabled.
18437 * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18438 * the list. This allows more than 1 item to be selected. To retrieve the list
18439 * of selected items, use elm_genlist_selected_items_get().
18441 * @see elm_genlist_selected_items_get()
18442 * @see elm_genlist_multi_select_get()
18446 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18448 * Gets if multi-selection in genlist is enabled or disabled.
18450 * @param obj The genlist object
18451 * @return Multi-select enabled/disabled
18452 * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18454 * @see elm_genlist_multi_select_set()
18458 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18460 * This sets the horizontal stretching mode.
18462 * @param obj The genlist object
18463 * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18465 * This sets the mode used for sizing items horizontally. Valid modes
18466 * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18467 * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18468 * the scroller will scroll horizontally. Otherwise items are expanded
18469 * to fill the width of the viewport of the scroller. If it is
18470 * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18471 * limited to that size.
18473 * @see elm_genlist_horizontal_get()
18477 EAPI void elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18478 EINA_DEPRECATED EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18480 * Gets the horizontal stretching mode.
18482 * @param obj The genlist object
18483 * @return The mode to use
18484 * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18486 * @see elm_genlist_horizontal_set()
18490 EAPI Elm_List_Mode elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18491 EINA_DEPRECATED EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18493 * Set the always select mode.
18495 * @param obj The genlist object
18496 * @param always_select The always select mode (@c EINA_TRUE = on, @c
18497 * EINA_FALSE = off). Default is @c EINA_FALSE.
18499 * Items will only call their selection func and callback when first
18500 * becoming selected. Any further clicks will do nothing, unless you
18501 * enable always select with elm_genlist_always_select_mode_set().
18502 * This means that, even if selected, every click will make the selected
18503 * callbacks be called.
18505 * @see elm_genlist_always_select_mode_get()
18509 EINA_DEPRECATED EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18511 * Get the always select mode.
18513 * @param obj The genlist object
18514 * @return The always select mode
18515 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18517 * @see elm_genlist_always_select_mode_set()
18521 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18523 * Enable/disable the no select mode.
18525 * @param obj The genlist object
18526 * @param no_select The no select mode
18527 * (EINA_TRUE = on, EINA_FALSE = off)
18529 * This will turn off the ability to select items entirely and they
18530 * will neither appear selected nor call selected callback functions.
18532 * @see elm_genlist_no_select_mode_get()
18536 EINA_DEPRECATED EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18538 * Gets whether the no select mode is enabled.
18540 * @param obj The genlist object
18541 * @return The no select mode
18542 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18544 * @see elm_genlist_no_select_mode_set()
18548 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18550 * Enable/disable compress mode.
18552 * @param obj The genlist object
18553 * @param compress The compress mode
18554 * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18556 * This will enable the compress mode where items are "compressed"
18557 * horizontally to fit the genlist scrollable viewport width. This is
18558 * special for genlist. Do not rely on
18559 * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18560 * work as genlist needs to handle it specially.
18562 * @see elm_genlist_compress_mode_get()
18566 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18568 * Get whether the compress mode is enabled.
18570 * @param obj The genlist object
18571 * @return The compress mode
18572 * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18574 * @see elm_genlist_compress_mode_set()
18578 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18580 * Enable/disable height-for-width mode.
18582 * @param obj The genlist object
18583 * @param setting The height-for-width mode (@c EINA_TRUE = on,
18584 * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18586 * With height-for-width mode the item width will be fixed (restricted
18587 * to a minimum of) to the list width when calculating its size in
18588 * order to allow the height to be calculated based on it. This allows,
18589 * for instance, text block to wrap lines if the Edje part is
18590 * configured with "text.min: 0 1".
18592 * @note This mode will make list resize slower as it will have to
18593 * recalculate every item height again whenever the list width
18596 * @note When height-for-width mode is enabled, it also enables
18597 * compress mode (see elm_genlist_compress_mode_set()) and
18598 * disables homogeneous (see elm_genlist_homogeneous_set()).
18602 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18604 * Get whether the height-for-width mode is enabled.
18606 * @param obj The genlist object
18607 * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18612 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18614 * Enable/disable horizontal and vertical bouncing effect.
18616 * @param obj The genlist object
18617 * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18618 * EINA_FALSE = off). Default is @c EINA_FALSE.
18619 * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18620 * EINA_FALSE = off). Default is @c EINA_TRUE.
18622 * This will enable or disable the scroller bouncing effect for the
18623 * genlist. See elm_scroller_bounce_set() for details.
18625 * @see elm_scroller_bounce_set()
18626 * @see elm_genlist_bounce_get()
18630 EINA_DEPRECATED EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18632 * Get whether the horizontal and vertical bouncing effect is enabled.
18634 * @param obj The genlist object
18635 * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18637 * @param v_bounce Pointer to a bool to receive if the bounce vertically
18640 * @see elm_genlist_bounce_set()
18644 EINA_DEPRECATED EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18646 * Enable/disable homogenous mode.
18648 * @param obj The genlist object
18649 * @param homogeneous Assume the items within the genlist are of the
18650 * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18653 * This will enable the homogeneous mode where items are of the same
18654 * height and width so that genlist may do the lazy-loading at its
18655 * maximum (which increases the performance for scrolling the list). This
18656 * implies 'compressed' mode.
18658 * @see elm_genlist_compress_mode_set()
18659 * @see elm_genlist_homogeneous_get()
18663 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18665 * Get whether the homogenous mode is enabled.
18667 * @param obj The genlist object
18668 * @return Assume the items within the genlist are of the same height
18669 * and width (EINA_TRUE = on, EINA_FALSE = off)
18671 * @see elm_genlist_homogeneous_set()
18675 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18677 * Set the maximum number of items within an item block
18679 * @param obj The genlist object
18680 * @param n Maximum number of items within an item block. Default is 32.
18682 * This will configure the block count to tune to the target with
18683 * particular performance matrix.
18685 * A block of objects will be used to reduce the number of operations due to
18686 * many objects in the screen. It can determine the visibility, or if the
18687 * object has changed, it theme needs to be updated, etc. doing this kind of
18688 * calculation to the entire block, instead of per object.
18690 * The default value for the block count is enough for most lists, so unless
18691 * you know you will have a lot of objects visible in the screen at the same
18692 * time, don't try to change this.
18694 * @see elm_genlist_block_count_get()
18695 * @see @ref Genlist_Implementation
18699 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18701 * Get the maximum number of items within an item block
18703 * @param obj The genlist object
18704 * @return Maximum number of items within an item block
18706 * @see elm_genlist_block_count_set()
18710 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18712 * Set the timeout in seconds for the longpress event.
18714 * @param obj The genlist object
18715 * @param timeout timeout in seconds. Default is 1.
18717 * This option will change how long it takes to send an event "longpressed"
18718 * after the mouse down signal is sent to the list. If this event occurs, no
18719 * "clicked" event will be sent.
18721 * @see elm_genlist_longpress_timeout_set()
18725 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18727 * Get the timeout in seconds for the longpress event.
18729 * @param obj The genlist object
18730 * @return timeout in seconds
18732 * @see elm_genlist_longpress_timeout_get()
18736 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18738 * Append a new item in a given genlist widget.
18740 * @param obj The genlist object
18741 * @param itc The item class for the item
18742 * @param data The item data
18743 * @param parent The parent item, or NULL if none
18744 * @param flags Item flags
18745 * @param func Convenience function called when the item is selected
18746 * @param func_data Data passed to @p func above.
18747 * @return A handle to the item added or @c NULL if not possible
18749 * This adds the given item to the end of the list or the end of
18750 * the children list if the @p parent is given.
18752 * @see elm_genlist_item_prepend()
18753 * @see elm_genlist_item_insert_before()
18754 * @see elm_genlist_item_insert_after()
18755 * @see elm_genlist_item_del()
18759 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);
18761 * Prepend a new item in a given genlist widget.
18763 * @param obj The genlist object
18764 * @param itc The item class for the item
18765 * @param data The item data
18766 * @param parent The parent item, or NULL if none
18767 * @param flags Item flags
18768 * @param func Convenience function called when the item is selected
18769 * @param func_data Data passed to @p func above.
18770 * @return A handle to the item added or NULL if not possible
18772 * This adds an item to the beginning of the list or beginning of the
18773 * children of the parent if given.
18775 * @see elm_genlist_item_append()
18776 * @see elm_genlist_item_insert_before()
18777 * @see elm_genlist_item_insert_after()
18778 * @see elm_genlist_item_del()
18782 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);
18784 * Insert an item before another in a genlist widget
18786 * @param obj The genlist object
18787 * @param itc The item class for the item
18788 * @param data The item data
18789 * @param before The item to place this new one before.
18790 * @param flags Item flags
18791 * @param func Convenience function called when the item is selected
18792 * @param func_data Data passed to @p func above.
18793 * @return A handle to the item added or @c NULL if not possible
18795 * This inserts an item before another in the list. It will be in the
18796 * same tree level or group as the item it is inserted before.
18798 * @see elm_genlist_item_append()
18799 * @see elm_genlist_item_prepend()
18800 * @see elm_genlist_item_insert_after()
18801 * @see elm_genlist_item_del()
18805 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);
18807 * Insert an item after another in a genlist widget
18809 * @param obj The genlist object
18810 * @param itc The item class for the item
18811 * @param data The item data
18812 * @param after The item to place this new one after.
18813 * @param flags Item flags
18814 * @param func Convenience function called when the item is selected
18815 * @param func_data Data passed to @p func above.
18816 * @return A handle to the item added or @c NULL if not possible
18818 * This inserts an item after another in the list. It will be in the
18819 * same tree level or group as the item it is inserted after.
18821 * @see elm_genlist_item_append()
18822 * @see elm_genlist_item_prepend()
18823 * @see elm_genlist_item_insert_before()
18824 * @see elm_genlist_item_del()
18828 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);
18830 * Insert a new item into the sorted genlist object
18832 * @param obj The genlist object
18833 * @param itc The item class for the item
18834 * @param data The item data
18835 * @param parent The parent item, or NULL if none
18836 * @param flags Item flags
18837 * @param comp The function called for the sort
18838 * @param func Convenience function called when item selected
18839 * @param func_data Data passed to @p func above.
18840 * @return A handle to the item added or NULL if not possible
18844 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);
18845 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);
18846 /* operations to retrieve existing items */
18848 * Get the selectd item in the genlist.
18850 * @param obj The genlist object
18851 * @return The selected item, or NULL if none is selected.
18853 * This gets the selected item in the list (if multi-selection is enabled, only
18854 * the item that was first selected in the list is returned - which is not very
18855 * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18858 * If no item is selected, NULL is returned.
18860 * @see elm_genlist_selected_items_get()
18864 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18866 * Get a list of selected items in the genlist.
18868 * @param obj The genlist object
18869 * @return The list of selected items, or NULL if none are selected.
18871 * It returns a list of the selected items. This list pointer is only valid so
18872 * long as the selection doesn't change (no items are selected or unselected, or
18873 * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18874 * pointers. The order of the items in this list is the order which they were
18875 * selected, i.e. the first item in this list is the first item that was
18876 * selected, and so on.
18878 * @note If not in multi-select mode, consider using function
18879 * elm_genlist_selected_item_get() instead.
18881 * @see elm_genlist_multi_select_set()
18882 * @see elm_genlist_selected_item_get()
18886 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18888 * Get the mode item style of items in the genlist
18889 * @param obj The genlist object
18890 * @return The mode item style string, or NULL if none is specified
18892 * This is a constant string and simply defines the name of the
18893 * style that will be used for mode animations. It can be
18894 * @c NULL if you don't plan to use Genlist mode. See
18895 * elm_genlist_item_mode_set() for more info.
18899 EAPI const char *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18901 * Set the mode item style of items in the genlist
18902 * @param obj The genlist object
18903 * @param style The mode item style string, or NULL if none is desired
18905 * This is a constant string and simply defines the name of the
18906 * style that will be used for mode animations. It can be
18907 * @c NULL if you don't plan to use Genlist mode. See
18908 * elm_genlist_item_mode_set() for more info.
18912 EAPI void elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
18914 * Get a list of realized items in genlist
18916 * @param obj The genlist object
18917 * @return The list of realized items, nor NULL if none are realized.
18919 * This returns a list of the realized items in the genlist. The list
18920 * contains Elm_Genlist_Item pointers. The list must be freed by the
18921 * caller when done with eina_list_free(). The item pointers in the
18922 * list are only valid so long as those items are not deleted or the
18923 * genlist is not deleted.
18925 * @see elm_genlist_realized_items_update()
18929 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18931 * Get the item that is at the x, y canvas coords.
18933 * @param obj The gelinst object.
18934 * @param x The input x coordinate
18935 * @param y The input y coordinate
18936 * @param posret The position relative to the item returned here
18937 * @return The item at the coordinates or NULL if none
18939 * This returns the item at the given coordinates (which are canvas
18940 * relative, not object-relative). If an item is at that coordinate,
18941 * that item handle is returned, and if @p posret is not NULL, the
18942 * integer pointed to is set to a value of -1, 0 or 1, depending if
18943 * the coordinate is on the upper portion of that item (-1), on the
18944 * middle section (0) or on the lower part (1). If NULL is returned as
18945 * an item (no item found there), then posret may indicate -1 or 1
18946 * based if the coordinate is above or below all items respectively in
18951 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);
18953 * Get the first item in the genlist
18955 * This returns the first item in the list.
18957 * @param obj The genlist object
18958 * @return The first item, or NULL if none
18962 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18964 * Get the last item in the genlist
18966 * This returns the last item in the list.
18968 * @return The last item, or NULL if none
18972 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18974 * Set the scrollbar policy
18976 * @param obj The genlist object
18977 * @param policy_h Horizontal scrollbar policy.
18978 * @param policy_v Vertical scrollbar policy.
18980 * This sets the scrollbar visibility policy for the given genlist
18981 * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
18982 * made visible if it is needed, and otherwise kept hidden.
18983 * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
18984 * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
18985 * respectively for the horizontal and vertical scrollbars. Default is
18986 * #ELM_SMART_SCROLLER_POLICY_AUTO
18988 * @see elm_genlist_scroller_policy_get()
18992 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
18994 * Get the scrollbar policy
18996 * @param obj The genlist object
18997 * @param policy_h Pointer to store the horizontal scrollbar policy.
18998 * @param policy_v Pointer to store the vertical scrollbar policy.
19000 * @see elm_genlist_scroller_policy_set()
19004 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);
19006 * Get the @b next item in a genlist widget's internal list of items,
19007 * given a handle to one of those items.
19009 * @param item The genlist item to fetch next from
19010 * @return The item after @p item, or @c NULL if there's none (and
19013 * This returns the item placed after the @p item, on the container
19016 * @see elm_genlist_item_prev_get()
19020 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19022 * Get the @b previous item in a genlist widget's internal list of items,
19023 * given a handle to one of those items.
19025 * @param item The genlist item to fetch previous from
19026 * @return The item before @p item, or @c NULL if there's none (and
19029 * This returns the item placed before the @p item, on the container
19032 * @see elm_genlist_item_next_get()
19036 EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19038 * Get the genlist object's handle which contains a given genlist
19041 * @param item The item to fetch the container from
19042 * @return The genlist (parent) object
19044 * This returns the genlist object itself that an item belongs to.
19048 EINA_DEPRECATED EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19050 * Get the parent item of the given item
19052 * @param it The item
19053 * @return The parent of the item or @c NULL if it has no parent.
19055 * This returns the item that was specified as parent of the item @p it on
19056 * elm_genlist_item_append() and insertion related functions.
19060 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19062 * Remove all sub-items (children) of the given item
19064 * @param it The item
19066 * This removes all items that are children (and their descendants) of the
19067 * given item @p it.
19069 * @see elm_genlist_clear()
19070 * @see elm_genlist_item_del()
19074 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19076 * Set whether a given genlist item is selected or not
19078 * @param it The item
19079 * @param selected Use @c EINA_TRUE, to make it selected, @c
19080 * EINA_FALSE to make it unselected
19082 * This sets the selected state of an item. If multi selection is
19083 * not enabled on the containing genlist and @p selected is @c
19084 * EINA_TRUE, any other previously selected items will get
19085 * unselected in favor of this new one.
19087 * @see elm_genlist_item_selected_get()
19091 EINA_DEPRECATED EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19093 * Get whether a given genlist item is selected or not
19095 * @param it The item
19096 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19098 * @see elm_genlist_item_selected_set() for more details
19102 EINA_DEPRECATED EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19104 * Sets the expanded state of an item.
19106 * @param it The item
19107 * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19109 * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19112 * The theme will respond to this change visually, and a signal "expanded" or
19113 * "contracted" will be sent from the genlist with a pointer to the item that
19114 * has been expanded/contracted.
19116 * Calling this function won't show or hide any child of this item (if it is
19117 * a parent). You must manually delete and create them on the callbacks fo
19118 * the "expanded" or "contracted" signals.
19120 * @see elm_genlist_item_expanded_get()
19124 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19126 * Get the expanded state of an item
19128 * @param it The item
19129 * @return The expanded state
19131 * This gets the expanded state of an item.
19133 * @see elm_genlist_item_expanded_set()
19137 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19139 * Get the depth of expanded item
19141 * @param it The genlist item object
19142 * @return The depth of expanded item
19146 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19148 * Set whether a given genlist item is disabled or not.
19150 * @param it The item
19151 * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19152 * to enable it back.
19154 * A disabled item cannot be selected or unselected. It will also
19155 * change its appearance, to signal the user it's disabled.
19157 * @see elm_genlist_item_disabled_get()
19161 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19163 * Get whether a given genlist item is disabled or not.
19165 * @param it The item
19166 * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19169 * @see elm_genlist_item_disabled_set() for more details
19173 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19175 * Sets the display only state of an item.
19177 * @param it The item
19178 * @param display_only @c EINA_TRUE if the item is display only, @c
19179 * EINA_FALSE otherwise.
19181 * A display only item cannot be selected or unselected. It is for
19182 * display only and not selecting or otherwise clicking, dragging
19183 * etc. by the user, thus finger size rules will not be applied to
19186 * It's good to set group index items to display only state.
19188 * @see elm_genlist_item_display_only_get()
19192 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19194 * Get the display only state of an item
19196 * @param it The item
19197 * @return @c EINA_TRUE if the item is display only, @c
19198 * EINA_FALSE otherwise.
19200 * @see elm_genlist_item_display_only_set()
19204 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19206 * Show the portion of a genlist's internal list containing a given
19207 * item, immediately.
19209 * @param it The item to display
19211 * This causes genlist to jump to the given item @p it and show it (by
19212 * immediately scrolling to that position), if it is not fully visible.
19214 * @see elm_genlist_item_bring_in()
19215 * @see elm_genlist_item_top_show()
19216 * @see elm_genlist_item_middle_show()
19220 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19222 * Animatedly bring in, to the visible are of a genlist, a given
19225 * @param it The item to display
19227 * This causes genlist to jump to the given item @p it and show it (by
19228 * animatedly scrolling), if it is not fully visible. This may use animation
19229 * to do so and take a period of time
19231 * @see elm_genlist_item_show()
19232 * @see elm_genlist_item_top_bring_in()
19233 * @see elm_genlist_item_middle_bring_in()
19237 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19239 * Show the portion of a genlist's internal list containing a given
19240 * item, immediately.
19242 * @param it The item to display
19244 * This causes genlist to jump to the given item @p it and show it (by
19245 * immediately scrolling to that position), if it is not fully visible.
19247 * The item will be positioned at the top of the genlist viewport.
19249 * @see elm_genlist_item_show()
19250 * @see elm_genlist_item_top_bring_in()
19254 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19256 * Animatedly bring in, to the visible are of a genlist, a given
19259 * @param it The item
19261 * This causes genlist to jump to the given item @p it and show it (by
19262 * animatedly scrolling), if it is not fully visible. This may use animation
19263 * to do so and take a period of time
19265 * The item will be positioned at the top of the genlist viewport.
19267 * @see elm_genlist_item_bring_in()
19268 * @see elm_genlist_item_top_show()
19272 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19274 * Show the portion of a genlist's internal list containing a given
19275 * item, immediately.
19277 * @param it The item to display
19279 * This causes genlist to jump to the given item @p it and show it (by
19280 * immediately scrolling to that position), if it is not fully visible.
19282 * The item will be positioned at the middle of the genlist viewport.
19284 * @see elm_genlist_item_show()
19285 * @see elm_genlist_item_middle_bring_in()
19289 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19291 * Animatedly bring in, to the visible are of a genlist, a given
19294 * @param it The item
19296 * This causes genlist to jump to the given item @p it and show it (by
19297 * animatedly scrolling), if it is not fully visible. This may use animation
19298 * to do so and take a period of time
19300 * The item will be positioned at the middle of the genlist viewport.
19302 * @see elm_genlist_item_bring_in()
19303 * @see elm_genlist_item_middle_show()
19307 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19309 * Remove a genlist item from the its parent, deleting it.
19311 * @param item The item to be removed.
19312 * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19314 * @see elm_genlist_clear(), to remove all items in a genlist at
19319 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19321 * Return the data associated to a given genlist item
19323 * @param item The genlist item.
19324 * @return the data associated to this item.
19326 * This returns the @c data value passed on the
19327 * elm_genlist_item_append() and related item addition calls.
19329 * @see elm_genlist_item_append()
19330 * @see elm_genlist_item_data_set()
19334 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19336 * Set the data associated to a given genlist item
19338 * @param item The genlist item
19339 * @param data The new data pointer to set on it
19341 * This @b overrides the @c data value passed on the
19342 * elm_genlist_item_append() and related item addition calls. This
19343 * function @b won't call elm_genlist_item_update() automatically,
19344 * so you'd issue it afterwards if you want to hove the item
19345 * updated to reflect the that new data.
19347 * @see elm_genlist_item_data_get()
19351 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19353 * Tells genlist to "orphan" icons fetchs by the item class
19355 * @param it The item
19357 * This instructs genlist to release references to icons in the item,
19358 * meaning that they will no longer be managed by genlist and are
19359 * floating "orphans" that can be re-used elsewhere if the user wants
19364 EAPI void elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19365 EINA_DEPRECATED EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19367 * Get the real Evas object created to implement the view of a
19368 * given genlist item
19370 * @param item The genlist item.
19371 * @return the Evas object implementing this item's view.
19373 * This returns the actual Evas object used to implement the
19374 * specified genlist item's view. This may be @c NULL, as it may
19375 * not have been created or may have been deleted, at any time, by
19376 * the genlist. <b>Do not modify this object</b> (move, resize,
19377 * show, hide, etc.), as the genlist is controlling it. This
19378 * function is for querying, emitting custom signals or hooking
19379 * lower level callbacks for events on that object. Do not delete
19380 * this object under any circumstances.
19382 * @see elm_genlist_item_data_get()
19386 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19388 * Update the contents of an item
19390 * @param it The item
19392 * This updates an item by calling all the item class functions again
19393 * to get the icons, labels and states. Use this when the original
19394 * item data has changed and the changes are desired to be reflected.
19396 * Use elm_genlist_realized_items_update() to update all already realized
19399 * @see elm_genlist_realized_items_update()
19403 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19405 * Update the item class of an item
19407 * @param it The item
19408 * @param itc The item class for the item
19410 * This sets another class fo the item, changing the way that it is
19411 * displayed. After changing the item class, elm_genlist_item_update() is
19412 * called on the item @p it.
19416 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19417 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19419 * Set the text to be shown in a given genlist item's tooltips.
19421 * @param item The genlist item
19422 * @param text The text to set in the content
19424 * This call will setup the text to be used as tooltip to that item
19425 * (analogous to elm_object_tooltip_text_set(), but being item
19426 * tooltips with higher precedence than object tooltips). It can
19427 * have only one tooltip at a time, so any previous tooltip data
19428 * will get removed.
19430 * In order to set an icon or something else as a tooltip, look at
19431 * elm_genlist_item_tooltip_content_cb_set().
19435 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19437 * Set the content to be shown in a given genlist item's tooltips
19439 * @param item The genlist item.
19440 * @param func The function returning the tooltip contents.
19441 * @param data What to provide to @a func as callback data/context.
19442 * @param del_cb Called when data is not needed anymore, either when
19443 * another callback replaces @p func, the tooltip is unset with
19444 * elm_genlist_item_tooltip_unset() or the owner @p item
19445 * dies. This callback receives as its first parameter the
19446 * given @p data, being @c event_info the item handle.
19448 * This call will setup the tooltip's contents to @p item
19449 * (analogous to elm_object_tooltip_content_cb_set(), but being
19450 * item tooltips with higher precedence than object tooltips). It
19451 * can have only one tooltip at a time, so any previous tooltip
19452 * content will get removed. @p func (with @p data) will be called
19453 * every time Elementary needs to show the tooltip and it should
19454 * return a valid Evas object, which will be fully managed by the
19455 * tooltip system, getting deleted when the tooltip is gone.
19457 * In order to set just a text as a tooltip, look at
19458 * elm_genlist_item_tooltip_text_set().
19462 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);
19464 * Unset a tooltip from a given genlist item
19466 * @param item genlist item to remove a previously set tooltip from.
19468 * This call removes any tooltip set on @p item. The callback
19469 * provided as @c del_cb to
19470 * elm_genlist_item_tooltip_content_cb_set() will be called to
19471 * notify it is not used anymore (and have resources cleaned, if
19474 * @see elm_genlist_item_tooltip_content_cb_set()
19478 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19480 * Set a different @b style for a given genlist item's tooltip.
19482 * @param item genlist item with tooltip set
19483 * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19484 * "default", @c "transparent", etc)
19486 * Tooltips can have <b>alternate styles</b> to be displayed on,
19487 * which are defined by the theme set on Elementary. This function
19488 * works analogously as elm_object_tooltip_style_set(), but here
19489 * applied only to genlist item objects. The default style for
19490 * tooltips is @c "default".
19492 * @note before you set a style you should define a tooltip with
19493 * elm_genlist_item_tooltip_content_cb_set() or
19494 * elm_genlist_item_tooltip_text_set()
19496 * @see elm_genlist_item_tooltip_style_get()
19500 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19502 * Get the style set a given genlist item's tooltip.
19504 * @param item genlist item with tooltip already set on.
19505 * @return style the theme style in use, which defaults to
19506 * "default". If the object does not have a tooltip set,
19507 * then @c NULL is returned.
19509 * @see elm_genlist_item_tooltip_style_set() for more details
19513 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19515 * @brief Disable size restrictions on an object's tooltip
19516 * @param item The tooltip's anchor object
19517 * @param disable If EINA_TRUE, size restrictions are disabled
19518 * @return EINA_FALSE on failure, EINA_TRUE on success
19520 * This function allows a tooltip to expand beyond its parant window's canvas.
19521 * It will instead be limited only by the size of the display.
19523 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19525 * @brief Retrieve size restriction state of an object's tooltip
19526 * @param item The tooltip's anchor object
19527 * @return If EINA_TRUE, size restrictions are disabled
19529 * This function returns whether a tooltip is allowed to expand beyond
19530 * its parant window's canvas.
19531 * It will instead be limited only by the size of the display.
19533 EAPI Eina_Bool elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19535 * Set the type of mouse pointer/cursor decoration to be shown,
19536 * when the mouse pointer is over the given genlist widget item
19538 * @param item genlist item to customize cursor on
19539 * @param cursor the cursor type's name
19541 * This function works analogously as elm_object_cursor_set(), but
19542 * here the cursor's changing area is restricted to the item's
19543 * area, and not the whole widget's. Note that that item cursors
19544 * have precedence over widget cursors, so that a mouse over @p
19545 * item will always show cursor @p type.
19547 * If this function is called twice for an object, a previously set
19548 * cursor will be unset on the second call.
19550 * @see elm_object_cursor_set()
19551 * @see elm_genlist_item_cursor_get()
19552 * @see elm_genlist_item_cursor_unset()
19556 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19558 * Get the type of mouse pointer/cursor decoration set to be shown,
19559 * when the mouse pointer is over the given genlist widget item
19561 * @param item genlist item with custom cursor set
19562 * @return the cursor type's name or @c NULL, if no custom cursors
19563 * were set to @p item (and on errors)
19565 * @see elm_object_cursor_get()
19566 * @see elm_genlist_item_cursor_set() for more details
19567 * @see elm_genlist_item_cursor_unset()
19571 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19573 * Unset any custom mouse pointer/cursor decoration set to be
19574 * shown, when the mouse pointer is over the given genlist widget
19575 * item, thus making it show the @b default cursor again.
19577 * @param item a genlist item
19579 * Use this call to undo any custom settings on this item's cursor
19580 * decoration, bringing it back to defaults (no custom style set).
19582 * @see elm_object_cursor_unset()
19583 * @see elm_genlist_item_cursor_set() for more details
19587 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19589 * Set a different @b style for a given custom cursor set for a
19592 * @param item genlist item with custom cursor set
19593 * @param style the <b>theme style</b> to use (e.g. @c "default",
19594 * @c "transparent", etc)
19596 * This function only makes sense when one is using custom mouse
19597 * cursor decorations <b>defined in a theme file</b> , which can
19598 * have, given a cursor name/type, <b>alternate styles</b> on
19599 * it. It works analogously as elm_object_cursor_style_set(), but
19600 * here applied only to genlist item objects.
19602 * @warning Before you set a cursor style you should have defined a
19603 * custom cursor previously on the item, with
19604 * elm_genlist_item_cursor_set()
19606 * @see elm_genlist_item_cursor_engine_only_set()
19607 * @see elm_genlist_item_cursor_style_get()
19611 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19613 * Get the current @b style set for a given genlist item's custom
19616 * @param item genlist item with custom cursor set.
19617 * @return style the cursor style in use. If the object does not
19618 * have a cursor set, then @c NULL is returned.
19620 * @see elm_genlist_item_cursor_style_set() for more details
19624 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19626 * Set if the (custom) cursor for a given genlist item should be
19627 * searched in its theme, also, or should only rely on the
19628 * rendering engine.
19630 * @param item item with custom (custom) cursor already set on
19631 * @param engine_only Use @c EINA_TRUE to have cursors looked for
19632 * only on those provided by the rendering engine, @c EINA_FALSE to
19633 * have them searched on the widget's theme, as well.
19635 * @note This call is of use only if you've set a custom cursor
19636 * for genlist items, with elm_genlist_item_cursor_set().
19638 * @note By default, cursors will only be looked for between those
19639 * provided by the rendering engine.
19643 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19645 * Get if the (custom) cursor for a given genlist item is being
19646 * searched in its theme, also, or is only relying on the rendering
19649 * @param item a genlist item
19650 * @return @c EINA_TRUE, if cursors are being looked for only on
19651 * those provided by the rendering engine, @c EINA_FALSE if they
19652 * are being searched on the widget's theme, as well.
19654 * @see elm_genlist_item_cursor_engine_only_set(), for more details
19658 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19660 * Update the contents of all realized items.
19662 * @param obj The genlist object.
19664 * This updates all realized items by calling all the item class functions again
19665 * to get the icons, labels and states. Use this when the original
19666 * item data has changed and the changes are desired to be reflected.
19668 * To update just one item, use elm_genlist_item_update().
19670 * @see elm_genlist_realized_items_get()
19671 * @see elm_genlist_item_update()
19675 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19677 * Activate a genlist mode on an item
19679 * @param item The genlist item
19680 * @param mode Mode name
19681 * @param mode_set Boolean to define set or unset mode.
19683 * A genlist mode is a different way of selecting an item. Once a mode is
19684 * activated on an item, any other selected item is immediately unselected.
19685 * This feature provides an easy way of implementing a new kind of animation
19686 * for selecting an item, without having to entirely rewrite the item style
19687 * theme. However, the elm_genlist_selected_* API can't be used to get what
19688 * item is activate for a mode.
19690 * The current item style will still be used, but applying a genlist mode to
19691 * an item will select it using a different kind of animation.
19693 * The current active item for a mode can be found by
19694 * elm_genlist_mode_item_get().
19696 * The characteristics of genlist mode are:
19697 * - Only one mode can be active at any time, and for only one item.
19698 * - Genlist handles deactivating other items when one item is activated.
19699 * - A mode is defined in the genlist theme (edc), and more modes can easily
19701 * - A mode style and the genlist item style are different things. They
19702 * can be combined to provide a default style to the item, with some kind
19703 * of animation for that item when the mode is activated.
19705 * When a mode is activated on an item, a new view for that item is created.
19706 * The theme of this mode defines the animation that will be used to transit
19707 * the item from the old view to the new view. This second (new) view will be
19708 * active for that item while the mode is active on the item, and will be
19709 * destroyed after the mode is totally deactivated from that item.
19711 * @see elm_genlist_mode_get()
19712 * @see elm_genlist_mode_item_get()
19716 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19718 * Get the last (or current) genlist mode used.
19720 * @param obj The genlist object
19722 * This function just returns the name of the last used genlist mode. It will
19723 * be the current mode if it's still active.
19725 * @see elm_genlist_item_mode_set()
19726 * @see elm_genlist_mode_item_get()
19730 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19732 * Get active genlist mode item
19734 * @param obj The genlist object
19735 * @return The active item for that current mode. Or @c NULL if no item is
19736 * activated with any mode.
19738 * This function returns the item that was activated with a mode, by the
19739 * function elm_genlist_item_mode_set().
19741 * @see elm_genlist_item_mode_set()
19742 * @see elm_genlist_mode_get()
19746 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19751 * @param obj The genlist object
19752 * @param reorder_mode The reorder mode
19753 * (EINA_TRUE = on, EINA_FALSE = off)
19757 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19760 * Get the reorder mode
19762 * @param obj The genlist object
19763 * @return The reorder mode
19764 * (EINA_TRUE = on, EINA_FALSE = off)
19768 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19775 * @defgroup Check Check
19777 * @image html img/widget/check/preview-00.png
19778 * @image latex img/widget/check/preview-00.eps
19779 * @image html img/widget/check/preview-01.png
19780 * @image latex img/widget/check/preview-01.eps
19781 * @image html img/widget/check/preview-02.png
19782 * @image latex img/widget/check/preview-02.eps
19784 * @brief The check widget allows for toggling a value between true and
19787 * Check objects are a lot like radio objects in layout and functionality
19788 * except they do not work as a group, but independently and only toggle the
19789 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19790 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19791 * returns the current state. For convenience, like the radio objects, you
19792 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19793 * for it to modify.
19795 * Signals that you can add callbacks for are:
19796 * "changed" - This is called whenever the user changes the state of one of
19797 * the check object(event_info is NULL).
19799 * Default contents parts of the check widget that you can use for are:
19800 * @li "elm.swallow.content" - A icon of the check
19802 * Default text parts of the check widget that you can use for are:
19803 * @li "elm.text" - Label of the check
19805 * @ref tutorial_check should give you a firm grasp of how to use this widget
19810 * @brief Add a new Check object
19812 * @param parent The parent object
19813 * @return The new object or NULL if it cannot be created
19815 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19817 * @brief Set the text label of the check object
19819 * @param obj The check object
19820 * @param label The text label string in UTF-8
19822 * @deprecated use elm_object_text_set() instead.
19824 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19826 * @brief Get the text label of the check object
19828 * @param obj The check object
19829 * @return The text label string in UTF-8
19831 * @deprecated use elm_object_text_get() instead.
19833 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19835 * @brief Set the icon object of the check object
19837 * @param obj The check object
19838 * @param icon The icon object
19840 * Once the icon object is set, a previously set one will be deleted.
19841 * If you want to keep that old content object, use the
19842 * elm_object_content_unset() function.
19844 * @deprecated use elm_object_content_set() instead.
19846 EINA_DEPRECATED EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19848 * @brief Get the icon object of the check object
19850 * @param obj The check object
19851 * @return The icon object
19853 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19855 * @brief Unset the icon used for the check object
19857 * @param obj The check object
19858 * @return The icon object that was being used
19860 * Unparent and return the icon object which was set for this widget.
19862 * @deprecated use elm_object_content_unset() instead.
19864 EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19866 * @brief Set the on/off state of the check object
19868 * @param obj The check object
19869 * @param state The state to use (1 == on, 0 == off)
19871 * This sets the state of the check. If set
19872 * with elm_check_state_pointer_set() the state of that variable is also
19873 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19875 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19877 * @brief Get the state of the check object
19879 * @param obj The check object
19880 * @return The boolean state
19882 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19884 * @brief Set a convenience pointer to a boolean to change
19886 * @param obj The check object
19887 * @param statep Pointer to the boolean to modify
19889 * This sets a pointer to a boolean, that, in addition to the check objects
19890 * state will also be modified directly. To stop setting the object pointed
19891 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19892 * then when this is called, the check objects state will also be modified to
19893 * reflect the value of the boolean @p statep points to, just like calling
19894 * elm_check_state_set().
19896 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19897 EINA_DEPRECATED EAPI void elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
19898 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);
19905 * @defgroup Radio Radio
19907 * @image html img/widget/radio/preview-00.png
19908 * @image latex img/widget/radio/preview-00.eps
19910 * @brief Radio is a widget that allows for 1 or more options to be displayed
19911 * and have the user choose only 1 of them.
19913 * A radio object contains an indicator, an optional Label and an optional
19914 * icon object. While it's possible to have a group of only one radio they,
19915 * are normally used in groups of 2 or more. To add a radio to a group use
19916 * elm_radio_group_add(). The radio object(s) will select from one of a set
19917 * of integer values, so any value they are configuring needs to be mapped to
19918 * a set of integers. To configure what value that radio object represents,
19919 * use elm_radio_state_value_set() to set the integer it represents. To set
19920 * the value the whole group(which one is currently selected) is to indicate
19921 * use elm_radio_value_set() on any group member, and to get the groups value
19922 * use elm_radio_value_get(). For convenience the radio objects are also able
19923 * to directly set an integer(int) to the value that is selected. To specify
19924 * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19925 * The radio objects will modify this directly. That implies the pointer must
19926 * point to valid memory for as long as the radio objects exist.
19928 * Signals that you can add callbacks for are:
19929 * @li changed - This is called whenever the user changes the state of one of
19930 * the radio objects within the group of radio objects that work together.
19932 * Default contents parts of the radio widget that you can use for are:
19933 * @li "elm.swallow.content" - A icon of the radio
19935 * @ref tutorial_radio show most of this API in action.
19939 * @brief Add a new radio to the parent
19941 * @param parent The parent object
19942 * @return The new object or NULL if it cannot be created
19944 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19946 * @brief Set the text label of the radio object
19948 * @param obj The radio object
19949 * @param label The text label string in UTF-8
19951 * @deprecated use elm_object_text_set() instead.
19953 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19955 * @brief Get the text label of the radio object
19957 * @param obj The radio object
19958 * @return The text label string in UTF-8
19960 * @deprecated use elm_object_text_set() instead.
19962 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19964 * @brief Set the icon object of the radio object
19966 * @param obj The radio object
19967 * @param icon The icon object
19969 * Once the icon object is set, a previously set one will be deleted. If you
19970 * want to keep that old content object, use the elm_radio_icon_unset()
19973 * @deprecated use elm_object_content_set() instead.
19975 EINA_DEPRECATED EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19977 * @brief Get the icon object of the radio object
19979 * @param obj The radio object
19980 * @return The icon object
19982 * @see elm_radio_icon_set()
19984 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19986 * @brief Unset the icon used for the radio object
19988 * @param obj The radio object
19989 * @return The icon object that was being used
19991 * Unparent and return the icon object which was set for this widget.
19993 * @see elm_radio_icon_set()
19994 * @deprecated use elm_object_content_unset() instead.
19996 EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19998 * @brief Add this radio to a group of other radio objects
20000 * @param obj The radio object
20001 * @param group Any object whose group the @p obj is to join.
20003 * Radio objects work in groups. Each member should have a different integer
20004 * value assigned. In order to have them work as a group, they need to know
20005 * about each other. This adds the given radio object to the group of which
20006 * the group object indicated is a member.
20008 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
20010 * @brief Set the integer value that this radio object represents
20012 * @param obj The radio object
20013 * @param value The value to use if this radio object is selected
20015 * This sets the value of the radio.
20017 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20019 * @brief Get the integer value that this radio object represents
20021 * @param obj The radio object
20022 * @return The value used if this radio object is selected
20024 * This gets the value of the radio.
20026 * @see elm_radio_value_set()
20028 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20030 * @brief Set the value of the radio.
20032 * @param obj The radio object
20033 * @param value The value to use for the group
20035 * This sets the value of the radio group and will also set the value if
20036 * pointed to, to the value supplied, but will not call any callbacks.
20038 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20040 * @brief Get the state of the radio object
20042 * @param obj The radio object
20043 * @return The integer state
20045 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20047 * @brief Set a convenience pointer to a integer to change
20049 * @param obj The radio object
20050 * @param valuep Pointer to the integer to modify
20052 * This sets a pointer to a integer, that, in addition to the radio objects
20053 * state will also be modified directly. To stop setting the object pointed
20054 * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
20055 * when this is called, the radio objects state will also be modified to
20056 * reflect the value of the integer valuep points to, just like calling
20057 * elm_radio_value_set().
20059 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
20065 * @defgroup Pager Pager
20067 * @image html img/widget/pager/preview-00.png
20068 * @image latex img/widget/pager/preview-00.eps
20070 * @brief Widget that allows flipping between 1 or more “pages” of objects.
20072 * The flipping between “pages” of objects is animated. All content in pager
20073 * is kept in a stack, the last content to be added will be on the top of the
20074 * stack(be visible).
20076 * Objects can be pushed or popped from the stack or deleted as normal.
20077 * Pushes and pops will animate (and a pop will delete the object once the
20078 * animation is finished). Any object already in the pager can be promoted to
20079 * the top(from its current stacking position) through the use of
20080 * elm_pager_content_promote(). Objects are pushed to the top with
20081 * elm_pager_content_push() and when the top item is no longer wanted, simply
20082 * pop it with elm_pager_content_pop() and it will also be deleted. If an
20083 * object is no longer needed and is not the top item, just delete it as
20084 * normal. You can query which objects are the top and bottom with
20085 * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20087 * Signals that you can add callbacks for are:
20088 * "hide,finished" - when the previous page is hided
20090 * This widget has the following styles available:
20093 * @li fade_translucide
20094 * @li fade_invisible
20095 * @note This styles affect only the flipping animations, the appearance when
20096 * not animating is unaffected by styles.
20098 * @ref tutorial_pager gives a good overview of the usage of the API.
20102 * Add a new pager to the parent
20104 * @param parent The parent object
20105 * @return The new object or NULL if it cannot be created
20109 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20111 * @brief Push an object to the top of the pager stack (and show it).
20113 * @param obj The pager object
20114 * @param content The object to push
20116 * The object pushed becomes a child of the pager, it will be controlled and
20117 * deleted when the pager is deleted.
20119 * @note If the content is already in the stack use
20120 * elm_pager_content_promote().
20121 * @warning Using this function on @p content already in the stack results in
20122 * undefined behavior.
20124 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20126 * @brief Pop the object that is on top of the stack
20128 * @param obj The pager object
20130 * This pops the object that is on the top(visible) of the pager, makes it
20131 * disappear, then deletes the object. The object that was underneath it on
20132 * the stack will become visible.
20134 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20136 * @brief Moves an object already in the pager stack to the top of the stack.
20138 * @param obj The pager object
20139 * @param content The object to promote
20141 * This will take the @p content and move it to the top of the stack as
20142 * if it had been pushed there.
20144 * @note If the content isn't already in the stack use
20145 * elm_pager_content_push().
20146 * @warning Using this function on @p content not already in the stack
20147 * results in undefined behavior.
20149 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20151 * @brief Return the object at the bottom of the pager stack
20153 * @param obj The pager object
20154 * @return The bottom object or NULL if none
20156 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20158 * @brief Return the object at the top of the pager stack
20160 * @param obj The pager object
20161 * @return The top object or NULL if none
20163 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20170 * @defgroup Slideshow Slideshow
20172 * @image html img/widget/slideshow/preview-00.png
20173 * @image latex img/widget/slideshow/preview-00.eps
20175 * This widget, as the name indicates, is a pre-made image
20176 * slideshow panel, with API functions acting on (child) image
20177 * items presentation. Between those actions, are:
20178 * - advance to next/previous image
20179 * - select the style of image transition animation
20180 * - set the exhibition time for each image
20181 * - start/stop the slideshow
20183 * The transition animations are defined in the widget's theme,
20184 * consequently new animations can be added without having to
20185 * update the widget's code.
20187 * @section Slideshow_Items Slideshow items
20189 * For slideshow items, just like for @ref Genlist "genlist" ones,
20190 * the user defines a @b classes, specifying functions that will be
20191 * called on the item's creation and deletion times.
20193 * The #Elm_Slideshow_Item_Class structure contains the following
20196 * - @c func.get - When an item is displayed, this function is
20197 * called, and it's where one should create the item object, de
20198 * facto. For example, the object can be a pure Evas image object
20199 * or an Elementary @ref Photocam "photocam" widget. See
20200 * #SlideshowItemGetFunc.
20201 * - @c func.del - When an item is no more displayed, this function
20202 * is called, where the user must delete any data associated to
20203 * the item. See #SlideshowItemDelFunc.
20205 * @section Slideshow_Caching Slideshow caching
20207 * The slideshow provides facilities to have items adjacent to the
20208 * one being displayed <b>already "realized"</b> (i.e. loaded) for
20209 * you, so that the system does not have to decode image data
20210 * anymore at the time it has to actually switch images on its
20211 * viewport. The user is able to set the numbers of items to be
20212 * cached @b before and @b after the current item, in the widget's
20215 * Smart events one can add callbacks for are:
20217 * - @c "changed" - when the slideshow switches its view to a new
20220 * List of examples for the slideshow widget:
20221 * @li @ref slideshow_example
20225 * @addtogroup Slideshow
20229 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20230 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20231 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Slideshow item handle */
20232 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20233 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20236 * @struct _Elm_Slideshow_Item_Class
20238 * Slideshow item class definition. See @ref Slideshow_Items for
20241 struct _Elm_Slideshow_Item_Class
20243 struct _Elm_Slideshow_Item_Class_Func
20245 SlideshowItemGetFunc get;
20246 SlideshowItemDelFunc del;
20248 }; /**< #Elm_Slideshow_Item_Class member definitions */
20251 * Add a new slideshow widget to the given parent Elementary
20252 * (container) object
20254 * @param parent The parent object
20255 * @return A new slideshow widget handle or @c NULL, on errors
20257 * This function inserts a new slideshow widget on the canvas.
20259 * @ingroup Slideshow
20261 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20264 * Add (append) a new item in a given slideshow widget.
20266 * @param obj The slideshow object
20267 * @param itc The item class for the item
20268 * @param data The item's data
20269 * @return A handle to the item added or @c NULL, on errors
20271 * Add a new item to @p obj's internal list of items, appending it.
20272 * The item's class must contain the function really fetching the
20273 * image object to show for this item, which could be an Evas image
20274 * object or an Elementary photo, for example. The @p data
20275 * parameter is going to be passed to both class functions of the
20278 * @see #Elm_Slideshow_Item_Class
20279 * @see elm_slideshow_item_sorted_insert()
20281 * @ingroup Slideshow
20283 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20286 * Insert a new item into the given slideshow widget, using the @p func
20287 * function to sort items (by item handles).
20289 * @param obj The slideshow object
20290 * @param itc The item class for the item
20291 * @param data The item's data
20292 * @param func The comparing function to be used to sort slideshow
20293 * items <b>by #Elm_Slideshow_Item item handles</b>
20294 * @return Returns The slideshow item handle, on success, or
20295 * @c NULL, on errors
20297 * Add a new item to @p obj's internal list of items, in a position
20298 * determined by the @p func comparing function. The item's class
20299 * must contain the function really fetching the image object to
20300 * show for this item, which could be an Evas image object or an
20301 * Elementary photo, for example. The @p data parameter is going to
20302 * be passed to both class functions of the item.
20304 * @see #Elm_Slideshow_Item_Class
20305 * @see elm_slideshow_item_add()
20307 * @ingroup Slideshow
20309 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);
20312 * Display a given slideshow widget's item, programmatically.
20314 * @param obj The slideshow object
20315 * @param item The item to display on @p obj's viewport
20317 * The change between the current item and @p item will use the
20318 * transition @p obj is set to use (@see
20319 * elm_slideshow_transition_set()).
20321 * @ingroup Slideshow
20323 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20326 * Slide to the @b next item, in a given slideshow widget
20328 * @param obj The slideshow object
20330 * The sliding animation @p obj is set to use will be the
20331 * transition effect used, after this call is issued.
20333 * @note If the end of the slideshow's internal list of items is
20334 * reached, it'll wrap around to the list's beginning, again.
20336 * @ingroup Slideshow
20338 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20341 * Slide to the @b previous item, in a given slideshow widget
20343 * @param obj The slideshow object
20345 * The sliding animation @p obj is set to use will be the
20346 * transition effect used, after this call is issued.
20348 * @note If the beginning of the slideshow's internal list of items
20349 * is reached, it'll wrap around to the list's end, again.
20351 * @ingroup Slideshow
20353 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20356 * Returns the list of sliding transition/effect names available, for a
20357 * given slideshow widget.
20359 * @param obj The slideshow object
20360 * @return The list of transitions (list of @b stringshared strings
20363 * The transitions, which come from @p obj's theme, must be an EDC
20364 * data item named @c "transitions" on the theme file, with (prefix)
20365 * names of EDC programs actually implementing them.
20367 * The available transitions for slideshows on the default theme are:
20368 * - @c "fade" - the current item fades out, while the new one
20369 * fades in to the slideshow's viewport.
20370 * - @c "black_fade" - the current item fades to black, and just
20371 * then, the new item will fade in.
20372 * - @c "horizontal" - the current item slides horizontally, until
20373 * it gets out of the slideshow's viewport, while the new item
20374 * comes from the left to take its place.
20375 * - @c "vertical" - the current item slides vertically, until it
20376 * gets out of the slideshow's viewport, while the new item comes
20377 * from the bottom to take its place.
20378 * - @c "square" - the new item starts to appear from the middle of
20379 * the current one, but with a tiny size, growing until its
20380 * target (full) size and covering the old one.
20382 * @warning The stringshared strings get no new references
20383 * exclusive to the user grabbing the list, here, so if you'd like
20384 * to use them out of this call's context, you'd better @c
20385 * eina_stringshare_ref() them.
20387 * @see elm_slideshow_transition_set()
20389 * @ingroup Slideshow
20391 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20394 * Set the current slide transition/effect in use for a given
20397 * @param obj The slideshow object
20398 * @param transition The new transition's name string
20400 * If @p transition is implemented in @p obj's theme (i.e., is
20401 * contained in the list returned by
20402 * elm_slideshow_transitions_get()), this new sliding effect will
20403 * be used on the widget.
20405 * @see elm_slideshow_transitions_get() for more details
20407 * @ingroup Slideshow
20409 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20412 * Get the current slide transition/effect in use for a given
20415 * @param obj The slideshow object
20416 * @return The current transition's name
20418 * @see elm_slideshow_transition_set() for more details
20420 * @ingroup Slideshow
20422 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20425 * Set the interval between each image transition on a given
20426 * slideshow widget, <b>and start the slideshow, itself</b>
20428 * @param obj The slideshow object
20429 * @param timeout The new displaying timeout for images
20431 * After this call, the slideshow widget will start cycling its
20432 * view, sequentially and automatically, with the images of the
20433 * items it has. The time between each new image displayed is going
20434 * to be @p timeout, in @b seconds. If a different timeout was set
20435 * previously and an slideshow was in progress, it will continue
20436 * with the new time between transitions, after this call.
20438 * @note A value less than or equal to 0 on @p timeout will disable
20439 * the widget's internal timer, thus halting any slideshow which
20440 * could be happening on @p obj.
20442 * @see elm_slideshow_timeout_get()
20444 * @ingroup Slideshow
20446 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20449 * Get the interval set for image transitions on a given slideshow
20452 * @param obj The slideshow object
20453 * @return Returns the timeout set on it
20455 * @see elm_slideshow_timeout_set() for more details
20457 * @ingroup Slideshow
20459 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20462 * Set if, after a slideshow is started, for a given slideshow
20463 * widget, its items should be displayed cyclically or not.
20465 * @param obj The slideshow object
20466 * @param loop Use @c EINA_TRUE to make it cycle through items or
20467 * @c EINA_FALSE for it to stop at the end of @p obj's internal
20470 * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20471 * ignore what is set by this functions, i.e., they'll @b always
20472 * cycle through items. This affects only the "automatic"
20473 * slideshow, as set by elm_slideshow_timeout_set().
20475 * @see elm_slideshow_loop_get()
20477 * @ingroup Slideshow
20479 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20482 * Get if, after a slideshow is started, for a given slideshow
20483 * widget, its items are to be displayed cyclically or not.
20485 * @param obj The slideshow object
20486 * @return @c EINA_TRUE, if the items in @p obj will be cycled
20487 * through or @c EINA_FALSE, otherwise
20489 * @see elm_slideshow_loop_set() for more details
20491 * @ingroup Slideshow
20493 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20496 * Remove all items from a given slideshow widget
20498 * @param obj The slideshow object
20500 * This removes (and deletes) all items in @p obj, leaving it
20503 * @see elm_slideshow_item_del(), to remove just one item.
20505 * @ingroup Slideshow
20507 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20510 * Get the internal list of items in a given slideshow widget.
20512 * @param obj The slideshow object
20513 * @return The list of items (#Elm_Slideshow_Item as data) or
20514 * @c NULL on errors.
20516 * This list is @b not to be modified in any way and must not be
20517 * freed. Use the list members with functions like
20518 * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20520 * @warning This list is only valid until @p obj object's internal
20521 * items list is changed. It should be fetched again with another
20522 * call to this function when changes happen.
20524 * @ingroup Slideshow
20526 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20529 * Delete a given item from a slideshow widget.
20531 * @param item The slideshow item
20533 * @ingroup Slideshow
20535 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20538 * Return the data associated with a given slideshow item
20540 * @param item The slideshow item
20541 * @return Returns the data associated to this item
20543 * @ingroup Slideshow
20545 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20548 * Returns the currently displayed item, in a given slideshow widget
20550 * @param obj The slideshow object
20551 * @return A handle to the item being displayed in @p obj or
20552 * @c NULL, if none is (and on errors)
20554 * @ingroup Slideshow
20556 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20559 * Get the real Evas object created to implement the view of a
20560 * given slideshow item
20562 * @param item The slideshow item.
20563 * @return the Evas object implementing this item's view.
20565 * This returns the actual Evas object used to implement the
20566 * specified slideshow item's view. This may be @c NULL, as it may
20567 * not have been created or may have been deleted, at any time, by
20568 * the slideshow. <b>Do not modify this object</b> (move, resize,
20569 * show, hide, etc.), as the slideshow is controlling it. This
20570 * function is for querying, emitting custom signals or hooking
20571 * lower level callbacks for events on that object. Do not delete
20572 * this object under any circumstances.
20574 * @see elm_slideshow_item_data_get()
20576 * @ingroup Slideshow
20578 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20581 * Get the the item, in a given slideshow widget, placed at
20582 * position @p nth, in its internal items list
20584 * @param obj The slideshow object
20585 * @param nth The number of the item to grab a handle to (0 being
20587 * @return The item stored in @p obj at position @p nth or @c NULL,
20588 * if there's no item with that index (and on errors)
20590 * @ingroup Slideshow
20592 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20595 * Set the current slide layout in use for a given slideshow widget
20597 * @param obj The slideshow object
20598 * @param layout The new layout's name string
20600 * If @p layout is implemented in @p obj's theme (i.e., is contained
20601 * in the list returned by elm_slideshow_layouts_get()), this new
20602 * images layout will be used on the widget.
20604 * @see elm_slideshow_layouts_get() for more details
20606 * @ingroup Slideshow
20608 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20611 * Get the current slide layout in use for a given slideshow widget
20613 * @param obj The slideshow object
20614 * @return The current layout's name
20616 * @see elm_slideshow_layout_set() for more details
20618 * @ingroup Slideshow
20620 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20623 * Returns the list of @b layout names available, for a given
20624 * slideshow widget.
20626 * @param obj The slideshow object
20627 * @return The list of layouts (list of @b stringshared strings
20630 * Slideshow layouts will change how the widget is to dispose each
20631 * image item in its viewport, with regard to cropping, scaling,
20634 * The layouts, which come from @p obj's theme, must be an EDC
20635 * data item name @c "layouts" on the theme file, with (prefix)
20636 * names of EDC programs actually implementing them.
20638 * The available layouts for slideshows on the default theme are:
20639 * - @c "fullscreen" - item images with original aspect, scaled to
20640 * touch top and down slideshow borders or, if the image's heigh
20641 * is not enough, left and right slideshow borders.
20642 * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20643 * one, but always leaving 10% of the slideshow's dimensions of
20644 * distance between the item image's borders and the slideshow
20645 * borders, for each axis.
20647 * @warning The stringshared strings get no new references
20648 * exclusive to the user grabbing the list, here, so if you'd like
20649 * to use them out of this call's context, you'd better @c
20650 * eina_stringshare_ref() them.
20652 * @see elm_slideshow_layout_set()
20654 * @ingroup Slideshow
20656 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20659 * Set the number of items to cache, on a given slideshow widget,
20660 * <b>before the current item</b>
20662 * @param obj The slideshow object
20663 * @param count Number of items to cache before the current one
20665 * The default value for this property is @c 2. See
20666 * @ref Slideshow_Caching "slideshow caching" for more details.
20668 * @see elm_slideshow_cache_before_get()
20670 * @ingroup Slideshow
20672 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20675 * Retrieve the number of items to cache, on a given slideshow widget,
20676 * <b>before the current item</b>
20678 * @param obj The slideshow object
20679 * @return The number of items set to be cached before the current one
20681 * @see elm_slideshow_cache_before_set() for more details
20683 * @ingroup Slideshow
20685 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20688 * Set the number of items to cache, on a given slideshow widget,
20689 * <b>after the current item</b>
20691 * @param obj The slideshow object
20692 * @param count Number of items to cache after the current one
20694 * The default value for this property is @c 2. See
20695 * @ref Slideshow_Caching "slideshow caching" for more details.
20697 * @see elm_slideshow_cache_after_get()
20699 * @ingroup Slideshow
20701 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20704 * Retrieve the number of items to cache, on a given slideshow widget,
20705 * <b>after the current item</b>
20707 * @param obj The slideshow object
20708 * @return The number of items set to be cached after the current one
20710 * @see elm_slideshow_cache_after_set() for more details
20712 * @ingroup Slideshow
20714 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20717 * Get the number of items stored in a given slideshow widget
20719 * @param obj The slideshow object
20720 * @return The number of items on @p obj, at the moment of this call
20722 * @ingroup Slideshow
20724 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20731 * @defgroup Fileselector File Selector
20733 * @image html img/widget/fileselector/preview-00.png
20734 * @image latex img/widget/fileselector/preview-00.eps
20736 * A file selector is a widget that allows a user to navigate
20737 * through a file system, reporting file selections back via its
20740 * It contains shortcut buttons for home directory (@c ~) and to
20741 * jump one directory upwards (..), as well as cancel/ok buttons to
20742 * confirm/cancel a given selection. After either one of those two
20743 * former actions, the file selector will issue its @c "done" smart
20746 * There's a text entry on it, too, showing the name of the current
20747 * selection. There's the possibility of making it editable, so it
20748 * is useful on file saving dialogs on applications, where one
20749 * gives a file name to save contents to, in a given directory in
20750 * the system. This custom file name will be reported on the @c
20751 * "done" smart callback (explained in sequence).
20753 * Finally, it has a view to display file system items into in two
20758 * If Elementary is built with support of the Ethumb thumbnailing
20759 * library, the second form of view will display preview thumbnails
20760 * of files which it supports.
20762 * Smart callbacks one can register to:
20764 * - @c "selected" - the user has clicked on a file (when not in
20765 * folders-only mode) or directory (when in folders-only mode)
20766 * - @c "directory,open" - the list has been populated with new
20767 * content (@c event_info is a pointer to the directory's
20768 * path, a @b stringshared string)
20769 * - @c "done" - the user has clicked on the "ok" or "cancel"
20770 * buttons (@c event_info is a pointer to the selection's
20771 * path, a @b stringshared string)
20773 * Here is an example on its usage:
20774 * @li @ref fileselector_example
20778 * @addtogroup Fileselector
20783 * Defines how a file selector widget is to layout its contents
20784 * (file system entries).
20786 typedef enum _Elm_Fileselector_Mode
20788 ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20789 ELM_FILESELECTOR_GRID, /**< layout as a grid */
20790 ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20791 } Elm_Fileselector_Mode;
20794 * Add a new file selector widget to the given parent Elementary
20795 * (container) object
20797 * @param parent The parent object
20798 * @return a new file selector widget handle or @c NULL, on errors
20800 * This function inserts a new file selector widget on the canvas.
20802 * @ingroup Fileselector
20804 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20807 * Enable/disable the file name entry box where the user can type
20808 * in a name for a file, in a given file selector widget
20810 * @param obj The file selector object
20811 * @param is_save @c EINA_TRUE to make the file selector a "saving
20812 * dialog", @c EINA_FALSE otherwise
20814 * Having the entry editable is useful on file saving dialogs on
20815 * applications, where one gives a file name to save contents to,
20816 * in a given directory in the system. This custom file name will
20817 * be reported on the @c "done" smart callback.
20819 * @see elm_fileselector_is_save_get()
20821 * @ingroup Fileselector
20823 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20826 * Get whether the given file selector is in "saving dialog" mode
20828 * @param obj The file selector object
20829 * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20830 * mode, @c EINA_FALSE otherwise (and on errors)
20832 * @see elm_fileselector_is_save_set() for more details
20834 * @ingroup Fileselector
20836 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20839 * Enable/disable folder-only view for a given file selector widget
20841 * @param obj The file selector object
20842 * @param only @c EINA_TRUE to make @p obj only display
20843 * directories, @c EINA_FALSE to make files to be displayed in it
20846 * If enabled, the widget's view will only display folder items,
20849 * @see elm_fileselector_folder_only_get()
20851 * @ingroup Fileselector
20853 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20856 * Get whether folder-only view is set for a given file selector
20859 * @param obj The file selector object
20860 * @return only @c EINA_TRUE if @p obj is only displaying
20861 * directories, @c EINA_FALSE if files are being displayed in it
20862 * too (and on errors)
20864 * @see elm_fileselector_folder_only_get()
20866 * @ingroup Fileselector
20868 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20871 * Enable/disable the "ok" and "cancel" buttons on a given file
20874 * @param obj The file selector object
20875 * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20877 * @note A file selector without those buttons will never emit the
20878 * @c "done" smart event, and is only usable if one is just hooking
20879 * to the other two events.
20881 * @see elm_fileselector_buttons_ok_cancel_get()
20883 * @ingroup Fileselector
20885 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20888 * Get whether the "ok" and "cancel" buttons on a given file
20889 * selector widget are being shown.
20891 * @param obj The file selector object
20892 * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20893 * otherwise (and on errors)
20895 * @see elm_fileselector_buttons_ok_cancel_set() for more details
20897 * @ingroup Fileselector
20899 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20902 * Enable/disable a tree view in the given file selector widget,
20903 * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20905 * @param obj The file selector object
20906 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20909 * In a tree view, arrows are created on the sides of directories,
20910 * allowing them to expand in place.
20912 * @note If it's in other mode, the changes made by this function
20913 * will only be visible when one switches back to "list" mode.
20915 * @see elm_fileselector_expandable_get()
20917 * @ingroup Fileselector
20919 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20922 * Get whether tree view is enabled for the given file selector
20925 * @param obj The file selector object
20926 * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20927 * otherwise (and or errors)
20929 * @see elm_fileselector_expandable_set() for more details
20931 * @ingroup Fileselector
20933 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20936 * Set, programmatically, the @b directory that a given file
20937 * selector widget will display contents from
20939 * @param obj The file selector object
20940 * @param path The path to display in @p obj
20942 * This will change the @b directory that @p obj is displaying. It
20943 * will also clear the text entry area on the @p obj object, which
20944 * displays select files' names.
20946 * @see elm_fileselector_path_get()
20948 * @ingroup Fileselector
20950 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20953 * Get the parent directory's path that a given file selector
20954 * widget is displaying
20956 * @param obj The file selector object
20957 * @return The (full) path of the directory the file selector is
20958 * displaying, a @b stringshared string
20960 * @see elm_fileselector_path_set()
20962 * @ingroup Fileselector
20964 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20967 * Set, programmatically, the currently selected file/directory in
20968 * the given file selector widget
20970 * @param obj The file selector object
20971 * @param path The (full) path to a file or directory
20972 * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
20973 * latter case occurs if the directory or file pointed to do not
20976 * @see elm_fileselector_selected_get()
20978 * @ingroup Fileselector
20980 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20983 * Get the currently selected item's (full) path, in the given file
20986 * @param obj The file selector object
20987 * @return The absolute path of the selected item, a @b
20988 * stringshared string
20990 * @note Custom editions on @p obj object's text entry, if made,
20991 * will appear on the return string of this function, naturally.
20993 * @see elm_fileselector_selected_set() for more details
20995 * @ingroup Fileselector
20997 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21000 * Set the mode in which a given file selector widget will display
21001 * (layout) file system entries in its view
21003 * @param obj The file selector object
21004 * @param mode The mode of the fileselector, being it one of
21005 * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
21006 * first one, naturally, will display the files in a list. The
21007 * latter will make the widget to display its entries in a grid
21010 * @note By using elm_fileselector_expandable_set(), the user may
21011 * trigger a tree view for that list.
21013 * @note If Elementary is built with support of the Ethumb
21014 * thumbnailing library, the second form of view will display
21015 * preview thumbnails of files which it supports. You must have
21016 * elm_need_ethumb() called in your Elementary for thumbnailing to
21019 * @see elm_fileselector_expandable_set().
21020 * @see elm_fileselector_mode_get().
21022 * @ingroup Fileselector
21024 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
21027 * Get the mode in which a given file selector widget is displaying
21028 * (layouting) file system entries in its view
21030 * @param obj The fileselector object
21031 * @return The mode in which the fileselector is at
21033 * @see elm_fileselector_mode_set() for more details
21035 * @ingroup Fileselector
21037 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21044 * @defgroup Progressbar Progress bar
21046 * The progress bar is a widget for visually representing the
21047 * progress status of a given job/task.
21049 * A progress bar may be horizontal or vertical. It may display an
21050 * icon besides it, as well as primary and @b units labels. The
21051 * former is meant to label the widget as a whole, while the
21052 * latter, which is formatted with floating point values (and thus
21053 * accepts a <c>printf</c>-style format string, like <c>"%1.2f
21054 * units"</c>), is meant to label the widget's <b>progress
21055 * value</b>. Label, icon and unit strings/objects are @b optional
21056 * for progress bars.
21058 * A progress bar may be @b inverted, in which state it gets its
21059 * values inverted, with high values being on the left or top and
21060 * low values on the right or bottom, as opposed to normally have
21061 * the low values on the former and high values on the latter,
21062 * respectively, for horizontal and vertical modes.
21064 * The @b span of the progress, as set by
21065 * elm_progressbar_span_size_set(), is its length (horizontally or
21066 * vertically), unless one puts size hints on the widget to expand
21067 * on desired directions, by any container. That length will be
21068 * scaled by the object or applications scaling factor. At any
21069 * point code can query the progress bar for its value with
21070 * elm_progressbar_value_get().
21072 * Available widget styles for progress bars:
21074 * - @c "wheel" (simple style, no text, no progression, only
21075 * "pulse" effect is available)
21077 * Default contents parts of the progressbar widget that you can use for are:
21078 * @li "elm.swallow.content" - A icon of the progressbar
21080 * Here is an example on its usage:
21081 * @li @ref progressbar_example
21085 * Add a new progress bar widget to the given parent Elementary
21086 * (container) object
21088 * @param parent The parent object
21089 * @return a new progress bar widget handle or @c NULL, on errors
21091 * This function inserts a new progress bar widget on the canvas.
21093 * @ingroup Progressbar
21095 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21098 * Set whether a given progress bar widget is at "pulsing mode" or
21101 * @param obj The progress bar object
21102 * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21103 * @c EINA_FALSE to put it back to its default one
21105 * By default, progress bars will display values from the low to
21106 * high value boundaries. There are, though, contexts in which the
21107 * state of progression of a given task is @b unknown. For those,
21108 * one can set a progress bar widget to a "pulsing state", to give
21109 * the user an idea that some computation is being held, but
21110 * without exact progress values. In the default theme it will
21111 * animate its bar with the contents filling in constantly and back
21112 * to non-filled, in a loop. To start and stop this pulsing
21113 * animation, one has to explicitly call elm_progressbar_pulse().
21115 * @see elm_progressbar_pulse_get()
21116 * @see elm_progressbar_pulse()
21118 * @ingroup Progressbar
21120 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21123 * Get whether a given progress bar widget is at "pulsing mode" or
21126 * @param obj The progress bar object
21127 * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21128 * if it's in the default one (and on errors)
21130 * @ingroup Progressbar
21132 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21135 * Start/stop a given progress bar "pulsing" animation, if its
21138 * @param obj The progress bar object
21139 * @param state @c EINA_TRUE, to @b start the pulsing animation,
21140 * @c EINA_FALSE to @b stop it
21142 * @note This call won't do anything if @p obj is not under "pulsing mode".
21144 * @see elm_progressbar_pulse_set() for more details.
21146 * @ingroup Progressbar
21148 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21151 * Set the progress value (in percentage) on a given progress bar
21154 * @param obj The progress bar object
21155 * @param val The progress value (@b must be between @c 0.0 and @c
21158 * Use this call to set progress bar levels.
21160 * @note If you passes a value out of the specified range for @p
21161 * val, it will be interpreted as the @b closest of the @b boundary
21162 * values in the range.
21164 * @ingroup Progressbar
21166 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21169 * Get the progress value (in percentage) on a given progress bar
21172 * @param obj The progress bar object
21173 * @return The value of the progressbar
21175 * @see elm_progressbar_value_set() for more details
21177 * @ingroup Progressbar
21179 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21182 * Set the label of a given progress bar widget
21184 * @param obj The progress bar object
21185 * @param label The text label string, in UTF-8
21187 * @ingroup Progressbar
21188 * @deprecated use elm_object_text_set() instead.
21190 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21193 * Get the label of a given progress bar widget
21195 * @param obj The progressbar object
21196 * @return The text label string, in UTF-8
21198 * @ingroup Progressbar
21199 * @deprecated use elm_object_text_set() instead.
21201 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21204 * Set the icon object of a given progress bar widget
21206 * @param obj The progress bar object
21207 * @param icon The icon object
21209 * Use this call to decorate @p obj with an icon next to it.
21211 * @note Once the icon object is set, a previously set one will be
21212 * deleted. If you want to keep that old content object, use the
21213 * elm_progressbar_icon_unset() function.
21215 * @see elm_progressbar_icon_get()
21216 * @deprecated use elm_object_content_set() instead.
21218 * @ingroup Progressbar
21220 EINA_DEPRECATED EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21223 * Retrieve the icon object set for a given progress bar widget
21225 * @param obj The progress bar object
21226 * @return The icon object's handle, if @p obj had one set, or @c NULL,
21227 * otherwise (and on errors)
21229 * @see elm_progressbar_icon_set() for more details
21230 * @deprecated use elm_object_content_set() instead.
21232 * @ingroup Progressbar
21234 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21237 * Unset an icon set on a given progress bar widget
21239 * @param obj The progress bar object
21240 * @return The icon object that was being used, if any was set, or
21241 * @c NULL, otherwise (and on errors)
21243 * This call will unparent and return the icon object which was set
21244 * for this widget, previously, on success.
21246 * @see elm_progressbar_icon_set() for more details
21247 * @deprecated use elm_object_content_unset() instead.
21249 * @ingroup Progressbar
21251 EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21254 * Set the (exact) length of the bar region of a given progress bar
21257 * @param obj The progress bar object
21258 * @param size The length of the progress bar's bar region
21260 * This sets the minimum width (when in horizontal mode) or height
21261 * (when in vertical mode) of the actual bar area of the progress
21262 * bar @p obj. This in turn affects the object's minimum size. Use
21263 * this when you're not setting other size hints expanding on the
21264 * given direction (like weight and alignment hints) and you would
21265 * like it to have a specific size.
21267 * @note Icon, label and unit text around @p obj will require their
21268 * own space, which will make @p obj to require more the @p size,
21271 * @see elm_progressbar_span_size_get()
21273 * @ingroup Progressbar
21275 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21278 * Get the length set for the bar region of a given progress bar
21281 * @param obj The progress bar object
21282 * @return The length of the progress bar's bar region
21284 * If that size was not set previously, with
21285 * elm_progressbar_span_size_set(), this call will return @c 0.
21287 * @ingroup Progressbar
21289 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21292 * Set the format string for a given progress bar widget's units
21295 * @param obj The progress bar object
21296 * @param format The format string for @p obj's units label
21298 * If @c NULL is passed on @p format, it will make @p obj's units
21299 * area to be hidden completely. If not, it'll set the <b>format
21300 * string</b> for the units label's @b text. The units label is
21301 * provided a floating point value, so the units text is up display
21302 * at most one floating point falue. Note that the units label is
21303 * optional. Use a format string such as "%1.2f meters" for
21306 * @note The default format string for a progress bar is an integer
21307 * percentage, as in @c "%.0f %%".
21309 * @see elm_progressbar_unit_format_get()
21311 * @ingroup Progressbar
21313 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21316 * Retrieve the format string set for a given progress bar widget's
21319 * @param obj The progress bar object
21320 * @return The format set string for @p obj's units label or
21321 * @c NULL, if none was set (and on errors)
21323 * @see elm_progressbar_unit_format_set() for more details
21325 * @ingroup Progressbar
21327 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21330 * Set the orientation of a given progress bar widget
21332 * @param obj The progress bar object
21333 * @param horizontal Use @c EINA_TRUE to make @p obj to be
21334 * @b horizontal, @c EINA_FALSE to make it @b vertical
21336 * Use this function to change how your progress bar is to be
21337 * disposed: vertically or horizontally.
21339 * @see elm_progressbar_horizontal_get()
21341 * @ingroup Progressbar
21343 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21346 * Retrieve the orientation of a given progress bar widget
21348 * @param obj The progress bar object
21349 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21350 * @c EINA_FALSE if it's @b vertical (and on errors)
21352 * @see elm_progressbar_horizontal_set() for more details
21354 * @ingroup Progressbar
21356 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21359 * Invert a given progress bar widget's displaying values order
21361 * @param obj The progress bar object
21362 * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21363 * @c EINA_FALSE to bring it back to default, non-inverted values.
21365 * A progress bar may be @b inverted, in which state it gets its
21366 * values inverted, with high values being on the left or top and
21367 * low values on the right or bottom, as opposed to normally have
21368 * the low values on the former and high values on the latter,
21369 * respectively, for horizontal and vertical modes.
21371 * @see elm_progressbar_inverted_get()
21373 * @ingroup Progressbar
21375 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21378 * Get whether a given progress bar widget's displaying values are
21381 * @param obj The progress bar object
21382 * @return @c EINA_TRUE, if @p obj has inverted values,
21383 * @c EINA_FALSE otherwise (and on errors)
21385 * @see elm_progressbar_inverted_set() for more details
21387 * @ingroup Progressbar
21389 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21392 * @defgroup Separator Separator
21394 * @brief Separator is a very thin object used to separate other objects.
21396 * A separator can be vertical or horizontal.
21398 * @ref tutorial_separator is a good example of how to use a separator.
21402 * @brief Add a separator object to @p parent
21404 * @param parent The parent object
21406 * @return The separator object, or NULL upon failure
21408 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21410 * @brief Set the horizontal mode of a separator object
21412 * @param obj The separator object
21413 * @param horizontal If true, the separator is horizontal
21415 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21417 * @brief Get the horizontal mode of a separator object
21419 * @param obj The separator object
21420 * @return If true, the separator is horizontal
21422 * @see elm_separator_horizontal_set()
21424 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21430 * @defgroup Spinner Spinner
21431 * @ingroup Elementary
21433 * @image html img/widget/spinner/preview-00.png
21434 * @image latex img/widget/spinner/preview-00.eps
21436 * A spinner is a widget which allows the user to increase or decrease
21437 * numeric values using arrow buttons, or edit values directly, clicking
21438 * over it and typing the new value.
21440 * By default the spinner will not wrap and has a label
21441 * of "%.0f" (just showing the integer value of the double).
21443 * A spinner has a label that is formatted with floating
21444 * point values and thus accepts a printf-style format string, like
21447 * It also allows specific values to be replaced by pre-defined labels.
21449 * Smart callbacks one can register to:
21451 * - "changed" - Whenever the spinner value is changed.
21452 * - "delay,changed" - A short time after the value is changed by the user.
21453 * This will be called only when the user stops dragging for a very short
21454 * period or when they release their finger/mouse, so it avoids possibly
21455 * expensive reactions to the value change.
21457 * Available styles for it:
21459 * - @c "vertical": up/down buttons at the right side and text left aligned.
21461 * Here is an example on its usage:
21462 * @ref spinner_example
21466 * @addtogroup Spinner
21471 * Add a new spinner widget to the given parent Elementary
21472 * (container) object.
21474 * @param parent The parent object.
21475 * @return a new spinner widget handle or @c NULL, on errors.
21477 * This function inserts a new spinner widget on the canvas.
21482 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21485 * Set the format string of the displayed label.
21487 * @param obj The spinner object.
21488 * @param fmt The format string for the label display.
21490 * If @c NULL, this sets the format to "%.0f". If not it sets the format
21491 * string for the label text. The label text is provided a floating point
21492 * value, so the label text can display up to 1 floating point value.
21493 * Note that this is optional.
21495 * Use a format string such as "%1.2f meters" for example, and it will
21496 * display values like: "3.14 meters" for a value equal to 3.14159.
21498 * Default is "%0.f".
21500 * @see elm_spinner_label_format_get()
21504 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21507 * Get the label format of the spinner.
21509 * @param obj The spinner object.
21510 * @return The text label format string in UTF-8.
21512 * @see elm_spinner_label_format_set() for details.
21516 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21519 * Set the minimum and maximum values for the spinner.
21521 * @param obj The spinner object.
21522 * @param min The minimum value.
21523 * @param max The maximum value.
21525 * Define the allowed range of values to be selected by the user.
21527 * If actual value is less than @p min, it will be updated to @p min. If it
21528 * is bigger then @p max, will be updated to @p max. Actual value can be
21529 * get with elm_spinner_value_get().
21531 * By default, min is equal to 0, and max is equal to 100.
21533 * @warning Maximum must be greater than minimum.
21535 * @see elm_spinner_min_max_get()
21539 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21542 * Get the minimum and maximum values of the spinner.
21544 * @param obj The spinner object.
21545 * @param min Pointer where to store the minimum value.
21546 * @param max Pointer where to store the maximum value.
21548 * @note If only one value is needed, the other pointer can be passed
21551 * @see elm_spinner_min_max_set() for details.
21555 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21558 * Set the step used to increment or decrement the spinner value.
21560 * @param obj The spinner object.
21561 * @param step The step value.
21563 * This value will be incremented or decremented to the displayed value.
21564 * It will be incremented while the user keep right or top arrow pressed,
21565 * and will be decremented while the user keep left or bottom arrow pressed.
21567 * The interval to increment / decrement can be set with
21568 * elm_spinner_interval_set().
21570 * By default step value is equal to 1.
21572 * @see elm_spinner_step_get()
21576 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21579 * Get the step used to increment or decrement the spinner value.
21581 * @param obj The spinner object.
21582 * @return The step value.
21584 * @see elm_spinner_step_get() for more details.
21588 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21591 * Set the value the spinner displays.
21593 * @param obj The spinner object.
21594 * @param val The value to be displayed.
21596 * Value will be presented on the label following format specified with
21597 * elm_spinner_format_set().
21599 * @warning The value must to be between min and max values. This values
21600 * are set by elm_spinner_min_max_set().
21602 * @see elm_spinner_value_get().
21603 * @see elm_spinner_format_set().
21604 * @see elm_spinner_min_max_set().
21608 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21611 * Get the value displayed by the spinner.
21613 * @param obj The spinner object.
21614 * @return The value displayed.
21616 * @see elm_spinner_value_set() for details.
21620 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21623 * Set whether the spinner should wrap when it reaches its
21624 * minimum or maximum value.
21626 * @param obj The spinner object.
21627 * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21630 * Disabled by default. If disabled, when the user tries to increment the
21632 * but displayed value plus step value is bigger than maximum value,
21634 * won't allow it. The same happens when the user tries to decrement it,
21635 * but the value less step is less than minimum value.
21637 * When wrap is enabled, in such situations it will allow these changes,
21638 * but will get the value that would be less than minimum and subtracts
21639 * from maximum. Or add the value that would be more than maximum to
21643 * @li min value = 10
21644 * @li max value = 50
21645 * @li step value = 20
21646 * @li displayed value = 20
21648 * When the user decrement value (using left or bottom arrow), it will
21649 * displays @c 40, because max - (min - (displayed - step)) is
21650 * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21652 * @see elm_spinner_wrap_get().
21656 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21659 * Get whether the spinner should wrap when it reaches its
21660 * minimum or maximum value.
21662 * @param obj The spinner object
21663 * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21664 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21666 * @see elm_spinner_wrap_set() for details.
21670 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21673 * Set whether the spinner can be directly edited by the user or not.
21675 * @param obj The spinner object.
21676 * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21677 * don't allow users to edit it directly.
21679 * Spinner objects can have edition @b disabled, in which state they will
21680 * be changed only by arrows.
21681 * Useful for contexts
21682 * where you don't want your users to interact with it writting the value.
21684 * when using special values, the user can see real value instead
21685 * of special label on edition.
21687 * It's enabled by default.
21689 * @see elm_spinner_editable_get()
21693 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21696 * Get whether the spinner can be directly edited by the user or not.
21698 * @param obj The spinner object.
21699 * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21700 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21702 * @see elm_spinner_editable_set() for details.
21706 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21709 * Set a special string to display in the place of the numerical value.
21711 * @param obj The spinner object.
21712 * @param value The value to be replaced.
21713 * @param label The label to be used.
21715 * It's useful for cases when a user should select an item that is
21716 * better indicated by a label than a value. For example, weekdays or months.
21720 * sp = elm_spinner_add(win);
21721 * elm_spinner_min_max_set(sp, 1, 3);
21722 * elm_spinner_special_value_add(sp, 1, "January");
21723 * elm_spinner_special_value_add(sp, 2, "February");
21724 * elm_spinner_special_value_add(sp, 3, "March");
21725 * evas_object_show(sp);
21730 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21733 * Set the interval on time updates for an user mouse button hold
21734 * on spinner widgets' arrows.
21736 * @param obj The spinner object.
21737 * @param interval The (first) interval value in seconds.
21739 * This interval value is @b decreased while the user holds the
21740 * mouse pointer either incrementing or decrementing spinner's value.
21742 * This helps the user to get to a given value distant from the
21743 * current one easier/faster, as it will start to change quicker and
21744 * quicker on mouse button holds.
21746 * The calculation for the next change interval value, starting from
21747 * the one set with this call, is the previous interval divided by
21748 * @c 1.05, so it decreases a little bit.
21750 * The default starting interval value for automatic changes is
21753 * @see elm_spinner_interval_get()
21757 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21760 * Get the interval on time updates for an user mouse button hold
21761 * on spinner widgets' arrows.
21763 * @param obj The spinner object.
21764 * @return The (first) interval value, in seconds, set on it.
21766 * @see elm_spinner_interval_set() for more details.
21770 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21777 * @defgroup Index Index
21779 * @image html img/widget/index/preview-00.png
21780 * @image latex img/widget/index/preview-00.eps
21782 * An index widget gives you an index for fast access to whichever
21783 * group of other UI items one might have. It's a list of text
21784 * items (usually letters, for alphabetically ordered access).
21786 * Index widgets are by default hidden and just appear when the
21787 * user clicks over it's reserved area in the canvas. In its
21788 * default theme, it's an area one @ref Fingers "finger" wide on
21789 * the right side of the index widget's container.
21791 * When items on the index are selected, smart callbacks get
21792 * called, so that its user can make other container objects to
21793 * show a given area or child object depending on the index item
21794 * selected. You'd probably be using an index together with @ref
21795 * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21798 * Smart events one can add callbacks for are:
21799 * - @c "changed" - When the selected index item changes. @c
21800 * event_info is the selected item's data pointer.
21801 * - @c "delay,changed" - When the selected index item changes, but
21802 * after a small idling period. @c event_info is the selected
21803 * item's data pointer.
21804 * - @c "selected" - When the user releases a mouse button and
21805 * selects an item. @c event_info is the selected item's data
21807 * - @c "level,up" - when the user moves a finger from the first
21808 * level to the second level
21809 * - @c "level,down" - when the user moves a finger from the second
21810 * level to the first level
21812 * The @c "delay,changed" event is so that it'll wait a small time
21813 * before actually reporting those events and, moreover, just the
21814 * last event happening on those time frames will actually be
21817 * Here are some examples on its usage:
21818 * @li @ref index_example_01
21819 * @li @ref index_example_02
21823 * @addtogroup Index
21827 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21830 * Add a new index widget to the given parent Elementary
21831 * (container) object
21833 * @param parent The parent object
21834 * @return a new index widget handle or @c NULL, on errors
21836 * This function inserts a new index widget on the canvas.
21840 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21843 * Set whether a given index widget is or not visible,
21846 * @param obj The index object
21847 * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21849 * Not to be confused with visible as in @c evas_object_show() --
21850 * visible with regard to the widget's auto hiding feature.
21852 * @see elm_index_active_get()
21856 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21859 * Get whether a given index widget is currently visible or not.
21861 * @param obj The index object
21862 * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21864 * @see elm_index_active_set() for more details
21868 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21871 * Set the items level for a given index widget.
21873 * @param obj The index object.
21874 * @param level @c 0 or @c 1, the currently implemented levels.
21876 * @see elm_index_item_level_get()
21880 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21883 * Get the items level set for a given index widget.
21885 * @param obj The index object.
21886 * @return @c 0 or @c 1, which are the levels @p obj might be at.
21888 * @see elm_index_item_level_set() for more information
21892 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21895 * Returns the last selected item's data, for a given index widget.
21897 * @param obj The index object.
21898 * @return The item @b data associated to the last selected item on
21899 * @p obj (or @c NULL, on errors).
21901 * @warning The returned value is @b not an #Elm_Index_Item item
21902 * handle, but the data associated to it (see the @c item parameter
21903 * in elm_index_item_append(), as an example).
21907 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21910 * Append a new item on a given index widget.
21912 * @param obj The index object.
21913 * @param letter Letter under which the item should be indexed
21914 * @param item The item data to set for the index's item
21916 * Despite the most common usage of the @p letter argument is for
21917 * single char strings, one could use arbitrary strings as index
21920 * @c item will be the pointer returned back on @c "changed", @c
21921 * "delay,changed" and @c "selected" smart events.
21925 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21928 * Prepend a new item on a given index widget.
21930 * @param obj The index object.
21931 * @param letter Letter under which the item should be indexed
21932 * @param item The item data to set for the index's item
21934 * Despite the most common usage of the @p letter argument is for
21935 * single char strings, one could use arbitrary strings as index
21938 * @c item will be the pointer returned back on @c "changed", @c
21939 * "delay,changed" and @c "selected" smart events.
21943 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21946 * Append a new item, on a given index widget, <b>after the item
21947 * having @p relative as data</b>.
21949 * @param obj The index object.
21950 * @param letter Letter under which the item should be indexed
21951 * @param item The item data to set for the index's item
21952 * @param relative The item data of the index item to be the
21953 * predecessor of this new one
21955 * Despite the most common usage of the @p letter argument is for
21956 * single char strings, one could use arbitrary strings as index
21959 * @c item will be the pointer returned back on @c "changed", @c
21960 * "delay,changed" and @c "selected" smart events.
21962 * @note If @p relative is @c NULL or if it's not found to be data
21963 * set on any previous item on @p obj, this function will behave as
21964 * elm_index_item_append().
21968 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21971 * Prepend a new item, on a given index widget, <b>after the item
21972 * having @p relative as data</b>.
21974 * @param obj The index object.
21975 * @param letter Letter under which the item should be indexed
21976 * @param item The item data to set for the index's item
21977 * @param relative The item data of the index item to be the
21978 * successor of this new one
21980 * Despite the most common usage of the @p letter argument is for
21981 * single char strings, one could use arbitrary strings as index
21984 * @c item will be the pointer returned back on @c "changed", @c
21985 * "delay,changed" and @c "selected" smart events.
21987 * @note If @p relative is @c NULL or if it's not found to be data
21988 * set on any previous item on @p obj, this function will behave as
21989 * elm_index_item_prepend().
21993 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21996 * Insert a new item into the given index widget, using @p cmp_func
21997 * function to sort items (by item handles).
21999 * @param obj The index object.
22000 * @param letter Letter under which the item should be indexed
22001 * @param item The item data to set for the index's item
22002 * @param cmp_func The comparing function to be used to sort index
22003 * items <b>by #Elm_Index_Item item handles</b>
22004 * @param cmp_data_func A @b fallback function to be called for the
22005 * sorting of index items <b>by item data</b>). It will be used
22006 * when @p cmp_func returns @c 0 (equality), which means an index
22007 * item with provided item data already exists. To decide which
22008 * data item should be pointed to by the index item in question, @p
22009 * cmp_data_func will be used. If @p cmp_data_func returns a
22010 * non-negative value, the previous index item data will be
22011 * replaced by the given @p item pointer. If the previous data need
22012 * to be freed, it should be done by the @p cmp_data_func function,
22013 * because all references to it will be lost. If this function is
22014 * not provided (@c NULL is given), index items will be @b
22015 * duplicated, if @p cmp_func returns @c 0.
22017 * Despite the most common usage of the @p letter argument is for
22018 * single char strings, one could use arbitrary strings as index
22021 * @c item will be the pointer returned back on @c "changed", @c
22022 * "delay,changed" and @c "selected" smart events.
22026 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);
22029 * Remove an item from a given index widget, <b>to be referenced by
22030 * it's data value</b>.
22032 * @param obj The index object
22033 * @param item The item's data pointer for the item to be removed
22036 * If a deletion callback is set, via elm_index_item_del_cb_set(),
22037 * that callback function will be called by this one.
22039 * @warning The item to be removed from @p obj will be found via
22040 * its item data pointer, and not by an #Elm_Index_Item handle.
22044 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22047 * Find a given index widget's item, <b>using item data</b>.
22049 * @param obj The index object
22050 * @param item The item data pointed to by the desired index item
22051 * @return The index item handle, if found, or @c NULL otherwise
22055 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22058 * Removes @b all items from a given index widget.
22060 * @param obj The index object.
22062 * If deletion callbacks are set, via elm_index_item_del_cb_set(),
22063 * that callback function will be called for each item in @p obj.
22067 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22070 * Go to a given items level on a index widget
22072 * @param obj The index object
22073 * @param level The index level (one of @c 0 or @c 1)
22077 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22080 * Return the data associated with a given index widget item
22082 * @param it The index widget item handle
22083 * @return The data associated with @p it
22085 * @see elm_index_item_data_set()
22089 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22092 * Set the data associated with a given index widget item
22094 * @param it The index widget item handle
22095 * @param data The new data pointer to set to @p it
22097 * This sets new item data on @p it.
22099 * @warning The old data pointer won't be touched by this function, so
22100 * the user had better to free that old data himself/herself.
22104 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22107 * Set the function to be called when a given index widget item is freed.
22109 * @param it The item to set the callback on
22110 * @param func The function to call on the item's deletion
22112 * When called, @p func will have both @c data and @c event_info
22113 * arguments with the @p it item's data value and, naturally, the
22114 * @c obj argument with a handle to the parent index widget.
22118 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22121 * Get the letter (string) set on a given index widget item.
22123 * @param it The index item handle
22124 * @return The letter string set on @p it
22128 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22135 * @defgroup Photocam Photocam
22137 * @image html img/widget/photocam/preview-00.png
22138 * @image latex img/widget/photocam/preview-00.eps
22140 * This is a widget specifically for displaying high-resolution digital
22141 * camera photos giving speedy feedback (fast load), low memory footprint
22142 * and zooming and panning as well as fitting logic. It is entirely focused
22143 * on jpeg images, and takes advantage of properties of the jpeg format (via
22144 * evas loader features in the jpeg loader).
22146 * Signals that you can add callbacks for are:
22147 * @li "clicked" - This is called when a user has clicked the photo without
22149 * @li "press" - This is called when a user has pressed down on the photo.
22150 * @li "longpressed" - This is called when a user has pressed down on the
22151 * photo for a long time without dragging around.
22152 * @li "clicked,double" - This is called when a user has double-clicked the
22154 * @li "load" - Photo load begins.
22155 * @li "loaded" - This is called when the image file load is complete for the
22156 * first view (low resolution blurry version).
22157 * @li "load,detail" - Photo detailed data load begins.
22158 * @li "loaded,detail" - This is called when the image file load is complete
22159 * for the detailed image data (full resolution needed).
22160 * @li "zoom,start" - Zoom animation started.
22161 * @li "zoom,stop" - Zoom animation stopped.
22162 * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22163 * @li "scroll" - the content has been scrolled (moved)
22164 * @li "scroll,anim,start" - scrolling animation has started
22165 * @li "scroll,anim,stop" - scrolling animation has stopped
22166 * @li "scroll,drag,start" - dragging the contents around has started
22167 * @li "scroll,drag,stop" - dragging the contents around has stopped
22169 * @ref tutorial_photocam shows the API in action.
22173 * @brief Types of zoom available.
22175 typedef enum _Elm_Photocam_Zoom_Mode
22177 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
22178 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22179 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22180 ELM_PHOTOCAM_ZOOM_MODE_LAST
22181 } Elm_Photocam_Zoom_Mode;
22183 * @brief Add a new Photocam object
22185 * @param parent The parent object
22186 * @return The new object or NULL if it cannot be created
22188 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22190 * @brief Set the photo file to be shown
22192 * @param obj The photocam object
22193 * @param file The photo file
22194 * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22196 * This sets (and shows) the specified file (with a relative or absolute
22197 * path) and will return a load error (same error that
22198 * evas_object_image_load_error_get() will return). The image will change and
22199 * adjust its size at this point and begin a background load process for this
22200 * photo that at some time in the future will be displayed at the full
22203 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22205 * @brief Returns the path of the current image file
22207 * @param obj The photocam object
22208 * @return Returns the path
22210 * @see elm_photocam_file_set()
22212 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22214 * @brief Set the zoom level of the photo
22216 * @param obj The photocam object
22217 * @param zoom The zoom level to set
22219 * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22220 * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22221 * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22222 * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22225 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22227 * @brief Get the zoom level of the photo
22229 * @param obj The photocam object
22230 * @return The current zoom level
22232 * This returns the current zoom level of the photocam object. Note that if
22233 * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22234 * (which is the default), the zoom level may be changed at any time by the
22235 * photocam object itself to account for photo size and photocam viewpoer
22238 * @see elm_photocam_zoom_set()
22239 * @see elm_photocam_zoom_mode_set()
22241 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22243 * @brief Set the zoom mode
22245 * @param obj The photocam object
22246 * @param mode The desired mode
22248 * This sets the zoom mode to manual or one of several automatic levels.
22249 * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22250 * elm_photocam_zoom_set() and will stay at that level until changed by code
22251 * or until zoom mode is changed. This is the default mode. The Automatic
22252 * modes will allow the photocam object to automatically adjust zoom mode
22253 * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22254 * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22255 * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22256 * pixels within the frame are left unfilled.
22258 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22260 * @brief Get the zoom mode
22262 * @param obj The photocam object
22263 * @return The current zoom mode
22265 * This gets the current zoom mode of the photocam object.
22267 * @see elm_photocam_zoom_mode_set()
22269 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22271 * @brief Get the current image pixel width and height
22273 * @param obj The photocam object
22274 * @param w A pointer to the width return
22275 * @param h A pointer to the height return
22277 * This gets the current photo pixel width and height (for the original).
22278 * The size will be returned in the integers @p w and @p h that are pointed
22281 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22283 * @brief Get the area of the image that is currently shown
22286 * @param x A pointer to the X-coordinate of region
22287 * @param y A pointer to the Y-coordinate of region
22288 * @param w A pointer to the width
22289 * @param h A pointer to the height
22291 * @see elm_photocam_image_region_show()
22292 * @see elm_photocam_image_region_bring_in()
22294 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22296 * @brief Set the viewed portion of the image
22298 * @param obj The photocam object
22299 * @param x X-coordinate of region in image original pixels
22300 * @param y Y-coordinate of region in image original pixels
22301 * @param w Width of region in image original pixels
22302 * @param h Height of region in image original pixels
22304 * This shows the region of the image without using animation.
22306 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22308 * @brief Bring in the viewed portion of the image
22310 * @param obj The photocam object
22311 * @param x X-coordinate of region in image original pixels
22312 * @param y Y-coordinate of region in image original pixels
22313 * @param w Width of region in image original pixels
22314 * @param h Height of region in image original pixels
22316 * This shows the region of the image using animation.
22318 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22320 * @brief Set the paused state for photocam
22322 * @param obj The photocam object
22323 * @param paused The pause state to set
22325 * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22326 * photocam. The default is off. This will stop zooming using animation on
22327 * zoom levels changes and change instantly. This will stop any existing
22328 * animations that are running.
22330 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22332 * @brief Get the paused state for photocam
22334 * @param obj The photocam object
22335 * @return The current paused state
22337 * This gets the current paused state for the photocam object.
22339 * @see elm_photocam_paused_set()
22341 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22343 * @brief Get the internal low-res image used for photocam
22345 * @param obj The photocam object
22346 * @return The internal image object handle, or NULL if none exists
22348 * This gets the internal image object inside photocam. Do not modify it. It
22349 * is for inspection only, and hooking callbacks to. Nothing else. It may be
22350 * deleted at any time as well.
22352 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22354 * @brief Set the photocam scrolling bouncing.
22356 * @param obj The photocam object
22357 * @param h_bounce bouncing for horizontal
22358 * @param v_bounce bouncing for vertical
22360 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22362 * @brief Get the photocam scrolling bouncing.
22364 * @param obj The photocam object
22365 * @param h_bounce bouncing for horizontal
22366 * @param v_bounce bouncing for vertical
22368 * @see elm_photocam_bounce_set()
22370 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22376 * @defgroup Map Map
22377 * @ingroup Elementary
22379 * @image html img/widget/map/preview-00.png
22380 * @image latex img/widget/map/preview-00.eps
22382 * This is a widget specifically for displaying a map. It uses basically
22383 * OpenStreetMap provider http://www.openstreetmap.org/,
22384 * but custom providers can be added.
22386 * It supports some basic but yet nice features:
22387 * @li zoom and scroll
22388 * @li markers with content to be displayed when user clicks over it
22389 * @li group of markers
22392 * Smart callbacks one can listen to:
22394 * - "clicked" - This is called when a user has clicked the map without
22396 * - "press" - This is called when a user has pressed down on the map.
22397 * - "longpressed" - This is called when a user has pressed down on the map
22398 * for a long time without dragging around.
22399 * - "clicked,double" - This is called when a user has double-clicked
22401 * - "load,detail" - Map detailed data load begins.
22402 * - "loaded,detail" - This is called when all currently visible parts of
22403 * the map are loaded.
22404 * - "zoom,start" - Zoom animation started.
22405 * - "zoom,stop" - Zoom animation stopped.
22406 * - "zoom,change" - Zoom changed when using an auto zoom mode.
22407 * - "scroll" - the content has been scrolled (moved).
22408 * - "scroll,anim,start" - scrolling animation has started.
22409 * - "scroll,anim,stop" - scrolling animation has stopped.
22410 * - "scroll,drag,start" - dragging the contents around has started.
22411 * - "scroll,drag,stop" - dragging the contents around has stopped.
22412 * - "downloaded" - This is called when all currently required map images
22414 * - "route,load" - This is called when route request begins.
22415 * - "route,loaded" - This is called when route request ends.
22416 * - "name,load" - This is called when name request begins.
22417 * - "name,loaded- This is called when name request ends.
22419 * Available style for map widget:
22422 * Available style for markers:
22427 * Available style for marker bubble:
22430 * List of examples:
22431 * @li @ref map_example_01
22432 * @li @ref map_example_02
22433 * @li @ref map_example_03
22442 * @enum _Elm_Map_Zoom_Mode
22443 * @typedef Elm_Map_Zoom_Mode
22445 * Set map's zoom behavior. It can be set to manual or automatic.
22447 * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22449 * Values <b> don't </b> work as bitmask, only one can be choosen.
22451 * @note Valid sizes are 2^zoom, consequently the map may be smaller
22452 * than the scroller view.
22454 * @see elm_map_zoom_mode_set()
22455 * @see elm_map_zoom_mode_get()
22459 typedef enum _Elm_Map_Zoom_Mode
22461 ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22462 ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22463 ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22464 ELM_MAP_ZOOM_MODE_LAST
22465 } Elm_Map_Zoom_Mode;
22468 * @enum _Elm_Map_Route_Sources
22469 * @typedef Elm_Map_Route_Sources
22471 * Set route service to be used. By default used source is
22472 * #ELM_MAP_ROUTE_SOURCE_YOURS.
22474 * @see elm_map_route_source_set()
22475 * @see elm_map_route_source_get()
22479 typedef enum _Elm_Map_Route_Sources
22481 ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22482 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. */
22483 ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22484 ELM_MAP_ROUTE_SOURCE_LAST
22485 } Elm_Map_Route_Sources;
22487 typedef enum _Elm_Map_Name_Sources
22489 ELM_MAP_NAME_SOURCE_NOMINATIM,
22490 ELM_MAP_NAME_SOURCE_LAST
22491 } Elm_Map_Name_Sources;
22494 * @enum _Elm_Map_Route_Type
22495 * @typedef Elm_Map_Route_Type
22497 * Set type of transport used on route.
22499 * @see elm_map_route_add()
22503 typedef enum _Elm_Map_Route_Type
22505 ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22506 ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22507 ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22508 ELM_MAP_ROUTE_TYPE_LAST
22509 } Elm_Map_Route_Type;
22512 * @enum _Elm_Map_Route_Method
22513 * @typedef Elm_Map_Route_Method
22515 * Set the routing method, what should be priorized, time or distance.
22517 * @see elm_map_route_add()
22521 typedef enum _Elm_Map_Route_Method
22523 ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22524 ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22525 ELM_MAP_ROUTE_METHOD_LAST
22526 } Elm_Map_Route_Method;
22528 typedef enum _Elm_Map_Name_Method
22530 ELM_MAP_NAME_METHOD_SEARCH,
22531 ELM_MAP_NAME_METHOD_REVERSE,
22532 ELM_MAP_NAME_METHOD_LAST
22533 } Elm_Map_Name_Method;
22535 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(). */
22536 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(). */
22537 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(). */
22538 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(). */
22539 typedef struct _Elm_Map_Name Elm_Map_Name; /**< A handle for specific coordinates. */
22540 typedef struct _Elm_Map_Track Elm_Map_Track;
22542 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. */
22543 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22544 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22545 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22547 typedef char *(*ElmMapModuleSourceFunc) (void);
22548 typedef int (*ElmMapModuleZoomMinFunc) (void);
22549 typedef int (*ElmMapModuleZoomMaxFunc) (void);
22550 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22551 typedef int (*ElmMapModuleRouteSourceFunc) (void);
22552 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22553 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22554 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22555 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22558 * Add a new map widget to the given parent Elementary (container) object.
22560 * @param parent The parent object.
22561 * @return a new map widget handle or @c NULL, on errors.
22563 * This function inserts a new map widget on the canvas.
22567 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22570 * Set the zoom level of the map.
22572 * @param obj The map object.
22573 * @param zoom The zoom level to set.
22575 * This sets the zoom level.
22577 * It will respect limits defined by elm_map_source_zoom_min_set() and
22578 * elm_map_source_zoom_max_set().
22580 * By default these values are 0 (world map) and 18 (maximum zoom).
22582 * This function should be used when zoom mode is set to
22583 * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22584 * with elm_map_zoom_mode_set().
22586 * @see elm_map_zoom_mode_set().
22587 * @see elm_map_zoom_get().
22591 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22594 * Get the zoom level of the map.
22596 * @param obj The map object.
22597 * @return The current zoom level.
22599 * This returns the current zoom level of the map object.
22601 * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22602 * (which is the default), the zoom level may be changed at any time by the
22603 * map object itself to account for map size and map viewport size.
22605 * @see elm_map_zoom_set() for details.
22609 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22612 * Set the zoom mode used by the map object.
22614 * @param obj The map object.
22615 * @param mode The zoom mode of the map, being it one of
22616 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22617 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22619 * This sets the zoom mode to manual or one of the automatic levels.
22620 * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22621 * elm_map_zoom_set() and will stay at that level until changed by code
22622 * or until zoom mode is changed. This is the default mode.
22624 * The Automatic modes will allow the map object to automatically
22625 * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22626 * adjust zoom so the map fits inside the scroll frame with no pixels
22627 * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22628 * ensure no pixels within the frame are left unfilled. Do not forget that
22629 * the valid sizes are 2^zoom, consequently the map may be smaller than
22630 * the scroller view.
22632 * @see elm_map_zoom_set()
22636 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22639 * Get the zoom mode used by the map object.
22641 * @param obj The map object.
22642 * @return The zoom mode of the map, being it one of
22643 * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22644 * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22646 * This function returns the current zoom mode used by the map object.
22648 * @see elm_map_zoom_mode_set() for more details.
22652 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22655 * Get the current coordinates of the map.
22657 * @param obj The map object.
22658 * @param lon Pointer where to store longitude.
22659 * @param lat Pointer where to store latitude.
22661 * This gets the current center coordinates of the map object. It can be
22662 * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22664 * @see elm_map_geo_region_bring_in()
22665 * @see elm_map_geo_region_show()
22669 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22672 * Animatedly bring in given coordinates to the center of the map.
22674 * @param obj The map object.
22675 * @param lon Longitude to center at.
22676 * @param lat Latitude to center at.
22678 * This causes map to jump to the given @p lat and @p lon coordinates
22679 * and show it (by scrolling) in the center of the viewport, if it is not
22680 * already centered. This will use animation to do so and take a period
22681 * of time to complete.
22683 * @see elm_map_geo_region_show() for a function to avoid animation.
22684 * @see elm_map_geo_region_get()
22688 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22691 * Show the given coordinates at the center of the map, @b immediately.
22693 * @param obj The map object.
22694 * @param lon Longitude to center at.
22695 * @param lat Latitude to center at.
22697 * This causes map to @b redraw its viewport's contents to the
22698 * region contining the given @p lat and @p lon, that will be moved to the
22699 * center of the map.
22701 * @see elm_map_geo_region_bring_in() for a function to move with animation.
22702 * @see elm_map_geo_region_get()
22706 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22709 * Pause or unpause the map.
22711 * @param obj The map object.
22712 * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22715 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22718 * The default is off.
22720 * This will stop zooming using animation, changing zoom levels will
22721 * change instantly. This will stop any existing animations that are running.
22723 * @see elm_map_paused_get()
22727 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22730 * Get a value whether map is paused or not.
22732 * @param obj The map object.
22733 * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22734 * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22736 * This gets the current paused state for the map object.
22738 * @see elm_map_paused_set() for details.
22742 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22745 * Set to show markers during zoom level changes or not.
22747 * @param obj The map object.
22748 * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22751 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22754 * The default is off.
22756 * This will stop zooming using animation, changing zoom levels will
22757 * change instantly. This will stop any existing animations that are running.
22759 * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22762 * The default is off.
22764 * Enabling it will force the map to stop displaying the markers during
22765 * zoom level changes. Set to on if you have a large number of markers.
22767 * @see elm_map_paused_markers_get()
22771 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22774 * Get a value whether markers will be displayed on zoom level changes or not
22776 * @param obj The map object.
22777 * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22778 * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22780 * This gets the current markers paused state for the map object.
22782 * @see elm_map_paused_markers_set() for details.
22786 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22789 * Get the information of downloading status.
22791 * @param obj The map object.
22792 * @param try_num Pointer where to store number of tiles being downloaded.
22793 * @param finish_num Pointer where to store number of tiles successfully
22796 * This gets the current downloading status for the map object, the number
22797 * of tiles being downloaded and the number of tiles already downloaded.
22801 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22804 * Convert a pixel coordinate (x,y) into a geographic coordinate
22805 * (longitude, latitude).
22807 * @param obj The map object.
22808 * @param x the coordinate.
22809 * @param y the coordinate.
22810 * @param size the size in pixels of the map.
22811 * The map is a square and generally his size is : pow(2.0, zoom)*256.
22812 * @param lon Pointer where to store the longitude that correspond to x.
22813 * @param lat Pointer where to store the latitude that correspond to y.
22815 * @note Origin pixel point is the top left corner of the viewport.
22816 * Map zoom and size are taken on account.
22818 * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22822 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);
22825 * Convert a geographic coordinate (longitude, latitude) into a pixel
22826 * coordinate (x, y).
22828 * @param obj The map object.
22829 * @param lon the longitude.
22830 * @param lat the latitude.
22831 * @param size the size in pixels of the map. The map is a square
22832 * and generally his size is : pow(2.0, zoom)*256.
22833 * @param x Pointer where to store the horizontal pixel coordinate that
22834 * correspond to the longitude.
22835 * @param y Pointer where to store the vertical pixel coordinate that
22836 * correspond to the latitude.
22838 * @note Origin pixel point is the top left corner of the viewport.
22839 * Map zoom and size are taken on account.
22841 * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22845 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);
22848 * Convert a geographic coordinate (longitude, latitude) into a name
22851 * @param obj The map object.
22852 * @param lon the longitude.
22853 * @param lat the latitude.
22854 * @return name A #Elm_Map_Name handle for this coordinate.
22856 * To get the string for this address, elm_map_name_address_get()
22859 * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22863 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22866 * Convert a name (address) into a geographic coordinate
22867 * (longitude, latitude).
22869 * @param obj The map object.
22870 * @param name The address.
22871 * @return name A #Elm_Map_Name handle for this address.
22873 * To get the longitude and latitude, elm_map_name_region_get()
22876 * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22880 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22883 * Convert a pixel coordinate into a rotated pixel coordinate.
22885 * @param obj The map object.
22886 * @param x horizontal coordinate of the point to rotate.
22887 * @param y vertical coordinate of the point to rotate.
22888 * @param cx rotation's center horizontal position.
22889 * @param cy rotation's center vertical position.
22890 * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22891 * @param xx Pointer where to store rotated x.
22892 * @param yy Pointer where to store rotated y.
22896 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);
22899 * Add a new marker to the map object.
22901 * @param obj The map object.
22902 * @param lon The longitude of the marker.
22903 * @param lat The latitude of the marker.
22904 * @param clas The class, to use when marker @b isn't grouped to others.
22905 * @param clas_group The class group, to use when marker is grouped to others
22906 * @param data The data passed to the callbacks.
22908 * @return The created marker or @c NULL upon failure.
22910 * A marker will be created and shown in a specific point of the map, defined
22911 * by @p lon and @p lat.
22913 * It will be displayed using style defined by @p class when this marker
22914 * is displayed alone (not grouped). A new class can be created with
22915 * elm_map_marker_class_new().
22917 * If the marker is grouped to other markers, it will be displayed with
22918 * style defined by @p class_group. Markers with the same group are grouped
22919 * if they are close. A new group class can be created with
22920 * elm_map_marker_group_class_new().
22922 * Markers created with this method can be deleted with
22923 * elm_map_marker_remove().
22925 * A marker can have associated content to be displayed by a bubble,
22926 * when a user click over it, as well as an icon. These objects will
22927 * be fetch using class' callback functions.
22929 * @see elm_map_marker_class_new()
22930 * @see elm_map_marker_group_class_new()
22931 * @see elm_map_marker_remove()
22935 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);
22938 * Set the maximum numbers of markers' content to be displayed in a group.
22940 * @param obj The map object.
22941 * @param max The maximum numbers of items displayed in a bubble.
22943 * A bubble will be displayed when the user clicks over the group,
22944 * and will place the content of markers that belong to this group
22947 * A group can have a long list of markers, consequently the creation
22948 * of the content of the bubble can be very slow.
22950 * In order to avoid this, a maximum number of items is displayed
22953 * By default this number is 30.
22955 * Marker with the same group class are grouped if they are close.
22957 * @see elm_map_marker_add()
22961 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
22964 * Remove a marker from the map.
22966 * @param marker The marker to remove.
22968 * @see elm_map_marker_add()
22972 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22975 * Get the current coordinates of the marker.
22977 * @param marker marker.
22978 * @param lat Pointer where to store the marker's latitude.
22979 * @param lon Pointer where to store the marker's longitude.
22981 * These values are set when adding markers, with function
22982 * elm_map_marker_add().
22984 * @see elm_map_marker_add()
22988 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
22991 * Animatedly bring in given marker to the center of the map.
22993 * @param marker The marker to center at.
22995 * This causes map to jump to the given @p marker's coordinates
22996 * and show it (by scrolling) in the center of the viewport, if it is not
22997 * already centered. This will use animation to do so and take a period
22998 * of time to complete.
23000 * @see elm_map_marker_show() for a function to avoid animation.
23001 * @see elm_map_marker_region_get()
23005 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23008 * Show the given marker at the center of the map, @b immediately.
23010 * @param marker The marker to center at.
23012 * This causes map to @b redraw its viewport's contents to the
23013 * region contining the given @p marker's coordinates, that will be
23014 * moved to the center of the map.
23016 * @see elm_map_marker_bring_in() for a function to move with animation.
23017 * @see elm_map_markers_list_show() if more than one marker need to be
23019 * @see elm_map_marker_region_get()
23023 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23026 * Move and zoom the map to display a list of markers.
23028 * @param markers A list of #Elm_Map_Marker handles.
23030 * The map will be centered on the center point of the markers in the list.
23031 * Then the map will be zoomed in order to fit the markers using the maximum
23032 * zoom which allows display of all the markers.
23034 * @warning All the markers should belong to the same map object.
23036 * @see elm_map_marker_show() to show a single marker.
23037 * @see elm_map_marker_bring_in()
23041 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
23044 * Get the Evas object returned by the ElmMapMarkerGetFunc callback
23046 * @param marker The marker wich content should be returned.
23047 * @return Return the evas object if it exists, else @c NULL.
23049 * To set callback function #ElmMapMarkerGetFunc for the marker class,
23050 * elm_map_marker_class_get_cb_set() should be used.
23052 * This content is what will be inside the bubble that will be displayed
23053 * when an user clicks over the marker.
23055 * This returns the actual Evas object used to be placed inside
23056 * the bubble. This may be @c NULL, as it may
23057 * not have been created or may have been deleted, at any time, by
23058 * the map. <b>Do not modify this object</b> (move, resize,
23059 * show, hide, etc.), as the map is controlling it. This
23060 * function is for querying, emitting custom signals or hooking
23061 * lower level callbacks for events on that object. Do not delete
23062 * this object under any circumstances.
23066 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23069 * Update the marker
23071 * @param marker The marker to be updated.
23073 * If a content is set to this marker, it will call function to delete it,
23074 * #ElmMapMarkerDelFunc, and then will fetch the content again with
23075 * #ElmMapMarkerGetFunc.
23077 * These functions are set for the marker class with
23078 * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23082 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23085 * Close all the bubbles opened by the user.
23087 * @param obj The map object.
23089 * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23090 * when the user clicks on a marker.
23092 * This functions is set for the marker class with
23093 * elm_map_marker_class_get_cb_set().
23097 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23100 * Create a new group class.
23102 * @param obj The map object.
23103 * @return Returns the new group class.
23105 * Each marker must be associated to a group class. Markers in the same
23106 * group are grouped if they are close.
23108 * The group class defines the style of the marker when a marker is grouped
23109 * to others markers. When it is alone, another class will be used.
23111 * A group class will need to be provided when creating a marker with
23112 * elm_map_marker_add().
23114 * Some properties and functions can be set by class, as:
23115 * - style, with elm_map_group_class_style_set()
23116 * - data - to be associated to the group class. It can be set using
23117 * elm_map_group_class_data_set().
23118 * - min zoom to display markers, set with
23119 * elm_map_group_class_zoom_displayed_set().
23120 * - max zoom to group markers, set using
23121 * elm_map_group_class_zoom_grouped_set().
23122 * - visibility - set if markers will be visible or not, set with
23123 * elm_map_group_class_hide_set().
23124 * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23125 * It can be set using elm_map_group_class_icon_cb_set().
23127 * @see elm_map_marker_add()
23128 * @see elm_map_group_class_style_set()
23129 * @see elm_map_group_class_data_set()
23130 * @see elm_map_group_class_zoom_displayed_set()
23131 * @see elm_map_group_class_zoom_grouped_set()
23132 * @see elm_map_group_class_hide_set()
23133 * @see elm_map_group_class_icon_cb_set()
23137 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23140 * Set the marker's style of a group class.
23142 * @param clas The group class.
23143 * @param style The style to be used by markers.
23145 * Each marker must be associated to a group class, and will use the style
23146 * defined by such class when grouped to other markers.
23148 * The following styles are provided by default theme:
23149 * @li @c radio - blue circle
23150 * @li @c radio2 - green circle
23153 * @see elm_map_group_class_new() for more details.
23154 * @see elm_map_marker_add()
23158 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23161 * Set the icon callback function of a group class.
23163 * @param clas The group class.
23164 * @param icon_get The callback function that will return the icon.
23166 * Each marker must be associated to a group class, and it can display a
23167 * custom icon. The function @p icon_get must return this icon.
23169 * @see elm_map_group_class_new() for more details.
23170 * @see elm_map_marker_add()
23174 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23177 * Set the data associated to the group class.
23179 * @param clas The group class.
23180 * @param data The new user data.
23182 * This data will be passed for callback functions, like icon get callback,
23183 * that can be set with elm_map_group_class_icon_cb_set().
23185 * If a data was previously set, the object will lose the pointer for it,
23186 * so if needs to be freed, you must do it yourself.
23188 * @see elm_map_group_class_new() for more details.
23189 * @see elm_map_group_class_icon_cb_set()
23190 * @see elm_map_marker_add()
23194 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23197 * Set the minimum zoom from where the markers are displayed.
23199 * @param clas The group class.
23200 * @param zoom The minimum zoom.
23202 * Markers only will be displayed when the map is displayed at @p zoom
23205 * @see elm_map_group_class_new() for more details.
23206 * @see elm_map_marker_add()
23210 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23213 * Set the zoom from where the markers are no more grouped.
23215 * @param clas The group class.
23216 * @param zoom The maximum zoom.
23218 * Markers only will be grouped when the map is displayed at
23219 * less than @p zoom.
23221 * @see elm_map_group_class_new() for more details.
23222 * @see elm_map_marker_add()
23226 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23229 * Set if the markers associated to the group class @clas are hidden or not.
23231 * @param clas The group class.
23232 * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23235 * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23240 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23243 * Create a new marker class.
23245 * @param obj The map object.
23246 * @return Returns the new group class.
23248 * Each marker must be associated to a class.
23250 * The marker class defines the style of the marker when a marker is
23251 * displayed alone, i.e., not grouped to to others markers. When grouped
23252 * it will use group class style.
23254 * A marker class will need to be provided when creating a marker with
23255 * elm_map_marker_add().
23257 * Some properties and functions can be set by class, as:
23258 * - style, with elm_map_marker_class_style_set()
23259 * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23260 * It can be set using elm_map_marker_class_icon_cb_set().
23261 * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23262 * Set using elm_map_marker_class_get_cb_set().
23263 * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23264 * Set using elm_map_marker_class_del_cb_set().
23266 * @see elm_map_marker_add()
23267 * @see elm_map_marker_class_style_set()
23268 * @see elm_map_marker_class_icon_cb_set()
23269 * @see elm_map_marker_class_get_cb_set()
23270 * @see elm_map_marker_class_del_cb_set()
23274 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23277 * Set the marker's style of a marker class.
23279 * @param clas The marker class.
23280 * @param style The style to be used by markers.
23282 * Each marker must be associated to a marker class, and will use the style
23283 * defined by such class when alone, i.e., @b not grouped to other markers.
23285 * The following styles are provided by default theme:
23290 * @see elm_map_marker_class_new() for more details.
23291 * @see elm_map_marker_add()
23295 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23298 * Set the icon callback function of a marker class.
23300 * @param clas The marker class.
23301 * @param icon_get The callback function that will return the icon.
23303 * Each marker must be associated to a marker class, and it can display a
23304 * custom icon. The function @p icon_get must return this icon.
23306 * @see elm_map_marker_class_new() for more details.
23307 * @see elm_map_marker_add()
23311 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23314 * Set the bubble content callback function of a marker class.
23316 * @param clas The marker class.
23317 * @param get The callback function that will return the content.
23319 * Each marker must be associated to a marker class, and it can display a
23320 * a content on a bubble that opens when the user click over the marker.
23321 * The function @p get must return this content object.
23323 * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23326 * @see elm_map_marker_class_new() for more details.
23327 * @see elm_map_marker_class_del_cb_set()
23328 * @see elm_map_marker_add()
23332 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23335 * Set the callback function used to delete bubble content of a marker class.
23337 * @param clas The marker class.
23338 * @param del The callback function that will delete the content.
23340 * Each marker must be associated to a marker class, and it can display a
23341 * a content on a bubble that opens when the user click over the marker.
23342 * The function to return such content can be set with
23343 * elm_map_marker_class_get_cb_set().
23345 * If this content must be freed, a callback function need to be
23346 * set for that task with this function.
23348 * If this callback is defined it will have to delete (or not) the
23349 * object inside, but if the callback is not defined the object will be
23350 * destroyed with evas_object_del().
23352 * @see elm_map_marker_class_new() for more details.
23353 * @see elm_map_marker_class_get_cb_set()
23354 * @see elm_map_marker_add()
23358 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23361 * Get the list of available sources.
23363 * @param obj The map object.
23364 * @return The source names list.
23366 * It will provide a list with all available sources, that can be set as
23367 * current source with elm_map_source_name_set(), or get with
23368 * elm_map_source_name_get().
23370 * Available sources:
23376 * @see elm_map_source_name_set() for more details.
23377 * @see elm_map_source_name_get()
23381 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23384 * Set the source of the map.
23386 * @param obj The map object.
23387 * @param source The source to be used.
23389 * Map widget retrieves images that composes the map from a web service.
23390 * This web service can be set with this method.
23392 * A different service can return a different maps with different
23393 * information and it can use different zoom values.
23395 * The @p source_name need to match one of the names provided by
23396 * elm_map_source_names_get().
23398 * The current source can be get using elm_map_source_name_get().
23400 * @see elm_map_source_names_get()
23401 * @see elm_map_source_name_get()
23406 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23409 * Get the name of currently used source.
23411 * @param obj The map object.
23412 * @return Returns the name of the source in use.
23414 * @see elm_map_source_name_set() for more details.
23418 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23421 * Set the source of the route service to be used by the map.
23423 * @param obj The map object.
23424 * @param source The route service to be used, being it one of
23425 * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23426 * and #ELM_MAP_ROUTE_SOURCE_ORS.
23428 * Each one has its own algorithm, so the route retrieved may
23429 * differ depending on the source route. Now, only the default is working.
23431 * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23432 * http://www.yournavigation.org/.
23434 * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23435 * assumptions. Its routing core is based on Contraction Hierarchies.
23437 * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23439 * @see elm_map_route_source_get().
23443 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23446 * Get the current route source.
23448 * @param obj The map object.
23449 * @return The source of the route service used by the map.
23451 * @see elm_map_route_source_set() for details.
23455 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23458 * Set the minimum zoom of the source.
23460 * @param obj The map object.
23461 * @param zoom New minimum zoom value to be used.
23463 * By default, it's 0.
23467 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23470 * Get the minimum zoom of the source.
23472 * @param obj The map object.
23473 * @return Returns the minimum zoom of the source.
23475 * @see elm_map_source_zoom_min_set() for details.
23479 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23482 * Set the maximum zoom of the source.
23484 * @param obj The map object.
23485 * @param zoom New maximum zoom value to be used.
23487 * By default, it's 18.
23491 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23494 * Get the maximum zoom of the source.
23496 * @param obj The map object.
23497 * @return Returns the maximum zoom of the source.
23499 * @see elm_map_source_zoom_min_set() for details.
23503 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23506 * Set the user agent used by the map object to access routing services.
23508 * @param obj The map object.
23509 * @param user_agent The user agent to be used by the map.
23511 * User agent is a client application implementing a network protocol used
23512 * in communications within a client–server distributed computing system
23514 * The @p user_agent identification string will transmitted in a header
23515 * field @c User-Agent.
23517 * @see elm_map_user_agent_get()
23521 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23524 * Get the user agent used by the map object.
23526 * @param obj The map object.
23527 * @return The user agent identification string used by the map.
23529 * @see elm_map_user_agent_set() for details.
23533 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23536 * Add a new route to the map object.
23538 * @param obj The map object.
23539 * @param type The type of transport to be considered when tracing a route.
23540 * @param method The routing method, what should be priorized.
23541 * @param flon The start longitude.
23542 * @param flat The start latitude.
23543 * @param tlon The destination longitude.
23544 * @param tlat The destination latitude.
23546 * @return The created route or @c NULL upon failure.
23548 * A route will be traced by point on coordinates (@p flat, @p flon)
23549 * to point on coordinates (@p tlat, @p tlon), using the route service
23550 * set with elm_map_route_source_set().
23552 * It will take @p type on consideration to define the route,
23553 * depending if the user will be walking or driving, the route may vary.
23554 * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23555 * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23557 * Another parameter is what the route should priorize, the minor distance
23558 * or the less time to be spend on the route. So @p method should be one
23559 * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23561 * Routes created with this method can be deleted with
23562 * elm_map_route_remove(), colored with elm_map_route_color_set(),
23563 * and distance can be get with elm_map_route_distance_get().
23565 * @see elm_map_route_remove()
23566 * @see elm_map_route_color_set()
23567 * @see elm_map_route_distance_get()
23568 * @see elm_map_route_source_set()
23572 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);
23575 * Remove a route from the map.
23577 * @param route The route to remove.
23579 * @see elm_map_route_add()
23583 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23586 * Set the route color.
23588 * @param route The route object.
23589 * @param r Red channel value, from 0 to 255.
23590 * @param g Green channel value, from 0 to 255.
23591 * @param b Blue channel value, from 0 to 255.
23592 * @param a Alpha channel value, from 0 to 255.
23594 * It uses an additive color model, so each color channel represents
23595 * how much of each primary colors must to be used. 0 represents
23596 * ausence of this color, so if all of the three are set to 0,
23597 * the color will be black.
23599 * These component values should be integers in the range 0 to 255,
23600 * (single 8-bit byte).
23602 * This sets the color used for the route. By default, it is set to
23603 * solid red (r = 255, g = 0, b = 0, a = 255).
23605 * For alpha channel, 0 represents completely transparent, and 255, opaque.
23607 * @see elm_map_route_color_get()
23611 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23614 * Get the route color.
23616 * @param route The route object.
23617 * @param r Pointer where to store the red channel value.
23618 * @param g Pointer where to store the green channel value.
23619 * @param b Pointer where to store the blue channel value.
23620 * @param a Pointer where to store the alpha channel value.
23622 * @see elm_map_route_color_set() for details.
23626 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23629 * Get the route distance in kilometers.
23631 * @param route The route object.
23632 * @return The distance of route (unit : km).
23636 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23639 * Get the information of route nodes.
23641 * @param route The route object.
23642 * @return Returns a string with the nodes of route.
23646 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23649 * Get the information of route waypoint.
23651 * @param route the route object.
23652 * @return Returns a string with information about waypoint of route.
23656 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23659 * Get the address of the name.
23661 * @param name The name handle.
23662 * @return Returns the address string of @p name.
23664 * This gets the coordinates of the @p name, created with one of the
23665 * conversion functions.
23667 * @see elm_map_utils_convert_name_into_coord()
23668 * @see elm_map_utils_convert_coord_into_name()
23672 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23675 * Get the current coordinates of the name.
23677 * @param name The name handle.
23678 * @param lat Pointer where to store the latitude.
23679 * @param lon Pointer where to store The longitude.
23681 * This gets the coordinates of the @p name, created with one of the
23682 * conversion functions.
23684 * @see elm_map_utils_convert_name_into_coord()
23685 * @see elm_map_utils_convert_coord_into_name()
23689 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23692 * Remove a name from the map.
23694 * @param name The name to remove.
23696 * Basically the struct handled by @p name will be freed, so convertions
23697 * between address and coordinates will be lost.
23699 * @see elm_map_utils_convert_name_into_coord()
23700 * @see elm_map_utils_convert_coord_into_name()
23704 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23709 * @param obj The map object.
23710 * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23711 * @param cx Rotation's center horizontal position.
23712 * @param cy Rotation's center vertical position.
23714 * @see elm_map_rotate_get()
23718 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23721 * Get the rotate degree of the map
23723 * @param obj The map object
23724 * @param degree Pointer where to store degrees from 0.0 to 360.0
23725 * to rotate arount Z axis.
23726 * @param cx Pointer where to store rotation's center horizontal position.
23727 * @param cy Pointer where to store rotation's center vertical position.
23729 * @see elm_map_rotate_set() to set map rotation.
23733 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);
23736 * Enable or disable mouse wheel to be used to zoom in / out the map.
23738 * @param obj The map object.
23739 * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23742 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23744 * It's disabled by default.
23746 * @see elm_map_wheel_disabled_get()
23750 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23753 * Get a value whether mouse wheel is enabled or not.
23755 * @param obj The map object.
23756 * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23757 * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23759 * Mouse wheel can be used for the user to zoom in or zoom out the map.
23761 * @see elm_map_wheel_disabled_set() for details.
23765 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23769 * Add a track on the map
23771 * @param obj The map object.
23772 * @param emap The emap route object.
23773 * @return The route object. This is an elm object of type Route.
23775 * @see elm_route_add() for details.
23779 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23783 * Remove a track from the map
23785 * @param obj The map object.
23786 * @param route The track to remove.
23790 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23797 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23799 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23801 EAPI double elm_route_lon_min_get(Evas_Object *obj);
23802 EAPI double elm_route_lat_min_get(Evas_Object *obj);
23803 EAPI double elm_route_lon_max_get(Evas_Object *obj);
23804 EAPI double elm_route_lat_max_get(Evas_Object *obj);
23808 * @defgroup Panel Panel
23810 * @image html img/widget/panel/preview-00.png
23811 * @image latex img/widget/panel/preview-00.eps
23813 * @brief A panel is a type of animated container that contains subobjects.
23814 * It can be expanded or contracted by clicking the button on it's edge.
23816 * Orientations are as follows:
23817 * @li ELM_PANEL_ORIENT_TOP
23818 * @li ELM_PANEL_ORIENT_LEFT
23819 * @li ELM_PANEL_ORIENT_RIGHT
23821 * To set/get/unset the content of the panel, you can use
23822 * elm_object_content_set/get/unset APIs.
23823 * Once the content object is set, a previously set one will be deleted.
23824 * If you want to keep that old content object, use the
23825 * elm_object_content_unset() function
23827 * @ref tutorial_panel shows one way to use this widget.
23830 typedef enum _Elm_Panel_Orient
23832 ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23833 ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23834 ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23835 ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23836 } Elm_Panel_Orient;
23838 * @brief Adds a panel object
23840 * @param parent The parent object
23842 * @return The panel object, or NULL on failure
23844 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23846 * @brief Sets the orientation of the panel
23848 * @param parent The parent object
23849 * @param orient The panel orientation. Can be one of the following:
23850 * @li ELM_PANEL_ORIENT_TOP
23851 * @li ELM_PANEL_ORIENT_LEFT
23852 * @li ELM_PANEL_ORIENT_RIGHT
23854 * Sets from where the panel will (dis)appear.
23856 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23858 * @brief Get the orientation of the panel.
23860 * @param obj The panel object
23861 * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23863 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23865 * @brief Set the content of the panel.
23867 * @param obj The panel object
23868 * @param content The panel content
23870 * Once the content object is set, a previously set one will be deleted.
23871 * If you want to keep that old content object, use the
23872 * elm_panel_content_unset() function.
23874 EINA_DEPRECATED EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23876 * @brief Get the content of the panel.
23878 * @param obj The panel object
23879 * @return The content that is being used
23881 * Return the content object which is set for this widget.
23883 * @see elm_panel_content_set()
23885 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23887 * @brief Unset the content of the panel.
23889 * @param obj The panel object
23890 * @return The content that was being used
23892 * Unparent and return the content object which was set for this widget.
23894 * @see elm_panel_content_set()
23896 EINA_DEPRECATED EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23898 * @brief Set the state of the panel.
23900 * @param obj The panel object
23901 * @param hidden If true, the panel will run the animation to contract
23903 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23905 * @brief Get the state of the panel.
23907 * @param obj The panel object
23908 * @param hidden If true, the panel is in the "hide" state
23910 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23912 * @brief Toggle the hidden state of the panel from code
23914 * @param obj The panel object
23916 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23922 * @defgroup Panes Panes
23923 * @ingroup Elementary
23925 * @image html img/widget/panes/preview-00.png
23926 * @image latex img/widget/panes/preview-00.eps width=\textwidth
23928 * @image html img/panes.png
23929 * @image latex img/panes.eps width=\textwidth
23931 * The panes adds a dragable bar between two contents. When dragged
23932 * this bar will resize contents size.
23934 * Panes can be displayed vertically or horizontally, and contents
23935 * size proportion can be customized (homogeneous by default).
23937 * Smart callbacks one can listen to:
23938 * - "press" - The panes has been pressed (button wasn't released yet).
23939 * - "unpressed" - The panes was released after being pressed.
23940 * - "clicked" - The panes has been clicked>
23941 * - "clicked,double" - The panes has been double clicked
23943 * Available styles for it:
23946 * Default contents parts of the panes widget that you can use for are:
23947 * @li "elm.swallow.left" - A leftside content of the panes
23948 * @li "elm.swallow.right" - A rightside content of the panes
23950 * If panes is displayed vertically, left content will be displayed at
23953 * Here is an example on its usage:
23954 * @li @ref panes_example
23957 #define ELM_PANES_CONTENT_LEFT "elm.swallow.left"
23958 #define ELM_PANES_CONTENT_RIGHT "elm.swallow.right"
23961 * @addtogroup Panes
23966 * Add a new panes widget to the given parent Elementary
23967 * (container) object.
23969 * @param parent The parent object.
23970 * @return a new panes widget handle or @c NULL, on errors.
23972 * This function inserts a new panes widget on the canvas.
23976 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23979 * Set the left content of the panes widget.
23981 * @param obj The panes object.
23982 * @param content The new left content object.
23984 * Once the content object is set, a previously set one will be deleted.
23985 * If you want to keep that old content object, use the
23986 * elm_panes_content_left_unset() function.
23988 * If panes is displayed vertically, left content will be displayed at
23991 * @see elm_panes_content_left_get()
23992 * @see elm_panes_content_right_set() to set content on the other side.
23996 EINA_DEPRECATED EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23999 * Set the right content of the panes widget.
24001 * @param obj The panes object.
24002 * @param content The new right content object.
24004 * Once the content object is set, a previously set one will be deleted.
24005 * If you want to keep that old content object, use the
24006 * elm_panes_content_right_unset() function.
24008 * If panes is displayed vertically, left content will be displayed at
24011 * @see elm_panes_content_right_get()
24012 * @see elm_panes_content_left_set() to set content on the other side.
24016 EINA_DEPRECATED EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24019 * Get the left content of the panes.
24021 * @param obj The panes object.
24022 * @return The left content object that is being used.
24024 * Return the left content object which is set for this widget.
24026 * @see elm_panes_content_left_set() for details.
24030 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24033 * Get the right content of the panes.
24035 * @param obj The panes object
24036 * @return The right content object that is being used
24038 * Return the right content object which is set for this widget.
24040 * @see elm_panes_content_right_set() for details.
24044 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24047 * Unset the left content used for the panes.
24049 * @param obj The panes object.
24050 * @return The left content object that was being used.
24052 * Unparent and return the left content object which was set for this widget.
24054 * @see elm_panes_content_left_set() for details.
24055 * @see elm_panes_content_left_get().
24059 EINA_DEPRECATED EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24062 * Unset the right content used for the panes.
24064 * @param obj The panes object.
24065 * @return The right content object that was being used.
24067 * Unparent and return the right content object which was set for this
24070 * @see elm_panes_content_right_set() for details.
24071 * @see elm_panes_content_right_get().
24075 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24078 * Get the size proportion of panes widget's left side.
24080 * @param obj The panes object.
24081 * @return float value between 0.0 and 1.0 representing size proportion
24084 * @see elm_panes_content_left_size_set() for more details.
24088 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24091 * Set the size proportion of panes widget's left side.
24093 * @param obj The panes object.
24094 * @param size Value between 0.0 and 1.0 representing size proportion
24097 * By default it's homogeneous, i.e., both sides have the same size.
24099 * If something different is required, it can be set with this function.
24100 * For example, if the left content should be displayed over
24101 * 75% of the panes size, @p size should be passed as @c 0.75.
24102 * This way, right content will be resized to 25% of panes size.
24104 * If displayed vertically, left content is displayed at top, and
24105 * right content at bottom.
24107 * @note This proportion will change when user drags the panes bar.
24109 * @see elm_panes_content_left_size_get()
24113 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24116 * Set the orientation of a given panes widget.
24118 * @param obj The panes object.
24119 * @param horizontal Use @c EINA_TRUE to make @p obj to be
24120 * @b horizontal, @c EINA_FALSE to make it @b vertical.
24122 * Use this function to change how your panes is to be
24123 * disposed: vertically or horizontally.
24125 * By default it's displayed horizontally.
24127 * @see elm_panes_horizontal_get()
24131 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24134 * Retrieve the orientation of a given panes widget.
24136 * @param obj The panes object.
24137 * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24138 * @c EINA_FALSE if it's @b vertical (and on errors).
24140 * @see elm_panes_horizontal_set() for more details.
24144 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24145 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24146 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24153 * @defgroup Flip Flip
24155 * @image html img/widget/flip/preview-00.png
24156 * @image latex img/widget/flip/preview-00.eps
24158 * This widget holds 2 content objects(Evas_Object): one on the front and one
24159 * on the back. It allows you to flip from front to back and vice-versa using
24160 * various animations.
24162 * If either the front or back contents are not set the flip will treat that
24163 * as transparent. So if you wore to set the front content but not the back,
24164 * and then call elm_flip_go() you would see whatever is below the flip.
24166 * For a list of supported animations see elm_flip_go().
24168 * Signals that you can add callbacks for are:
24169 * "animate,begin" - when a flip animation was started
24170 * "animate,done" - when a flip animation is finished
24172 * @ref tutorial_flip show how to use most of the API.
24176 typedef enum _Elm_Flip_Mode
24178 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24179 ELM_FLIP_ROTATE_X_CENTER_AXIS,
24180 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24181 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24182 ELM_FLIP_CUBE_LEFT,
24183 ELM_FLIP_CUBE_RIGHT,
24185 ELM_FLIP_CUBE_DOWN,
24186 ELM_FLIP_PAGE_LEFT,
24187 ELM_FLIP_PAGE_RIGHT,
24191 typedef enum _Elm_Flip_Interaction
24193 ELM_FLIP_INTERACTION_NONE,
24194 ELM_FLIP_INTERACTION_ROTATE,
24195 ELM_FLIP_INTERACTION_CUBE,
24196 ELM_FLIP_INTERACTION_PAGE
24197 } Elm_Flip_Interaction;
24198 typedef enum _Elm_Flip_Direction
24200 ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24201 ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24202 ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24203 ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24204 } Elm_Flip_Direction;
24206 * @brief Add a new flip to the parent
24208 * @param parent The parent object
24209 * @return The new object or NULL if it cannot be created
24211 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24213 * @brief Set the front content of the flip widget.
24215 * @param obj The flip object
24216 * @param content The new front content object
24218 * Once the content object is set, a previously set one will be deleted.
24219 * If you want to keep that old content object, use the
24220 * elm_flip_content_front_unset() function.
24222 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24224 * @brief Set the back content of the flip widget.
24226 * @param obj The flip object
24227 * @param content The new back content object
24229 * Once the content object is set, a previously set one will be deleted.
24230 * If you want to keep that old content object, use the
24231 * elm_flip_content_back_unset() function.
24233 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24235 * @brief Get the front content used for the flip
24237 * @param obj The flip object
24238 * @return The front content object that is being used
24240 * Return the front content object which is set for this widget.
24242 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24244 * @brief Get the back content used for the flip
24246 * @param obj The flip object
24247 * @return The back content object that is being used
24249 * Return the back content object which is set for this widget.
24251 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24253 * @brief Unset the front content used for the flip
24255 * @param obj The flip object
24256 * @return The front content object that was being used
24258 * Unparent and return the front content object which was set for this widget.
24260 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24262 * @brief Unset the back content used for the flip
24264 * @param obj The flip object
24265 * @return The back content object that was being used
24267 * Unparent and return the back content object which was set for this widget.
24269 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24271 * @brief Get flip front visibility state
24273 * @param obj The flip objct
24274 * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24277 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24279 * @brief Set flip perspective
24281 * @param obj The flip object
24282 * @param foc The coordinate to set the focus on
24283 * @param x The X coordinate
24284 * @param y The Y coordinate
24286 * @warning This function currently does nothing.
24288 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24290 * @brief Runs the flip animation
24292 * @param obj The flip object
24293 * @param mode The mode type
24295 * Flips the front and back contents using the @p mode animation. This
24296 * efectively hides the currently visible content and shows the hidden one.
24298 * There a number of possible animations to use for the flipping:
24299 * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24300 * around a horizontal axis in the middle of its height, the other content
24301 * is shown as the other side of the flip.
24302 * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24303 * around a vertical axis in the middle of its width, the other content is
24304 * shown as the other side of the flip.
24305 * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24306 * around a diagonal axis in the middle of its width, the other content is
24307 * shown as the other side of the flip.
24308 * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24309 * around a diagonal axis in the middle of its height, the other content is
24310 * shown as the other side of the flip.
24311 * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24312 * as if the flip was a cube, the other content is show as the right face of
24314 * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24315 * right as if the flip was a cube, the other content is show as the left
24316 * face of the cube.
24317 * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24318 * flip was a cube, the other content is show as the bottom face of the cube.
24319 * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24320 * the flip was a cube, the other content is show as the upper face of the
24322 * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24323 * if the flip was a book, the other content is shown as the page below that.
24324 * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24325 * as if the flip was a book, the other content is shown as the page below
24327 * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24328 * flip was a book, the other content is shown as the page below that.
24329 * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24330 * flip was a book, the other content is shown as the page below that.
24332 * @image html elm_flip.png
24333 * @image latex elm_flip.eps width=\textwidth
24335 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24337 * @brief Set the interactive flip mode
24339 * @param obj The flip object
24340 * @param mode The interactive flip mode to use
24342 * This sets if the flip should be interactive (allow user to click and
24343 * drag a side of the flip to reveal the back page and cause it to flip).
24344 * By default a flip is not interactive. You may also need to set which
24345 * sides of the flip are "active" for flipping and how much space they use
24346 * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24347 * and elm_flip_interacton_direction_hitsize_set()
24349 * The four avilable mode of interaction are:
24350 * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24351 * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24352 * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24353 * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24355 * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24356 * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24357 * happen, those can only be acheived with elm_flip_go();
24359 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24361 * @brief Get the interactive flip mode
24363 * @param obj The flip object
24364 * @return The interactive flip mode
24366 * Returns the interactive flip mode set by elm_flip_interaction_set()
24368 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24370 * @brief Set which directions of the flip respond to interactive flip
24372 * @param obj The flip object
24373 * @param dir The direction to change
24374 * @param enabled If that direction is enabled or not
24376 * By default all directions are disabled, so you may want to enable the
24377 * desired directions for flipping if you need interactive flipping. You must
24378 * call this function once for each direction that should be enabled.
24380 * @see elm_flip_interaction_set()
24382 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24384 * @brief Get the enabled state of that flip direction
24386 * @param obj The flip object
24387 * @param dir The direction to check
24388 * @return If that direction is enabled or not
24390 * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24392 * @see elm_flip_interaction_set()
24394 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24396 * @brief Set the amount of the flip that is sensitive to interactive flip
24398 * @param obj The flip object
24399 * @param dir The direction to modify
24400 * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24402 * Set the amount of the flip that is sensitive to interactive flip, with 0
24403 * representing no area in the flip and 1 representing the entire flip. There
24404 * is however a consideration to be made in that the area will never be
24405 * smaller than the finger size set(as set in your Elementary configuration).
24407 * @see elm_flip_interaction_set()
24409 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24411 * @brief Get the amount of the flip that is sensitive to interactive flip
24413 * @param obj The flip object
24414 * @param dir The direction to check
24415 * @return The size set for that direction
24417 * Returns the amount os sensitive area set by
24418 * elm_flip_interacton_direction_hitsize_set().
24420 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24425 /* scrolledentry */
24426 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24427 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24428 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24429 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24430 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24431 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24432 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24433 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24434 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24435 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24436 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24437 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24438 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24439 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24440 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24441 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24442 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24443 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24444 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24445 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24446 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24447 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24448 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24449 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24450 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24451 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24452 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24453 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24454 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24455 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24456 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24457 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24458 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24459 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24460 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24461 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);
24462 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24463 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24464 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);
24465 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24466 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);
24467 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24468 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24469 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24470 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24471 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24472 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24473 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24474 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24475 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);
24476 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);
24477 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);
24478 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);
24479 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);
24480 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);
24481 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24482 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24483 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24484 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24485 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24486 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24487 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24490 * @defgroup Conformant Conformant
24491 * @ingroup Elementary
24493 * @image html img/widget/conformant/preview-00.png
24494 * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24496 * @image html img/conformant.png
24497 * @image latex img/conformant.eps width=\textwidth
24499 * The aim is to provide a widget that can be used in elementary apps to
24500 * account for space taken up by the indicator, virtual keypad & softkey
24501 * windows when running the illume2 module of E17.
24503 * So conformant content will be sized and positioned considering the
24504 * space required for such stuff, and when they popup, as a keyboard
24505 * shows when an entry is selected, conformant content won't change.
24507 * Available styles for it:
24510 * Default contents parts of the conformant widget that you can use for are:
24511 * @li "elm.swallow.content" - A content of the conformant
24513 * See how to use this widget in this example:
24514 * @ref conformant_example
24518 * @addtogroup Conformant
24523 * Add a new conformant widget to the given parent Elementary
24524 * (container) object.
24526 * @param parent The parent object.
24527 * @return A new conformant widget handle or @c NULL, on errors.
24529 * This function inserts a new conformant widget on the canvas.
24531 * @ingroup Conformant
24533 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24536 * Set the content of the conformant widget.
24538 * @param obj The conformant object.
24539 * @param content The content to be displayed by the conformant.
24541 * Content will be sized and positioned considering the space required
24542 * to display a virtual keyboard. So it won't fill all the conformant
24543 * size. This way is possible to be sure that content won't resize
24544 * or be re-positioned after the keyboard is displayed.
24546 * Once the content object is set, a previously set one will be deleted.
24547 * If you want to keep that old content object, use the
24548 * elm_object_content_unset() function.
24550 * @see elm_object_content_unset()
24551 * @see elm_object_content_get()
24553 * @ingroup Conformant
24555 EINA_DEPRECATED EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24558 * Get the content of the conformant widget.
24560 * @param obj The conformant object.
24561 * @return The content that is being used.
24563 * Return the content object which is set for this widget.
24564 * It won't be unparent from conformant. For that, use
24565 * elm_object_content_unset().
24567 * @see elm_object_content_set().
24568 * @see elm_object_content_unset()
24570 * @ingroup Conformant
24572 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24575 * Unset the content of the conformant widget.
24577 * @param obj The conformant object.
24578 * @return The content that was being used.
24580 * Unparent and return the content object which was set for this widget.
24582 * @see elm_object_content_set().
24584 * @ingroup Conformant
24586 EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24589 * Returns the Evas_Object that represents the content area.
24591 * @param obj The conformant object.
24592 * @return The content area of the widget.
24594 * @ingroup Conformant
24596 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24603 * @defgroup Mapbuf Mapbuf
24604 * @ingroup Elementary
24606 * @image html img/widget/mapbuf/preview-00.png
24607 * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24609 * This holds one content object and uses an Evas Map of transformation
24610 * points to be later used with this content. So the content will be
24611 * moved, resized, etc as a single image. So it will improve performance
24612 * when you have a complex interafce, with a lot of elements, and will
24613 * need to resize or move it frequently (the content object and its
24616 * To set/get/unset the content of the mapbuf, you can use
24617 * elm_object_content_set/get/unset APIs.
24618 * Once the content object is set, a previously set one will be deleted.
24619 * If you want to keep that old content object, use the
24620 * elm_object_content_unset() function.
24622 * To enable map, elm_mapbuf_enabled_set() should be used.
24624 * See how to use this widget in this example:
24625 * @ref mapbuf_example
24629 * @addtogroup Mapbuf
24634 * Add a new mapbuf widget to the given parent Elementary
24635 * (container) object.
24637 * @param parent The parent object.
24638 * @return A new mapbuf widget handle or @c NULL, on errors.
24640 * This function inserts a new mapbuf widget on the canvas.
24644 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24647 * Set the content of the mapbuf.
24649 * @param obj The mapbuf object.
24650 * @param content The content that will be filled in this mapbuf object.
24652 * Once the content object is set, a previously set one will be deleted.
24653 * If you want to keep that old content object, use the
24654 * elm_mapbuf_content_unset() function.
24656 * To enable map, elm_mapbuf_enabled_set() should be used.
24660 EINA_DEPRECATED EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24663 * Get the content of the mapbuf.
24665 * @param obj The mapbuf object.
24666 * @return The content that is being used.
24668 * Return the content object which is set for this widget.
24670 * @see elm_mapbuf_content_set() for details.
24674 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24677 * Unset the content of the mapbuf.
24679 * @param obj The mapbuf object.
24680 * @return The content that was being used.
24682 * Unparent and return the content object which was set for this widget.
24684 * @see elm_mapbuf_content_set() for details.
24688 EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24691 * Enable or disable the map.
24693 * @param obj The mapbuf object.
24694 * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24696 * This enables the map that is set or disables it. On enable, the object
24697 * geometry will be saved, and the new geometry will change (position and
24698 * size) to reflect the map geometry set.
24700 * Also, when enabled, alpha and smooth states will be used, so if the
24701 * content isn't solid, alpha should be enabled, for example, otherwise
24702 * a black retangle will fill the content.
24704 * When disabled, the stored map will be freed and geometry prior to
24705 * enabling the map will be restored.
24707 * It's disabled by default.
24709 * @see elm_mapbuf_alpha_set()
24710 * @see elm_mapbuf_smooth_set()
24714 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24717 * Get a value whether map is enabled or not.
24719 * @param obj The mapbuf object.
24720 * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24721 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24723 * @see elm_mapbuf_enabled_set() for details.
24727 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24730 * Enable or disable smooth map rendering.
24732 * @param obj The mapbuf object.
24733 * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24736 * This sets smoothing for map rendering. If the object is a type that has
24737 * its own smoothing settings, then both the smooth settings for this object
24738 * and the map must be turned off.
24740 * By default smooth maps are enabled.
24744 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24747 * Get a value whether smooth map rendering is enabled or not.
24749 * @param obj The mapbuf object.
24750 * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24751 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24753 * @see elm_mapbuf_smooth_set() for details.
24757 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24760 * Set or unset alpha flag for map rendering.
24762 * @param obj The mapbuf object.
24763 * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24766 * This sets alpha flag for map rendering. If the object is a type that has
24767 * its own alpha settings, then this will take precedence. Only image objects
24768 * have this currently. It stops alpha blending of the map area, and is
24769 * useful if you know the object and/or all sub-objects is 100% solid.
24771 * Alpha is enabled by default.
24775 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24778 * Get a value whether alpha blending is enabled or not.
24780 * @param obj The mapbuf object.
24781 * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24782 * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24784 * @see elm_mapbuf_alpha_set() for details.
24788 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24795 * @defgroup Flipselector Flip Selector
24797 * @image html img/widget/flipselector/preview-00.png
24798 * @image latex img/widget/flipselector/preview-00.eps
24800 * A flip selector is a widget to show a set of @b text items, one
24801 * at a time, with the same sheet switching style as the @ref Clock
24802 * "clock" widget, when one changes the current displaying sheet
24803 * (thus, the "flip" in the name).
24805 * User clicks to flip sheets which are @b held for some time will
24806 * make the flip selector to flip continuosly and automatically for
24807 * the user. The interval between flips will keep growing in time,
24808 * so that it helps the user to reach an item which is distant from
24809 * the current selection.
24811 * Smart callbacks one can register to:
24812 * - @c "selected" - when the widget's selected text item is changed
24813 * - @c "overflowed" - when the widget's current selection is changed
24814 * from the first item in its list to the last
24815 * - @c "underflowed" - when the widget's current selection is changed
24816 * from the last item in its list to the first
24818 * Available styles for it:
24821 * Here is an example on its usage:
24822 * @li @ref flipselector_example
24826 * @addtogroup Flipselector
24830 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24833 * Add a new flip selector widget to the given parent Elementary
24834 * (container) widget
24836 * @param parent The parent object
24837 * @return a new flip selector widget handle or @c NULL, on errors
24839 * This function inserts a new flip selector widget on the canvas.
24841 * @ingroup Flipselector
24843 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24846 * Programmatically select the next item of a flip selector widget
24848 * @param obj The flipselector object
24850 * @note The selection will be animated. Also, if it reaches the
24851 * end of its list of member items, it will continue with the first
24854 * @ingroup Flipselector
24856 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24859 * Programmatically select the previous item of a flip selector
24862 * @param obj The flipselector object
24864 * @note The selection will be animated. Also, if it reaches the
24865 * beginning of its list of member items, it will continue with the
24866 * last one backwards.
24868 * @ingroup Flipselector
24870 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24873 * Append a (text) item to a flip selector widget
24875 * @param obj The flipselector object
24876 * @param label The (text) label of the new item
24877 * @param func Convenience callback function to take place when
24879 * @param data Data passed to @p func, above
24880 * @return A handle to the item added or @c NULL, on errors
24882 * The widget's list of labels to show will be appended with the
24883 * given value. If the user wishes so, a callback function pointer
24884 * can be passed, which will get called when this same item is
24887 * @note The current selection @b won't be modified by appending an
24888 * element to the list.
24890 * @note The maximum length of the text label is going to be
24891 * determined <b>by the widget's theme</b>. Strings larger than
24892 * that value are going to be @b truncated.
24894 * @ingroup Flipselector
24896 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24899 * Prepend a (text) item to a flip selector widget
24901 * @param obj The flipselector object
24902 * @param label The (text) label of the new item
24903 * @param func Convenience callback function to take place when
24905 * @param data Data passed to @p func, above
24906 * @return A handle to the item added or @c NULL, on errors
24908 * The widget's list of labels to show will be prepended with the
24909 * given value. If the user wishes so, a callback function pointer
24910 * can be passed, which will get called when this same item is
24913 * @note The current selection @b won't be modified by prepending
24914 * an element to the list.
24916 * @note The maximum length of the text label is going to be
24917 * determined <b>by the widget's theme</b>. Strings larger than
24918 * that value are going to be @b truncated.
24920 * @ingroup Flipselector
24922 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24925 * Get the internal list of items in a given flip selector widget.
24927 * @param obj The flipselector object
24928 * @return The list of items (#Elm_Flipselector_Item as data) or
24929 * @c NULL on errors.
24931 * This list is @b not to be modified in any way and must not be
24932 * freed. Use the list members with functions like
24933 * elm_flipselector_item_label_set(),
24934 * elm_flipselector_item_label_get(),
24935 * elm_flipselector_item_del(),
24936 * elm_flipselector_item_selected_get(),
24937 * elm_flipselector_item_selected_set().
24939 * @warning This list is only valid until @p obj object's internal
24940 * items list is changed. It should be fetched again with another
24941 * call to this function when changes happen.
24943 * @ingroup Flipselector
24945 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24948 * Get the first item in the given flip selector widget's list of
24951 * @param obj The flipselector object
24952 * @return The first item or @c NULL, if it has no items (and on
24955 * @see elm_flipselector_item_append()
24956 * @see elm_flipselector_last_item_get()
24958 * @ingroup Flipselector
24960 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24963 * Get the last item in the given flip selector widget's list of
24966 * @param obj The flipselector object
24967 * @return The last item or @c NULL, if it has no items (and on
24970 * @see elm_flipselector_item_prepend()
24971 * @see elm_flipselector_first_item_get()
24973 * @ingroup Flipselector
24975 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24978 * Get the currently selected item in a flip selector widget.
24980 * @param obj The flipselector object
24981 * @return The selected item or @c NULL, if the widget has no items
24984 * @ingroup Flipselector
24986 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24989 * Set whether a given flip selector widget's item should be the
24990 * currently selected one.
24992 * @param item The flip selector item
24993 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
24995 * This sets whether @p item is or not the selected (thus, under
24996 * display) one. If @p item is different than one under display,
24997 * the latter will be unselected. If the @p item is set to be
24998 * unselected, on the other hand, the @b first item in the widget's
24999 * internal members list will be the new selected one.
25001 * @see elm_flipselector_item_selected_get()
25003 * @ingroup Flipselector
25005 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
25008 * Get whether a given flip selector widget's item is the currently
25011 * @param item The flip selector item
25012 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
25015 * @see elm_flipselector_item_selected_set()
25017 * @ingroup Flipselector
25019 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25022 * Delete a given item from a flip selector widget.
25024 * @param item The item to delete
25026 * @ingroup Flipselector
25028 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25031 * Get the label of a given flip selector widget's item.
25033 * @param item The item to get label from
25034 * @return The text label of @p item or @c NULL, on errors
25036 * @see elm_flipselector_item_label_set()
25038 * @ingroup Flipselector
25040 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25043 * Set the label of a given flip selector widget's item.
25045 * @param item The item to set label on
25046 * @param label The text label string, in UTF-8 encoding
25048 * @see elm_flipselector_item_label_get()
25050 * @ingroup Flipselector
25052 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
25055 * Gets the item before @p item in a flip selector widget's
25056 * internal list of items.
25058 * @param item The item to fetch previous from
25059 * @return The item before the @p item, in its parent's list. If
25060 * there is no previous item for @p item or there's an
25061 * error, @c NULL is returned.
25063 * @see elm_flipselector_item_next_get()
25065 * @ingroup Flipselector
25067 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25070 * Gets the item after @p item in a flip selector widget's
25071 * internal list of items.
25073 * @param item The item to fetch next from
25074 * @return The item after the @p item, in its parent's list. If
25075 * there is no next item for @p item or there's an
25076 * error, @c NULL is returned.
25078 * @see elm_flipselector_item_next_get()
25080 * @ingroup Flipselector
25082 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25085 * Set the interval on time updates for an user mouse button hold
25086 * on a flip selector widget.
25088 * @param obj The flip selector object
25089 * @param interval The (first) interval value in seconds
25091 * This interval value is @b decreased while the user holds the
25092 * mouse pointer either flipping up or flipping doww a given flip
25095 * This helps the user to get to a given item distant from the
25096 * current one easier/faster, as it will start to flip quicker and
25097 * quicker on mouse button holds.
25099 * The calculation for the next flip interval value, starting from
25100 * the one set with this call, is the previous interval divided by
25101 * 1.05, so it decreases a little bit.
25103 * The default starting interval value for automatic flips is
25106 * @see elm_flipselector_interval_get()
25108 * @ingroup Flipselector
25110 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25113 * Get the interval on time updates for an user mouse button hold
25114 * on a flip selector widget.
25116 * @param obj The flip selector object
25117 * @return The (first) interval value, in seconds, set on it
25119 * @see elm_flipselector_interval_set() for more details
25121 * @ingroup Flipselector
25123 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25129 * @addtogroup Calendar
25134 * @enum _Elm_Calendar_Mark_Repeat
25135 * @typedef Elm_Calendar_Mark_Repeat
25137 * Event periodicity, used to define if a mark should be repeated
25138 * @b beyond event's day. It's set when a mark is added.
25140 * So, for a mark added to 13th May with periodicity set to WEEKLY,
25141 * there will be marks every week after this date. Marks will be displayed
25142 * at 13th, 20th, 27th, 3rd June ...
25144 * Values don't work as bitmask, only one can be choosen.
25146 * @see elm_calendar_mark_add()
25148 * @ingroup Calendar
25150 typedef enum _Elm_Calendar_Mark_Repeat
25152 ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25153 ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25154 ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25155 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*/
25156 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. */
25157 } Elm_Calendar_Mark_Repeat;
25159 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(). */
25162 * Add a new calendar widget to the given parent Elementary
25163 * (container) object.
25165 * @param parent The parent object.
25166 * @return a new calendar widget handle or @c NULL, on errors.
25168 * This function inserts a new calendar widget on the canvas.
25170 * @ref calendar_example_01
25172 * @ingroup Calendar
25174 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25177 * Get weekdays names displayed by the calendar.
25179 * @param obj The calendar object.
25180 * @return Array of seven strings to be used as weekday names.
25182 * By default, weekdays abbreviations get from system are displayed:
25183 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25184 * The first string is related to Sunday, the second to Monday...
25186 * @see elm_calendar_weekdays_name_set()
25188 * @ref calendar_example_05
25190 * @ingroup Calendar
25192 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25195 * Set weekdays names to be displayed by the calendar.
25197 * @param obj The calendar object.
25198 * @param weekdays Array of seven strings to be used as weekday names.
25199 * @warning It must have 7 elements, or it will access invalid memory.
25200 * @warning The strings must be NULL terminated ('@\0').
25202 * By default, weekdays abbreviations get from system are displayed:
25203 * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25205 * The first string should be related to Sunday, the second to Monday...
25207 * The usage should be like this:
25209 * const char *weekdays[] =
25211 * "Sunday", "Monday", "Tuesday", "Wednesday",
25212 * "Thursday", "Friday", "Saturday"
25214 * elm_calendar_weekdays_names_set(calendar, weekdays);
25217 * @see elm_calendar_weekdays_name_get()
25219 * @ref calendar_example_02
25221 * @ingroup Calendar
25223 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25226 * Set the minimum and maximum values for the year
25228 * @param obj The calendar object
25229 * @param min The minimum year, greater than 1901;
25230 * @param max The maximum year;
25232 * Maximum must be greater than minimum, except if you don't wan't to set
25234 * Default values are 1902 and -1.
25236 * If the maximum year is a negative value, it will be limited depending
25237 * on the platform architecture (year 2037 for 32 bits);
25239 * @see elm_calendar_min_max_year_get()
25241 * @ref calendar_example_03
25243 * @ingroup Calendar
25245 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25248 * Get the minimum and maximum values for the year
25250 * @param obj The calendar object.
25251 * @param min The minimum year.
25252 * @param max The maximum year.
25254 * Default values are 1902 and -1.
25256 * @see elm_calendar_min_max_year_get() for more details.
25258 * @ref calendar_example_05
25260 * @ingroup Calendar
25262 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25265 * Enable or disable day selection
25267 * @param obj The calendar object.
25268 * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25271 * Enabled by default. If disabled, the user still can select months,
25272 * but not days. Selected days are highlighted on calendar.
25273 * It should be used if you won't need such selection for the widget usage.
25275 * When a day is selected, or month is changed, smart callbacks for
25276 * signal "changed" will be called.
25278 * @see elm_calendar_day_selection_enable_get()
25280 * @ref calendar_example_04
25282 * @ingroup Calendar
25284 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25287 * Get a value whether day selection is enabled or not.
25289 * @see elm_calendar_day_selection_enable_set() for details.
25291 * @param obj The calendar object.
25292 * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25293 * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25295 * @ref calendar_example_05
25297 * @ingroup Calendar
25299 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25303 * Set selected date to be highlighted on calendar.
25305 * @param obj The calendar object.
25306 * @param selected_time A @b tm struct to represent the selected date.
25308 * Set the selected date, changing the displayed month if needed.
25309 * Selected date changes when the user goes to next/previous month or
25310 * select a day pressing over it on calendar.
25312 * @see elm_calendar_selected_time_get()
25314 * @ref calendar_example_04
25316 * @ingroup Calendar
25318 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25321 * Get selected date.
25323 * @param obj The calendar object
25324 * @param selected_time A @b tm struct to point to selected date
25325 * @return EINA_FALSE means an error ocurred and returned time shouldn't
25328 * Get date selected by the user or set by function
25329 * elm_calendar_selected_time_set().
25330 * Selected date changes when the user goes to next/previous month or
25331 * select a day pressing over it on calendar.
25333 * @see elm_calendar_selected_time_get()
25335 * @ref calendar_example_05
25337 * @ingroup Calendar
25339 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25342 * Set a function to format the string that will be used to display
25345 * @param obj The calendar object
25346 * @param format_function Function to set the month-year string given
25347 * the selected date
25349 * By default it uses strftime with "%B %Y" format string.
25350 * It should allocate the memory that will be used by the string,
25351 * that will be freed by the widget after usage.
25352 * A pointer to the string and a pointer to the time struct will be provided.
25357 * _format_month_year(struct tm *selected_time)
25360 * if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25361 * return strdup(buf);
25364 * elm_calendar_format_function_set(calendar, _format_month_year);
25367 * @ref calendar_example_02
25369 * @ingroup Calendar
25371 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25374 * Add a new mark to the calendar
25376 * @param obj The calendar object
25377 * @param mark_type A string used to define the type of mark. It will be
25378 * emitted to the theme, that should display a related modification on these
25379 * days representation.
25380 * @param mark_time A time struct to represent the date of inclusion of the
25381 * mark. For marks that repeats it will just be displayed after the inclusion
25382 * date in the calendar.
25383 * @param repeat Repeat the event following this periodicity. Can be a unique
25384 * mark (that don't repeat), daily, weekly, monthly or annually.
25385 * @return The created mark or @p NULL upon failure.
25387 * Add a mark that will be drawn in the calendar respecting the insertion
25388 * time and periodicity. It will emit the type as signal to the widget theme.
25389 * Default theme supports "holiday" and "checked", but it can be extended.
25391 * It won't immediately update the calendar, drawing the marks.
25392 * For this, call elm_calendar_marks_draw(). However, when user selects
25393 * next or previous month calendar forces marks drawn.
25395 * Marks created with this method can be deleted with
25396 * elm_calendar_mark_del().
25400 * struct tm selected_time;
25401 * time_t current_time;
25403 * current_time = time(NULL) + 5 * 84600;
25404 * localtime_r(¤t_time, &selected_time);
25405 * elm_calendar_mark_add(cal, "holiday", selected_time,
25406 * ELM_CALENDAR_ANNUALLY);
25408 * current_time = time(NULL) + 1 * 84600;
25409 * localtime_r(¤t_time, &selected_time);
25410 * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25412 * elm_calendar_marks_draw(cal);
25415 * @see elm_calendar_marks_draw()
25416 * @see elm_calendar_mark_del()
25418 * @ref calendar_example_06
25420 * @ingroup Calendar
25422 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);
25425 * Delete mark from the calendar.
25427 * @param mark The mark to be deleted.
25429 * If deleting all calendar marks is required, elm_calendar_marks_clear()
25430 * should be used instead of getting marks list and deleting each one.
25432 * @see elm_calendar_mark_add()
25434 * @ref calendar_example_06
25436 * @ingroup Calendar
25438 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25441 * Remove all calendar's marks
25443 * @param obj The calendar object.
25445 * @see elm_calendar_mark_add()
25446 * @see elm_calendar_mark_del()
25448 * @ingroup Calendar
25450 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25454 * Get a list of all the calendar marks.
25456 * @param obj The calendar object.
25457 * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25459 * @see elm_calendar_mark_add()
25460 * @see elm_calendar_mark_del()
25461 * @see elm_calendar_marks_clear()
25463 * @ingroup Calendar
25465 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25468 * Draw calendar marks.
25470 * @param obj The calendar object.
25472 * Should be used after adding, removing or clearing marks.
25473 * It will go through the entire marks list updating the calendar.
25474 * If lots of marks will be added, add all the marks and then call
25477 * When the month is changed, i.e. user selects next or previous month,
25478 * marks will be drawed.
25480 * @see elm_calendar_mark_add()
25481 * @see elm_calendar_mark_del()
25482 * @see elm_calendar_marks_clear()
25484 * @ref calendar_example_06
25486 * @ingroup Calendar
25488 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25491 * Set a day text color to the same that represents Saturdays.
25493 * @param obj The calendar object.
25494 * @param pos The text position. Position is the cell counter, from left
25495 * to right, up to down. It starts on 0 and ends on 41.
25497 * @deprecated use elm_calendar_mark_add() instead like:
25500 * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25501 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25504 * @see elm_calendar_mark_add()
25506 * @ingroup Calendar
25508 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25511 * Set a day text color to the same that represents Sundays.
25513 * @param obj The calendar object.
25514 * @param pos The text position. Position is the cell counter, from left
25515 * to right, up to down. It starts on 0 and ends on 41.
25517 * @deprecated use elm_calendar_mark_add() instead like:
25520 * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25521 * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25524 * @see elm_calendar_mark_add()
25526 * @ingroup Calendar
25528 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25531 * Set a day text color to the same that represents Weekdays.
25533 * @param obj The calendar object
25534 * @param pos The text position. Position is the cell counter, from left
25535 * to right, up to down. It starts on 0 and ends on 41.
25537 * @deprecated use elm_calendar_mark_add() instead like:
25540 * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25542 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25543 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25544 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25545 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25546 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25547 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25548 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25549 * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25550 * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25553 * @see elm_calendar_mark_add()
25555 * @ingroup Calendar
25557 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25560 * Set the interval on time updates for an user mouse button hold
25561 * on calendar widgets' month selection.
25563 * @param obj The calendar object
25564 * @param interval The (first) interval value in seconds
25566 * This interval value is @b decreased while the user holds the
25567 * mouse pointer either selecting next or previous month.
25569 * This helps the user to get to a given month distant from the
25570 * current one easier/faster, as it will start to change quicker and
25571 * quicker on mouse button holds.
25573 * The calculation for the next change interval value, starting from
25574 * the one set with this call, is the previous interval divided by
25575 * 1.05, so it decreases a little bit.
25577 * The default starting interval value for automatic changes is
25580 * @see elm_calendar_interval_get()
25582 * @ingroup Calendar
25584 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25587 * Get the interval on time updates for an user mouse button hold
25588 * on calendar widgets' month selection.
25590 * @param obj The calendar object
25591 * @return The (first) interval value, in seconds, set on it
25593 * @see elm_calendar_interval_set() for more details
25595 * @ingroup Calendar
25597 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25604 * @defgroup Diskselector Diskselector
25605 * @ingroup Elementary
25607 * @image html img/widget/diskselector/preview-00.png
25608 * @image latex img/widget/diskselector/preview-00.eps
25610 * A diskselector is a kind of list widget. It scrolls horizontally,
25611 * and can contain label and icon objects. Three items are displayed
25612 * with the selected one in the middle.
25614 * It can act like a circular list with round mode and labels can be
25615 * reduced for a defined length for side items.
25617 * Smart callbacks one can listen to:
25618 * - "selected" - when item is selected, i.e. scroller stops.
25620 * Available styles for it:
25623 * List of examples:
25624 * @li @ref diskselector_example_01
25625 * @li @ref diskselector_example_02
25629 * @addtogroup Diskselector
25633 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(). */
25636 * Add a new diskselector widget to the given parent Elementary
25637 * (container) object.
25639 * @param parent The parent object.
25640 * @return a new diskselector widget handle or @c NULL, on errors.
25642 * This function inserts a new diskselector widget on the canvas.
25644 * @ingroup Diskselector
25646 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25649 * Enable or disable round mode.
25651 * @param obj The diskselector object.
25652 * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25655 * Disabled by default. If round mode is enabled the items list will
25656 * work like a circle list, so when the user reaches the last item,
25657 * the first one will popup.
25659 * @see elm_diskselector_round_get()
25661 * @ingroup Diskselector
25663 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25666 * Get a value whether round mode is enabled or not.
25668 * @see elm_diskselector_round_set() for details.
25670 * @param obj The diskselector object.
25671 * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25672 * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25674 * @ingroup Diskselector
25676 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25679 * Get the side labels max length.
25681 * @deprecated use elm_diskselector_side_label_length_get() instead:
25683 * @param obj The diskselector object.
25684 * @return The max length defined for side labels, or 0 if not a valid
25687 * @ingroup Diskselector
25689 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25692 * Set the side labels max length.
25694 * @deprecated use elm_diskselector_side_label_length_set() instead:
25696 * @param obj The diskselector object.
25697 * @param len The max length defined for side labels.
25699 * @ingroup Diskselector
25701 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25704 * Get the side labels max length.
25706 * @see elm_diskselector_side_label_length_set() for details.
25708 * @param obj The diskselector object.
25709 * @return The max length defined for side labels, or 0 if not a valid
25712 * @ingroup Diskselector
25714 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25717 * Set the side labels max length.
25719 * @param obj The diskselector object.
25720 * @param len The max length defined for side labels.
25722 * Length is the number of characters of items' label that will be
25723 * visible when it's set on side positions. It will just crop
25724 * the string after defined size. E.g.:
25726 * An item with label "January" would be displayed on side position as
25727 * "Jan" if max length is set to 3, or "Janu", if this property
25730 * When it's selected, the entire label will be displayed, except for
25731 * width restrictions. In this case label will be cropped and "..."
25732 * will be concatenated.
25734 * Default side label max length is 3.
25736 * This property will be applyed over all items, included before or
25737 * later this function call.
25739 * @ingroup Diskselector
25741 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25744 * Set the number of items to be displayed.
25746 * @param obj The diskselector object.
25747 * @param num The number of items the diskselector will display.
25749 * Default value is 3, and also it's the minimun. If @p num is less
25750 * than 3, it will be set to 3.
25752 * Also, it can be set on theme, using data item @c display_item_num
25753 * on group "elm/diskselector/item/X", where X is style set.
25756 * group { name: "elm/diskselector/item/X";
25758 * item: "display_item_num" "5";
25761 * @ingroup Diskselector
25763 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25766 * Get the number of items in the diskselector object.
25768 * @param obj The diskselector object.
25770 * @ingroup Diskselector
25772 EAPI int elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25775 * Set bouncing behaviour when the scrolled content reaches an edge.
25777 * Tell the internal scroller object whether it should bounce or not
25778 * when it reaches the respective edges for each axis.
25780 * @param obj The diskselector object.
25781 * @param h_bounce Whether to bounce or not in the horizontal axis.
25782 * @param v_bounce Whether to bounce or not in the vertical axis.
25784 * @see elm_scroller_bounce_set()
25786 * @ingroup Diskselector
25788 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25791 * Get the bouncing behaviour of the internal scroller.
25793 * Get whether the internal scroller should bounce when the edge of each
25794 * axis is reached scrolling.
25796 * @param obj The diskselector object.
25797 * @param h_bounce Pointer where to store the bounce state of the horizontal
25799 * @param v_bounce Pointer where to store the bounce state of the vertical
25802 * @see elm_scroller_bounce_get()
25803 * @see elm_diskselector_bounce_set()
25805 * @ingroup Diskselector
25807 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25810 * Get the scrollbar policy.
25812 * @see elm_diskselector_scroller_policy_get() for details.
25814 * @param obj The diskselector object.
25815 * @param policy_h Pointer where to store horizontal scrollbar policy.
25816 * @param policy_v Pointer where to store vertical scrollbar policy.
25818 * @ingroup Diskselector
25820 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);
25823 * Set the scrollbar policy.
25825 * @param obj The diskselector object.
25826 * @param policy_h Horizontal scrollbar policy.
25827 * @param policy_v Vertical scrollbar policy.
25829 * This sets the scrollbar visibility policy for the given scroller.
25830 * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25831 * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25832 * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25833 * This applies respectively for the horizontal and vertical scrollbars.
25835 * The both are disabled by default, i.e., are set to
25836 * #ELM_SCROLLER_POLICY_OFF.
25838 * @ingroup Diskselector
25840 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
25843 * Remove all diskselector's items.
25845 * @param obj The diskselector object.
25847 * @see elm_diskselector_item_del()
25848 * @see elm_diskselector_item_append()
25850 * @ingroup Diskselector
25852 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25855 * Get a list of all the diskselector items.
25857 * @param obj The diskselector object.
25858 * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
25859 * or @c NULL on failure.
25861 * @see elm_diskselector_item_append()
25862 * @see elm_diskselector_item_del()
25863 * @see elm_diskselector_clear()
25865 * @ingroup Diskselector
25867 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25870 * Appends a new item to the diskselector object.
25872 * @param obj The diskselector object.
25873 * @param label The label of the diskselector item.
25874 * @param icon The icon object to use at left side of the item. An
25875 * icon can be any Evas object, but usually it is an icon created
25876 * with elm_icon_add().
25877 * @param func The function to call when the item is selected.
25878 * @param data The data to associate with the item for related callbacks.
25880 * @return The created item or @c NULL upon failure.
25882 * A new item will be created and appended to the diskselector, i.e., will
25883 * be set as last item. Also, if there is no selected item, it will
25884 * be selected. This will always happens for the first appended item.
25886 * If no icon is set, label will be centered on item position, otherwise
25887 * the icon will be placed at left of the label, that will be shifted
25890 * Items created with this method can be deleted with
25891 * elm_diskselector_item_del().
25893 * Associated @p data can be properly freed when item is deleted if a
25894 * callback function is set with elm_diskselector_item_del_cb_set().
25896 * If a function is passed as argument, it will be called everytime this item
25897 * is selected, i.e., the user stops the diskselector with this
25898 * item on center position. If such function isn't needed, just passing
25899 * @c NULL as @p func is enough. The same should be done for @p data.
25901 * Simple example (with no function callback or data associated):
25903 * disk = elm_diskselector_add(win);
25904 * ic = elm_icon_add(win);
25905 * elm_icon_file_set(ic, "path/to/image", NULL);
25906 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25907 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
25910 * @see elm_diskselector_item_del()
25911 * @see elm_diskselector_item_del_cb_set()
25912 * @see elm_diskselector_clear()
25913 * @see elm_icon_add()
25915 * @ingroup Diskselector
25917 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);
25921 * Delete them item from the diskselector.
25923 * @param it The item of diskselector to be deleted.
25925 * If deleting all diskselector items is required, elm_diskselector_clear()
25926 * should be used instead of getting items list and deleting each one.
25928 * @see elm_diskselector_clear()
25929 * @see elm_diskselector_item_append()
25930 * @see elm_diskselector_item_del_cb_set()
25932 * @ingroup Diskselector
25934 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25937 * Set the function called when a diskselector item is freed.
25939 * @param it The item to set the callback on
25940 * @param func The function called
25942 * If there is a @p func, then it will be called prior item's memory release.
25943 * That will be called with the following arguments:
25945 * @li item's Evas object;
25948 * This way, a data associated to a diskselector item could be properly
25951 * @ingroup Diskselector
25953 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
25956 * Get the data associated to the item.
25958 * @param it The diskselector item
25959 * @return The data associated to @p it
25961 * The return value is a pointer to data associated to @p item when it was
25962 * created, with function elm_diskselector_item_append(). If no data
25963 * was passed as argument, it will return @c NULL.
25965 * @see elm_diskselector_item_append()
25967 * @ingroup Diskselector
25969 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25972 * Set the icon associated to the item.
25974 * @param it The diskselector item
25975 * @param icon The icon object to associate with @p it
25977 * The icon object to use at left side of the item. An
25978 * icon can be any Evas object, but usually it is an icon created
25979 * with elm_icon_add().
25981 * Once the icon object is set, a previously set one will be deleted.
25982 * @warning Setting the same icon for two items will cause the icon to
25983 * dissapear from the first item.
25985 * If an icon was passed as argument on item creation, with function
25986 * elm_diskselector_item_append(), it will be already
25987 * associated to the item.
25989 * @see elm_diskselector_item_append()
25990 * @see elm_diskselector_item_icon_get()
25992 * @ingroup Diskselector
25994 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
25997 * Get the icon associated to the item.
25999 * @param it The diskselector item
26000 * @return The icon associated to @p it
26002 * The return value is a pointer to the icon associated to @p item when it was
26003 * created, with function elm_diskselector_item_append(), or later
26004 * with function elm_diskselector_item_icon_set. If no icon
26005 * was passed as argument, it will return @c NULL.
26007 * @see elm_diskselector_item_append()
26008 * @see elm_diskselector_item_icon_set()
26010 * @ingroup Diskselector
26012 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26015 * Set the label of item.
26017 * @param it The item of diskselector.
26018 * @param label The label of item.
26020 * The label to be displayed by the item.
26022 * If no icon is set, label will be centered on item position, otherwise
26023 * the icon will be placed at left of the label, that will be shifted
26026 * An item with label "January" would be displayed on side position as
26027 * "Jan" if max length is set to 3 with function
26028 * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26031 * When this @p item is selected, the entire label will be displayed,
26032 * except for width restrictions.
26033 * In this case label will be cropped and "..." will be concatenated,
26034 * but only for display purposes. It will keep the entire string, so
26035 * if diskselector is resized the remaining characters will be displayed.
26037 * If a label was passed as argument on item creation, with function
26038 * elm_diskselector_item_append(), it will be already
26039 * displayed by the item.
26041 * @see elm_diskselector_side_label_lenght_set()
26042 * @see elm_diskselector_item_label_get()
26043 * @see elm_diskselector_item_append()
26045 * @ingroup Diskselector
26047 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26050 * Get the label of item.
26052 * @param it The item of diskselector.
26053 * @return The label of item.
26055 * The return value is a pointer to the label associated to @p item when it was
26056 * created, with function elm_diskselector_item_append(), or later
26057 * with function elm_diskselector_item_label_set. If no label
26058 * was passed as argument, it will return @c NULL.
26060 * @see elm_diskselector_item_label_set() for more details.
26061 * @see elm_diskselector_item_append()
26063 * @ingroup Diskselector
26065 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26068 * Get the selected item.
26070 * @param obj The diskselector object.
26071 * @return The selected diskselector item.
26073 * The selected item can be unselected with function
26074 * elm_diskselector_item_selected_set(), and the first item of
26075 * diskselector will be selected.
26077 * The selected item always will be centered on diskselector, with
26078 * full label displayed, i.e., max lenght set to side labels won't
26079 * apply on the selected item. More details on
26080 * elm_diskselector_side_label_length_set().
26082 * @ingroup Diskselector
26084 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26087 * Set the selected state of an item.
26089 * @param it The diskselector item
26090 * @param selected The selected state
26092 * This sets the selected state of the given item @p it.
26093 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26095 * If a new item is selected the previosly selected will be unselected.
26096 * Previoulsy selected item can be get with function
26097 * elm_diskselector_selected_item_get().
26099 * If the item @p it is unselected, the first item of diskselector will
26102 * Selected items will be visible on center position of diskselector.
26103 * So if it was on another position before selected, or was invisible,
26104 * diskselector will animate items until the selected item reaches center
26107 * @see elm_diskselector_item_selected_get()
26108 * @see elm_diskselector_selected_item_get()
26110 * @ingroup Diskselector
26112 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26115 * Get whether the @p item is selected or not.
26117 * @param it The diskselector item.
26118 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26119 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26121 * @see elm_diskselector_selected_item_set() for details.
26122 * @see elm_diskselector_item_selected_get()
26124 * @ingroup Diskselector
26126 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26129 * Get the first item of the diskselector.
26131 * @param obj The diskselector object.
26132 * @return The first item, or @c NULL if none.
26134 * The list of items follows append order. So it will return the first
26135 * item appended to the widget that wasn't deleted.
26137 * @see elm_diskselector_item_append()
26138 * @see elm_diskselector_items_get()
26140 * @ingroup Diskselector
26142 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26145 * Get the last item of the diskselector.
26147 * @param obj The diskselector object.
26148 * @return The last item, or @c NULL if none.
26150 * The list of items follows append order. So it will return last first
26151 * item appended to the widget that wasn't deleted.
26153 * @see elm_diskselector_item_append()
26154 * @see elm_diskselector_items_get()
26156 * @ingroup Diskselector
26158 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26161 * Get the item before @p item in diskselector.
26163 * @param it The diskselector item.
26164 * @return The item before @p item, or @c NULL if none or on failure.
26166 * The list of items follows append order. So it will return item appended
26167 * just before @p item and that wasn't deleted.
26169 * If it is the first item, @c NULL will be returned.
26170 * First item can be get by elm_diskselector_first_item_get().
26172 * @see elm_diskselector_item_append()
26173 * @see elm_diskselector_items_get()
26175 * @ingroup Diskselector
26177 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26180 * Get the item after @p item in diskselector.
26182 * @param it The diskselector item.
26183 * @return The item after @p item, or @c NULL if none or on failure.
26185 * The list of items follows append order. So it will return item appended
26186 * just after @p item and that wasn't deleted.
26188 * If it is the last item, @c NULL will be returned.
26189 * Last item can be get by elm_diskselector_last_item_get().
26191 * @see elm_diskselector_item_append()
26192 * @see elm_diskselector_items_get()
26194 * @ingroup Diskselector
26196 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26199 * Set the text to be shown in the diskselector item.
26201 * @param item Target item
26202 * @param text The text to set in the content
26204 * Setup the text as tooltip to object. The item can have only one tooltip,
26205 * so any previous tooltip data is removed.
26207 * @see elm_object_tooltip_text_set() for more details.
26209 * @ingroup Diskselector
26211 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26214 * Set the content to be shown in the tooltip item.
26216 * Setup the tooltip to item. The item can have only one tooltip,
26217 * so any previous tooltip data is removed. @p func(with @p data) will
26218 * be called every time that need show the tooltip and it should
26219 * return a valid Evas_Object. This object is then managed fully by
26220 * tooltip system and is deleted when the tooltip is gone.
26222 * @param item the diskselector item being attached a tooltip.
26223 * @param func the function used to create the tooltip contents.
26224 * @param data what to provide to @a func as callback data/context.
26225 * @param del_cb called when data is not needed anymore, either when
26226 * another callback replaces @p func, the tooltip is unset with
26227 * elm_diskselector_item_tooltip_unset() or the owner @a item
26228 * dies. This callback receives as the first parameter the
26229 * given @a data, and @c event_info is the item.
26231 * @see elm_object_tooltip_content_cb_set() for more details.
26233 * @ingroup Diskselector
26235 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);
26238 * Unset tooltip from item.
26240 * @param item diskselector item to remove previously set tooltip.
26242 * Remove tooltip from item. The callback provided as del_cb to
26243 * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26244 * it is not used anymore.
26246 * @see elm_object_tooltip_unset() for more details.
26247 * @see elm_diskselector_item_tooltip_content_cb_set()
26249 * @ingroup Diskselector
26251 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26255 * Sets a different style for this item tooltip.
26257 * @note before you set a style you should define a tooltip with
26258 * elm_diskselector_item_tooltip_content_cb_set() or
26259 * elm_diskselector_item_tooltip_text_set()
26261 * @param item diskselector item with tooltip already set.
26262 * @param style the theme style to use (default, transparent, ...)
26264 * @see elm_object_tooltip_style_set() for more details.
26266 * @ingroup Diskselector
26268 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26271 * Get the style for this item tooltip.
26273 * @param item diskselector item with tooltip already set.
26274 * @return style the theme style in use, defaults to "default". If the
26275 * object does not have a tooltip set, then NULL is returned.
26277 * @see elm_object_tooltip_style_get() for more details.
26278 * @see elm_diskselector_item_tooltip_style_set()
26280 * @ingroup Diskselector
26282 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26285 * Set the cursor to be shown when mouse is over the diskselector item
26287 * @param item Target item
26288 * @param cursor the cursor name to be used.
26290 * @see elm_object_cursor_set() for more details.
26292 * @ingroup Diskselector
26294 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26297 * Get the cursor to be shown when mouse is over the diskselector item
26299 * @param item diskselector item with cursor already set.
26300 * @return the cursor name.
26302 * @see elm_object_cursor_get() for more details.
26303 * @see elm_diskselector_cursor_set()
26305 * @ingroup Diskselector
26307 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26311 * Unset the cursor to be shown when mouse is over the diskselector item
26313 * @param item Target item
26315 * @see elm_object_cursor_unset() for more details.
26316 * @see elm_diskselector_cursor_set()
26318 * @ingroup Diskselector
26320 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26323 * Sets a different style for this item cursor.
26325 * @note before you set a style you should define a cursor with
26326 * elm_diskselector_item_cursor_set()
26328 * @param item diskselector item with cursor already set.
26329 * @param style the theme style to use (default, transparent, ...)
26331 * @see elm_object_cursor_style_set() for more details.
26333 * @ingroup Diskselector
26335 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26339 * Get the style for this item cursor.
26341 * @param item diskselector item with cursor already set.
26342 * @return style the theme style in use, defaults to "default". If the
26343 * object does not have a cursor set, then @c NULL is returned.
26345 * @see elm_object_cursor_style_get() for more details.
26346 * @see elm_diskselector_item_cursor_style_set()
26348 * @ingroup Diskselector
26350 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26354 * Set if the cursor set should be searched on the theme or should use
26355 * the provided by the engine, only.
26357 * @note before you set if should look on theme you should define a cursor
26358 * with elm_diskselector_item_cursor_set().
26359 * By default it will only look for cursors provided by the engine.
26361 * @param item widget item with cursor already set.
26362 * @param engine_only boolean to define if cursors set with
26363 * elm_diskselector_item_cursor_set() should be searched only
26364 * between cursors provided by the engine or searched on widget's
26367 * @see elm_object_cursor_engine_only_set() for more details.
26369 * @ingroup Diskselector
26371 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26374 * Get the cursor engine only usage for this item cursor.
26376 * @param item widget item with cursor already set.
26377 * @return engine_only boolean to define it cursors should be looked only
26378 * between the provided by the engine or searched on widget's theme as well.
26379 * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26381 * @see elm_object_cursor_engine_only_get() for more details.
26382 * @see elm_diskselector_item_cursor_engine_only_set()
26384 * @ingroup Diskselector
26386 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26393 * @defgroup Colorselector Colorselector
26397 * @image html img/widget/colorselector/preview-00.png
26398 * @image latex img/widget/colorselector/preview-00.eps
26400 * @brief Widget for user to select a color.
26402 * Signals that you can add callbacks for are:
26403 * "changed" - When the color value changes(event_info is NULL).
26405 * See @ref tutorial_colorselector.
26408 * @brief Add a new colorselector to the parent
26410 * @param parent The parent object
26411 * @return The new object or NULL if it cannot be created
26413 * @ingroup Colorselector
26415 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26417 * Set a color for the colorselector
26419 * @param obj Colorselector object
26420 * @param r r-value of color
26421 * @param g g-value of color
26422 * @param b b-value of color
26423 * @param a a-value of color
26425 * @ingroup Colorselector
26427 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26429 * Get a color from the colorselector
26431 * @param obj Colorselector object
26432 * @param r integer pointer for r-value of color
26433 * @param g integer pointer for g-value of color
26434 * @param b integer pointer for b-value of color
26435 * @param a integer pointer for a-value of color
26437 * @ingroup Colorselector
26439 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26445 * @defgroup Ctxpopup Ctxpopup
26447 * @image html img/widget/ctxpopup/preview-00.png
26448 * @image latex img/widget/ctxpopup/preview-00.eps
26450 * @brief Context popup widet.
26452 * A ctxpopup is a widget that, when shown, pops up a list of items.
26453 * It automatically chooses an area inside its parent object's view
26454 * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26455 * optimally fit into it. In the default theme, it will also point an
26456 * arrow to it's top left position at the time one shows it. Ctxpopup
26457 * items have a label and/or an icon. It is intended for a small
26458 * number of items (hence the use of list, not genlist).
26460 * @note Ctxpopup is a especialization of @ref Hover.
26462 * Signals that you can add callbacks for are:
26463 * "dismissed" - the ctxpopup was dismissed
26465 * Default contents parts of the ctxpopup widget that you can use for are:
26466 * @li "elm.swallow.content" - A content of the ctxpopup
26468 * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26471 typedef enum _Elm_Ctxpopup_Direction
26473 ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26475 ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26476 the clicked area */
26477 ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26478 the clicked area */
26479 ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26481 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26482 } Elm_Ctxpopup_Direction;
26485 * @brief Add a new Ctxpopup object to the parent.
26487 * @param parent Parent object
26488 * @return New object or @c NULL, if it cannot be created
26490 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26492 * @brief Set the Ctxpopup's parent
26494 * @param obj The ctxpopup object
26495 * @param area The parent to use
26497 * Set the parent object.
26499 * @note elm_ctxpopup_add() will automatically call this function
26500 * with its @c parent argument.
26502 * @see elm_ctxpopup_add()
26503 * @see elm_hover_parent_set()
26505 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26507 * @brief Get the Ctxpopup's parent
26509 * @param obj The ctxpopup object
26511 * @see elm_ctxpopup_hover_parent_set() for more information
26513 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26515 * @brief Clear all items in the given ctxpopup object.
26517 * @param obj Ctxpopup object
26519 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26521 * @brief Change the ctxpopup's orientation to horizontal or vertical.
26523 * @param obj Ctxpopup object
26524 * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26526 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26528 * @brief Get the value of current ctxpopup object's orientation.
26530 * @param obj Ctxpopup object
26531 * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26533 * @see elm_ctxpopup_horizontal_set()
26535 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26537 * @brief Add a new item to a ctxpopup object.
26539 * @param obj Ctxpopup object
26540 * @param icon Icon to be set on new item
26541 * @param label The Label of the new item
26542 * @param func Convenience function called when item selected
26543 * @param data Data passed to @p func
26544 * @return A handle to the item added or @c NULL, on errors
26546 * @warning Ctxpopup can't hold both an item list and a content at the same
26547 * time. When an item is added, any previous content will be removed.
26549 * @see elm_ctxpopup_content_set()
26551 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);
26553 * @brief Delete the given item in a ctxpopup object.
26555 * @param it Ctxpopup item to be deleted
26557 * @see elm_ctxpopup_item_append()
26559 EAPI void elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26561 * @brief Set the ctxpopup item's state as disabled or enabled.
26563 * @param it Ctxpopup item to be enabled/disabled
26564 * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26566 * When disabled the item is greyed out to indicate it's state.
26568 EAPI void elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26570 * @brief Get the ctxpopup item's disabled/enabled state.
26572 * @param it Ctxpopup item to be enabled/disabled
26573 * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26575 * @see elm_ctxpopup_item_disabled_set()
26577 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26579 * @brief Get the icon object for the given ctxpopup item.
26581 * @param it Ctxpopup item
26582 * @return icon object or @c NULL, if the item does not have icon or an error
26585 * @see elm_ctxpopup_item_append()
26586 * @see elm_ctxpopup_item_icon_set()
26588 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26590 * @brief Sets the side icon associated with the ctxpopup item
26592 * @param it Ctxpopup item
26593 * @param icon Icon object to be set
26595 * Once the icon object is set, a previously set one will be deleted.
26596 * @warning Setting the same icon for two items will cause the icon to
26597 * dissapear from the first item.
26599 * @see elm_ctxpopup_item_append()
26601 EAPI void elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26603 * @brief Get the label for the given ctxpopup item.
26605 * @param it Ctxpopup item
26606 * @return label string or @c NULL, if the item does not have label or an
26609 * @see elm_ctxpopup_item_append()
26610 * @see elm_ctxpopup_item_label_set()
26612 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26614 * @brief (Re)set the label on the given ctxpopup item.
26616 * @param it Ctxpopup item
26617 * @param label String to set as label
26619 EAPI void elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26621 * @brief Set an elm widget as the content of the ctxpopup.
26623 * @param obj Ctxpopup object
26624 * @param content Content to be swallowed
26626 * If the content object is already set, a previous one will bedeleted. If
26627 * you want to keep that old content object, use the
26628 * elm_ctxpopup_content_unset() function.
26630 * @deprecated use elm_object_content_set()
26632 * @warning Ctxpopup can't hold both a item list and a content at the same
26633 * time. When a content is set, any previous items will be removed.
26635 EINA_DEPRECATED EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26637 * @brief Unset the ctxpopup content
26639 * @param obj Ctxpopup object
26640 * @return The content that was being used
26642 * Unparent and return the content object which was set for this widget.
26644 * @deprecated use elm_object_content_unset()
26646 * @see elm_ctxpopup_content_set()
26648 EINA_DEPRECATED EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26650 * @brief Set the direction priority of a ctxpopup.
26652 * @param obj Ctxpopup object
26653 * @param first 1st priority of direction
26654 * @param second 2nd priority of direction
26655 * @param third 3th priority of direction
26656 * @param fourth 4th priority of direction
26658 * This functions gives a chance to user to set the priority of ctxpopup
26659 * showing direction. This doesn't guarantee the ctxpopup will appear in the
26660 * requested direction.
26662 * @see Elm_Ctxpopup_Direction
26664 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);
26666 * @brief Get the direction priority of a ctxpopup.
26668 * @param obj Ctxpopup object
26669 * @param first 1st priority of direction to be returned
26670 * @param second 2nd priority of direction to be returned
26671 * @param third 3th priority of direction to be returned
26672 * @param fourth 4th priority of direction to be returned
26674 * @see elm_ctxpopup_direction_priority_set() for more information.
26676 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);
26679 * @brief Get the current direction of a ctxpopup.
26681 * @param obj Ctxpopup object
26682 * @return current direction of a ctxpopup
26684 * @warning Once the ctxpopup showed up, the direction would be determined
26686 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26695 * @defgroup Transit Transit
26696 * @ingroup Elementary
26698 * Transit is designed to apply various animated transition effects to @c
26699 * Evas_Object, such like translation, rotation, etc. For using these
26700 * effects, create an @ref Elm_Transit and add the desired transition effects.
26702 * Once the effects are added into transit, they will be automatically
26703 * managed (their callback will be called until the duration is ended, and
26704 * they will be deleted on completion).
26708 * Elm_Transit *trans = elm_transit_add();
26709 * elm_transit_object_add(trans, obj);
26710 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26711 * elm_transit_duration_set(transit, 1);
26712 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26713 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26714 * elm_transit_repeat_times_set(transit, 3);
26717 * Some transition effects are used to change the properties of objects. They
26719 * @li @ref elm_transit_effect_translation_add
26720 * @li @ref elm_transit_effect_color_add
26721 * @li @ref elm_transit_effect_rotation_add
26722 * @li @ref elm_transit_effect_wipe_add
26723 * @li @ref elm_transit_effect_zoom_add
26724 * @li @ref elm_transit_effect_resizing_add
26726 * Other transition effects are used to make one object disappear and another
26727 * object appear on its old place. These effects are:
26729 * @li @ref elm_transit_effect_flip_add
26730 * @li @ref elm_transit_effect_resizable_flip_add
26731 * @li @ref elm_transit_effect_fade_add
26732 * @li @ref elm_transit_effect_blend_add
26734 * It's also possible to make a transition chain with @ref
26735 * elm_transit_chain_transit_add.
26737 * @warning We strongly recommend to use elm_transit just when edje can not do
26738 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26739 * animations can be manipulated inside the theme.
26741 * List of examples:
26742 * @li @ref transit_example_01_explained
26743 * @li @ref transit_example_02_explained
26744 * @li @ref transit_example_03_c
26745 * @li @ref transit_example_04_c
26751 * @enum Elm_Transit_Tween_Mode
26753 * The type of acceleration used in the transition.
26757 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26758 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26759 over time, then decrease again
26761 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26763 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26765 } Elm_Transit_Tween_Mode;
26768 * @enum Elm_Transit_Effect_Flip_Axis
26770 * The axis where flip effect should be applied.
26774 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26775 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26776 } Elm_Transit_Effect_Flip_Axis;
26778 * @enum Elm_Transit_Effect_Wipe_Dir
26780 * The direction where the wipe effect should occur.
26784 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26785 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26786 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26787 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26788 } Elm_Transit_Effect_Wipe_Dir;
26789 /** @enum Elm_Transit_Effect_Wipe_Type
26791 * Whether the wipe effect should show or hide the object.
26795 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26797 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26799 } Elm_Transit_Effect_Wipe_Type;
26802 * @typedef Elm_Transit
26804 * The Transit created with elm_transit_add(). This type has the information
26805 * about the objects which the transition will be applied, and the
26806 * transition effects that will be used. It also contains info about
26807 * duration, number of repetitions, auto-reverse, etc.
26809 typedef struct _Elm_Transit Elm_Transit;
26810 typedef void Elm_Transit_Effect;
26812 * @typedef Elm_Transit_Effect_Transition_Cb
26814 * Transition callback called for this effect on each transition iteration.
26816 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26818 * Elm_Transit_Effect_End_Cb
26820 * Transition callback called for this effect when the transition is over.
26822 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26825 * Elm_Transit_Del_Cb
26827 * A callback called when the transit is deleted.
26829 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26834 * @note Is not necessary to delete the transit object, it will be deleted at
26835 * the end of its operation.
26836 * @note The transit will start playing when the program enter in the main loop, is not
26837 * necessary to give a start to the transit.
26839 * @return The transit object.
26843 EAPI Elm_Transit *elm_transit_add(void);
26846 * Stops the animation and delete the @p transit object.
26848 * Call this function if you wants to stop the animation before the duration
26849 * time. Make sure the @p transit object is still alive with
26850 * elm_transit_del_cb_set() function.
26851 * All added effects will be deleted, calling its repective data_free_cb
26852 * functions. The function setted by elm_transit_del_cb_set() will be called.
26854 * @see elm_transit_del_cb_set()
26856 * @param transit The transit object to be deleted.
26859 * @warning Just call this function if you are sure the transit is alive.
26861 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26864 * Add a new effect to the transit.
26866 * @note The cb function and the data are the key to the effect. If you try to
26867 * add an already added effect, nothing is done.
26868 * @note After the first addition of an effect in @p transit, if its
26869 * effect list become empty again, the @p transit will be killed by
26870 * elm_transit_del(transit) function.
26874 * Elm_Transit *transit = elm_transit_add();
26875 * elm_transit_effect_add(transit,
26876 * elm_transit_effect_blend_op,
26877 * elm_transit_effect_blend_context_new(),
26878 * elm_transit_effect_blend_context_free);
26881 * @param transit The transit object.
26882 * @param transition_cb The operation function. It is called when the
26883 * animation begins, it is the function that actually performs the animation.
26884 * It is called with the @p data, @p transit and the time progression of the
26885 * animation (a double value between 0.0 and 1.0).
26886 * @param effect The context data of the effect.
26887 * @param end_cb The function to free the context data, it will be called
26888 * at the end of the effect, it must finalize the animation and free the
26892 * @warning The transit free the context data at the and of the transition with
26893 * the data_free_cb function, do not use the context data in another transit.
26895 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);
26898 * Delete an added effect.
26900 * This function will remove the effect from the @p transit, calling the
26901 * data_free_cb to free the @p data.
26903 * @see elm_transit_effect_add()
26905 * @note If the effect is not found, nothing is done.
26906 * @note If the effect list become empty, this function will call
26907 * elm_transit_del(transit), that is, it will kill the @p transit.
26909 * @param transit The transit object.
26910 * @param transition_cb The operation function.
26911 * @param effect The context data of the effect.
26915 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);
26918 * Add new object to apply the effects.
26920 * @note After the first addition of an object in @p transit, if its
26921 * object list become empty again, the @p transit will be killed by
26922 * elm_transit_del(transit) function.
26923 * @note If the @p obj belongs to another transit, the @p obj will be
26924 * removed from it and it will only belong to the @p transit. If the old
26925 * transit stays without objects, it will die.
26926 * @note When you add an object into the @p transit, its state from
26927 * evas_object_pass_events_get(obj) is saved, and it is applied when the
26928 * transit ends, if you change this state whith evas_object_pass_events_set()
26929 * after add the object, this state will change again when @p transit stops to
26932 * @param transit The transit object.
26933 * @param obj Object to be animated.
26936 * @warning It is not allowed to add a new object after transit begins to go.
26938 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26941 * Removes an added object from the transit.
26943 * @note If the @p obj is not in the @p transit, nothing is done.
26944 * @note If the list become empty, this function will call
26945 * elm_transit_del(transit), that is, it will kill the @p transit.
26947 * @param transit The transit object.
26948 * @param obj Object to be removed from @p transit.
26951 * @warning It is not allowed to remove objects after transit begins to go.
26953 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26956 * Get the objects of the transit.
26958 * @param transit The transit object.
26959 * @return a Eina_List with the objects from the transit.
26963 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26966 * Enable/disable keeping up the objects states.
26967 * If it is not kept, the objects states will be reset when transition ends.
26969 * @note @p transit can not be NULL.
26970 * @note One state includes geometry, color, map data.
26972 * @param transit The transit object.
26973 * @param state_keep Keeping or Non Keeping.
26977 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
26980 * Get a value whether the objects states will be reset or not.
26982 * @note @p transit can not be NULL
26984 * @see elm_transit_objects_final_state_keep_set()
26986 * @param transit The transit object.
26987 * @return EINA_TRUE means the states of the objects will be reset.
26988 * If @p transit is NULL, EINA_FALSE is returned
26992 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26995 * Set the event enabled when transit is operating.
26997 * If @p enabled is EINA_TRUE, the objects of the transit will receives
26998 * events from mouse and keyboard during the animation.
26999 * @note When you add an object with elm_transit_object_add(), its state from
27000 * evas_object_pass_events_get(obj) is saved, and it is applied when the
27001 * transit ends, if you change this state with evas_object_pass_events_set()
27002 * after adding the object, this state will change again when @p transit stops
27005 * @param transit The transit object.
27006 * @param enabled Events are received when enabled is @c EINA_TRUE, and
27007 * ignored otherwise.
27011 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
27014 * Get the value of event enabled status.
27016 * @see elm_transit_event_enabled_set()
27018 * @param transit The Transit object
27019 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
27020 * EINA_FALSE is returned
27024 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27027 * Set the user-callback function when the transit is deleted.
27029 * @note Using this function twice will overwrite the first function setted.
27030 * @note the @p transit object will be deleted after call @p cb function.
27032 * @param transit The transit object.
27033 * @param cb Callback function pointer. This function will be called before
27034 * the deletion of the transit.
27035 * @param data Callback funtion user data. It is the @p op parameter.
27039 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27042 * Set reverse effect automatically.
27044 * If auto reverse is setted, after running the effects with the progress
27045 * parameter from 0 to 1, it will call the effecs again with the progress
27046 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27047 * where the duration was setted with the function elm_transit_add and
27048 * the repeat with the function elm_transit_repeat_times_set().
27050 * @param transit The transit object.
27051 * @param reverse EINA_TRUE means the auto_reverse is on.
27055 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27058 * Get if the auto reverse is on.
27060 * @see elm_transit_auto_reverse_set()
27062 * @param transit The transit object.
27063 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27064 * EINA_FALSE is returned
27068 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27071 * Set the transit repeat count. Effect will be repeated by repeat count.
27073 * This function sets the number of repetition the transit will run after
27074 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27075 * If the @p repeat is a negative number, it will repeat infinite times.
27077 * @note If this function is called during the transit execution, the transit
27078 * will run @p repeat times, ignoring the times it already performed.
27080 * @param transit The transit object
27081 * @param repeat Repeat count
27085 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27088 * Get the transit repeat count.
27090 * @see elm_transit_repeat_times_set()
27092 * @param transit The Transit object.
27093 * @return The repeat count. If @p transit is NULL
27098 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27101 * Set the transit animation acceleration type.
27103 * This function sets the tween mode of the transit that can be:
27104 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27105 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27106 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27107 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27109 * @param transit The transit object.
27110 * @param tween_mode The tween type.
27114 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27117 * Get the transit animation acceleration type.
27119 * @note @p transit can not be NULL
27121 * @param transit The transit object.
27122 * @return The tween type. If @p transit is NULL
27123 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27127 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27130 * Set the transit animation time
27132 * @note @p transit can not be NULL
27134 * @param transit The transit object.
27135 * @param duration The animation time.
27139 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27142 * Get the transit animation time
27144 * @note @p transit can not be NULL
27146 * @param transit The transit object.
27148 * @return The transit animation time.
27152 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27155 * Starts the transition.
27156 * Once this API is called, the transit begins to measure the time.
27158 * @note @p transit can not be NULL
27160 * @param transit The transit object.
27164 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27167 * Pause/Resume the transition.
27169 * If you call elm_transit_go again, the transit will be started from the
27170 * beginning, and will be unpaused.
27172 * @note @p transit can not be NULL
27174 * @param transit The transit object.
27175 * @param paused Whether the transition should be paused or not.
27179 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27182 * Get the value of paused status.
27184 * @see elm_transit_paused_set()
27186 * @note @p transit can not be NULL
27188 * @param transit The transit object.
27189 * @return EINA_TRUE means transition is paused. If @p transit is NULL
27190 * EINA_FALSE is returned
27194 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27197 * Get the time progression of the animation (a double value between 0.0 and 1.0).
27199 * The value returned is a fraction (current time / total time). It
27200 * represents the progression position relative to the total.
27202 * @note @p transit can not be NULL
27204 * @param transit The transit object.
27206 * @return The time progression value. If @p transit is NULL
27211 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27214 * Makes the chain relationship between two transits.
27216 * @note @p transit can not be NULL. Transit would have multiple chain transits.
27217 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27219 * @param transit The transit object.
27220 * @param chain_transit The chain transit object. This transit will be operated
27221 * after transit is done.
27223 * This function adds @p chain_transit transition to a chain after the @p
27224 * transit, and will be started as soon as @p transit ends. See @ref
27225 * transit_example_02_explained for a full example.
27229 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27232 * Cut off the chain relationship between two transits.
27234 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27235 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27237 * @param transit The transit object.
27238 * @param chain_transit The chain transit object.
27240 * This function remove the @p chain_transit transition from the @p transit.
27244 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27247 * Get the current chain transit list.
27249 * @note @p transit can not be NULL.
27251 * @param transit The transit object.
27252 * @return chain transit list.
27256 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
27259 * Add the Resizing Effect to Elm_Transit.
27261 * @note This API is one of the facades. It creates resizing effect context
27262 * and add it's required APIs to elm_transit_effect_add.
27264 * @see elm_transit_effect_add()
27266 * @param transit Transit object.
27267 * @param from_w Object width size when effect begins.
27268 * @param from_h Object height size when effect begins.
27269 * @param to_w Object width size when effect ends.
27270 * @param to_h Object height size when effect ends.
27271 * @return Resizing effect context data.
27275 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);
27278 * Add the Translation Effect to Elm_Transit.
27280 * @note This API is one of the facades. It creates translation effect context
27281 * and add it's required APIs to elm_transit_effect_add.
27283 * @see elm_transit_effect_add()
27285 * @param transit Transit object.
27286 * @param from_dx X Position variation when effect begins.
27287 * @param from_dy Y Position variation when effect begins.
27288 * @param to_dx X Position variation when effect ends.
27289 * @param to_dy Y Position variation when effect ends.
27290 * @return Translation effect context data.
27293 * @warning It is highly recommended just create a transit with this effect when
27294 * the window that the objects of the transit belongs has already been created.
27295 * This is because this effect needs the geometry information about the objects,
27296 * and if the window was not created yet, it can get a wrong information.
27298 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);
27301 * Add the Zoom Effect to Elm_Transit.
27303 * @note This API is one of the facades. It creates zoom effect context
27304 * and add it's required APIs to elm_transit_effect_add.
27306 * @see elm_transit_effect_add()
27308 * @param transit Transit object.
27309 * @param from_rate Scale rate when effect begins (1 is current rate).
27310 * @param to_rate Scale rate when effect ends.
27311 * @return Zoom effect context data.
27314 * @warning It is highly recommended just create a transit with this effect when
27315 * the window that the objects of the transit belongs has already been created.
27316 * This is because this effect needs the geometry information about the objects,
27317 * and if the window was not created yet, it can get a wrong information.
27319 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27322 * Add the Flip Effect to Elm_Transit.
27324 * @note This API is one of the facades. It creates flip effect context
27325 * and add it's required APIs to elm_transit_effect_add.
27326 * @note This effect is applied to each pair of objects in the order they are listed
27327 * in the transit list of objects. The first object in the pair will be the
27328 * "front" object and the second will be the "back" object.
27330 * @see elm_transit_effect_add()
27332 * @param transit Transit object.
27333 * @param axis Flipping Axis(X or Y).
27334 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27335 * @return Flip effect context data.
27338 * @warning It is highly recommended just create a transit with this effect when
27339 * the window that the objects of the transit belongs has already been created.
27340 * This is because this effect needs the geometry information about the objects,
27341 * and if the window was not created yet, it can get a wrong information.
27343 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27346 * Add the Resizable Flip Effect to Elm_Transit.
27348 * @note This API is one of the facades. It creates resizable flip effect context
27349 * and add it's required APIs to elm_transit_effect_add.
27350 * @note This effect is applied to each pair of objects in the order they are listed
27351 * in the transit list of objects. The first object in the pair will be the
27352 * "front" object and the second will be the "back" object.
27354 * @see elm_transit_effect_add()
27356 * @param transit Transit object.
27357 * @param axis Flipping Axis(X or Y).
27358 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27359 * @return Resizable flip effect context data.
27362 * @warning It is highly recommended just create a transit with this effect when
27363 * the window that the objects of the transit belongs has already been created.
27364 * This is because this effect needs the geometry information about the objects,
27365 * and if the window was not created yet, it can get a wrong information.
27367 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27370 * Add the Wipe Effect to Elm_Transit.
27372 * @note This API is one of the facades. It creates wipe effect context
27373 * and add it's required APIs to elm_transit_effect_add.
27375 * @see elm_transit_effect_add()
27377 * @param transit Transit object.
27378 * @param type Wipe type. Hide or show.
27379 * @param dir Wipe Direction.
27380 * @return Wipe effect context data.
27383 * @warning It is highly recommended just create a transit with this effect when
27384 * the window that the objects of the transit belongs has already been created.
27385 * This is because this effect needs the geometry information about the objects,
27386 * and if the window was not created yet, it can get a wrong information.
27388 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27391 * Add the Color Effect to Elm_Transit.
27393 * @note This API is one of the facades. It creates color effect context
27394 * and add it's required APIs to elm_transit_effect_add.
27396 * @see elm_transit_effect_add()
27398 * @param transit Transit object.
27399 * @param from_r RGB R when effect begins.
27400 * @param from_g RGB G when effect begins.
27401 * @param from_b RGB B when effect begins.
27402 * @param from_a RGB A when effect begins.
27403 * @param to_r RGB R when effect ends.
27404 * @param to_g RGB G when effect ends.
27405 * @param to_b RGB B when effect ends.
27406 * @param to_a RGB A when effect ends.
27407 * @return Color effect context data.
27411 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);
27414 * Add the Fade Effect to Elm_Transit.
27416 * @note This API is one of the facades. It creates fade effect context
27417 * and add it's required APIs to elm_transit_effect_add.
27418 * @note This effect is applied to each pair of objects in the order they are listed
27419 * in the transit list of objects. The first object in the pair will be the
27420 * "before" object and the second will be the "after" object.
27422 * @see elm_transit_effect_add()
27424 * @param transit Transit object.
27425 * @return Fade effect context data.
27428 * @warning It is highly recommended just create a transit with this effect when
27429 * the window that the objects of the transit belongs has already been created.
27430 * This is because this effect needs the color information about the objects,
27431 * and if the window was not created yet, it can get a wrong information.
27433 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27436 * Add the Blend Effect to Elm_Transit.
27438 * @note This API is one of the facades. It creates blend effect context
27439 * and add it's required APIs to elm_transit_effect_add.
27440 * @note This effect is applied to each pair of objects in the order they are listed
27441 * in the transit list of objects. The first object in the pair will be the
27442 * "before" object and the second will be the "after" object.
27444 * @see elm_transit_effect_add()
27446 * @param transit Transit object.
27447 * @return Blend effect context data.
27450 * @warning It is highly recommended just create a transit with this effect when
27451 * the window that the objects of the transit belongs has already been created.
27452 * This is because this effect needs the color information about the objects,
27453 * and if the window was not created yet, it can get a wrong information.
27455 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27458 * Add the Rotation Effect to Elm_Transit.
27460 * @note This API is one of the facades. It creates rotation effect context
27461 * and add it's required APIs to elm_transit_effect_add.
27463 * @see elm_transit_effect_add()
27465 * @param transit Transit object.
27466 * @param from_degree Degree when effect begins.
27467 * @param to_degree Degree when effect is ends.
27468 * @return Rotation effect context data.
27471 * @warning It is highly recommended just create a transit with this effect when
27472 * the window that the objects of the transit belongs has already been created.
27473 * This is because this effect needs the geometry information about the objects,
27474 * and if the window was not created yet, it can get a wrong information.
27476 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27479 * Add the ImageAnimation Effect to Elm_Transit.
27481 * @note This API is one of the facades. It creates image animation effect context
27482 * and add it's required APIs to elm_transit_effect_add.
27483 * The @p images parameter is a list images paths. This list and
27484 * its contents will be deleted at the end of the effect by
27485 * elm_transit_effect_image_animation_context_free() function.
27489 * char buf[PATH_MAX];
27490 * Eina_List *images = NULL;
27491 * Elm_Transit *transi = elm_transit_add();
27493 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27494 * images = eina_list_append(images, eina_stringshare_add(buf));
27496 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27497 * images = eina_list_append(images, eina_stringshare_add(buf));
27498 * elm_transit_effect_image_animation_add(transi, images);
27502 * @see elm_transit_effect_add()
27504 * @param transit Transit object.
27505 * @param images Eina_List of images file paths. This list and
27506 * its contents will be deleted at the end of the effect by
27507 * elm_transit_effect_image_animation_context_free() function.
27508 * @return Image Animation effect context data.
27512 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27517 typedef struct _Elm_Store Elm_Store;
27518 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
27519 typedef struct _Elm_Store_Item Elm_Store_Item;
27520 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
27521 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
27522 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27523 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
27524 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
27525 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
27526 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
27527 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
27529 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27530 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
27531 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
27532 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27536 ELM_STORE_ITEM_MAPPING_NONE = 0,
27537 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27538 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27539 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27540 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27541 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27542 // can add more here as needed by common apps
27543 ELM_STORE_ITEM_MAPPING_LAST
27544 } Elm_Store_Item_Mapping_Type;
27546 struct _Elm_Store_Item_Mapping_Icon
27548 // FIXME: allow edje file icons
27550 Elm_Icon_Lookup_Order lookup_order;
27551 Eina_Bool standard_name : 1;
27552 Eina_Bool no_scale : 1;
27553 Eina_Bool smooth : 1;
27554 Eina_Bool scale_up : 1;
27555 Eina_Bool scale_down : 1;
27558 struct _Elm_Store_Item_Mapping_Empty
27563 struct _Elm_Store_Item_Mapping_Photo
27568 struct _Elm_Store_Item_Mapping_Custom
27570 Elm_Store_Item_Mapping_Cb func;
27573 struct _Elm_Store_Item_Mapping
27575 Elm_Store_Item_Mapping_Type type;
27580 Elm_Store_Item_Mapping_Empty empty;
27581 Elm_Store_Item_Mapping_Icon icon;
27582 Elm_Store_Item_Mapping_Photo photo;
27583 Elm_Store_Item_Mapping_Custom custom;
27584 // add more types here
27588 struct _Elm_Store_Item_Info
27590 Elm_Genlist_Item_Class *item_class;
27591 const Elm_Store_Item_Mapping *mapping;
27596 struct _Elm_Store_Item_Info_Filesystem
27598 Elm_Store_Item_Info base;
27602 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27603 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27605 EAPI void elm_store_free(Elm_Store *st);
27607 EAPI Elm_Store *elm_store_filesystem_new(void);
27608 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27609 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27610 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27612 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27614 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27615 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27616 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27617 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27618 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27619 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27621 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27622 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27623 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27624 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27625 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27626 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27627 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27630 * @defgroup SegmentControl SegmentControl
27631 * @ingroup Elementary
27633 * @image html img/widget/segment_control/preview-00.png
27634 * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27636 * @image html img/segment_control.png
27637 * @image latex img/segment_control.eps width=\textwidth
27639 * Segment control widget is a horizontal control made of multiple segment
27640 * items, each segment item functioning similar to discrete two state button.
27641 * A segment control groups the items together and provides compact
27642 * single button with multiple equal size segments.
27644 * Segment item size is determined by base widget
27645 * size and the number of items added.
27646 * Only one segment item can be at selected state. A segment item can display
27647 * combination of Text and any Evas_Object like Images or other widget.
27649 * Smart callbacks one can listen to:
27650 * - "changed" - When the user clicks on a segment item which is not
27651 * previously selected and get selected. The event_info parameter is the
27652 * segment item pointer.
27654 * Available styles for it:
27657 * Here is an example on its usage:
27658 * @li @ref segment_control_example
27662 * @addtogroup SegmentControl
27666 typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27669 * Add a new segment control widget to the given parent Elementary
27670 * (container) object.
27672 * @param parent The parent object.
27673 * @return a new segment control widget handle or @c NULL, on errors.
27675 * This function inserts a new segment control widget on the canvas.
27677 * @ingroup SegmentControl
27679 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27682 * Append a new item to the segment control object.
27684 * @param obj The segment control object.
27685 * @param icon The icon object to use for the left side of the item. An
27686 * icon can be any Evas object, but usually it is an icon created
27687 * with elm_icon_add().
27688 * @param label The label of the item.
27689 * Note that, NULL is different from empty string "".
27690 * @return The created item or @c NULL upon failure.
27692 * A new item will be created and appended to the segment control, i.e., will
27693 * be set as @b last item.
27695 * If it should be inserted at another position,
27696 * elm_segment_control_item_insert_at() should be used instead.
27698 * Items created with this function can be deleted with function
27699 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27701 * @note @p label set to @c NULL is different from empty string "".
27703 * only has icon, it will be displayed bigger and centered. If it has
27704 * icon and label, even that an empty string, icon will be smaller and
27705 * positioned at left.
27709 * sc = elm_segment_control_add(win);
27710 * ic = elm_icon_add(win);
27711 * elm_icon_file_set(ic, "path/to/image", NULL);
27712 * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27713 * elm_segment_control_item_add(sc, ic, "label");
27714 * evas_object_show(sc);
27717 * @see elm_segment_control_item_insert_at()
27718 * @see elm_segment_control_item_del()
27720 * @ingroup SegmentControl
27722 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27725 * Insert a new item to the segment control object at specified position.
27727 * @param obj The segment control object.
27728 * @param icon The icon object to use for the left side of the item. An
27729 * icon can be any Evas object, but usually it is an icon created
27730 * with elm_icon_add().
27731 * @param label The label of the item.
27732 * @param index Item position. Value should be between 0 and items count.
27733 * @return The created item or @c NULL upon failure.
27735 * Index values must be between @c 0, when item will be prepended to
27736 * segment control, and items count, that can be get with
27737 * elm_segment_control_item_count_get(), case when item will be appended
27738 * to segment control, just like elm_segment_control_item_add().
27740 * Items created with this function can be deleted with function
27741 * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27743 * @note @p label set to @c NULL is different from empty string "".
27745 * only has icon, it will be displayed bigger and centered. If it has
27746 * icon and label, even that an empty string, icon will be smaller and
27747 * positioned at left.
27749 * @see elm_segment_control_item_add()
27750 * @see elm_segment_control_item_count_get()
27751 * @see elm_segment_control_item_del()
27753 * @ingroup SegmentControl
27755 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);
27758 * Remove a segment control item from its parent, deleting it.
27760 * @param it The item to be removed.
27762 * Items can be added with elm_segment_control_item_add() or
27763 * elm_segment_control_item_insert_at().
27765 * @ingroup SegmentControl
27767 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27770 * Remove a segment control item at given index from its parent,
27773 * @param obj The segment control object.
27774 * @param index The position of the segment control item to be deleted.
27776 * Items can be added with elm_segment_control_item_add() or
27777 * elm_segment_control_item_insert_at().
27779 * @ingroup SegmentControl
27781 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27784 * Get the Segment items count from segment control.
27786 * @param obj The segment control object.
27787 * @return Segment items count.
27789 * It will just return the number of items added to segment control @p obj.
27791 * @ingroup SegmentControl
27793 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27796 * Get the item placed at specified index.
27798 * @param obj The segment control object.
27799 * @param index The index of the segment item.
27800 * @return The segment control item or @c NULL on failure.
27802 * Index is the position of an item in segment control widget. Its
27803 * range is from @c 0 to <tt> count - 1 </tt>.
27804 * Count is the number of items, that can be get with
27805 * elm_segment_control_item_count_get().
27807 * @ingroup SegmentControl
27809 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27812 * Get the label of item.
27814 * @param obj The segment control object.
27815 * @param index The index of the segment item.
27816 * @return The label of the item at @p index.
27818 * The return value is a pointer to the label associated to the item when
27819 * it was created, with function elm_segment_control_item_add(), or later
27820 * with function elm_segment_control_item_label_set. If no label
27821 * was passed as argument, it will return @c NULL.
27823 * @see elm_segment_control_item_label_set() for more details.
27824 * @see elm_segment_control_item_add()
27826 * @ingroup SegmentControl
27828 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27831 * Set the label of item.
27833 * @param it The item of segment control.
27834 * @param text The label of item.
27836 * The label to be displayed by the item.
27837 * Label will be at right of the icon (if set).
27839 * If a label was passed as argument on item creation, with function
27840 * elm_control_segment_item_add(), it will be already
27841 * displayed by the item.
27843 * @see elm_segment_control_item_label_get()
27844 * @see elm_segment_control_item_add()
27846 * @ingroup SegmentControl
27848 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
27851 * Get the icon associated to the item.
27853 * @param obj The segment control object.
27854 * @param index The index of the segment item.
27855 * @return The left side icon associated to the item at @p index.
27857 * The return value is a pointer to the icon associated to the item when
27858 * it was created, with function elm_segment_control_item_add(), or later
27859 * with function elm_segment_control_item_icon_set(). If no icon
27860 * was passed as argument, it will return @c NULL.
27862 * @see elm_segment_control_item_add()
27863 * @see elm_segment_control_item_icon_set()
27865 * @ingroup SegmentControl
27867 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27870 * Set the icon associated to the item.
27872 * @param it The segment control item.
27873 * @param icon The icon object to associate with @p it.
27875 * The icon object to use at left side of the item. An
27876 * icon can be any Evas object, but usually it is an icon created
27877 * with elm_icon_add().
27879 * Once the icon object is set, a previously set one will be deleted.
27880 * @warning Setting the same icon for two items will cause the icon to
27881 * dissapear from the first item.
27883 * If an icon was passed as argument on item creation, with function
27884 * elm_segment_control_item_add(), it will be already
27885 * associated to the item.
27887 * @see elm_segment_control_item_add()
27888 * @see elm_segment_control_item_icon_get()
27890 * @ingroup SegmentControl
27892 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27895 * Get the index of an item.
27897 * @param it The segment control item.
27898 * @return The position of item in segment control widget.
27900 * Index is the position of an item in segment control widget. Its
27901 * range is from @c 0 to <tt> count - 1 </tt>.
27902 * Count is the number of items, that can be get with
27903 * elm_segment_control_item_count_get().
27905 * @ingroup SegmentControl
27907 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27910 * Get the base object of the item.
27912 * @param it The segment control item.
27913 * @return The base object associated with @p it.
27915 * Base object is the @c Evas_Object that represents that item.
27917 * @ingroup SegmentControl
27919 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27922 * Get the selected item.
27924 * @param obj The segment control object.
27925 * @return The selected item or @c NULL if none of segment items is
27928 * The selected item can be unselected with function
27929 * elm_segment_control_item_selected_set().
27931 * The selected item always will be highlighted on segment control.
27933 * @ingroup SegmentControl
27935 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27938 * Set the selected state of an item.
27940 * @param it The segment control item
27941 * @param select The selected state
27943 * This sets the selected state of the given item @p it.
27944 * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27946 * If a new item is selected the previosly selected will be unselected.
27947 * Previoulsy selected item can be get with function
27948 * elm_segment_control_item_selected_get().
27950 * The selected item always will be highlighted on segment control.
27952 * @see elm_segment_control_item_selected_get()
27954 * @ingroup SegmentControl
27956 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
27963 * @defgroup Grid Grid
27965 * The grid is a grid layout widget that lays out a series of children as a
27966 * fixed "grid" of widgets using a given percentage of the grid width and
27967 * height each using the child object.
27969 * The Grid uses a "Virtual resolution" that is stretched to fill the grid
27970 * widgets size itself. The default is 100 x 100, so that means the
27971 * position and sizes of children will effectively be percentages (0 to 100)
27972 * of the width or height of the grid widget
27978 * Add a new grid to the parent
27980 * @param parent The parent object
27981 * @return The new object or NULL if it cannot be created
27985 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
27988 * Set the virtual size of the grid
27990 * @param obj The grid object
27991 * @param w The virtual width of the grid
27992 * @param h The virtual height of the grid
27996 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
27999 * Get the virtual size of the grid
28001 * @param obj The grid object
28002 * @param w Pointer to integer to store the virtual width of the grid
28003 * @param h Pointer to integer to store the virtual height of the grid
28007 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28010 * Pack child at given position and size
28012 * @param obj The grid object
28013 * @param subobj The child to pack
28014 * @param x The virtual x coord at which to pack it
28015 * @param y The virtual y coord at which to pack it
28016 * @param w The virtual width at which to pack it
28017 * @param h The virtual height at which to pack it
28021 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28024 * Unpack a child from a grid object
28026 * @param obj The grid object
28027 * @param subobj The child to unpack
28031 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28034 * Faster way to remove all child objects from a grid object.
28036 * @param obj The grid object
28037 * @param clear If true, it will delete just removed children
28041 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28044 * Set packing of an existing child at to position and size
28046 * @param subobj The child to set packing of
28047 * @param x The virtual x coord at which to pack it
28048 * @param y The virtual y coord at which to pack it
28049 * @param w The virtual width at which to pack it
28050 * @param h The virtual height at which to pack it
28054 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28057 * get packing of a child
28059 * @param subobj The child to query
28060 * @param x Pointer to integer to store the virtual x coord
28061 * @param y Pointer to integer to store the virtual y coord
28062 * @param w Pointer to integer to store the virtual width
28063 * @param h Pointer to integer to store the virtual height
28067 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28073 EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28074 EINA_DEPRECATED EAPI void elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28075 EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28076 EAPI void elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28077 EAPI Eina_Bool elm_factory_maxmin_mode_get(const Evas_Object *obj);
28078 EAPI void elm_factory_maxmin_reset_set(Evas_Object *obj);
28081 * @defgroup Video Video
28083 * @addtogroup Video
28086 * Elementary comes with two object that help design application that need
28087 * to display video. The main one, Elm_Video, display a video by using Emotion.
28088 * It does embedded the video inside an Edje object, so you can do some
28089 * animation depending on the video state change. It does also implement a
28090 * ressource management policy to remove this burden from the application writer.
28092 * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28093 * It take care of updating its content according to Emotion event and provide a
28094 * way to theme itself. It also does automatically raise the priority of the
28095 * linked Elm_Video so it will use the video decoder if available. It also does
28096 * activate the remember function on the linked Elm_Video object.
28098 * Signals that you can add callback for are :
28100 * "forward,clicked" - the user clicked the forward button.
28101 * "info,clicked" - the user clicked the info button.
28102 * "next,clicked" - the user clicked the next button.
28103 * "pause,clicked" - the user clicked the pause button.
28104 * "play,clicked" - the user clicked the play button.
28105 * "prev,clicked" - the user clicked the prev button.
28106 * "rewind,clicked" - the user clicked the rewind button.
28107 * "stop,clicked" - the user clicked the stop button.
28109 * To set the video of the player, you can use elm_object_content_set() API.
28114 * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28116 * @param parent The parent object
28117 * @return a new player widget handle or @c NULL, on errors.
28119 * This function inserts a new player widget on the canvas.
28121 * @see elm_object_content_set()
28125 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28128 * @brief Link a Elm_Payer with an Elm_Video object.
28130 * @param player the Elm_Player object.
28131 * @param video The Elm_Video object.
28133 * This mean that action on the player widget will affect the
28134 * video object and the state of the video will be reflected in
28135 * the player itself.
28137 * @see elm_player_add()
28138 * @see elm_video_add()
28142 EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28145 * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28147 * @param parent The parent object
28148 * @return a new video widget handle or @c NULL, on errors.
28150 * This function inserts a new video widget on the canvas.
28152 * @seeelm_video_file_set()
28153 * @see elm_video_uri_set()
28157 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28160 * @brief Define the file that will be the video source.
28162 * @param video The video object to define the file for.
28163 * @param filename The file to target.
28165 * This function will explicitly define a filename as a source
28166 * for the video of the Elm_Video object.
28168 * @see elm_video_uri_set()
28169 * @see elm_video_add()
28170 * @see elm_player_add()
28174 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28177 * @brief Define the uri that will be the video source.
28179 * @param video The video object to define the file for.
28180 * @param uri The uri to target.
28182 * This function will define an uri as a source for the video of the
28183 * Elm_Video object. URI could be remote source of video, like http:// or local source
28184 * like for example WebCam who are most of the time v4l2:// (but that depend and
28185 * you should use Emotion API to request and list the available Webcam on your system).
28187 * @see elm_video_file_set()
28188 * @see elm_video_add()
28189 * @see elm_player_add()
28193 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28196 * @brief Get the underlying Emotion object.
28198 * @param video The video object to proceed the request on.
28199 * @return the underlying Emotion object.
28203 EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28206 * @brief Start to play the video
28208 * @param video The video object to proceed the request on.
28210 * Start to play the video and cancel all suspend state.
28214 EAPI void elm_video_play(Evas_Object *video);
28217 * @brief Pause the video
28219 * @param video The video object to proceed the request on.
28221 * Pause the video and start a timer to trigger suspend mode.
28225 EAPI void elm_video_pause(Evas_Object *video);
28228 * @brief Stop the video
28230 * @param video The video object to proceed the request on.
28232 * Stop the video and put the emotion in deep sleep mode.
28236 EAPI void elm_video_stop(Evas_Object *video);
28239 * @brief Is the video actually playing.
28241 * @param video The video object to proceed the request on.
28242 * @return EINA_TRUE if the video is actually playing.
28244 * You should consider watching event on the object instead of polling
28245 * the object state.
28249 EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28252 * @brief Is it possible to seek inside the video.
28254 * @param video The video object to proceed the request on.
28255 * @return EINA_TRUE if is possible to seek inside the video.
28259 EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28262 * @brief Is the audio muted.
28264 * @param video The video object to proceed the request on.
28265 * @return EINA_TRUE if the audio is muted.
28269 EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28272 * @brief Change the mute state of the Elm_Video object.
28274 * @param video The video object to proceed the request on.
28275 * @param mute The new mute state.
28279 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28282 * @brief Get the audio level of the current video.
28284 * @param video The video object to proceed the request on.
28285 * @return the current audio level.
28289 EAPI double elm_video_audio_level_get(const Evas_Object *video);
28292 * @brief Set the audio level of anElm_Video object.
28294 * @param video The video object to proceed the request on.
28295 * @param volume The new audio volume.
28299 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28301 EAPI double elm_video_play_position_get(const Evas_Object *video);
28302 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28303 EAPI double elm_video_play_length_get(const Evas_Object *video);
28304 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28305 EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28306 EAPI const char *elm_video_title_get(const Evas_Object *video);
28312 * @defgroup Naviframe Naviframe
28313 * @ingroup Elementary
28315 * @brief Naviframe is a kind of view manager for the applications.
28317 * Naviframe provides functions to switch different pages with stack
28318 * mechanism. It means if one page(item) needs to be changed to the new one,
28319 * then naviframe would push the new page to it's internal stack. Of course,
28320 * it can be back to the previous page by popping the top page. Naviframe
28321 * provides some transition effect while the pages are switching (same as
28324 * Since each item could keep the different styles, users could keep the
28325 * same look & feel for the pages or different styles for the items in it's
28328 * Signals that you can add callback for are:
28329 * @li "transition,finished" - When the transition is finished in changing
28331 * @li "title,clicked" - User clicked title area
28333 * Default contents parts of the naviframe items that you can use for are:
28334 * @li "elm.swallow.content" - A main content of the page
28335 * @li "elm.swallow.icon" - A icon in the title area
28336 * @li "elm.swallow.prev_btn" - A button to go to the previous page
28337 * @li "elm.swallow.next_btn" - A button to go to the next page
28339 * Default text parts of the naviframe items that you can use for are:
28340 * @li "elm.text.title" - Title label in the title area
28341 * @li "elm.text.subtitle" - Sub-title label in the title area
28343 * @ref tutorial_naviframe gives a good overview of the usage of the API.
28346 #define ELM_NAVIFRAME_ITEM_CONTENT_ICON "elm.swallow.icon"
28347 #define ELM_NAVIFRAME_ITEM_CONTENT_PREV_BTN "elm.swallow.prev_btn"
28348 #define ELM_NAVIFRAME_ITEM_CONTNET_NEXT_BTN "elm.swallow.next_btn"
28349 #define ELM_NAVIFRAME_ITEM_TEXT_SUBTITLE "elm.text.subtitle"
28352 * @addtogroup Naviframe
28357 * @brief Add a new Naviframe object to the parent.
28359 * @param parent Parent object
28360 * @return New object or @c NULL, if it cannot be created
28362 * @ingroup Naviframe
28364 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28366 * @brief Push a new item to the top of the naviframe stack (and show it).
28368 * @param obj The naviframe object
28369 * @param title_label The label in the title area. The name of the title
28370 * label part is "elm.text.title"
28371 * @param prev_btn The button to go to the previous item. If it is NULL,
28372 * then naviframe will create a back button automatically. The name of
28373 * the prev_btn part is "elm.swallow.prev_btn"
28374 * @param next_btn The button to go to the next item. Or It could be just an
28375 * extra function button. The name of the next_btn part is
28376 * "elm.swallow.next_btn"
28377 * @param content The main content object. The name of content part is
28378 * "elm.swallow.content"
28379 * @param item_style The current item style name. @c NULL would be default.
28380 * @return The created item or @c NULL upon failure.
28382 * The item pushed becomes one page of the naviframe, this item will be
28383 * deleted when it is popped.
28385 * @see also elm_naviframe_item_style_set()
28386 * @see also elm_naviframe_item_insert_before()
28387 * @see also elm_naviframe_item_insert_after()
28389 * The following styles are available for this item:
28392 * @ingroup Naviframe
28394 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);
28396 * @brief Insert a new item into the naviframe before item @p before.
28398 * @param before The naviframe item to insert before.
28399 * @param title_label The label in the title area. The name of the title
28400 * label part is "elm.text.title"
28401 * @param prev_btn The button to go to the previous item. If it is NULL,
28402 * then naviframe will create a back button automatically. The name of
28403 * the prev_btn part is "elm.swallow.prev_btn"
28404 * @param next_btn The button to go to the next item. Or It could be just an
28405 * extra function button. The name of the next_btn part is
28406 * "elm.swallow.next_btn"
28407 * @param content The main content object. The name of content part is
28408 * "elm.swallow.content"
28409 * @param item_style The current item style name. @c NULL would be default.
28410 * @return The created item or @c NULL upon failure.
28412 * The item is inserted into the naviframe straight away without any
28413 * transition operations. This item will be deleted when it is popped.
28415 * @see also elm_naviframe_item_style_set()
28416 * @see also elm_naviframe_item_push()
28417 * @see also elm_naviframe_item_insert_after()
28419 * The following styles are available for this item:
28422 * @ingroup Naviframe
28424 EAPI Elm_Object_Item *elm_naviframe_item_insert_before(Elm_Object_Item *before, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) EINA_ARG_NONNULL(1, 5);
28426 * @brief Insert a new item into the naviframe after item @p after.
28428 * @param after The naviframe item to insert after.
28429 * @param title_label The label in the title area. The name of the title
28430 * label part is "elm.text.title"
28431 * @param prev_btn The button to go to the previous item. If it is NULL,
28432 * then naviframe will create a back button automatically. The name of
28433 * the prev_btn part is "elm.swallow.prev_btn"
28434 * @param next_btn The button to go to the next item. Or It could be just an
28435 * extra function button. The name of the next_btn part is
28436 * "elm.swallow.next_btn"
28437 * @param content The main content object. The name of content part is
28438 * "elm.swallow.content"
28439 * @param item_style The current item style name. @c NULL would be default.
28440 * @return The created item or @c NULL upon failure.
28442 * The item is inserted into the naviframe straight away without any
28443 * transition operations. This item will be deleted when it is popped.
28445 * @see also elm_naviframe_item_style_set()
28446 * @see also elm_naviframe_item_push()
28447 * @see also elm_naviframe_item_insert_before()
28449 * The following styles are available for this item:
28452 * @ingroup Naviframe
28454 EAPI Elm_Object_Item *elm_naviframe_item_insert_after(Elm_Object_Item *after, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) EINA_ARG_NONNULL(1, 5);
28456 * @brief Pop an item that is on top of the stack
28458 * @param obj The naviframe object
28459 * @return @c NULL or the content object(if the
28460 * elm_naviframe_content_preserve_on_pop_get is true).
28462 * This pops an item that is on the top(visible) of the naviframe, makes it
28463 * disappear, then deletes the item. The item that was underneath it on the
28464 * stack will become visible.
28466 * @see also elm_naviframe_content_preserve_on_pop_get()
28468 * @ingroup Naviframe
28470 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28472 * @brief Pop the items between the top and the above one on the given item.
28474 * @param it The naviframe item
28476 * @ingroup Naviframe
28478 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28480 * Promote an item already in the naviframe stack to the top of the stack
28482 * @param it The naviframe item
28484 * This will take the indicated item and promote it to the top of the stack
28485 * as if it had been pushed there. The item must already be inside the
28486 * naviframe stack to work.
28489 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28491 * @brief Delete the given item instantly.
28493 * @param it The naviframe item
28495 * This just deletes the given item from the naviframe item list instantly.
28496 * So this would not emit any signals for view transitions but just change
28497 * the current view if the given item is a top one.
28499 * @ingroup Naviframe
28501 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28503 * @brief preserve the content objects when items are popped.
28505 * @param obj The naviframe object
28506 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28508 * @see also elm_naviframe_content_preserve_on_pop_get()
28510 * @ingroup Naviframe
28512 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28514 * @brief Get a value whether preserve mode is enabled or not.
28516 * @param obj The naviframe object
28517 * @return If @c EINA_TRUE, preserve mode is enabled
28519 * @see also elm_naviframe_content_preserve_on_pop_set()
28521 * @ingroup Naviframe
28523 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28525 * @brief Get a top item on the naviframe stack
28527 * @param obj The naviframe object
28528 * @return The top item on the naviframe stack or @c NULL, if the stack is
28531 * @ingroup Naviframe
28533 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28535 * @brief Get a bottom item on the naviframe stack
28537 * @param obj The naviframe object
28538 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28541 * @ingroup Naviframe
28543 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28545 * @brief Set an item style
28547 * @param obj The naviframe item
28548 * @param item_style The current item style name. @c NULL would be default
28550 * The following styles are available for this item:
28553 * @see also elm_naviframe_item_style_get()
28555 * @ingroup Naviframe
28557 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28559 * @brief Get an item style
28561 * @param obj The naviframe item
28562 * @return The current item style name
28564 * @see also elm_naviframe_item_style_set()
28566 * @ingroup Naviframe
28568 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28570 * @brief Show/Hide the title area
28572 * @param it The naviframe item
28573 * @param visible If @c EINA_TRUE, title area will be visible, hidden
28576 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
28578 * @see also elm_naviframe_item_title_visible_get()
28580 * @ingroup Naviframe
28582 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28584 * @brief Get a value whether title area is visible or not.
28586 * @param it The naviframe item
28587 * @return If @c EINA_TRUE, title area is visible
28589 * @see also elm_naviframe_item_title_visible_set()
28591 * @ingroup Naviframe
28593 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28596 * @brief Set creating prev button automatically or not
28598 * @param obj The naviframe object
28599 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28600 * be created internally when you pass the @c NULL to the prev_btn
28601 * parameter in elm_naviframe_item_push
28603 * @see also elm_naviframe_item_push()
28605 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28607 * @brief Get a value whether prev button(back button) will be auto pushed or
28610 * @param obj The naviframe object
28611 * @return If @c EINA_TRUE, prev button will be auto pushed.
28613 * @see also elm_naviframe_item_push()
28614 * elm_naviframe_prev_btn_auto_pushed_set()
28616 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28618 * @brief Get a list of all the naviframe items.
28620 * @param obj The naviframe object
28621 * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
28622 * or @c NULL on failure.
28624 EAPI Eina_Inlist *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);