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_EMAP_DEF@ ELM_EMAP
316 @ELM_DEBUG_DEF@ ELM_DEBUG
317 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
318 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
320 /* Standard headers for standard system calls etc. */
325 #include <sys/types.h>
326 #include <sys/stat.h>
327 #include <sys/time.h>
328 #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>
378 # include <Efreet_Mime.h>
379 # include <Efreet_Trash.h>
383 # include <Ethumb_Client.h>
395 # ifdef ELEMENTARY_BUILD
397 # define EAPI __declspec(dllexport)
400 # endif /* ! DLL_EXPORT */
402 # define EAPI __declspec(dllimport)
403 # endif /* ! EFL_EVAS_BUILD */
407 # define EAPI __attribute__ ((visibility("default")))
414 #endif /* ! _WIN32 */
417 /* allow usage from c++ */
422 #define ELM_VERSION_MAJOR @VMAJ@
423 #define ELM_VERSION_MINOR @VMIN@
425 typedef struct _Elm_Version
433 EAPI extern Elm_Version *elm_version;
436 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
437 #define ELM_PI 3.14159265358979323846
440 * @defgroup General General
442 * @brief General Elementary API. Functions that don't relate to
443 * Elementary objects specifically.
445 * Here are documented functions which init/shutdown the library,
446 * that apply to generic Elementary objects, that deal with
447 * configuration, et cetera.
449 * @ref general_functions_example_page "This" example contemplates
450 * some of these functions.
454 * @addtogroup General
459 * Defines couple of standard Evas_Object layers to be used
460 * with evas_object_layer_set().
462 * @note whenever extending with new values, try to keep some padding
463 * to siblings so there is room for further extensions.
465 typedef enum _Elm_Object_Layer
467 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
468 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
469 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
470 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
471 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
472 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
475 /**************************************************************************/
476 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
479 * Emitted when any Elementary's policy value is changed.
481 EAPI extern int ELM_EVENT_POLICY_CHANGED;
484 * @typedef Elm_Event_Policy_Changed
486 * Data on the event when an Elementary policy has changed
488 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
491 * @struct _Elm_Event_Policy_Changed
493 * Data on the event when an Elementary policy has changed
495 struct _Elm_Event_Policy_Changed
497 unsigned int policy; /**< the policy identifier */
498 int new_value; /**< value the policy had before the change */
499 int old_value; /**< new value the policy got */
503 * Policy identifiers.
505 typedef enum _Elm_Policy
507 ELM_POLICY_QUIT, /**< under which circumstances the application
508 * should quit automatically. @see
512 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
515 typedef enum _Elm_Policy_Quit
517 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
519 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
521 * window is closed */
522 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
524 typedef enum _Elm_Focus_Direction
528 } Elm_Focus_Direction;
530 typedef enum _Elm_Text_Format
532 ELM_TEXT_FORMAT_PLAIN_UTF8,
533 ELM_TEXT_FORMAT_MARKUP_UTF8
537 * Line wrapping types.
539 typedef enum _Elm_Wrap_Type
541 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
542 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
543 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
544 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
550 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
551 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
552 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
553 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
554 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
555 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
556 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
557 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
558 ELM_INPUT_PANEL_LAYOUT_INVALID
559 } Elm_Input_Panel_Layout;
563 ELM_AUTOCAPITAL_TYPE_NONE,
564 ELM_AUTOCAPITAL_TYPE_WORD,
565 ELM_AUTOCAPITAL_TYPE_SENTENCE,
566 ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
567 } Elm_Autocapital_Type;
570 * @typedef Elm_Object_Item
571 * An Elementary Object item handle.
574 typedef struct _Elm_Object_Item Elm_Object_Item;
578 * Called back when a widget's tooltip is activated and needs content.
579 * @param data user-data given to elm_object_tooltip_content_cb_set()
580 * @param obj owner widget.
582 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj);
585 * Called back when a widget's item tooltip is activated and needs content.
586 * @param data user-data given to elm_object_tooltip_content_cb_set()
587 * @param obj owner widget.
588 * @param item context dependent item. As an example, if tooltip was
589 * set on Elm_List_Item, then it is of this type.
591 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, void *item);
593 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
595 #ifndef ELM_LIB_QUICKLAUNCH
596 #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 */
598 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
601 /**************************************************************************/
605 * Initialize Elementary
607 * @param[in] argc System's argument count value
608 * @param[in] argv System's pointer to array of argument strings
609 * @return The init counter value.
611 * This function initializes Elementary and increments a counter of
612 * the number of calls to it. It returns the new counter's value.
614 * @warning This call is exported only for use by the @c ELM_MAIN()
615 * macro. There is no need to use this if you use this macro (which
616 * is highly advisable). An elm_main() should contain the entry
617 * point code for your application, having the same prototype as
618 * elm_init(), and @b not being static (putting the @c EAPI symbol
619 * in front of its type declaration is advisable). The @c
620 * ELM_MAIN() call should be placed just after it.
623 * @dontinclude bg_example_01.c
627 * See the full @ref bg_example_01_c "example".
629 * @see elm_shutdown().
632 EAPI int elm_init(int argc, char **argv);
635 * Shut down Elementary
637 * @return The init counter value.
639 * This should be called at the end of your application, just
640 * before it ceases to do any more processing. This will clean up
641 * any permanent resources your application may have allocated via
642 * Elementary that would otherwise persist.
644 * @see elm_init() for an example
648 EAPI int elm_shutdown(void);
651 * Run Elementary's main loop
653 * This call should be issued just after all initialization is
654 * completed. This function will not return until elm_exit() is
655 * called. It will keep looping, running the main
656 * (event/processing) loop for Elementary.
658 * @see elm_init() for an example
662 EAPI void elm_run(void);
665 * Exit Elementary's main loop
667 * If this call is issued, it will flag the main loop to cease
668 * processing and return back to its parent function (usually your
669 * elm_main() function).
671 * @see elm_init() for an example. There, just after a request to
672 * close the window comes, the main loop will be left.
674 * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
675 * applications, you'll be able to get this function called automatically for you.
679 EAPI void elm_exit(void);
682 * Provide information in order to make Elementary determine the @b
683 * run time location of the software in question, so other data files
684 * such as images, sound files, executable utilities, libraries,
685 * modules and locale files can be found.
687 * @param mainfunc This is your application's main function name,
688 * whose binary's location is to be found. Providing @c NULL
689 * will make Elementary not to use it
690 * @param dom This will be used as the application's "domain", in the
691 * form of a prefix to any environment variables that may
692 * override prefix detection and the directory name, inside the
693 * standard share or data directories, where the software's
694 * data files will be looked for.
695 * @param checkfile This is an (optional) magic file's path to check
696 * for existence (and it must be located in the data directory,
697 * under the share directory provided above). Its presence will
698 * help determine the prefix found was correct. Pass @c NULL if
699 * the check is not to be done.
701 * This function allows one to re-locate the application somewhere
702 * else after compilation, if the developer wishes for easier
703 * distribution of pre-compiled binaries.
705 * The prefix system is designed to locate where the given software is
706 * installed (under a common path prefix) at run time and then report
707 * specific locations of this prefix and common directories inside
708 * this prefix like the binary, library, data and locale directories,
709 * through the @c elm_app_*_get() family of functions.
711 * Call elm_app_info_set() early on before you change working
712 * directory or anything about @c argv[0], so it gets accurate
715 * It will then try and trace back which file @p mainfunc comes from,
716 * if provided, to determine the application's prefix directory.
718 * The @p dom parameter provides a string prefix to prepend before
719 * environment variables, allowing a fallback to @b specific
720 * environment variables to locate the software. You would most
721 * probably provide a lowercase string there, because it will also
722 * serve as directory domain, explained next. For environment
723 * variables purposes, this string is made uppercase. For example if
724 * @c "myapp" is provided as the prefix, then the program would expect
725 * @c "MYAPP_PREFIX" as a master environment variable to specify the
726 * exact install prefix for the software, or more specific environment
727 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
728 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
729 * the user or scripts before launching. If not provided (@c NULL),
730 * environment variables will not be used to override compiled-in
731 * defaults or auto detections.
733 * The @p dom string also provides a subdirectory inside the system
734 * shared data directory for data files. For example, if the system
735 * directory is @c /usr/local/share, then this directory name is
736 * appended, creating @c /usr/local/share/myapp, if it @p was @c
737 * "myapp". It is expected that the application installs data files in
740 * The @p checkfile is a file name or path of something inside the
741 * share or data directory to be used to test that the prefix
742 * detection worked. For example, your app will install a wallpaper
743 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
744 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
747 * @see elm_app_compile_bin_dir_set()
748 * @see elm_app_compile_lib_dir_set()
749 * @see elm_app_compile_data_dir_set()
750 * @see elm_app_compile_locale_set()
751 * @see elm_app_prefix_dir_get()
752 * @see elm_app_bin_dir_get()
753 * @see elm_app_lib_dir_get()
754 * @see elm_app_data_dir_get()
755 * @see elm_app_locale_dir_get()
757 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
760 * Provide information on the @b fallback application's binaries
761 * directory, in scenarios where they get overriden by
762 * elm_app_info_set().
764 * @param dir The path to the default binaries directory (compile time
767 * @note Elementary will as well use this path to determine actual
768 * names of binaries' directory paths, maybe changing it to be @c
769 * something/local/bin instead of @c something/bin, only, for
772 * @warning You should call this function @b before
773 * elm_app_info_set().
775 EAPI void elm_app_compile_bin_dir_set(const char *dir);
778 * Provide information on the @b fallback application's libraries
779 * directory, on scenarios where they get overriden by
780 * elm_app_info_set().
782 * @param dir The path to the default libraries directory (compile
785 * @note Elementary will as well use this path to determine actual
786 * names of libraries' directory paths, maybe changing it to be @c
787 * something/lib32 or @c something/lib64 instead of @c something/lib,
790 * @warning You should call this function @b before
791 * elm_app_info_set().
793 EAPI void elm_app_compile_lib_dir_set(const char *dir);
796 * Provide information on the @b fallback application's data
797 * directory, on scenarios where they get overriden by
798 * elm_app_info_set().
800 * @param dir The path to the default data directory (compile time
803 * @note Elementary will as well use this path to determine actual
804 * names of data directory paths, maybe changing it to be @c
805 * something/local/share instead of @c something/share, only, for
808 * @warning You should call this function @b before
809 * elm_app_info_set().
811 EAPI void elm_app_compile_data_dir_set(const char *dir);
814 * Provide information on the @b fallback application's locale
815 * directory, on scenarios where they get overriden by
816 * elm_app_info_set().
818 * @param dir The path to the default locale directory (compile time
821 * @warning You should call this function @b before
822 * elm_app_info_set().
824 EAPI void elm_app_compile_locale_set(const char *dir);
827 * Retrieve the application's run time prefix directory, as set by
828 * elm_app_info_set() and the way (environment) the application was
831 * @return The directory prefix the application is actually using.
833 EAPI const char *elm_app_prefix_dir_get(void);
836 * Retrieve the application's run time binaries prefix directory, as
837 * set by elm_app_info_set() and the way (environment) the application
840 * @return The binaries directory prefix the application is actually
843 EAPI const char *elm_app_bin_dir_get(void);
846 * Retrieve the application's run time libraries prefix directory, as
847 * set by elm_app_info_set() and the way (environment) the application
850 * @return The libraries directory prefix the application is actually
853 EAPI const char *elm_app_lib_dir_get(void);
856 * Retrieve the application's run time data prefix directory, as
857 * set by elm_app_info_set() and the way (environment) the application
860 * @return The data directory prefix the application is actually
863 EAPI const char *elm_app_data_dir_get(void);
866 * Retrieve the application's run time locale prefix directory, as
867 * set by elm_app_info_set() and the way (environment) the application
870 * @return The locale directory prefix the application is actually
873 EAPI const char *elm_app_locale_dir_get(void);
875 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
876 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
877 EAPI int elm_quicklaunch_init(int argc, char **argv);
878 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
879 EAPI int elm_quicklaunch_sub_shutdown(void);
880 EAPI int elm_quicklaunch_shutdown(void);
881 EAPI void elm_quicklaunch_seed(void);
882 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
883 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
884 EAPI void elm_quicklaunch_cleanup(void);
885 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
886 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
888 EAPI Eina_Bool elm_need_efreet(void);
889 EAPI Eina_Bool elm_need_e_dbus(void);
890 EAPI Eina_Bool elm_need_ethumb(void);
893 * Set a new policy's value (for a given policy group/identifier).
895 * @param policy policy identifier, as in @ref Elm_Policy.
896 * @param value policy value, which depends on the identifier
898 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
900 * Elementary policies define applications' behavior,
901 * somehow. These behaviors are divided in policy groups (see
902 * #Elm_Policy enumeration). This call will emit the Ecore event
903 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
904 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
907 * @note Currently, we have only one policy identifier/group
908 * (#ELM_POLICY_QUIT), which has two possible values.
912 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
915 * Gets the policy value for given policy identifier.
917 * @param policy policy identifier, as in #Elm_Policy.
918 * @return The currently set policy value, for that
919 * identifier. Will be @c 0 if @p policy passed is invalid.
923 EAPI int elm_policy_get(unsigned int policy);
926 * Change the language of the current application
928 * The @p lang passed must be the full name of the locale to use, for
929 * example "en_US.utf8" or "es_ES@euro".
931 * Changing language with this function will make Elementary run through
932 * all its widgets, translating strings set with
933 * elm_object_domain_translatable_text_part_set(). This way, an entire
934 * UI can have its language changed without having to restart the program.
936 * For more complex cases, like having formatted strings that need
937 * translation, widgets will also emit a "language,changed" signal that
938 * the user can listen to to manually translate the text.
940 * @param lang Language to set, must be the full name of the locale
944 EAPI void elm_language_set(const char *lang);
947 * Set a label of an object
949 * @param obj The Elementary object
950 * @param part The text part name to set (NULL for the default label)
951 * @param label The new text of the label
953 * @note Elementary objects may have many labels (e.g. Action Slider)
957 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
959 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
962 * Get a label of an object
964 * @param obj The Elementary object
965 * @param part The text part name to get (NULL for the default label)
966 * @return text of the label or NULL for any error
968 * @note Elementary objects may have many labels (e.g. Action Slider)
972 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
974 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
977 * Set a content of an object
979 * @param obj The Elementary object
980 * @param part The content part name to set (NULL for the default content)
981 * @param content The new content of the object
983 * @note Elementary objects may have many contents
987 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
989 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
992 * Get a content of an object
994 * @param obj The Elementary object
995 * @param item The content part name to get (NULL for the default content)
996 * @return content of the object or NULL for any error
998 * @note Elementary objects may have many contents
1002 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1004 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
1007 * Unset a content of an object
1009 * @param obj The Elementary object
1010 * @param item The content part name to unset (NULL for the default content)
1012 * @note Elementary objects may have many contents
1016 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1018 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1021 * Set a content of an object item
1023 * @param it The Elementary object item
1024 * @param part The content part name to set (NULL for the default content)
1025 * @param content The new content of the object item
1027 * @note Elementary object items may have many contents
1031 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1033 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1036 * Get a content of an object item
1038 * @param it The Elementary object item
1039 * @param part The content part name to unset (NULL for the default content)
1040 * @return content of the object item or NULL for any error
1042 * @note Elementary object items may have many contents
1046 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1048 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1051 * Unset a content of an object item
1053 * @param it The Elementary object item
1054 * @param part The content part name to unset (NULL for the default content)
1056 * @note Elementary object items may have many contents
1060 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1062 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1065 * Set a label of an object item
1067 * @param it The Elementary object item
1068 * @param part The text part name to set (NULL for the default label)
1069 * @param label The new text of the label
1071 * @note Elementary object items may have many labels
1075 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1077 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1080 * Get a label of an object item
1082 * @param it The Elementary object item
1083 * @param part The text part name to get (NULL for the default label)
1084 * @return text of the label or NULL for any error
1086 * @note Elementary object items may have many labels
1090 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1092 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1095 * Set the text to read out when in accessibility mode
1097 * @param obj The object which is to be described
1098 * @param txt The text that describes the widget to people with poor or no vision
1102 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1105 * Set the text to read out when in accessibility mode
1107 * @param it The object item which is to be described
1108 * @param txt The text that describes the widget to people with poor or no vision
1112 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1115 * Get the data associated with an object item
1116 * @param it The object item
1117 * @return The data associated with @p it
1121 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1124 * Set the data associated with an object item
1125 * @param it The object item
1126 * @param data The data to be associated with @p it
1130 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1133 * Send a signal to the edje object of the widget item.
1135 * This function sends a signal to the edje object of the obj item. An
1136 * edje program can respond to a signal by specifying matching
1137 * 'signal' and 'source' fields.
1139 * @param it The Elementary object item
1140 * @param emission The signal's name.
1141 * @param source The signal's source.
1144 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1151 * @defgroup Caches Caches
1153 * These are functions which let one fine-tune some cache values for
1154 * Elementary applications, thus allowing for performance adjustments.
1160 * @brief Flush all caches.
1162 * Frees all data that was in cache and is not currently being used to reduce
1163 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1164 * to calling all of the following functions:
1165 * @li edje_file_cache_flush()
1166 * @li edje_collection_cache_flush()
1167 * @li eet_clearcache()
1168 * @li evas_image_cache_flush()
1169 * @li evas_font_cache_flush()
1170 * @li evas_render_dump()
1171 * @note Evas caches are flushed for every canvas associated with a window.
1175 EAPI void elm_all_flush(void);
1178 * Get the configured cache flush interval time
1180 * This gets the globally configured cache flush interval time, in
1183 * @return The cache flush interval time
1186 * @see elm_all_flush()
1188 EAPI int elm_cache_flush_interval_get(void);
1191 * Set the configured cache flush interval time
1193 * This sets the globally configured cache flush interval time, in ticks
1195 * @param size The cache flush interval time
1198 * @see elm_all_flush()
1200 EAPI void elm_cache_flush_interval_set(int size);
1203 * Set the configured cache flush interval time for all applications on the
1206 * This sets the globally configured cache flush interval time -- in ticks
1207 * -- for all applications on the display.
1209 * @param size The cache flush interval time
1212 EAPI void elm_cache_flush_interval_all_set(int size);
1215 * Get the configured cache flush enabled state
1217 * This gets the globally configured cache flush state - if it is enabled
1218 * or not. When cache flushing is enabled, elementary will regularly
1219 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1220 * memory and allow usage to re-seed caches and data in memory where it
1221 * can do so. An idle application will thus minimise its memory usage as
1222 * data will be freed from memory and not be re-loaded as it is idle and
1223 * not rendering or doing anything graphically right now.
1225 * @return The cache flush state
1228 * @see elm_all_flush()
1230 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1233 * Set the configured cache flush enabled state
1235 * This sets the globally configured cache flush enabled state.
1237 * @param size The cache flush enabled state
1240 * @see elm_all_flush()
1242 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1245 * Set the configured cache flush enabled state for all applications on the
1248 * This sets the globally configured cache flush enabled state for all
1249 * applications on the display.
1251 * @param size The cache flush enabled state
1254 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1257 * Get the configured font cache size
1259 * This gets the globally configured font cache size, in bytes.
1261 * @return The font cache size
1264 EAPI int elm_font_cache_get(void);
1267 * Set the configured font cache size
1269 * This sets the globally configured font cache size, in bytes
1271 * @param size The font cache size
1274 EAPI void elm_font_cache_set(int size);
1277 * Set the configured font cache size for all applications on the
1280 * This sets the globally configured font cache size -- in bytes
1281 * -- for all applications on the display.
1283 * @param size The font cache size
1286 EAPI void elm_font_cache_all_set(int size);
1289 * Get the configured image cache size
1291 * This gets the globally configured image cache size, in bytes
1293 * @return The image cache size
1296 EAPI int elm_image_cache_get(void);
1299 * Set the configured image cache size
1301 * This sets the globally configured image cache size, in bytes
1303 * @param size The image cache size
1306 EAPI void elm_image_cache_set(int size);
1309 * Set the configured image cache size for all applications on the
1312 * This sets the globally configured image cache size -- in bytes
1313 * -- for all applications on the display.
1315 * @param size The image cache size
1318 EAPI void elm_image_cache_all_set(int size);
1321 * Get the configured edje file cache size.
1323 * This gets the globally configured edje file cache size, in number
1326 * @return The edje file cache size
1329 EAPI int elm_edje_file_cache_get(void);
1332 * Set the configured edje file cache size
1334 * This sets the globally configured edje file cache size, in number
1337 * @param size The edje file cache size
1340 EAPI void elm_edje_file_cache_set(int size);
1343 * Set the configured edje file cache size for all applications on the
1346 * This sets the globally configured edje file cache size -- in number
1347 * of files -- for all applications on the display.
1349 * @param size The edje file cache size
1352 EAPI void elm_edje_file_cache_all_set(int size);
1355 * Get the configured edje collections (groups) cache size.
1357 * This gets the globally configured edje collections cache size, in
1358 * number of collections.
1360 * @return The edje collections cache size
1363 EAPI int elm_edje_collection_cache_get(void);
1366 * Set the configured edje collections (groups) cache size
1368 * This sets the globally configured edje collections cache size, in
1369 * number of collections.
1371 * @param size The edje collections cache size
1374 EAPI void elm_edje_collection_cache_set(int size);
1377 * Set the configured edje collections (groups) cache size for all
1378 * applications on the display
1380 * This sets the globally configured edje collections cache size -- in
1381 * number of collections -- for all applications on the display.
1383 * @param size The edje collections cache size
1386 EAPI void elm_edje_collection_cache_all_set(int size);
1393 * @defgroup Scaling Widget Scaling
1395 * Different widgets can be scaled independently. These functions
1396 * allow you to manipulate this scaling on a per-widget basis. The
1397 * object and all its children get their scaling factors multiplied
1398 * by the scale factor set. This is multiplicative, in that if a
1399 * child also has a scale size set it is in turn multiplied by its
1400 * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1401 * double size, @c 0.5 is half, etc.
1403 * @ref general_functions_example_page "This" example contemplates
1404 * some of these functions.
1408 * Set the scaling factor for a given Elementary object
1410 * @param obj The Elementary to operate on
1411 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1416 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1419 * Get the scaling factor for a given Elementary object
1421 * @param obj The object
1422 * @return The scaling factor set by elm_object_scale_set()
1426 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1429 * @defgroup Password_last_show Password last input show
1431 * Last show feature of password mode enables user to view
1432 * the last input entered for few seconds before masking it.
1433 * These functions allow to set this feature in password mode
1434 * of entry widget and also allow to manipulate the duration
1435 * for which the input has to be visible.
1441 * Get show last setting of password mode.
1443 * This gets the show last input setting of password mode which might be
1444 * enabled or disabled.
1446 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1448 * @ingroup Password_last_show
1450 EAPI Eina_Bool elm_password_show_last_get(void);
1453 * Set show last setting in password mode.
1455 * This enables or disables show last setting of password mode.
1457 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1458 * @see elm_password_show_last_timeout_set()
1459 * @ingroup Password_last_show
1461 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1464 * Get's the timeout value in last show password mode.
1466 * This gets the time out value for which the last input entered in password
1467 * mode will be visible.
1469 * @return The timeout value of last show password mode.
1470 * @ingroup Password_last_show
1472 EAPI double elm_password_show_last_timeout_get(void);
1475 * Set's the timeout value in last show password mode.
1477 * This sets the time out value for which the last input entered in password
1478 * mode will be visible.
1480 * @param password_show_last_timeout The timeout value.
1481 * @see elm_password_show_last_set()
1482 * @ingroup Password_last_show
1484 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1490 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1491 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1492 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1493 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1495 * Set the style to use by a widget
1497 * Sets the style name that will define the appearance of a widget. Styles
1498 * vary from widget to widget and may also be defined by other themes
1499 * by means of extensions and overlays.
1501 * @param obj The Elementary widget to style
1502 * @param style The style name to use
1504 * @see elm_theme_extension_add()
1505 * @see elm_theme_overlay_add()
1509 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1511 * Get the style used by the widget
1513 * This gets the style being used for that widget. Note that the string
1514 * pointer is only valid as longas the object is valid and the style doesn't
1517 * @param obj The Elementary widget to query for its style
1518 * @return The style name used
1520 * @see elm_object_style_set()
1524 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1527 * @defgroup Styles Styles
1529 * Widgets can have different styles of look. These generic API's
1530 * set styles of widgets, if they support them (and if the theme(s)
1533 * @ref general_functions_example_page "This" example contemplates
1534 * some of these functions.
1538 * Set the disabled state of an Elementary object.
1540 * @param obj The Elementary object to operate on
1541 * @param disabled The state to put in in: @c EINA_TRUE for
1542 * disabled, @c EINA_FALSE for enabled
1544 * Elementary objects can be @b disabled, in which state they won't
1545 * receive input and, in general, will be themed differently from
1546 * their normal state, usually greyed out. Useful for contexts
1547 * where you don't want your users to interact with some of the
1548 * parts of you interface.
1550 * This sets the state for the widget, either disabling it or
1555 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1558 * Get the disabled state of an Elementary object.
1560 * @param obj The Elementary object to operate on
1561 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1562 * if it's enabled (or on errors)
1564 * This gets the state of the widget, which might be enabled or disabled.
1568 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1571 * @defgroup WidgetNavigation Widget Tree Navigation.
1573 * How to check if an Evas Object is an Elementary widget? How to
1574 * get the first elementary widget that is parent of the given
1575 * object? These are all covered in widget tree navigation.
1577 * @ref general_functions_example_page "This" example contemplates
1578 * some of these functions.
1581 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1584 * Get the first parent of the given object that is an Elementary
1587 * @param obj the Elementary object to query parent from.
1588 * @return the parent object that is an Elementary widget, or @c
1589 * NULL, if it was not found.
1591 * Use this to query for an object's parent widget.
1593 * @note Most of Elementary users wouldn't be mixing non-Elementary
1594 * smart objects in the objects tree of an application, as this is
1595 * an advanced usage of Elementary with Evas. So, except for the
1596 * application's window, which is the root of that tree, all other
1597 * objects would have valid Elementary widget parents.
1599 * @ingroup WidgetNavigation
1601 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1602 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1603 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1605 EAPI double elm_scale_get(void);
1606 EAPI void elm_scale_set(double scale);
1607 EAPI void elm_scale_all_set(double scale);
1609 EAPI Eina_Bool elm_mirrored_get(void);
1610 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1612 EAPI Eina_Bool elm_config_save(void);
1613 EAPI void elm_config_reload(void);
1615 EAPI const char *elm_profile_current_get(void);
1616 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1617 EAPI void elm_profile_dir_free(const char *p_dir);
1618 EAPI Eina_List *elm_profile_list_get(void);
1619 EAPI void elm_profile_list_free(Eina_List *l);
1620 EAPI void elm_profile_set(const char *profile);
1621 EAPI void elm_profile_all_set(const char *profile);
1623 EAPI const char *elm_engine_current_get(void);
1624 EAPI void elm_engine_set(const char *engine);
1626 typedef struct _Elm_Text_Class
1632 typedef struct _Elm_Font_Overlay
1634 const char *text_class;
1636 Evas_Font_Size size;
1639 typedef struct _Elm_Font_Properties
1643 } Elm_Font_Properties;
1645 EAPI const Eina_List *elm_text_classes_list_get(void);
1646 EAPI void elm_text_classes_list_free(const Eina_List *list);
1648 EAPI const Eina_List *elm_font_overlay_list_get(void);
1649 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1650 EAPI void elm_font_overlay_unset(const char *text_class);
1651 EAPI void elm_font_overlay_apply(void);
1652 EAPI void elm_font_overlay_all_apply(void);
1654 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
1655 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
1656 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
1657 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
1658 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
1659 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
1662 * @defgroup Fingers Fingers
1664 * Elementary is designed to be finger-friendly for touchscreens,
1665 * and so in addition to scaling for display resolution, it can
1666 * also scale based on finger "resolution" (or size). You can then
1667 * customize the granularity of the areas meant to receive clicks
1670 * Different profiles may have pre-set values for finger sizes.
1672 * @ref general_functions_example_page "This" example contemplates
1673 * some of these functions.
1677 * Get the configured "finger size"
1679 * @return The finger size
1681 * This gets the globally configured finger size, <b>in pixels</b>
1685 EAPI Evas_Coord elm_finger_size_get(void);
1686 EAPI void elm_finger_size_set(Evas_Coord size);
1687 EAPI void elm_finger_size_all_set(Evas_Coord size);
1690 * @defgroup Focus Focus
1692 * An Elementary application has, at all times, one (and only one)
1693 * @b focused object. This is what determines where the input
1694 * events go to within the application's window. Also, focused
1695 * objects can be decorated differently, in order to signal to the
1696 * user where the input is, at a given moment.
1698 * Elementary applications also have the concept of <b>focus
1699 * chain</b>: one can cycle through all the windows' focusable
1700 * objects by input (tab key) or programmatically. The default
1701 * focus chain for an application is the one define by the order in
1702 * which the widgets where added in code. One will cycle through
1703 * top level widgets, and, for each one containg sub-objects, cycle
1704 * through them all, before returning to the level
1705 * above. Elementary also allows one to set @b custom focus chains
1706 * for their applications.
1708 * Besides the focused decoration a widget may exhibit, when it
1709 * gets focus, Elementary has a @b global focus highlight object
1710 * that can be enabled for a window. If one chooses to do so, this
1711 * extra highlight effect will surround the current focused object,
1714 * @note Some Elementary widgets are @b unfocusable, after
1715 * creation, by their very nature: they are not meant to be
1716 * interacted with input events, but are there just for visual
1719 * @ref general_functions_example_page "This" example contemplates
1720 * some of these functions.
1723 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
1724 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
1725 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
1726 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
1729 * Get the whether an Elementary object has the focus or not.
1731 * @param obj The Elementary object to get the information from
1732 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
1733 * not (and on errors).
1735 * @see elm_object_focus()
1739 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1742 * Make a given Elementary object the focused one.
1744 * @param obj The Elementary object to make focused.
1746 * @note This object, if it can handle focus, will take the focus
1747 * away from the one who had it previously and will, for now on, be
1748 * the one receiving input events.
1750 * @see elm_object_focus_get()
1754 EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1757 * Remove the focus from an Elementary object
1759 * @param obj The Elementary to take focus from
1761 * This removes the focus from @p obj, passing it back to the
1762 * previous element in the focus chain list.
1764 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
1768 EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1771 * Set the ability for an Element object to be focused
1773 * @param obj The Elementary object to operate on
1774 * @param enable @c EINA_TRUE if the object can be focused, @c
1775 * EINA_FALSE if not (and on errors)
1777 * This sets whether the object @p obj is able to take focus or
1778 * not. Unfocusable objects do nothing when programmatically
1779 * focused, being the nearest focusable parent object the one
1780 * really getting focus. Also, when they receive mouse input, they
1781 * will get the event, but not take away the focus from where it
1786 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
1789 * Get whether an Elementary object is focusable or not
1791 * @param obj The Elementary object to operate on
1792 * @return @c EINA_TRUE if the object is allowed to be focused, @c
1793 * EINA_FALSE if not (and on errors)
1795 * @note Objects which are meant to be interacted with by input
1796 * events are created able to be focused, by default. All the
1801 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1803 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
1804 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1805 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1806 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1807 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1808 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
1809 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
1812 * Make the elementary object and its children to be unfocusable (or focusable).
1814 * @param obj The Elementary object to operate on
1815 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
1816 * @c EINA_FALSE for focusable.
1818 * This sets whether the object @p obj and its children objects
1819 * able to take focus or not. If the tree is unfocusable,
1820 * newest focused object which is not in this tree will get focus.
1821 * This API can be helpful for an object to be deleted.
1822 * When an object will be deleted soon, it and its children may not
1823 * want to get focus (by focus reverting or by other focus controls).
1824 * Then, just use this API before deleting.
1826 * @see elm_object_tree_unfocusable_get()
1830 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
1833 * Get whether an Elementary object and its children are unfocusable or not.
1835 * @param obj The Elementary object to get the information from
1836 * @return @c EINA_TRUE, if the tree is unfocussable,
1837 * @c EINA_FALSE if not (and on errors).
1839 * @see elm_object_tree_unfocusable_set()
1843 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
1845 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
1846 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
1847 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
1848 EAPI double elm_scroll_bounce_friction_get(void);
1849 EAPI void elm_scroll_bounce_friction_set(double friction);
1850 EAPI void elm_scroll_bounce_friction_all_set(double friction);
1851 EAPI double elm_scroll_page_scroll_friction_get(void);
1852 EAPI void elm_scroll_page_scroll_friction_set(double friction);
1853 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
1854 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
1855 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
1856 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
1857 EAPI double elm_scroll_zoom_friction_get(void);
1858 EAPI void elm_scroll_zoom_friction_set(double friction);
1859 EAPI void elm_scroll_zoom_friction_all_set(double friction);
1860 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
1861 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
1862 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
1863 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
1864 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
1865 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
1866 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
1867 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
1868 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
1869 EAPI double elm_scroll_thumbscroll_friction_get(void);
1870 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
1871 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
1872 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
1873 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
1874 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
1877 * Get the sensitivity amount which is be multiplied by the length of
1880 * @return the thumb scroll sensitivity friction
1882 * @ingroup Scrolling
1884 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
1887 * Set the sensitivity amount which is be multiplied by the length of
1890 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
1891 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
1894 * @see elm_thumbscroll_sensitivity_friction_get()
1895 * @note parameter value will get bound to 0.1 - 1.0 interval, always
1897 * @ingroup Scrolling
1899 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
1902 * Set the sensitivity amount which is be multiplied by the length of
1903 * mouse dragging, for all Elementary application windows.
1905 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
1906 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
1909 * @see elm_thumbscroll_sensitivity_friction_get()
1910 * @note parameter value will get bound to 0.1 - 1.0 interval, always
1912 * @ingroup Scrolling
1914 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
1920 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1921 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1922 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1923 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1924 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1925 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1926 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1927 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1929 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1930 EAPI void elm_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, void (*func) (void *data, Evas_Object *o, const char *emission, const char *source), void *data) EINA_ARG_NONNULL(1, 4);
1931 EAPI void *elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, void (*func) (void *data, Evas_Object *o, const char *emission, const char *source)) EINA_ARG_NONNULL(1, 4);
1933 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1934 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1937 * Adjust size of an element for finger usage.
1939 * @param times_w How many fingers should fit horizontally
1940 * @param w Pointer to the width size to adjust
1941 * @param times_h How many fingers should fit vertically
1942 * @param h Pointer to the height size to adjust
1944 * This takes width and height sizes (in pixels) as input and a
1945 * size multiple (which is how many fingers you want to place
1946 * within the area, being "finger" the size set by
1947 * elm_finger_size_set()), and adjusts the size to be large enough
1948 * to accommodate the resulting size -- if it doesn't already
1949 * accommodate it. On return the @p w and @p h sizes pointed to by
1950 * these parameters will be modified, on those conditions.
1952 * @note This is kind of a low level Elementary call, most useful
1953 * on size evaluation times for widgets. An external user wouldn't
1954 * be calling, most of the time.
1958 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
1960 EAPI double elm_longpress_timeout_get(void);
1961 EAPI void elm_longpress_timeout_set(double longpress_timeout);
1964 * don't use it unless you are sure
1966 EAPI void elm_object_tree_dump(const Evas_Object *top);
1967 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
1969 EAPI void elm_autocapitalization_allow_all_set(Eina_Bool autocap);
1970 EAPI void elm_autoperiod_allow_all_set(Eina_Bool autoperiod);
1975 * @defgroup Theme Theme
1977 * Elementary uses Edje to theme its widgets, naturally. But for the most
1978 * part this is hidden behind a simpler interface that lets the user set
1979 * extensions and choose the style of widgets in a much easier way.
1981 * Instead of thinking in terms of paths to Edje files and their groups
1982 * each time you want to change the appearance of a widget, Elementary
1983 * works so you can add any theme file with extensions or replace the
1984 * main theme at one point in the application, and then just set the style
1985 * of widgets with elm_object_style_set() and related functions. Elementary
1986 * will then look in its list of themes for a matching group and apply it,
1987 * and when the theme changes midway through the application, all widgets
1988 * will be updated accordingly.
1990 * There are three concepts you need to know to understand how Elementary
1991 * theming works: default theme, extensions and overlays.
1993 * Default theme, obviously enough, is the one that provides the default
1994 * look of all widgets. End users can change the theme used by Elementary
1995 * by setting the @c ELM_THEME environment variable before running an
1996 * application, or globally for all programs using the @c elementary_config
1997 * utility. Applications can change the default theme using elm_theme_set(),
1998 * but this can go against the user wishes, so it's not an adviced practice.
2000 * Ideally, applications should find everything they need in the already
2001 * provided theme, but there may be occasions when that's not enough and
2002 * custom styles are required to correctly express the idea. For this
2003 * cases, Elementary has extensions.
2005 * Extensions allow the application developer to write styles of its own
2006 * to apply to some widgets. This requires knowledge of how each widget
2007 * is themed, as extensions will always replace the entire group used by
2008 * the widget, so important signals and parts need to be there for the
2009 * object to behave properly (see documentation of Edje for details).
2010 * Once the theme for the extension is done, the application needs to add
2011 * it to the list of themes Elementary will look into, using
2012 * elm_theme_extension_add(), and set the style of the desired widgets as
2013 * he would normally with elm_object_style_set().
2015 * Overlays, on the other hand, can replace the look of all widgets by
2016 * overriding the default style. Like extensions, it's up to the application
2017 * developer to write the theme for the widgets it wants, the difference
2018 * being that when looking for the theme, Elementary will check first the
2019 * list of overlays, then the set theme and lastly the list of extensions,
2020 * so with overlays it's possible to replace the default view and every
2021 * widget will be affected. This is very much alike to setting the whole
2022 * theme for the application and will probably clash with the end user
2023 * options, not to mention the risk of ending up with not matching styles
2024 * across the program. Unless there's a very special reason to use them,
2025 * overlays should be avoided for the resons exposed before.
2027 * All these theme lists are handled by ::Elm_Theme instances. Elementary
2028 * keeps one default internally and every function that receives one of
2029 * these can be called with NULL to refer to this default (except for
2030 * elm_theme_free()). It's possible to create a new instance of a
2031 * ::Elm_Theme to set other theme for a specific widget (and all of its
2032 * children), but this is as discouraged, if not even more so, than using
2033 * overlays. Don't use this unless you really know what you are doing.
2035 * But to be less negative about things, you can look at the following
2037 * @li @ref theme_example_01 "Using extensions"
2038 * @li @ref theme_example_02 "Using overlays"
2043 * @typedef Elm_Theme
2045 * Opaque handler for the list of themes Elementary looks for when
2046 * rendering widgets.
2048 * Stay out of this unless you really know what you are doing. For most
2049 * cases, sticking to the default is all a developer needs.
2051 typedef struct _Elm_Theme Elm_Theme;
2054 * Create a new specific theme
2056 * This creates an empty specific theme that only uses the default theme. A
2057 * specific theme has its own private set of extensions and overlays too
2058 * (which are empty by default). Specific themes do not fall back to themes
2059 * of parent objects. They are not intended for this use. Use styles, overlays
2060 * and extensions when needed, but avoid specific themes unless there is no
2061 * other way (example: you want to have a preview of a new theme you are
2062 * selecting in a "theme selector" window. The preview is inside a scroller
2063 * and should display what the theme you selected will look like, but not
2064 * actually apply it yet. The child of the scroller will have a specific
2065 * theme set to show this preview before the user decides to apply it to all
2068 EAPI Elm_Theme *elm_theme_new(void);
2070 * Free a specific theme
2072 * @param th The theme to free
2074 * This frees a theme created with elm_theme_new().
2076 EAPI void elm_theme_free(Elm_Theme *th);
2078 * Copy the theme fom the source to the destination theme
2080 * @param th The source theme to copy from
2081 * @param thdst The destination theme to copy data to
2083 * This makes a one-time static copy of all the theme config, extensions
2084 * and overlays from @p th to @p thdst. If @p th references a theme, then
2085 * @p thdst is also set to reference it, with all the theme settings,
2086 * overlays and extensions that @p th had.
2088 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
2090 * Tell the source theme to reference the ref theme
2092 * @param th The theme that will do the referencing
2093 * @param thref The theme that is the reference source
2095 * This clears @p th to be empty and then sets it to refer to @p thref
2096 * so @p th acts as an override to @p thref, but where its overrides
2097 * don't apply, it will fall through to @pthref for configuration.
2099 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
2101 * Return the theme referred to
2103 * @param th The theme to get the reference from
2104 * @return The referenced theme handle
2106 * This gets the theme set as the reference theme by elm_theme_ref_set().
2107 * If no theme is set as a reference, NULL is returned.
2109 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
2111 * Return the default theme
2113 * @return The default theme handle
2115 * This returns the internal default theme setup handle that all widgets
2116 * use implicitly unless a specific theme is set. This is also often use
2117 * as a shorthand of NULL.
2119 EAPI Elm_Theme *elm_theme_default_get(void);
2121 * Prepends a theme overlay to the list of overlays
2123 * @param th The theme to add to, or if NULL, the default theme
2124 * @param item The Edje file path to be used
2126 * Use this if your application needs to provide some custom overlay theme
2127 * (An Edje file that replaces some default styles of widgets) where adding
2128 * new styles, or changing system theme configuration is not possible. Do
2129 * NOT use this instead of a proper system theme configuration. Use proper
2130 * configuration files, profiles, environment variables etc. to set a theme
2131 * so that the theme can be altered by simple confiugration by a user. Using
2132 * this call to achieve that effect is abusing the API and will create lots
2135 * @see elm_theme_extension_add()
2137 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
2139 * Delete a theme overlay from the list of overlays
2141 * @param th The theme to delete from, or if NULL, the default theme
2142 * @param item The name of the theme overlay
2144 * @see elm_theme_overlay_add()
2146 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
2148 * Appends a theme extension to the list of extensions.
2150 * @param th The theme to add to, or if NULL, the default theme
2151 * @param item The Edje file path to be used
2153 * This is intended when an application needs more styles of widgets or new
2154 * widget themes that the default does not provide (or may not provide). The
2155 * application has "extended" usage by coming up with new custom style names
2156 * for widgets for specific uses, but as these are not "standard", they are
2157 * not guaranteed to be provided by a default theme. This means the
2158 * application is required to provide these extra elements itself in specific
2159 * Edje files. This call adds one of those Edje files to the theme search
2160 * path to be search after the default theme. The use of this call is
2161 * encouraged when default styles do not meet the needs of the application.
2162 * Use this call instead of elm_theme_overlay_add() for almost all cases.
2164 * @see elm_object_style_set()
2166 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
2168 * Deletes a theme extension from the list of extensions.
2170 * @param th The theme to delete from, or if NULL, the default theme
2171 * @param item The name of the theme extension
2173 * @see elm_theme_extension_add()
2175 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
2177 * Set the theme search order for the given theme
2179 * @param th The theme to set the search order, or if NULL, the default theme
2180 * @param theme Theme search string
2182 * This sets the search string for the theme in path-notation from first
2183 * theme to search, to last, delimited by the : character. Example:
2185 * "shiny:/path/to/file.edj:default"
2187 * See the ELM_THEME environment variable for more information.
2189 * @see elm_theme_get()
2190 * @see elm_theme_list_get()
2192 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
2194 * Return the theme search order
2196 * @param th The theme to get the search order, or if NULL, the default theme
2197 * @return The internal search order path
2199 * This function returns a colon separated string of theme elements as
2200 * returned by elm_theme_list_get().
2202 * @see elm_theme_set()
2203 * @see elm_theme_list_get()
2205 EAPI const char *elm_theme_get(Elm_Theme *th);
2207 * Return a list of theme elements to be used in a theme.
2209 * @param th Theme to get the list of theme elements from.
2210 * @return The internal list of theme elements
2212 * This returns the internal list of theme elements (will only be valid as
2213 * long as the theme is not modified by elm_theme_set() or theme is not
2214 * freed by elm_theme_free(). This is a list of strings which must not be
2215 * altered as they are also internal. If @p th is NULL, then the default
2216 * theme element list is returned.
2218 * A theme element can consist of a full or relative path to a .edj file,
2219 * or a name, without extension, for a theme to be searched in the known
2220 * theme paths for Elemementary.
2222 * @see elm_theme_set()
2223 * @see elm_theme_get()
2225 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
2227 * Return the full patrh for a theme element
2229 * @param f The theme element name
2230 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
2231 * @return The full path to the file found.
2233 * This returns a string you should free with free() on success, NULL on
2234 * failure. This will search for the given theme element, and if it is a
2235 * full or relative path element or a simple searchable name. The returned
2236 * path is the full path to the file, if searched, and the file exists, or it
2237 * is simply the full path given in the element or a resolved path if
2238 * relative to home. The @p in_search_path boolean pointed to is set to
2239 * EINA_TRUE if the file was a searchable file andis in the search path,
2240 * and EINA_FALSE otherwise.
2242 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
2244 * Flush the current theme.
2246 * @param th Theme to flush
2248 * This flushes caches that let elementary know where to find theme elements
2249 * in the given theme. If @p th is NULL, then the default theme is flushed.
2250 * Call this function if source theme data has changed in such a way as to
2251 * make any caches Elementary kept invalid.
2253 EAPI void elm_theme_flush(Elm_Theme *th);
2255 * This flushes all themes (default and specific ones).
2257 * This will flush all themes in the current application context, by calling
2258 * elm_theme_flush() on each of them.
2260 EAPI void elm_theme_full_flush(void);
2262 * Set the theme for all elementary using applications on the current display
2264 * @param theme The name of the theme to use. Format same as the ELM_THEME
2265 * environment variable.
2267 EAPI void elm_theme_all_set(const char *theme);
2269 * Return a list of theme elements in the theme search path
2271 * @return A list of strings that are the theme element names.
2273 * This lists all available theme files in the standard Elementary search path
2274 * for theme elements, and returns them in alphabetical order as theme
2275 * element names in a list of strings. Free this with
2276 * elm_theme_name_available_list_free() when you are done with the list.
2278 EAPI Eina_List *elm_theme_name_available_list_new(void);
2280 * Free the list returned by elm_theme_name_available_list_new()
2282 * This frees the list of themes returned by
2283 * elm_theme_name_available_list_new(). Once freed the list should no longer
2284 * be used. a new list mys be created.
2286 EAPI void elm_theme_name_available_list_free(Eina_List *list);
2288 * Set a specific theme to be used for this object and its children
2290 * @param obj The object to set the theme on
2291 * @param th The theme to set
2293 * This sets a specific theme that will be used for the given object and any
2294 * child objects it has. If @p th is NULL then the theme to be used is
2295 * cleared and the object will inherit its theme from its parent (which
2296 * ultimately will use the default theme if no specific themes are set).
2298 * Use special themes with great care as this will annoy users and make
2299 * configuration difficult. Avoid any custom themes at all if it can be
2302 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
2304 * Get the specific theme to be used
2306 * @param obj The object to get the specific theme from
2307 * @return The specifc theme set.
2309 * This will return a specific theme set, or NULL if no specific theme is
2310 * set on that object. It will not return inherited themes from parents, only
2311 * the specific theme set for that specific object. See elm_object_theme_set()
2312 * for more information.
2314 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2320 typedef enum _Elm_Win_Type
2323 ELM_WIN_DIALOG_BASIC,
2330 ELM_WIN_DROPDOWN_MENU,
2333 ELM_WIN_NOTIFICATION,
2336 ELM_WIN_INLINED_IMAGE,
2339 typedef enum _Elm_Win_Keyboard_Mode
2341 ELM_WIN_KEYBOARD_UNKNOWN,
2342 ELM_WIN_KEYBOARD_OFF,
2343 ELM_WIN_KEYBOARD_ON,
2344 ELM_WIN_KEYBOARD_ALPHA,
2345 ELM_WIN_KEYBOARD_NUMERIC,
2346 ELM_WIN_KEYBOARD_PIN,
2347 ELM_WIN_KEYBOARD_PHONE_NUMBER,
2348 ELM_WIN_KEYBOARD_HEX,
2349 ELM_WIN_KEYBOARD_TERMINAL,
2350 ELM_WIN_KEYBOARD_PASSWORD,
2351 ELM_WIN_KEYBOARD_IP,
2352 ELM_WIN_KEYBOARD_HOST,
2353 ELM_WIN_KEYBOARD_FILE,
2354 ELM_WIN_KEYBOARD_URL,
2355 ELM_WIN_KEYBOARD_KEYPAD,
2356 ELM_WIN_KEYBOARD_J2ME
2357 } Elm_Win_Keyboard_Mode;
2359 typedef enum _Elm_Illume_Command
2361 ELM_ILLUME_COMMAND_FOCUS_BACK,
2362 ELM_ILLUME_COMMAND_FOCUS_FORWARD,
2363 ELM_ILLUME_COMMAND_FOCUS_HOME,
2364 ELM_ILLUME_COMMAND_CLOSE
2365 } Elm_Illume_Command;
2367 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
2368 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2369 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2370 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
2371 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2372 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
2373 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2374 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
2375 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
2376 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
2377 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
2378 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2379 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
2380 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2381 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
2382 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2383 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
2384 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2385 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
2386 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2387 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
2388 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2389 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
2390 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2391 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
2392 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2393 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
2394 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2395 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
2396 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
2397 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2398 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
2399 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2400 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
2401 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2402 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
2403 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2404 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
2405 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2406 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
2407 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2408 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
2409 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2410 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
2411 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
2412 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
2413 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
2414 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2415 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
2416 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2417 EAPI void elm_win_indicator_state_set(Evas_Object *obj, int show_state);
2418 EAPI int elm_win_indicator_state_get(Evas_Object *obj);
2420 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
2421 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
2422 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
2423 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
2424 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
2425 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
2426 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
2428 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
2429 * (blank mouse, private mouse obj, defaultmouse)
2432 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
2433 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2434 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
2435 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2437 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
2439 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
2440 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
2441 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
2442 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2443 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2444 /* available styles:
2449 /* X specific calls - won't work on non-x engines (return 0) */
2450 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2451 /* smart callbacks called:
2452 * "delete,request" - the user requested to delete the window
2453 * "focus,in" - window got focus
2454 * "focus,out" - window lost focus
2455 * "moved" - window that holds the canvas was moved
2461 * @brief Background object, used for setting a solid color, image or Edje
2462 * group as background to a window or any container object.
2464 * The bg object is used for setting a solid background to a window or
2465 * packing into any container object. It works just like an image, but has
2466 * some properties useful to a background, like setting it to tiled,
2467 * centered, scaled or stretched.
2469 * Here is some sample code using it:
2470 * @li @ref bg_01_example_page
2471 * @li @ref bg_02_example_page
2472 * @li @ref bg_03_example_page
2476 typedef enum _Elm_Bg_Option
2478 ELM_BG_OPTION_CENTER, /**< center the background */
2479 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
2480 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
2481 ELM_BG_OPTION_TILE /**< tile background at its original size */
2485 * Add a new background to the parent
2487 * @param parent The parent object
2488 * @return The new object or NULL if it cannot be created
2492 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2495 * Set the file (image or edje) used for the background
2497 * @param obj The bg object
2498 * @param file The file path
2499 * @param group Optional key (group in Edje) within the file
2501 * This sets the image file used in the background object. The image (or edje)
2502 * will be stretched (retaining aspect if its an image file) to completely fill
2503 * the bg object. This may mean some parts are not visible.
2505 * @note Once the image of @p obj is set, a previously set one will be deleted,
2506 * even if @p file is NULL.
2510 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
2513 * Get the file (image or edje) used for the background
2515 * @param obj The bg object
2516 * @param file The file path
2517 * @param group Optional key (group in Edje) within the file
2521 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2524 * Set the option used for the background image
2526 * @param obj The bg object
2527 * @param option The desired background option (TILE, SCALE)
2529 * This sets the option used for manipulating the display of the background
2530 * image. The image can be tiled or scaled.
2534 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
2537 * Get the option used for the background image
2539 * @param obj The bg object
2540 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
2544 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2546 * Set the option used for the background color
2548 * @param obj The bg object
2553 * This sets the color used for the background rectangle. Its range goes
2558 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
2560 * Get the option used for the background color
2562 * @param obj The bg object
2569 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
2572 * Set the overlay object used for the background object.
2574 * @param obj The bg object
2575 * @param overlay The overlay object
2577 * This provides a way for elm_bg to have an 'overlay' that will be on top
2578 * of the bg. Once the over object is set, a previously set one will be
2579 * deleted, even if you set the new one to NULL. If you want to keep that
2580 * old content object, use the elm_bg_overlay_unset() function.
2585 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
2588 * Get the overlay object used for the background object.
2590 * @param obj The bg object
2591 * @return The content that is being used
2593 * Return the content object which is set for this widget
2597 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2600 * Get the overlay object used for the background object.
2602 * @param obj The bg object
2603 * @return The content that was being used
2605 * Unparent and return the overlay object which was set for this widget
2609 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2612 * Set the size of the pixmap representation of the image.
2614 * This option just makes sense if an image is going to be set in the bg.
2616 * @param obj The bg object
2617 * @param w The new width of the image pixmap representation.
2618 * @param h The new height of the image pixmap representation.
2620 * This function sets a new size for pixmap representation of the given bg
2621 * image. It allows the image to be loaded already in the specified size,
2622 * reducing the memory usage and load time when loading a big image with load
2623 * size set to a smaller size.
2625 * NOTE: this is just a hint, the real size of the pixmap may differ
2626 * depending on the type of image being loaded, being bigger than requested.
2630 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
2631 /* smart callbacks called:
2635 typedef enum _Elm_Icon_Lookup_Order
2637 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
2638 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
2639 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
2640 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
2641 } Elm_Icon_Lookup_Order;
2643 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2644 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2645 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2646 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2647 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
2648 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2649 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2650 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2651 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
2652 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2653 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
2654 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
2655 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
2656 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2657 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
2658 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2659 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
2660 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2661 EAPI Eina_Bool elm_icon_anim_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2662 EAPI void elm_icon_anim_set(Evas_Object *obj, Eina_Bool anim) EINA_ARG_NONNULL(1);
2663 EAPI Eina_Bool elm_icon_anim_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2664 EAPI void elm_icon_anim_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
2665 EAPI Eina_Bool elm_icon_anim_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2667 /* smart callbacks called:
2668 * "clicked" - the user clicked the icon
2672 typedef enum _Elm_Image_Orient
2674 ELM_IMAGE_ORIENT_NONE,
2675 ELM_IMAGE_ROTATE_90_CW,
2676 ELM_IMAGE_ROTATE_180_CW,
2677 ELM_IMAGE_ROTATE_90_CCW,
2678 ELM_IMAGE_FLIP_HORIZONTAL,
2679 ELM_IMAGE_FLIP_VERTICAL,
2680 ELM_IMAGE_FLIP_TRANSPOSE,
2681 ELM_IMAGE_FLIP_TRANSVERSE
2683 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2684 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2685 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2686 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2687 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2688 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
2689 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
2690 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2691 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
2692 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
2693 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
2694 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2695 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
2696 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2697 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
2698 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2699 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
2700 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2701 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2702 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
2703 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2705 /* smart callbacks called:
2706 * "clicked" - the user clicked the image
2710 typedef void (*Elm_GLView_Func)(Evas_Object *obj);
2712 typedef enum _Elm_GLView_Mode
2714 ELM_GLVIEW_ALPHA = 1,
2715 ELM_GLVIEW_DEPTH = 2,
2716 ELM_GLVIEW_STENCIL = 4
2720 * Defines a policy for the glview resizing.
2722 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
2724 typedef enum _Elm_GLView_Resize_Policy
2726 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
2727 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
2728 } Elm_GLView_Resize_Policy;
2730 typedef enum _Elm_GLView_Render_Policy
2732 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
2733 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
2734 } Elm_GLView_Render_Policy;
2737 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2738 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2739 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2740 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2741 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
2742 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
2743 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
2744 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2745 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2746 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2747 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2748 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
2754 * A box arranges objects in a linear fashion, governed by a layout function
2755 * that defines the details of this arrangement.
2757 * By default, the box will use an internal function to set the layout to
2758 * a single row, either vertical or horizontal. This layout is affected
2759 * by a number of parameters, such as the homogeneous flag set by
2760 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
2761 * elm_box_align_set() and the hints set to each object in the box.
2763 * For this default layout, it's possible to change the orientation with
2764 * elm_box_horizontal_set(). The box will start in the vertical orientation,
2765 * placing its elements ordered from top to bottom. When horizontal is set,
2766 * the order will go from left to right. If the box is set to be
2767 * homogeneous, every object in it will be assigned the same space, that
2768 * of the largest object. Padding can be used to set some spacing between
2769 * the cell given to each object. The alignment of the box, set with
2770 * elm_box_align_set(), determines how the bounding box of all the elements
2771 * will be placed within the space given to the box widget itself.
2773 * The size hints of each object also affect how they are placed and sized
2774 * within the box. evas_object_size_hint_min_set() will give the minimum
2775 * size the object can have, and the box will use it as the basis for all
2776 * latter calculations. Elementary widgets set their own minimum size as
2777 * needed, so there's rarely any need to use it manually.
2779 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
2780 * used to tell whether the object will be allocated the minimum size it
2781 * needs or if the space given to it should be expanded. It's important
2782 * to realize that expanding the size given to the object is not the same
2783 * thing as resizing the object. It could very well end being a small
2784 * widget floating in a much larger empty space. If not set, the weight
2785 * for objects will normally be 0.0 for both axis, meaning the widget will
2786 * not be expanded. To take as much space possible, set the weight to
2787 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
2789 * Besides how much space each object is allocated, it's possible to control
2790 * how the widget will be placed within that space using
2791 * evas_object_size_hint_align_set(). By default, this value will be 0.5
2792 * for both axis, meaning the object will be centered, but any value from
2793 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
2794 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
2795 * is -1.0, means the object will be resized to fill the entire space it
2798 * In addition, customized functions to define the layout can be set, which
2799 * allow the application developer to organize the objects within the box
2800 * in any number of ways.
2802 * The special elm_box_layout_transition() function can be used
2803 * to switch from one layout to another, animating the motion of the
2804 * children of the box.
2806 * @note Objects should not be added to box objects using _add() calls.
2808 * Some examples on how to use boxes follow:
2809 * @li @ref box_example_01
2810 * @li @ref box_example_02
2815 * @typedef Elm_Box_Transition
2817 * Opaque handler containing the parameters to perform an animated
2818 * transition of the layout the box uses.
2820 * @see elm_box_transition_new()
2821 * @see elm_box_layout_set()
2822 * @see elm_box_layout_transition()
2824 typedef struct _Elm_Box_Transition Elm_Box_Transition;
2827 * Add a new box to the parent
2829 * By default, the box will be in vertical mode and non-homogeneous.
2831 * @param parent The parent object
2832 * @return The new object or NULL if it cannot be created
2834 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2836 * Set the horizontal orientation
2838 * By default, box object arranges their contents vertically from top to
2840 * By calling this function with @p horizontal as EINA_TRUE, the box will
2841 * become horizontal, arranging contents from left to right.
2843 * @note This flag is ignored if a custom layout function is set.
2845 * @param obj The box object
2846 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
2847 * EINA_FALSE = vertical)
2849 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
2851 * Get the horizontal orientation
2853 * @param obj The box object
2854 * @return EINA_TRUE if the box is set to horizintal mode, EINA_FALSE otherwise
2856 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2858 * Set the box to arrange its children homogeneously
2860 * If enabled, homogeneous layout makes all items the same size, according
2861 * to the size of the largest of its children.
2863 * @note This flag is ignored if a custom layout function is set.
2865 * @param obj The box object
2866 * @param homogeneous The homogeneous flag
2868 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
2870 * Get whether the box is using homogeneous mode or not
2872 * @param obj The box object
2873 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
2875 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2876 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
2877 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2879 * Add an object to the beginning of the pack list
2881 * Pack @p subobj into the box @p obj, placing it first in the list of
2882 * children objects. The actual position the object will get on screen
2883 * depends on the layout used. If no custom layout is set, it will be at
2884 * the top or left, depending if the box is vertical or horizontal,
2887 * @param obj The box object
2888 * @param subobj The object to add to the box
2890 * @see elm_box_pack_end()
2891 * @see elm_box_pack_before()
2892 * @see elm_box_pack_after()
2893 * @see elm_box_unpack()
2894 * @see elm_box_unpack_all()
2895 * @see elm_box_clear()
2897 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2899 * Add an object at the end of the pack list
2901 * Pack @p subobj into the box @p obj, placing it last in the list of
2902 * children objects. The actual position the object will get on screen
2903 * depends on the layout used. If no custom layout is set, it will be at
2904 * the bottom or right, depending if the box is vertical or horizontal,
2907 * @param obj The box object
2908 * @param subobj The object to add to the box
2910 * @see elm_box_pack_start()
2911 * @see elm_box_pack_before()
2912 * @see elm_box_pack_after()
2913 * @see elm_box_unpack()
2914 * @see elm_box_unpack_all()
2915 * @see elm_box_clear()
2917 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2919 * Adds an object to the box before the indicated object
2921 * This will add the @p subobj to the box indicated before the object
2922 * indicated with @p before. If @p before is not already in the box, results
2923 * are undefined. Before means either to the left of the indicated object or
2924 * above it depending on orientation.
2926 * @param obj The box object
2927 * @param subobj The object to add to the box
2928 * @param before The object before which to add it
2930 * @see elm_box_pack_start()
2931 * @see elm_box_pack_end()
2932 * @see elm_box_pack_after()
2933 * @see elm_box_unpack()
2934 * @see elm_box_unpack_all()
2935 * @see elm_box_clear()
2937 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
2939 * Adds an object to the box after the indicated object
2941 * This will add the @p subobj to the box indicated after the object
2942 * indicated with @p after. If @p after is not already in the box, results
2943 * are undefined. After means either to the right of the indicated object or
2944 * below it depending on orientation.
2946 * @param obj The box object
2947 * @param subobj The object to add to the box
2948 * @param after The object after which to add it
2950 * @see elm_box_pack_start()
2951 * @see elm_box_pack_end()
2952 * @see elm_box_pack_before()
2953 * @see elm_box_unpack()
2954 * @see elm_box_unpack_all()
2955 * @see elm_box_clear()
2957 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
2959 * Clear the box of all children
2961 * Remove all the elements contained by the box, deleting the respective
2964 * @param obj The box object
2966 * @see elm_box_unpack()
2967 * @see elm_box_unpack_all()
2969 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
2973 * Remove the object given by @p subobj from the box @p obj without
2976 * @param obj The box object
2978 * @see elm_box_unpack_all()
2979 * @see elm_box_clear()
2981 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2983 * Remove all items from the box, without deleting them
2985 * Clear the box from all children, but don't delete the respective objects.
2986 * If no other references of the box children exist, the objects will never
2987 * be deleted, and thus the application will leak the memory. Make sure
2988 * when using this function that you hold a reference to all the objects
2989 * in the box @p obj.
2991 * @param obj The box object
2993 * @see elm_box_clear()
2994 * @see elm_box_unpack()
2996 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
2998 * Retrieve a list of the objects packed into the box
3000 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
3001 * The order of the list corresponds to the packing order the box uses.
3003 * You must free this list with eina_list_free() once you are done with it.
3005 * @param obj The box object
3007 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3009 * Set the space (padding) between the box's elements.
3011 * Extra space in pixels that will be added between a box child and its
3012 * neighbors after its containing cell has been calculated. This padding
3013 * is set for all elements in the box, besides any possible padding that
3014 * individual elements may have through their size hints.
3016 * @param obj The box object
3017 * @param horizontal The horizontal space between elements
3018 * @param vertical The vertical space between elements
3020 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
3022 * Get the space (padding) between the box's elements.
3024 * @param obj The box object
3025 * @param horizontal The horizontal space between elements
3026 * @param vertical The vertical space between elements
3028 * @see elm_box_padding_set()
3030 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
3032 * Set the alignment of the whole bouding box of contents.
3034 * Sets how the bounding box containing all the elements of the box, after
3035 * their sizes and position has been calculated, will be aligned within
3036 * the space given for the whole box widget.
3038 * @param obj The box object
3039 * @param horizontal The horizontal alignment of elements
3040 * @param vertical The vertical alignment of elements
3042 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
3044 * Get the alignment of the whole bouding box of contents.
3046 * @param obj The box object
3047 * @param horizontal The horizontal alignment of elements
3048 * @param vertical The vertical alignment of elements
3050 * @see elm_box_align_set()
3052 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
3055 * Set the layout defining function to be used by the box
3057 * Whenever anything changes that requires the box in @p obj to recalculate
3058 * the size and position of its elements, the function @p cb will be called
3059 * to determine what the layout of the children will be.
3061 * Once a custom function is set, everything about the children layout
3062 * is defined by it. The flags set by elm_box_horizontal_set() and
3063 * elm_box_homogeneous_set() no longer have any meaning, and the values
3064 * given by elm_box_padding_set() and elm_box_align_set() are up to this
3065 * layout function to decide if they are used and how. These last two
3066 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
3067 * passed to @p cb. The @c Evas_Object the function receives is not the
3068 * Elementary widget, but the internal Evas Box it uses, so none of the
3069 * functions described here can be used on it.
3071 * Any of the layout functions in @c Evas can be used here, as well as the
3072 * special elm_box_layout_transition().
3074 * The final @p data argument received by @p cb is the same @p data passed
3075 * here, and the @p free_data function will be called to free it
3076 * whenever the box is destroyed or another layout function is set.
3078 * Setting @p cb to NULL will revert back to the default layout function.
3080 * @param obj The box object
3081 * @param cb The callback function used for layout
3082 * @param data Data that will be passed to layout function
3083 * @param free_data Function called to free @p data
3085 * @see elm_box_layout_transition()
3087 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);
3089 * Special layout function that animates the transition from one layout to another
3091 * Normally, when switching the layout function for a box, this will be
3092 * reflected immediately on screen on the next render, but it's also
3093 * possible to do this through an animated transition.
3095 * This is done by creating an ::Elm_Box_Transition and setting the box
3096 * layout to this function.
3100 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
3101 * evas_object_box_layout_vertical, // start
3102 * NULL, // data for initial layout
3103 * NULL, // free function for initial data
3104 * evas_object_box_layout_horizontal, // end
3105 * NULL, // data for final layout
3106 * NULL, // free function for final data
3107 * anim_end, // will be called when animation ends
3108 * NULL); // data for anim_end function\
3109 * elm_box_layout_set(box, elm_box_layout_transition, t,
3110 * elm_box_transition_free);
3113 * @note This function can only be used with elm_box_layout_set(). Calling
3114 * it directly will not have the expected results.
3116 * @see elm_box_transition_new
3117 * @see elm_box_transition_free
3118 * @see elm_box_layout_set
3120 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
3122 * Create a new ::Elm_Box_Transition to animate the switch of layouts
3124 * If you want to animate the change from one layout to another, you need
3125 * to set the layout function of the box to elm_box_layout_transition(),
3126 * passing as user data to it an instance of ::Elm_Box_Transition with the
3127 * necessary information to perform this animation. The free function to
3128 * set for the layout is elm_box_transition_free().
3130 * The parameters to create an ::Elm_Box_Transition sum up to how long
3131 * will it be, in seconds, a layout function to describe the initial point,
3132 * another for the final position of the children and one function to be
3133 * called when the whole animation ends. This last function is useful to
3134 * set the definitive layout for the box, usually the same as the end
3135 * layout for the animation, but could be used to start another transition.
3137 * @param start_layout The layout function that will be used to start the animation
3138 * @param start_layout_data The data to be passed the @p start_layout function
3139 * @param start_layout_free_data Function to free @p start_layout_data
3140 * @param end_layout The layout function that will be used to end the animation
3141 * @param end_layout_free_data The data to be passed the @p end_layout function
3142 * @param end_layout_free_data Function to free @p end_layout_data
3143 * @param transition_end_cb Callback function called when animation ends
3144 * @param transition_end_data Data to be passed to @p transition_end_cb
3145 * @return An instance of ::Elm_Box_Transition
3147 * @see elm_box_transition_new
3148 * @see elm_box_layout_transition
3150 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);
3152 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
3154 * This function is mostly useful as the @c free_data parameter in
3155 * elm_box_layout_set() when elm_box_layout_transition().
3157 * @param data The Elm_Box_Transition instance to be freed.
3159 * @see elm_box_transition_new
3160 * @see elm_box_layout_transition
3162 EAPI void elm_box_transition_free(void *data);
3169 * @defgroup Button Button
3171 * @image html widget/button/preview-00.png
3172 * @image html widget/button/preview-01.png
3173 * @image html widget/button/preview-02.png
3175 * This is a push-button. Press it and run some function. It can contain
3176 * a simple label and icon object and it also has an autorepeat feature.
3178 * This widgets emits the following signals:
3179 * @li "clicked": the user clicked the button (press/release).
3180 * @li "repeated": the user pressed the button without releasing it.
3181 * @li "pressed": button was pressed.
3182 * @li "unpressed": button was released after being pressed.
3183 * In all three cases, the @c event parameter of the callback will be
3186 * Also, defined in the default theme, the button has the following styles
3188 * @li default: a normal button.
3189 * @li anchor: Like default, but the button fades away when the mouse is not
3190 * over it, leaving only the text or icon.
3191 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
3192 * continuous look across its options.
3193 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
3195 * Follow through a complete example @ref button_example_01 "here".
3201 UIControlStateDefault,
3202 UIControlStateHighlighted,
3203 UIControlStateDisabled,
3204 UIControlStateFocused,
3205 UIControlStateReserved
3209 * Add a new button to the parent's canvas
3211 * @param parent The parent object
3212 * @return The new object or NULL if it cannot be created
3214 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3216 * Set the label used in the button
3218 * The passed @p label can be NULL to clean any existing text in it and
3219 * leave the button as an icon only object.
3221 * @param obj The button object
3222 * @param label The text will be written on the button
3223 * @deprecated use elm_object_text_set() instead.
3225 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3227 * Get the label set for the button
3229 * The string returned is an internal pointer and should not be freed or
3230 * altered. It will also become invalid when the button is destroyed.
3231 * The string returned, if not NULL, is a stringshare, so if you need to
3232 * keep it around even after the button is destroyed, you can use
3233 * eina_stringshare_ref().
3235 * @param obj The button object
3236 * @return The text set to the label, or NULL if nothing is set
3237 * @deprecated use elm_object_text_set() instead.
3239 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3241 * Set the label for each state of button
3243 * The passed @p label can be NULL to clean any existing text in it and
3244 * leave the button as an icon only object for the state.
3246 * @param obj The button object
3247 * @param label The text will be written on the button
3248 * @param state The state of button
3252 EINA_DEPRECATED EAPI void elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlState state) EINA_ARG_NONNULL(1);
3254 * Get the label of button for each state
3256 * The string returned is an internal pointer and should not be freed or
3257 * altered. It will also become invalid when the button is destroyed.
3258 * The string returned, if not NULL, is a stringshare, so if you need to
3259 * keep it around even after the button is destroyed, you can use
3260 * eina_stringshare_ref().
3262 * @param obj The button object
3263 * @param state The state of button
3264 * @return The title of button for state
3268 EINA_DEPRECATED EAPI const char *elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) EINA_ARG_NONNULL(1);
3270 * Set the icon used for the button
3272 * Setting a new icon will delete any other that was previously set, making
3273 * any reference to them invalid. If you need to maintain the previous
3274 * object alive, unset it first with elm_button_icon_unset().
3276 * @param obj The button object
3277 * @param icon The icon object for the button
3279 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3281 * Get the icon used for the button
3283 * Return the icon object which is set for this widget. If the button is
3284 * destroyed or another icon is set, the returned object will be deleted
3285 * and any reference to it will be invalid.
3287 * @param obj The button object
3288 * @return The icon object that is being used
3290 * @see elm_button_icon_unset()
3292 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3294 * Remove the icon set without deleting it and return the object
3296 * This function drops the reference the button holds of the icon object
3297 * and returns this last object. It is used in case you want to remove any
3298 * icon, or set another one, without deleting the actual object. The button
3299 * will be left without an icon set.
3301 * @param obj The button object
3302 * @return The icon object that was being used
3304 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3306 * Turn on/off the autorepeat event generated when the button is kept pressed
3308 * When off, no autorepeat is performed and buttons emit a normal @c clicked
3309 * signal when they are clicked.
3311 * When on, keeping a button pressed will continuously emit a @c repeated
3312 * signal until the button is released. The time it takes until it starts
3313 * emitting the signal is given by
3314 * elm_button_autorepeat_initial_timeout_set(), and the time between each
3315 * new emission by elm_button_autorepeat_gap_timeout_set().
3317 * @param obj The button object
3318 * @param on A bool to turn on/off the event
3320 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
3322 * Get whether the autorepeat feature is enabled
3324 * @param obj The button object
3325 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
3327 * @see elm_button_autorepeat_set()
3329 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3331 * Set the initial timeout before the autorepeat event is generated
3333 * Sets the timeout, in seconds, since the button is pressed until the
3334 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
3335 * won't be any delay and the even will be fired the moment the button is
3338 * @param obj The button object
3339 * @param t Timeout in seconds
3341 * @see elm_button_autorepeat_set()
3342 * @see elm_button_autorepeat_gap_timeout_set()
3344 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
3346 * Get the initial timeout before the autorepeat event is generated
3348 * @param obj The button object
3349 * @return Timeout in seconds
3351 * @see elm_button_autorepeat_initial_timeout_set()
3353 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3355 * Set the interval between each generated autorepeat event
3357 * After the first @c repeated event is fired, all subsequent ones will
3358 * follow after a delay of @p t seconds for each.
3360 * @param obj The button object
3361 * @param t Interval in seconds
3363 * @see elm_button_autorepeat_initial_timeout_set()
3365 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
3367 * Get the interval between each generated autorepeat event
3369 * @param obj The button object
3370 * @return Interval in seconds
3372 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3378 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3379 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3380 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3381 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3382 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3383 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3384 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3385 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3386 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
3387 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
3388 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
3389 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3390 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3391 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3392 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3393 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3394 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3395 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3396 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3397 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3398 /* available styles:
3402 * hoversel_vertical_entry
3404 /* smart callbacks called:
3405 * "file,chosen" - the user has selected a path, whose string pointer comes
3409 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3410 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3411 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3412 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3413 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3414 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3415 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3416 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3417 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
3418 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
3419 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
3420 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3421 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3422 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3423 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3424 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3425 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3426 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3427 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3428 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3429 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
3430 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3432 /* scroller policy */
3433 typedef enum _Elm_Scroller_Policy
3435 ELM_SCROLLER_POLICY_AUTO = 0,
3436 ELM_SCROLLER_POLICY_ON,
3437 ELM_SCROLLER_POLICY_OFF,
3438 ELM_SCROLLER_POLICY_LAST
3439 } Elm_Scroller_Policy;
3441 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3442 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
3443 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3444 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3445 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
3446 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
3447 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);
3448 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
3449 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
3450 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);
3451 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
3452 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
3453 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
3454 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
3455 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
3456 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);
3457 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
3458 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
3459 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
3460 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
3461 EINA_DEPRECATED EAPI void elm_scroller_page_move_set(Evas_Object *obj, Eina_Bool set);
3462 /* smart callbacks called:
3463 * "edge,left" - the left edge of the content has been reached
3464 * "edge,right" - the right edge of the content has been reached
3465 * "edge,top" - the top edge of the content has been reached
3466 * "edge,bottom" - the bottom edge of the content has been reached
3467 * "scroll" - the content has been scrolled (moved)
3468 * "scroll,anim,start" - scrolling animation has started
3469 * "scroll,anim,stop" - scrolling animation has stopped
3470 * "scroll,drag,start" - dragging the contents around has started
3471 * "scroll,drag,stop" - dragging the contents around has stopped
3475 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3476 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 */
3477 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
3478 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
3479 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3480 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
3481 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3482 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
3483 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3484 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
3485 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);
3486 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
3487 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);
3488 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
3489 EINA_DEPRECATED EAPI void elm_label_wrap_mode_set(Evas_Object *obj, Eina_Bool wrapmode) EINA_ARG_NONNULL(1);
3490 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
3491 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
3492 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
3493 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
3494 /* available styles:
3498 /* smart callbacks called:
3502 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3503 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3504 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3505 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3506 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3507 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3508 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
3509 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
3510 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
3511 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3512 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
3513 /* smart callbacks called:
3514 * "changed" - Whenever the toggle value has been changed. Is not called
3515 * until the toggle is released by the cursor (assuming it has been triggered
3516 * by the cursor in the first place).
3520 * @page tutorial_frame Frame example
3521 * @dontinclude frame_example_01.c
3523 * In this example we are going to create 4 Frames with different styles and
3524 * add a rectangle of different color in each.
3526 * We start we the usual setup code:
3529 * And then create one rectangle:
3532 * To add it in our first frame, which since it doesn't have it's style
3533 * specifically set uses the default style:
3536 * And then create another rectangle:
3539 * To add it in our second frame, which uses the "pad_small" style, note that
3540 * even tough we are setting a text for this frame it won't be show, only the
3541 * default style shows the Frame's title:
3543 * @note The "pad_small", "pad_medium", "pad_large" and "pad_huge" styles are
3544 * very similar, their only difference is the size of the empty area around
3545 * the content of the frame.
3547 * And then create yet another rectangle:
3550 * To add it in our third frame, which uses the "outdent_top" style, note
3551 * that even tough we are setting a text for this frame it won't be show,
3552 * only the default style shows the Frame's title:
3555 * And then create one last rectangle:
3558 * To add it in our fourth and final frame, which uses the "outdent_bottom"
3559 * style, note that even tough we are setting a text for this frame it won't
3560 * be show, only the default style shows the Frame's title:
3563 * And now we are left with just some more setup code:
3566 * Our example will look like this:
3567 * @image html screenshots/frame_example_01.png
3568 * @image latex screenshots/frame_example_01.eps
3570 * @example frame_example_01.c
3573 * @defgroup Frame Frame
3575 * @brief Frame is a widget that holds some content and has a title.
3577 * The default look is a frame with a title, but Frame supports multple
3585 * @li outdent_bottom
3587 * Of all this styles only default shows the title. Frame emits no signals.
3589 * For a detailed example see the @ref tutorial_frame.
3594 * @brief Add a new frame to the parent
3596 * @param parent The parent object
3597 * @return The new object or NULL if it cannot be created
3599 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3601 * @brief Set the frame label
3603 * @param obj The frame object
3604 * @param label The label of this frame object
3606 * @deprecated use elm_object_text_set() instead.
3608 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3610 * @brief Get the frame label
3612 * @param obj The frame object
3614 * @return The label of this frame objet or NULL if unable to get frame
3616 * @deprecated use elm_object_text_get() instead.
3618 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3620 * @brief Set the content of the frame widget
3622 * Once the content object is set, a previously set one will be deleted.
3623 * If you want to keep that old content object, use the
3624 * elm_frame_content_unset() function.
3626 * @param obj The frame object
3627 * @param content The content will be filled in this frame object
3629 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
3631 * @brief Get the content of the frame widget
3633 * Return the content object which is set for this widget
3635 * @param obj The frame object
3636 * @return The content that is being used
3638 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3640 * @brief Unset the content of the frame widget
3642 * Unparent and return the content object which was set for this widget
3644 * @param obj The frame object
3645 * @return The content that was being used
3647 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3653 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3654 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
3655 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3656 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
3657 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3658 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
3659 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
3660 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
3661 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3662 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
3663 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
3664 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
3667 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class;
3668 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func;
3669 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Item of Elm_Gengrid. Sub-type of Elm_Widget_Item */
3670 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
3671 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
3672 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
3673 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj);
3675 struct _Elm_Gengrid_Item_Class
3677 const char *item_style;
3678 struct _Elm_Gengrid_Item_Class_Func
3680 GridItemLabelGetFunc label_get;
3681 GridItemIconGetFunc icon_get;
3682 GridItemStateGetFunc state_get;
3683 GridItemDelFunc del;
3687 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3688 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
3689 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
3690 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
3691 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
3693 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
3694 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3695 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
3696 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3697 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
3698 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3699 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
3700 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3701 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
3702 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
3703 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
3704 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
3705 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
3706 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
3707 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3709 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3710 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3712 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3713 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3714 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3715 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3716 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3717 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3718 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
3719 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3720 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
3721 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
3722 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
3723 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3724 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3725 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3726 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3727 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
3728 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3730 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
3731 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);
3732 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3733 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
3734 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3735 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
3736 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3737 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3738 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
3739 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3740 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
3741 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3743 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3744 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3745 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3747 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);
3748 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);
3749 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);
3750 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);
3751 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);
3752 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);
3753 /* smart callbacks called:
3755 * selected - User has selected an item.
3756 * unselected - User has unselected an item.
3757 * clicked,double - User has double-clicked or pressed enter on an item.
3758 * realized - An evas object for an item was built.
3759 * unrealized - An evas object for an item was deleted.
3760 * changed - An item has been added, removed, resized or moved,
3761 * or gengrid has been resized or horizontal property has been changed.
3762 * scroll - the content has been scrolled (moved).
3763 * "scroll,anim,start" - This is called when scrolling animation has started.
3764 * "scroll,anim,stop" - This is called when scrolling animation has stopped.
3765 * "scroll,drag,start" - dragging the contents around has started.
3766 * "scroll,drag,stop" - dragging the contents around has stopped.
3767 * drag - Gengrid is being dragged.
3768 * "drag,start,up" - Gengrid has been dragged (not scrolled) up.
3769 * "drag,start,down" - Gengrid has been dragged (not scrolled) down.
3770 * "drag,start,left" - Gengrid has been dragged (not scrolled) left.
3771 * "drag,start,rigth" - Gengrid has been dragged (nto scrolled) right.
3772 * "drag,stop" - Gengrid is not being dragged.
3776 * @defgroup Clock Clock
3778 * This is a @b digital clock widget. In its default theme, it has a
3779 * vintage "flipping numbers clock" appearance, which will animate
3780 * sheets of individual algarisms individually as time goes by.
3782 * A newly created clock will fetch system's time (already
3783 * considering local time adjustments) to start with, and will tick
3784 * accondingly. It may or may not show seconds.
3786 * Clocks have an @b edition mode. When in it, the sheets will
3787 * display extra arrow indications on the top and bottom and the
3788 * user may click on them to raise or lower the time values. After
3789 * it's told to exit edition mode, it will keep ticking with that
3790 * new time set (it keeps the difference from local time).
3792 * Also, when under edition mode, user clicks on the cited arrows
3793 * which are @b held for some time will make the clock to flip the
3794 * sheet, thus editing the time, continuosly and automatically for
3795 * the user. The interval between sheet flips will keep growing in
3796 * time, so that it helps the user to reach a time which is distant
3799 * The time display is, by default, in military mode (24h), but an
3800 * am/pm indicator may be optionally shown, too, when it will
3803 * Smart callbacks one can register to:
3804 * - "changed" - the clock's user changed the time
3806 * Here is an example on its usage:
3807 * @li @ref clock_example
3816 * Identifiers for which clock digits should be editable, when a
3817 * clock widget is in edition mode. Values may be ORed together to
3818 * make a mask, naturally.
3820 * @see elm_clock_edit_set()
3821 * @see elm_clock_digit_edit_set()
3823 typedef enum _Elm_Clock_Digedit
3825 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
3826 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
3827 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
3828 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
3829 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
3830 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
3831 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
3832 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
3833 } Elm_Clock_Digedit;
3836 * Add a new clock widget to the given parent Elementary
3837 * (container) object
3839 * @param parent The parent object
3840 * @return a new clock widget handle or @c NULL, on errors
3842 * This function inserts a new clock widget on the canvas.
3846 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3849 * Set a clock widget's time, programmatically
3851 * @param obj The clock widget object
3852 * @param hrs The hours to set
3853 * @param min The minutes to set
3854 * @param sec The secondes to set
3856 * This function updates the time that is showed by the clock
3859 * Values @b must be set within the following ranges:
3860 * - 0 - 23, for hours
3861 * - 0 - 59, for minutes
3862 * - 0 - 59, for seconds,
3864 * even if the clock is not in "military" mode.
3866 * @warning The behavior for values set out of those ranges is @b
3871 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
3874 * Get a clock widget's time values
3876 * @param obj The clock object
3877 * @param[out] hrs Pointer to the variable to get the hours value
3878 * @param[out] min Pointer to the variable to get the minutes value
3879 * @param[out] sec Pointer to the variable to get the seconds value
3881 * This function gets the time set for @p obj, returning
3882 * it on the variables passed as the arguments to function
3884 * @note Use @c NULL pointers on the time values you're not
3885 * interested in: they'll be ignored by the function.
3889 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
3892 * Set whether a given clock widget is under <b>edition mode</b> or
3893 * under (default) displaying-only mode.
3895 * @param obj The clock object
3896 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
3897 * put it back to "displaying only" mode
3899 * This function makes a clock's time to be editable or not <b>by
3900 * user interaction</b>. When in edition mode, clocks @b stop
3901 * ticking, until one brings them back to canonical mode. The
3902 * elm_clock_digit_edit_set() function will influence which digits
3903 * of the clock will be editable. By default, all of them will be
3904 * (#ELM_CLOCK_NONE).
3906 * @note am/pm sheets, if being shown, will @b always be editable
3907 * under edition mode.
3909 * @see elm_clock_edit_get()
3913 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
3916 * Retrieve whether a given clock widget is under <b>edition
3917 * mode</b> or under (default) displaying-only mode.
3919 * @param obj The clock object
3920 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
3923 * This function retrieves whether the clock's time can be edited
3924 * or not by user interaction.
3926 * @see elm_clock_edit_set() for more details
3930 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3933 * Set what digits of the given clock widget should be editable
3934 * when in edition mode.
3936 * @param obj The clock object
3937 * @param digedit Bit mask indicating the digits to be editable
3938 * (values in #Elm_Clock_Digedit).
3940 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
3941 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
3944 * @see elm_clock_digit_edit_get()
3948 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
3951 * Retrieve what digits of the given clock widget should be
3952 * editable when in edition mode.
3954 * @param obj The clock object
3955 * @return Bit mask indicating the digits to be editable
3956 * (values in #Elm_Clock_Digedit).
3958 * @see elm_clock_digit_edit_set() for more details
3962 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3965 * Set if the given clock widget must show hours in military or
3968 * @param obj The clock object
3969 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
3972 * This function sets if the clock must show hours in military or
3973 * am/pm mode. In some countries like Brazil the military mode
3974 * (00-24h-format) is used, in opposition to the USA, where the
3975 * am/pm mode is more commonly used.
3977 * @see elm_clock_show_am_pm_get()
3981 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
3984 * Get if the given clock widget shows hours in military or am/pm
3987 * @param obj The clock object
3988 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
3991 * This function gets if the clock shows hours in military or am/pm
3994 * @see elm_clock_show_am_pm_set() for more details
3998 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4001 * Set if the given clock widget must show time with seconds or not
4003 * @param obj The clock object
4004 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
4006 * This function sets if the given clock must show or not elapsed
4007 * seconds. By default, they are @b not shown.
4009 * @see elm_clock_show_seconds_get()
4013 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
4016 * Get whether the given clock widget is showing time with seconds
4019 * @param obj The clock object
4020 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
4022 * This function gets whether @p obj is showing or not the elapsed
4025 * @see elm_clock_show_seconds_set()
4029 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4032 * Set the interval on time updates for an user mouse button hold
4033 * on clock widgets' time edition.
4035 * @param obj The clock object
4036 * @param interval The (first) interval value in seconds
4038 * This interval value is @b decreased while the user holds the
4039 * mouse pointer either incrementing or decrementing a given the
4040 * clock digit's value.
4042 * This helps the user to get to a given time distant from the
4043 * current one easier/faster, as it will start to flip quicker and
4044 * quicker on mouse button holds.
4046 * The calculation for the next flip interval value, starting from
4047 * the one set with this call, is the previous interval divided by
4048 * 1.05, so it decreases a little bit.
4050 * The default starting interval value for automatic flips is
4053 * @see elm_clock_interval_get()
4057 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
4060 * Get the interval on time updates for an user mouse button hold
4061 * on clock widgets' time edition.
4063 * @param obj The clock object
4064 * @return The (first) interval value, in seconds, set on it
4066 * @see elm_clock_interval_set() for more details
4070 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4077 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4078 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4079 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
4080 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
4081 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
4082 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
4083 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
4084 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
4085 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
4086 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
4087 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
4088 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
4089 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
4090 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
4091 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);
4092 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
4093 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
4094 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4095 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
4096 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
4097 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
4098 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
4099 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
4100 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
4101 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
4102 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);
4103 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
4105 * @def elm_layout_icon_set
4106 * Convienience macro to set the icon object in a layout that follows the
4107 * Elementary naming convention for its parts.
4111 #define elm_layout_icon_set(_ly, _obj) \
4114 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
4115 if ((_obj)) sig = "elm,state,icon,visible"; \
4116 else sig = "elm,state,icon,hidden"; \
4117 elm_object_signal_emit((_ly), sig, "elm"); \
4121 * @def elm_layout_icon_get
4122 * Convienience macro to get the icon object from a layout that follows the
4123 * Elementary naming convention for its parts.
4127 #define elm_layout_icon_get(_ly) \
4128 elm_layout_content_get((_ly), "elm.swallow.icon")
4131 * @def elm_layout_end_set
4132 * Convienience macro to set the end object in a layout that follows the
4133 * Elementary naming convention for its parts.
4137 #define elm_layout_end_set(_ly, _obj) \
4140 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
4141 if ((_obj)) sig = "elm,state,end,visible"; \
4142 else sig = "elm,state,end,hidden"; \
4143 elm_object_signal_emit((_ly), sig, "elm"); \
4147 * @def elm_layout_end_get
4148 * Convienience macro to get the end object in a layout that follows the
4149 * Elementary naming convention for its parts.
4153 #define elm_layout_end_get(_ly) \
4154 elm_layout_content_get((_ly), "elm.swallow.end")
4157 * @def elm_layout_label_set
4158 * Convienience macro to set the label in a layout that follows the
4159 * Elementary naming convention for its parts.
4162 * @deprecate use elm_object_text_* instead.
4164 #define elm_layout_label_set(_ly, _txt) \
4165 elm_layout_text_set((_ly), "elm.text", (_txt))
4168 * @def elm_layout_label_get
4169 * Convienience macro to get the label in a layout that follows the
4170 * Elementary naming convention for its parts.
4173 * @deprecate use elm_object_text_* instead.
4175 #define elm_layout_label_get(_ly) \
4176 elm_layout_text_get((_ly), "elm.text")
4178 /* smart callbacks called:
4182 typedef enum _Elm_Notify_Orient
4184 ELM_NOTIFY_ORIENT_TOP,
4185 ELM_NOTIFY_ORIENT_CENTER,
4186 ELM_NOTIFY_ORIENT_BOTTOM,
4187 ELM_NOTIFY_ORIENT_LEFT,
4188 ELM_NOTIFY_ORIENT_RIGHT,
4189 ELM_NOTIFY_ORIENT_TOP_LEFT,
4190 ELM_NOTIFY_ORIENT_TOP_RIGHT,
4191 ELM_NOTIFY_ORIENT_BOTTOM_LEFT,
4192 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT,
4193 ELM_NOTIFY_ORIENT_LAST
4194 } Elm_Notify_Orient;
4195 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4196 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4197 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4198 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4199 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4200 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4201 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
4202 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4203 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
4204 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4205 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
4206 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4207 /* smart callbacks called:
4208 * "timeout" - when timeout happens on notify and it's hidden
4209 * "block,clicked" - when it's hidden by a click outside of the notify's view
4213 typedef enum _Elm_Hover_Axis
4215 ELM_HOVER_AXIS_NONE,
4216 ELM_HOVER_AXIS_HORIZONTAL,
4217 ELM_HOVER_AXIS_VERTICAL,
4220 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4221 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
4222 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4223 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4224 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4225 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
4226 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
4227 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
4228 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
4229 /* available styles:
4235 /* smart callbacks called:
4236 * "clicked" - the user clicked the empty space in the hover to dismiss
4237 * "smart,changed" - a content object placed under the "smart"
4238 * policy was replaced to a new slot direction.
4242 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
4243 struct _Elm_Entry_Anchor_Info
4247 Evas_Coord x, y, w, h;
4249 typedef enum _Elm_Icon_Type
4256 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
4258 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4259 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
4260 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4261 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
4262 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4263 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
4264 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4265 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
4266 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4267 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4268 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
4269 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
4270 EINA_DEPRECATED EAPI void elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
4271 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4272 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
4273 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4274 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
4275 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
4276 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
4277 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
4278 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
4279 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
4280 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
4281 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
4282 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
4283 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
4284 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
4285 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
4286 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4287 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4288 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4289 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);
4290 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
4291 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4292 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
4293 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
4294 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
4295 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4296 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);
4297 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
4298 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4299 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);
4300 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);
4301 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);
4302 EAPI void elm_entry_text_filter_append(Evas_Object *obj, void (*func) (void *data, Evas_Object *entry, char **text), void *data) EINA_ARG_NONNULL(1, 2);
4303 EAPI void elm_entry_text_filter_prepend(Evas_Object *obj, void (*func) (void *data, Evas_Object *entry, char **text), void *data) EINA_ARG_NONNULL(1, 2);
4304 EAPI void elm_entry_text_filter_remove(Evas_Object *obj, void (*func) (void *data, Evas_Object *entry, char **text), void *data) EINA_ARG_NONNULL(1, 2);
4305 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
4306 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
4307 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
4308 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
4309 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
4310 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
4311 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4312 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
4313 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4314 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
4315 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
4316 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
4317 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
4318 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
4319 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
4320 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
4321 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
4322 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
4323 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
4324 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
4325 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
4326 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
4328 /* pre-made filters for entries */
4329 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
4330 struct _Elm_Entry_Filter_Limit_Size
4335 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
4336 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
4337 struct _Elm_Entry_Filter_Accept_Set
4339 const char *accepted;
4340 const char *rejected;
4342 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
4344 * Set the input panel layout of the entry
4346 * @param obj The entry object
4347 * @param layout layout type
4349 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
4351 * Get the input panel layout of the entry
4353 * @param obj The entry object
4354 * @return layout type
4356 * @see elm_entry_input_panel_layout_set
4358 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4360 * Set the autocapitalization type on the immodule.
4362 * @param obj The entry object
4363 * @param autocapital_type The type of autocapitalization
4365 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
4367 * Retrieve the autocapitalization type on the immodule.
4369 * @param obj The entry object
4370 * @return autocapitalization type
4372 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4374 * Sets the attribute to show the input panel automatically.
4376 * @param obj The entry object
4377 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
4379 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4381 * Retrieve the attribute to show the input panel automatically.
4383 * @param obj The entry object
4384 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
4386 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4388 EAPI void elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
4389 EAPI void elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
4390 EAPI void elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
4391 EAPI void elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
4392 EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
4393 EAPI void elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
4394 EAPI void elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
4396 EINA_DEPRECATED EAPI void elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
4397 EINA_DEPRECATED EAPI Evas_Coord elm_entry_wrap_width_get(const Evas_Object *obj);
4398 EINA_DEPRECATED EAPI void elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
4399 EINA_DEPRECATED EAPI void elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
4400 EINA_DEPRECATED EAPI void elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
4402 /* smart callbacks called:
4403 * "changed" - the text content changed
4404 * "selection,start" - the user started selecting text
4405 * "selection,changed" - the user modified the selection size/location
4406 * "selection,cleared" - the user cleared the selection
4407 * "selection,paste" - the user requested a paste of text
4408 * "selection,copy" - the user copied the text
4409 * "selection,cut" - the user cut the text
4410 * "cursor,changed" - the cursor changed position
4411 * "anchor,clicked" - achor called was clicked | event_info = Elm_Entry_Anchor_Info
4412 * "activated" - when the enter key is pressed (useful for single line)
4413 * "press" - when finger/mouse is pressed down
4414 * "clicked" - when finger/mouse is pressed and released (without a drag etc.)
4415 * "clicked,double" - when finger/mouse is double-pressed
4416 * "longpressed" - the entry has been longpressed
4417 * "focused" - the entry has received keyboard focus
4418 * "unfocused" - keyboard focus is gone
4421 /* composite widgets - these basically put together basic widgets above
4422 * in convenient packages that do more than basic stuff */
4426 * @defgroup Anchorview Anchorview
4428 * Anchorview is for displaying text that contains markup with anchors
4429 * like <c>\<a href=1234\>something\</\></c> in it.
4431 * Besides being styled differently, the anchorview widget provides the
4432 * necessary functionality so that clicking on these anchors brings up a
4433 * popup with user defined content such as "call", "add to contacts" or
4434 * "open web page". This popup is provided using the @ref Hover widget.
4436 * This widget is very similar to @ref Anchorblock, so refer to that
4437 * widget for an example. The only difference Anchorview has is that the
4438 * widget is already provided with scrolling functionality, so if the
4439 * text set to it is too large to fit in the given space, it will scroll,
4440 * whereas the @ref Anchorblock widget will keep growing to ensure all the
4441 * text can be displayed.
4443 * This widget emits the following signals:
4444 * @li "anchor,clicked": will be called when an anchor is clicked. The
4445 * @p event_info parameter on the callback will be a pointer of type
4446 * ::Elm_Entry_Anchorview_Info.
4448 * See @ref Anchorblock for an example on how to use both of them.
4457 * @typedef Elm_Entry_Anchorview_Info
4459 * The info sent in the callback for "anchor,clicked" signals emitted by
4460 * the Anchorview widget.
4462 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
4464 * @struct _Elm_Entry_Anchorview_Info
4466 * The info sent in the callback for "anchor,clicked" signals emitted by
4467 * the Anchorview widget.
4469 struct _Elm_Entry_Anchorview_Info
4471 const char *name; /**< Name of the anchor, as indicated in its href
4473 int button; /**< The mouse button used to click on it */
4474 Evas_Object *hover; /**< The hover object to use for the popup */
4476 Evas_Coord x, y, w, h;
4477 } anchor, /**< Geometry selection of text used as anchor */
4478 hover_parent; /**< Geometry of the object used as parent by the
4480 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
4481 for content on the left side of
4482 the hover. Before calling the
4483 callback, the widget will make the
4484 necessary calculations to check
4485 which sides are fit to be set with
4486 content, based on the position the
4487 hover is activated and its distance
4488 to the edges of its parent object
4490 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
4491 the right side of the hover.
4492 See @ref hover_left */
4493 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
4494 of the hover. See @ref hover_left */
4495 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
4496 below the hover. See @ref
4500 * Add a new Anchorview object
4502 * @param parent The parent object
4503 * @return The new object or NULL if it cannot be created
4505 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4507 * Set the text to show in the anchorview
4509 * Sets the text of the anchorview to @p text. This text can include markup
4510 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
4511 * text that will be specially styled and react to click events, ended with
4512 * either of \</a\> or \</\>. When clicked, the anchor will emit an
4513 * "anchor,clicked" signal that you can attach a callback to with
4514 * evas_object_smart_callback_add(). The name of the anchor given in the
4515 * event info struct will be the one set in the href attribute, in this
4518 * Other markup can be used to style the text in different ways, but it's
4519 * up to the style defined in the theme which tags do what.
4520 * @deprecated use elm_object_text_set() instead.
4522 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
4524 * Get the markup text set for the anchorview
4526 * Retrieves the text set on the anchorview, with markup tags included.
4528 * @param obj The anchorview object
4529 * @return The markup text set or @c NULL if nothing was set or an error
4531 * @deprecated use elm_object_text_set() instead.
4533 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4535 * Set the parent of the hover popup
4537 * Sets the parent object to use by the hover created by the anchorview
4538 * when an anchor is clicked. See @ref Hover for more details on this.
4539 * If no parent is set, the same anchorview object will be used.
4541 * @param obj The anchorview object
4542 * @param parent The object to use as parent for the hover
4544 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4546 * Get the parent of the hover popup
4548 * Get the object used as parent for the hover created by the anchorview
4549 * widget. See @ref Hover for more details on this.
4551 * @param obj The anchorview object
4552 * @return The object used as parent for the hover, NULL if none is set.
4554 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4556 * Set the style that the hover should use
4558 * When creating the popup hover, anchorview will request that it's
4559 * themed according to @p style.
4561 * @param obj The anchorview object
4562 * @param style The style to use for the underlying hover
4564 * @see elm_object_style_set()
4566 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4568 * Get the style that the hover should use
4570 * Get the style the hover created by anchorview will use.
4572 * @param obj The anchorview object
4573 * @return The style to use by the hover. NULL means the default is used.
4575 * @see elm_object_style_set()
4577 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4579 * Ends the hover popup in the anchorview
4581 * When an anchor is clicked, the anchorview widget will create a hover
4582 * object to use as a popup with user provided content. This function
4583 * terminates this popup, returning the anchorview to its normal state.
4585 * @param obj The anchorview object
4587 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
4589 * Set bouncing behaviour when the scrolled content reaches an edge
4591 * Tell the internal scroller object whether it should bounce or not
4592 * when it reaches the respective edges for each axis.
4594 * @param obj The anchorview object
4595 * @param h_bounce Whether to bounce or not in the horizontal axis
4596 * @param v_bounce Whether to bounce or not in the vertical axis
4598 * @see elm_scroller_bounce_set()
4600 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
4602 * Get the set bouncing behaviour of the internal scroller
4604 * Get whether the internal scroller should bounce when the edge of each
4605 * axis is reached scrolling.
4607 * @param obj The anchorview object
4608 * @param h_bounce Pointer where to store the bounce state of the horizontal
4610 * @param v_bounce Pointer where to store the bounce state of the vertical
4613 * @see elm_scroller_bounce_get()
4615 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
4617 * Appends a custom item provider to the given anchorview
4619 * Appends the given function to the list of items providers. This list is
4620 * called, one function at a time, with the given @p data pointer, the
4621 * anchorview object and, in the @p item parameter, the item name as
4622 * referenced in its href string. Following functions in the list will be
4623 * called in order until one of them returns something different to NULL,
4624 * which should be an Evas_Object which will be used in place of the item
4627 * Items in the markup text take the form \<item relsize=16x16 vsize=full
4628 * href=item/name\>\</item\>
4630 * @param obj The anchorview object
4631 * @param func The function to add to the list of providers
4632 * @param data User data that will be passed to the callback function
4634 * @see elm_entry_item_provider_append()
4636 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);
4638 * Prepend a custom item provider to the given anchorview
4640 * Like elm_anchorview_item_provider_append(), but it adds the function
4641 * @p func to the beginning of the list, instead of the end.
4643 * @param obj The anchorview object
4644 * @param func The function to add to the list of providers
4645 * @param data User data that will be passed to the callback function
4647 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);
4649 * Remove a custom item provider from the list of the given anchorview
4651 * Removes the function and data pairing that matches @p func and @p data.
4652 * That is, unless the same function and same user data are given, the
4653 * function will not be removed from the list. This allows us to add the
4654 * same callback several times, with different @p data pointers and be
4655 * able to remove them later without conflicts.
4657 * @param obj The anchorview object
4658 * @param func The function to remove from the list
4659 * @param data The data matching the function to remove from the list
4661 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);
4668 * @defgroup Anchorblock Anchorblock
4670 * Anchorblock is for displaying text that contains markup with anchors
4671 * like <c>\<a href=1234\>something\</\></c> in it.
4673 * Besides being styled differently, the anchorblock widget provides the
4674 * necessary functionality so that clicking on these anchors brings up a
4675 * popup with user defined content such as "call", "add to contacts" or
4676 * "open web page". This popup is provided using the @ref Hover widget.
4678 * This widget emits the following signals:
4679 * @li "anchor,clicked": will be called when an anchor is clicked. The
4680 * @p event_info parameter on the callback will be a pointer of type
4681 * ::Elm_Entry_Anchorblock_Info.
4687 * Since examples are usually better than plain words, we might as well
4688 * try @ref tutorial_anchorblock_example "one".
4691 * @page tutorial_anchorblock_example Anchorblock/Anchorview example
4692 * This exampel will show both Anchorblock and @ref Anchorview,
4693 * since both are very similar and it's easier to show them once and side
4694 * by side, so the difference is more clear.
4696 * We'll show the relevant snippets of the code here, but the full example
4697 * can be found here... sorry, @ref anchorblock_example_01.c "here".
4699 * As for the actual example, it's just a simple window with an anchorblock
4700 * and an anchorview, both containing the same text. After including
4701 * Elementary.h and declaring some functions we'll need, we jump to our
4702 * elm_main (see ELM_MAIN) and create our window.
4703 * @dontinclude anchorblock_example_01.c
4708 * With the needed variables declared, we'll create the window and a box to
4709 * hold our widgets, but we don't need to go through that here.
4711 * In order to make clear where the anchorblock ends and the anchorview
4712 * begins, they'll be each inside a @ref Frame. After creating the frame,
4713 * the anchorblock follows.
4714 * @skip elm_frame_add
4715 * @until elm_frame_content_set
4717 * Nothing out of the ordinary there. What's worth mentioning is the call
4718 * to elm_anchorblock_hover_parent_set(). We are telling our widget that
4719 * when an anchor is clicked, the hover for the popup will cover the entire
4720 * window. This affects the area that will be obscured by the hover and
4721 * where clicking will dismiss it, as well as the calculations it does to
4722 * inform the best locations where to insert the popups content.
4723 * Other than that, the code is pretty standard. We also need to set our
4724 * callback for when an anchor is clicked, since it's our task to populate
4725 * the popup. There's no default for it.
4727 * The anchorview is no different, we only change a few things so it looks
4729 * @until elm_frame_content_set
4731 * Then we run, so stuff works and close our main function in the usual way.
4734 * Now, a little note. Normally you would use either one of anchorblock or
4735 * anchorview, set your one callback to clicks and do your stuff in there.
4736 * In this example, however, there are a few tricks to make it easier to
4737 * show both widgets in one go (and to save me some typing). So we have
4738 * two callbacks, one per widget, that will call a common function to do
4739 * the rest. The trick is using ::Elm_Entry_Anchorblock_Info for the
4740 * anchorview too, since both are equal, and passing a callback to use
4741 * for our buttons to end the hover, because each widget has a different
4743 * @until _anchorview_clicked_cb
4746 * The meat of our popup is in the following function. We check what kind
4747 * of menu we need to show, based on the name set to the anchor in the
4748 * markup text. If there's no type (something went wrong, no valid contact
4749 * in the address list) we are just putting a button that does nothing, but
4750 * it's perfectly reasonable to just end the hover and call it quits.
4752 * Our popup will consist of one main button in the middle of our hover,
4753 * and possibly a secondary button and a list of other options. We'll create
4754 * first our main button and check what kind of popup we need afterwards.
4757 * @until eina_stringshare_add
4760 * Each button has two callbacks, one is our hack to close the hover
4761 * properly based on which widget it belongs to, the other a simple
4762 * printf that will show the action with the anchors own data. This is
4763 * not how you would usually do it. Instead, the common case is to have
4764 * one callback for the button that will know which function to call to end
4765 * things, but since we are doing it this way it's worth noting that
4766 * smart callbacks will be called in reverse in respect to the order they
4767 * were added, and since our @c btn_end_cb will close the hover, and thus
4768 * delete our buttons, the other callback wouldn't be called if we had
4771 * After our telephone popup, there are a few others that are practically
4772 * the same, so they won't be shown here.
4774 * Once we are done with that, it's time to place our actions into our
4775 * hover. Main button goes in the middle without much questioning, and then
4776 * we see if we have a secondary button and a box of extra options.
4777 * Because I said so, secondary button goes on either side and box of
4778 * options either on top or below the main one, but to choose which
4779 * exactly, we use the hints our callback info has, which saves us from
4780 * having to do the math and see which side has more space available, with
4781 * a little special case where we delete our extra stuff if there's nowhere
4785 * @skip evas_object_smart
4786 * @until evas_object_del(box)
4790 * The example will look like this:
4791 * @image html screenshots/anchorblock_01.png
4792 * @image latex screenshots/anchorblock_01.eps
4794 * @example anchorblock_example_01.c
4797 * @addtogroup Anchorblock
4801 * @typedef Elm_Entry_Anchorblock_Info
4803 * The info sent in the callback for "anchor,clicked" signals emitted by
4804 * the Anchorblock widget.
4806 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
4808 * @struct _Elm_Entry_Anchorblock_Info
4810 * The info sent in the callback for "anchor,clicked" signals emitted by
4811 * the Anchorblock widget.
4813 struct _Elm_Entry_Anchorblock_Info
4815 const char *name; /**< Name of the anchor, as indicated in its href
4817 int button; /**< The mouse button used to click on it */
4818 Evas_Object *hover; /**< The hover object to use for the popup */
4820 Evas_Coord x, y, w, h;
4821 } anchor, /**< Geometry selection of text used as anchor */
4822 hover_parent; /**< Geometry of the object used as parent by the
4824 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
4825 for content on the left side of
4826 the hover. Before calling the
4827 callback, the widget will make the
4828 necessary calculations to check
4829 which sides are fit to be set with
4830 content, based on the position the
4831 hover is activated and its distance
4832 to the edges of its parent object
4834 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
4835 the right side of the hover.
4836 See @ref hover_left */
4837 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
4838 of the hover. See @ref hover_left */
4839 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
4840 below the hover. See @ref
4844 * Add a new Anchorblock object
4846 * @param parent The parent object
4847 * @return The new object or NULL if it cannot be created
4849 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4851 * Set the text to show in the anchorblock
4853 * Sets the text of the anchorblock to @p text. This text can include markup
4854 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
4855 * of text that will be specially styled and react to click events, ended
4856 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
4857 * "anchor,clicked" signal that you can attach a callback to with
4858 * evas_object_smart_callback_add(). The name of the anchor given in the
4859 * event info struct will be the one set in the href attribute, in this
4862 * Other markup can be used to style the text in different ways, but it's
4863 * up to the style defined in the theme which tags do what.
4864 * @deprecated use elm_object_text_set() instead.
4866 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
4868 * Get the markup text set for the anchorblock
4870 * Retrieves the text set on the anchorblock, with markup tags included.
4872 * @param obj The anchorblock object
4873 * @return The markup text set or @c NULL if nothing was set or an error
4875 * @deprecated use elm_object_text_set() instead.
4877 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4879 * Set the parent of the hover popup
4881 * Sets the parent object to use by the hover created by the anchorblock
4882 * when an anchor is clicked. See @ref Hover for more details on this.
4884 * @param obj The anchorblock object
4885 * @param parent The object to use as parent for the hover
4887 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4889 * Get the parent of the hover popup
4891 * Get the object used as parent for the hover created by the anchorblock
4892 * widget. See @ref Hover for more details on this.
4893 * If no parent is set, the same anchorblock object will be used.
4895 * @param obj The anchorblock object
4896 * @return The object used as parent for the hover, NULL if none is set.
4898 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4900 * Set the style that the hover should use
4902 * When creating the popup hover, anchorblock will request that it's
4903 * themed according to @p style.
4905 * @param obj The anchorblock object
4906 * @param style The style to use for the underlying hover
4908 * @see elm_object_style_set()
4910 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4912 * Get the style that the hover should use
4914 * Get the style the hover created by anchorblock will use.
4916 * @param obj The anchorblock object
4917 * @return The style to use by the hover. NULL means the default is used.
4919 * @see elm_object_style_set()
4921 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4923 * Ends the hover popup in the anchorblock
4925 * When an anchor is clicked, the anchorblock widget will create a hover
4926 * object to use as a popup with user provided content. This function
4927 * terminates this popup, returning the anchorblock to its normal state.
4929 * @param obj The anchorblock object
4931 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
4933 * Appends a custom item provider to the given anchorblock
4935 * Appends the given function to the list of items providers. This list is
4936 * called, one function at a time, with the given @p data pointer, the
4937 * anchorblock object and, in the @p item parameter, the item name as
4938 * referenced in its href string. Following functions in the list will be
4939 * called in order until one of them returns something different to NULL,
4940 * which should be an Evas_Object which will be used in place of the item
4943 * Items in the markup text take the form \<item relsize=16x16 vsize=full
4944 * href=item/name\>\</item\>
4946 * @param obj The anchorblock object
4947 * @param func The function to add to the list of providers
4948 * @param data User data that will be passed to the callback function
4950 * @see elm_entry_item_provider_append()
4952 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);
4954 * Prepend a custom item provider to the given anchorblock
4956 * Like elm_anchorblock_item_provider_append(), but it adds the function
4957 * @p func to the beginning of the list, instead of the end.
4959 * @param obj The anchorblock object
4960 * @param func The function to add to the list of providers
4961 * @param data User data that will be passed to the callback function
4963 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);
4965 * Remove a custom item provider from the list of the given anchorblock
4967 * Removes the function and data pairing that matches @p func and @p data.
4968 * That is, unless the same function and same user data are given, the
4969 * function will not be removed from the list. This allows us to add the
4970 * same callback several times, with different @p data pointers and be
4971 * able to remove them later without conflicts.
4973 * @param obj The anchorblock object
4974 * @param func The function to remove from the list
4975 * @param data The data matching the function to remove from the list
4977 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);
4983 * @defgroup Bubble Bubble
4985 * @brief The Bubble is a widget to show text similarly to how speech is
4986 * represented in comics.
4988 * The bubble widget contains 5 important visual elements:
4989 * @li The frame is a rectangle with rounded rectangles and an "arrow".
4990 * @li The @p icon is an image to which the frame's arrow points to.
4991 * @li The @p label is a text which appears to the right of the icon if the
4992 * corner is "top_left" or "bottom_left" and is right aligned to the frame
4994 * @li The @p info is a text which appears to the right of the label. Info's
4995 * font is of a ligther color than label.
4996 * @li The @p content is an evas object that is shown inside the frame.
4998 * The position of the arrow, icon, label and info depends on which corner is
4999 * selected. The four available corners are:
5000 * @li "top_left" - Default
5003 * @li "bottom_right"
5005 * Signals that you can add callbacks for are:
5006 * @li "clicked" - This is called when a user has clicked the bubble.
5008 * For an example of using a buble see @ref bubble_01_example_page "this".
5013 * Add a new bubble to the parent
5015 * @param parent The parent object
5016 * @return The new object or NULL if it cannot be created
5018 * This function adds a text bubble to the given parent evas object.
5020 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5022 * Set the label of the bubble
5024 * @param obj The bubble object
5025 * @param label The string to set in the label
5027 * This function sets the title of the bubble. Where this appears depends on
5028 * the selected corner.
5029 * @deprecated use elm_object_text_set() instead.
5031 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5033 * Get the label of the bubble
5035 * @param obj The bubble object
5036 * @return The string of set in the label
5038 * This function gets the title of the bubble.
5039 * @deprecated use elm_object_text_set() instead.
5041 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5043 * Set the info of the bubble
5045 * @param obj The bubble object
5046 * @param info The given info about the bubble
5048 * This function sets the info of the bubble. Where this appears depends on
5049 * the selected corner.
5050 * @deprecated use elm_object_text_set() instead.
5052 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
5054 * Get the info of the bubble
5056 * @param obj The bubble object
5058 * @return The "info" string of the bubble
5060 * This function gets the info text.
5061 * @deprecated use elm_object_text_set() instead.
5063 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5065 * Set the content to be shown in the bubble
5067 * Once the content object is set, a previously set one will be deleted.
5068 * If you want to keep the old content object, use the
5069 * elm_bubble_content_unset() function.
5071 * @param obj The bubble object
5072 * @param content The given content of the bubble
5074 * This function sets the content shown on the middle of the bubble.
5076 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5078 * Get the content shown in the bubble
5080 * Return the content object which is set for this widget.
5082 * @param obj The bubble object
5083 * @return The content that is being used
5085 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5087 * Unset the content shown in the bubble
5089 * Unparent and return the content object which was set for this widget.
5091 * @param obj The bubble object
5092 * @return The content that was being used
5094 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5096 * Set the icon of the bubble
5098 * Once the icon object is set, a previously set one will be deleted.
5099 * If you want to keep the old content object, use the
5100 * elm_icon_content_unset() function.
5102 * @param obj The bubble object
5103 * @param icon The given icon for the bubble
5105 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5107 * Get the icon of the bubble
5109 * @param obj The bubble object
5110 * @return The icon for the bubble
5112 * This function gets the icon shown on the top left of bubble.
5114 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5116 * Unset the icon of the bubble
5118 * Unparent and return the icon object which was set for this widget.
5120 * @param obj The bubble object
5121 * @return The icon that was being used
5123 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5125 * Set the corner of the bubble
5127 * @param obj The bubble object.
5128 * @param corner The given corner for the bubble.
5130 * This function sets the corner of the bubble. The corner will be used to
5131 * determine where the arrow in the frame points to and where label, icon and
5134 * Possible values for corner are:
5135 * @li "top_left" - Default
5138 * @li "bottom_right"
5140 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
5142 * Get the corner of the bubble
5144 * @param obj The bubble object.
5145 * @return The given corner for the bubble.
5147 * This function gets the selected corner of the bubble.
5149 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5151 EINA_DEPRECATED EAPI void elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
5152 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5159 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5160 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
5161 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5162 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
5163 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5164 /* smart callbacks called:
5165 * "clicked" - the user clicked the icon
5166 * "drag,start" - Someone started dragging the image out of the object
5167 * "drag,end" - Dragged item was dropped (somewhere)
5171 /** @defgroup Elm_Gesture_Layer Gesture Layer */
5173 * @enum _Elm_Gesture_Types
5174 * Emum of supported gesture types.
5175 * @ingroup Elm_Gesture_Layer
5177 enum _Elm_Gesture_Types
5179 ELM_GESTURE_FIRST = 0,
5181 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
5182 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
5183 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
5184 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
5186 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
5188 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
5189 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
5191 ELM_GESTURE_ZOOM, /**< Zoom */
5192 ELM_GESTURE_ROTATE, /**< Rotate */
5198 * @typedef Elm_Gesture_Types
5199 * Type for Emum of supported gesture types.
5200 * @ingroup Elm_Gesture_Layer
5202 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
5205 * @enum _Elm_Gesture_State
5206 * Emum of gesture states.
5207 * @ingroup Elm_Gesture_Layer
5209 enum _Elm_Gesture_State
5211 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
5212 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
5213 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
5214 ELM_GESTURE_STATE_END, /**< Gesture completed */
5215 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
5218 * @typedef Elm_Gesture_State
5220 * @ingroup Elm_Gesture_Layer
5222 typedef enum _Elm_Gesture_State Elm_Gesture_State;
5225 * @struct _Elm_Gesture_Taps_Info
5226 * Struct holds taps info for user
5227 * @ingroup Elm_Gesture_Layer
5229 struct _Elm_Gesture_Taps_Info
5231 Evas_Coord x, y; /**< Holds center point between fingers */
5232 unsigned int n; /**< Number of fingers tapped */
5233 unsigned int timestamp; /**< event timestamp */
5237 * @typedef Elm_Gesture_Taps_Info
5238 * holds taps info for user
5239 * @ingroup Elm_Gesture_Layer
5241 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
5244 * @struct _Elm_Gesture_Momentum_Info
5245 * Struct holds momentum info for user
5246 * x1 and y1 are not necessarily in sync
5247 * x1 holds x value of x direction starting point
5248 * and same holds for y1.
5249 * This is noticeable when doing V-shape movement
5250 * @ingroup Elm_Gesture_Layer
5252 struct _Elm_Gesture_Momentum_Info
5253 { /* Report line ends, timestamps, and momentum computed */
5254 Evas_Coord x1; /**< Final-swipe direction starting point on X */
5255 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
5256 Evas_Coord x2; /**< Final-swipe direction ending point on X */
5257 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
5259 unsigned int tx; /**< Timestamp of start of final x-swipe */
5260 unsigned int ty; /**< Timestamp of start of final y-swipe */
5262 Evas_Coord mx; /**< Momentum on X */
5263 Evas_Coord my; /**< Momentum on Y */
5265 unsigned int n; /**< Number of fingers */
5269 * @typedef Elm_Gesture_Momentum_Info
5270 * holds momentum info for user
5271 * @ingroup Elm_Gesture_Layer
5273 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
5276 * @struct _Elm_Gesture_Line_Info
5277 * Struct holds line info for user
5278 * @ingroup Elm_Gesture_Layer
5280 struct _Elm_Gesture_Line_Info
5281 { /* Report line ends, timestamps, and momentum computed */
5282 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
5283 /* FIXME should be radians, bot degrees */
5284 double angle; /**< Angle (direction) of lines */
5288 * @typedef _Elm_Gesture_Line_Info
5289 * Holds line info for user
5290 * @ingroup Elm_Gesture_Layer
5292 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
5295 * @struct _Elm_Gesture_Zoom_Info
5296 * Struct holds zoom info for user
5297 * @ingroup Elm_Gesture_Layer
5299 struct _Elm_Gesture_Zoom_Info
5301 Evas_Coord x, y; /**< Holds zoom center point reported to user */
5302 Evas_Coord radius; /**< Holds radius between fingers reported to user */
5303 double zoom; /**< Zoom value: 1.0 means no zoom */
5304 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
5308 * @typedef Elm_Gesture_Zoom_Info
5309 * Holds zoom info for user
5310 * @ingroup Elm_Gesture_Layer
5312 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
5315 * @struct _Elm_Gesture_Rotate_Info
5316 * Struct holds rotation info for user
5317 * @ingroup Elm_Gesture_Layer
5319 struct _Elm_Gesture_Rotate_Info
5321 Evas_Coord x, y; /**< Holds zoom center point reported to user */
5322 Evas_Coord radius; /**< Holds radius between fingers reported to user */
5323 double base_angle; /**< Holds start-angle */
5324 double angle; /**< Rotation value: 0.0 means no rotation */
5325 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
5329 * @typedef Elm_Gesture_Rotate_Info
5330 * Holds rotation info for user
5331 * @ingroup Elm_Gesture_Layer
5333 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
5336 * @typedef Elm_Gesture_Event_Cb
5337 * User callback used to stream gesture info from gesture layer
5338 * @param data user data
5339 * @param event_info gesture report info
5340 * Returns a flag field to be applied on the causing event.
5341 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
5342 * upon the event, in an irreversible way.
5344 * @ingroup Elm_Gesture_Layer
5346 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
5349 * Use function to set callbacks to be notified about
5350 * change of state of gesture.
5351 * When a user registers a callback with this function
5352 * this means this gesture has to be tested.
5354 * When ALL callbacks for a gesture are set to NULL
5355 * it means user isn't interested in gesture-state
5356 * and it will not be tested.
5358 * @param obj Pointer to gesture-layer.
5359 * @param idx The gesture you would like to track its state.
5360 * @param cb callback function pointer.
5361 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
5362 * @param data user info to be sent to callback (usually, Smart Data)
5364 * @ingroup Elm_Gesture_Layer
5366 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);
5369 * Call this function to get repeat-events settings.
5371 * @param obj Pointer to gesture-layer.
5373 * @return repeat events settings.
5374 * @see elm_gesture_layer_hold_events_set()
5375 * @ingroup Elm_Gesture_Layer
5377 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5380 * This function called in order to make gesture-layer repeat events.
5381 * Set this of you like to get the raw events only if gestures were not detected.
5382 * Clear this if you like gesture layer to fwd events as testing gestures.
5384 * @param obj Pointer to gesture-layer.
5385 * @param r Repeat: TRUE/FALSE
5387 * @ingroup Elm_Gesture_Layer
5389 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
5392 * This function sets step-value for zoom action.
5393 * Set step to any positive value.
5394 * Cancel step setting by setting to 0.0
5396 * @param obj Pointer to gesture-layer.
5397 * @param s new zoom step value.
5399 * @ingroup Elm_Gesture_Layer
5401 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
5404 * This function sets step-value for rotate action.
5405 * Set step to any positive value.
5406 * Cancel step setting by setting to 0.0
5408 * @param obj Pointer to gesture-layer.
5409 * @param s new roatate step value.
5411 * @ingroup Elm_Gesture_Layer
5413 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
5416 * This function called to attach gesture-layer to an Evas_Object.
5417 * @param obj Pointer to gesture-layer.
5418 * @param t Pointer to underlying object (AKA Target)
5420 * @return TRUE, FALSE on success, failure.
5422 * @ingroup Elm_Gesture_Layer
5424 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
5427 * Call this function to construct a new gesture-layer object.
5428 * This does not activate the gesture layer. You have to
5429 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
5431 * @param parent the parent object.
5433 * @return Pointer to new gesture-layer object.
5435 * @ingroup Elm_Gesture_Layer
5437 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5440 typedef enum _Elm_Thumb_Animation_Setting
5442 ELM_THUMB_ANIMATION_START = 0, /* Play animation once */
5443 ELM_THUMB_ANIMATION_LOOP, /* Keep playing animation until stop is requested */
5444 ELM_THUMB_ANIMATION_STOP,
5445 ELM_THUMB_ANIMATION_LAST
5446 } Elm_Thumb_Animation_Setting;
5448 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5449 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
5450 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
5451 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
5452 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
5453 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
5454 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5455 EAPI void *elm_thumb_ethumb_client_get(void);
5456 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
5457 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
5458 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5459 /* available styles:
5463 /* smart callbacks called:
5464 * "clicked" - This is called when a user has clicked the thumb without dragging around.
5465 * "clicked,double" - This is called when a user has double-clicked the thumb.
5466 * "press" - This is called when a user has pressed down the thumb.
5467 * "generate,start" - The thumbnail generation started.
5468 * "generate,stop" - The generation process stopped.
5469 * "generate,error" - The generation failed.
5470 * "load,error" - The thumbnail image loading failed.
5474 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5475 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5476 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5477 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
5478 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5479 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5480 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5481 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5482 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5483 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5484 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
5485 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
5486 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5487 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5488 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5489 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);
5490 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
5491 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5492 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
5493 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
5494 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);
5495 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);
5496 /* smart callbacks called:
5497 * "clicked" - the user clicked the hoversel button and popped up the sel
5498 * "selected" - an item in the hoversel list is selected
5499 * "dismissed" - the hover is dismissed
5503 typedef enum _Elm_Toolbar_Shrink_Mode
5505 ELM_TOOLBAR_SHRINK_NONE, /**< set toolbar minimun size to fit all the items */
5506 ELM_TOOLBAR_SHRINK_HIDE, /**< hide excess items */
5507 ELM_TOOLBAR_SHRINK_SCROLL, /**< allow accessing excess items through a scroller */
5508 ELM_TOOLBAR_SHRINK_MENU /**< inserts a button to pop up a menu with excess items */
5509 } Elm_Toolbar_Shrink_Mode;
5511 typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item */
5512 typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /** State of a Elm_Toolbar_Item */
5514 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5515 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
5516 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5517 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5518 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5519 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
5520 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5521 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);
5522 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);
5523 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);
5524 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);
5525 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5526 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5527 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5528 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5529 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5530 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
5531 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5532 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5533 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5534 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
5535 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5536 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
5537 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5538 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5539 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5540 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5541 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
5542 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5543 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5544 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5545 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5546 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
5547 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5548 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
5549 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5550 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5551 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5552 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5553 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5554 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
5555 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5556 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
5557 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5558 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
5559 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5560 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);
5561 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
5562 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
5563 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5564 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5565 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5566 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5567 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
5568 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);
5569 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5570 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
5571 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5572 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
5573 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5574 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5575 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
5576 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5577 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5578 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5579 /* smart callbacks called:
5580 * "clicked" - when the user clicks on a toolbar item and becomes selected
5582 /* available styles:
5584 * transparent (no background or shadow, just show the provided content)
5588 EAPI double elm_tooltip_delay_get(void);
5589 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
5590 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
5591 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
5592 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
5593 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);
5594 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5595 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
5596 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5597 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
5598 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5599 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5600 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
5601 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5602 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5603 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5606 EAPI int elm_cursor_engine_only_get(void);
5607 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
5610 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
5611 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5612 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
5613 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5614 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
5615 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
5616 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5617 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5618 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);
5619 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
5620 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5621 EAPI void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
5622 EAPI const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5623 EAPI const Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5624 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5625 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5626 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5627 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5628 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
5629 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5630 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5631 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5632 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5633 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
5634 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5635 EAPI const Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
5636 EAPI const Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
5637 EAPI const Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
5638 EAPI const Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5639 EAPI const Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5641 /* smart callbacks called:
5642 * "clicked" - the user clicked the empty space in the menu to dismiss. event_info is NULL.
5646 typedef enum _Elm_List_Mode
5648 ELM_LIST_COMPRESS = 0,
5654 typedef struct _Elm_List_Item Elm_List_Item; /**< Item of Elm_List. Sub-type of Elm_Widget_Item */
5655 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5656 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);
5657 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);
5658 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);
5659 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);
5660 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);
5661 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5662 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
5663 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
5664 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5665 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
5666 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5667 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5668 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5669 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
5670 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5671 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5672 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5673 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5674 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
5675 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5676 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5677 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5678 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5679 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5680 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5681 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5682 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5683 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5684 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
5685 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5686 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
5687 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5688 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5689 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
5690 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5691 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5692 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
5693 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);
5694 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5695 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
5696 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5697 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
5698 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5699 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5700 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
5701 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5702 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5703 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5704 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5705 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5706 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5707 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5708 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
5709 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);
5710 /* smart callbacks called:
5711 * "clicked,double" - when the user double-clicked an item
5712 * "selected" - when the user selected an item
5713 * "unselected" - when the user selected an item
5714 * "longpressed" - an item in the hoversel list is long-pressed
5715 * "scroll,edge,top" - the list is scrolled until the top edge
5716 * "scroll,edge,bottom" - the list is scrolled until the bottom edge
5717 * "scroll,edge,left" - the list is scrolled until the left edge
5718 * "scroll,edge,right" - the list is scrolled until the right edge
5722 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5723 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5724 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5725 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5726 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5727 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5728 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
5729 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5730 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5731 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
5732 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5733 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
5734 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5735 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
5736 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5737 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);
5738 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);
5739 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5740 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5741 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
5742 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
5743 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
5744 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5745 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
5746 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5747 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
5748 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5749 /* smart callbacks called:
5750 * "changed" - Whenever the slider value is changed by the user.
5751 * "slider,drag,start" - dragging the slider indicator around has started
5752 * "slider,drag,stop" - dragging the slider indicator around has stopped
5753 * "delay,changed" - A short time after the value is changed by the user.
5754 * This will be called only when the user stops dragging for a very short
5755 * period or when they release their finger/mouse, so it avoids possibly
5756 * expensive reactions to the value change.
5763 * @addtogroup Actionslider Actionslider
5765 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
5766 * properties. The indicator is the element the user drags to choose a label.
5767 * When the position is set with magnet, when released the indicator will be
5768 * moved to it if it's nearest the magnetized position.
5770 * @note By default all positions are set as enabled.
5772 * Signals that you can add callbacks for are:
5774 * "selected" - when user selects an enabled position (the label is passed
5777 * "pos_changed" - when the indicator reaches any of the positions("left",
5778 * "right" or "center").
5780 * See an example of actionslider usage @ref actionslider_example_page "here"
5784 typedef enum _Elm_Actionslider_Indicator_Pos
5786 ELM_ACTIONSLIDER_INDICATOR_NONE,
5787 ELM_ACTIONSLIDER_INDICATOR_LEFT,
5788 ELM_ACTIONSLIDER_INDICATOR_RIGHT,
5789 ELM_ACTIONSLIDER_INDICATOR_CENTER
5790 } Elm_Actionslider_Indicator_Pos;
5792 typedef enum _Elm_Actionslider_Magnet_Pos
5794 ELM_ACTIONSLIDER_MAGNET_NONE = 0,
5795 ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
5796 ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
5797 ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
5798 ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
5799 ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
5800 } Elm_Actionslider_Magnet_Pos;
5802 typedef enum _Elm_Actionslider_Label_Pos
5804 ELM_ACTIONSLIDER_LABEL_LEFT,
5805 ELM_ACTIONSLIDER_LABEL_RIGHT,
5806 ELM_ACTIONSLIDER_LABEL_CENTER,
5807 ELM_ACTIONSLIDER_LABEL_BUTTON
5808 } Elm_Actionslider_Label_Pos;
5810 /* smart callbacks called:
5811 * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
5815 * Add a new actionslider to the parent.
5817 * @param parent The parent object
5818 * @return The new actionslider object or NULL if it cannot be created
5820 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5823 * Set actionslider label.
5825 * @param[in] obj The actionslider object
5826 * @param[in] pos The position of the label.
5827 * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
5828 * @param label The label which is going to be set.
5830 EAPI void elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
5832 * Get actionslider labels.
5834 * @param obj The actionslider object
5835 * @param left_label A char** to place the left_label of @p obj into.
5836 * @param center_label A char** to place the center_label of @p obj into.
5837 * @param right_label A char** to place the right_label of @p obj into.
5839 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);
5841 * Get actionslider selected label.
5843 * @param obj The actionslider object
5844 * @return The selected label
5846 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5848 * Set actionslider indicator position.
5850 * @param obj The actionslider object.
5851 * @param pos The position of the indicator.
5853 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
5855 * Get actionslider indicator position.
5857 * @param obj The actionslider object.
5858 * @return The position of the indicator.
5860 EAPI Elm_Actionslider_Indicator_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5862 * Set actionslider magnet position. To make multiple positions magnets @c or
5863 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
5865 * @param obj The actionslider object.
5866 * @param pos Bit mask indicating the magnet positions.
5868 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
5870 * Get actionslider magnet position.
5872 * @param obj The actionslider object.
5873 * @return The positions with magnet property.
5875 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5877 * Set actionslider enabled position. To set multiple positions as enabled @c or
5878 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
5880 * @note All the positions are enabled by default.
5882 * @param obj The actionslider object.
5883 * @param pos Bit mask indicating the enabled positions.
5885 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
5887 * Get actionslider enabled position.
5889 * @param obj The actionslider object.
5890 * @return The enabled positions.
5892 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5894 * Set the label used on the indicator.
5896 * @param obj The actionslider object
5897 * @param label The label to be set on the indicator.
5898 * @deprecated use elm_object_text_set() instead.
5900 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5902 * Get the label used on the indicator object.
5904 * @param obj The actionslider object
5905 * @return The indicator label
5906 * @deprecated use elm_object_text_get() instead.
5908 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5911 * Hold actionslider object movement.
5913 * @param[in] obj The actionslider object
5914 * @param[in] flag Actionslider hold/release
5915 * (EINA_TURE = hold/EIN_FALSE = release)
5917 * @ingroup Actionslider
5919 EAPI void elm_actionslider_hold(Evas_Object *obj, Eina_Bool flag) EINA_ARG_NONNULL(1);
5927 typedef enum _Elm_Genlist_Item_Flags
5929 ELM_GENLIST_ITEM_NONE = 0,
5930 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0),
5931 ELM_GENLIST_ITEM_GROUP = (1 << 1)
5932 } Elm_Genlist_Item_Flags;
5933 typedef enum _Elm_Genlist_Item_Field_Flags
5935 ELM_GENLIST_ITEM_FIELD_ALL = 0,
5936 ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
5937 ELM_GENLIST_ITEM_FIELD_ICON = (1 << 1),
5938 ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
5939 } Elm_Genlist_Item_Field_Flags;
5940 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;
5941 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
5942 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
5943 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
5944 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
5945 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
5946 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj);
5947 typedef void (*GenlistItemMovedFunc) ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
5949 struct _Elm_Genlist_Item_Class
5951 const char *item_style;
5953 GenlistItemLabelGetFunc label_get;
5954 GenlistItemIconGetFunc icon_get;
5955 GenlistItemStateGetFunc state_get;
5956 GenlistItemDelFunc del;
5957 GenlistItemMovedFunc moved;
5959 const char *edit_item_style;
5960 const char *mode_item_style;
5962 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5963 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5964 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
5965 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5966 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
5967 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5968 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
5969 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5970 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
5971 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5972 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
5973 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5974 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
5975 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5976 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5977 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5978 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5979 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5980 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
5981 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5982 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
5983 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5984 /* operations to add items */
5985 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);
5986 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);
5987 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);
5988 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);
5989 /* operations to retrieve existing items */
5990 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5991 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5992 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5993 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);
5994 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5995 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5996 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
5997 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);
5998 /* available item styles:
6000 * default_style - The text part is a textblock
6002 * icon_top_text_bottom
6004 /* Genlist Item operation */
6005 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6006 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6007 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6008 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
6009 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6010 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6011 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6012 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
6013 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6014 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
6015 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6016 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6017 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
6018 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
6019 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6020 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6021 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6022 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6023 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
6024 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
6025 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6026 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6027 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
6028 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
6029 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
6030 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6031 EAPI void elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
6032 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
6033 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
6034 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
6035 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);
6036 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6037 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
6038 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6039 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
6040 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6041 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6042 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
6043 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6044 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
6045 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6046 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
6047 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
6048 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6049 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6050 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
6051 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6052 /* Signals that you can add callbacks for are:
6053 * "clicked,double" - This is called when a user has double-clicked an item.
6054 * The event_info parameter is the genlist item that was
6056 * "selected" - This is called when a user has made an item selected. The
6057 * event_info parameter is the genlist item that was selected.
6058 * "unselected" - This is called when a user has made an item unselected. The
6059 * event_info parameter is the genlist item that was unselected.
6060 * "expanded" - This is called when elm_genlist_item_expanded_set() is called
6061 * and the item is now meant to be expanded. The event_info parameter is the
6062 * genlist item that was indicated to expand. It is the job of this callback
6063 * to then fill in the child items.
6064 * "contracted" - This is called when elm_genlist_item_expanded_set() is called
6065 * and the item is now meant to be contracted. The event_info parameter is
6066 * the genlist item that was indicated to contract. It is the job of this
6067 * callback to then delete the child items.
6068 * "expand,request" - This is called when a user has indicated they want to
6069 * expand a tree branch item. The callback should decide if the item can
6070 * expand (has any children) and then call elm_genlist_item_expanded_set()
6071 * appropriately to set the state. The event_info parameter is the genlist
6072 * item that was indicated to expand.
6073 * "contract,request" - This is called when a user has indicated they want to
6074 * contract a tree branch item. The callback should decide if the item can
6075 * contract (has any children) and then call elm_genlist_item_expanded_set()
6076 * appropriately to set the state. The event_info parameter is the genlist
6077 * item that was indicated to contract.
6078 * "realized" - This is called when the item in the list is created as a real
6079 * evas object. event_info parameter is the genlist item that was created.
6080 * The object may be deleted at any time, so it is up to the caller to
6081 * not use the object pointer from elm_genlist_item_object_get() in a way
6082 * where it may point to freed objects.
6083 * "unrealized" - This is called just before an item is unrealized. After
6084 * this call icon objects provided will be deleted and the item object
6085 * itself delete or be put into a floating cache.
6086 * "drag,start,up" - This is called when the item in the list has been dragged
6087 * (not scrolled) up.
6088 * "drag,start,down" - This is called when the item in the list has been dragged
6089 * (not scrolled) down.
6090 * "drag,start,left" - This is called when the item in the list has been dragged i
6091 * (not scrolled) left.
6092 * "drag,start,right" - This is called when the item in the list has been dragged
6093 * (not scrolled) right.
6094 * "drag,stop" - This is called when the item in the list has stopped being
6096 * "drag" - This is called when the item in the list is being dragged.
6097 * "longpressed" - This is called when the item is pressed for a certain amount
6098 * of time. By default it's 1 second.
6099 * "scroll,anim,start" - This is called when scrolling animation has started.
6100 * "scroll,anim,stop" - This is called when scrolling animation has stopped.
6101 * "scroll,drag,start" - This is called when dragging the content has started.
6102 * "scroll,drag,stop" - This is called when dragging the content has stopped.
6103 * "scroll,edge,top" - This is called when the genlist is scrolled until the
6105 * "scroll,edge,bottom" - This is called when the genlist is scrolled until the
6107 * "scroll,edge,left" - This is called when the genlist is scrolled until the
6109 * "scroll,edge,right" - This is called when the genlist is scrolled until the
6111 * "multi,swipe,left" - This is called when the genlist is multi-touch swiped
6113 * "multi,swipe,right" - This is called when the genlist is multi-touch swiped
6115 * "multi,swipe,up" - This is called when the genlist is multi-touch swiped up.
6116 * "multi,swipe,down" - This is called when the genlist is multi-touch swiped
6118 * "multi,pinch,out" - This is called when the genlist is multi-touch pinched
6120 * "multi,pinch,in" - This is called when the genlist is multi-touch pinched in.
6123 EAPI void elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
6124 EAPI Eina_Bool elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6125 EAPI void elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
6126 EAPI Eina_Bool elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6127 EAPI void elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
6128 EAPI void elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
6129 EAPI void elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
6130 EAPI void elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
6131 EAPI void elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
6132 EAPI Eina_Bool elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6135 * @page tutorial_check Check example
6136 * @dontinclude check_example_01.c
6138 * This example will show 2 checkboxes, one with just a label and the second
6139 * one with both a label and an icon. This example also ilustrates how to
6140 * have the checkbox change the value of a variable and how to react to those
6143 * We will start with the usual setup code:
6146 * And now we create our first checkbox, set its label, tell it to change
6147 * the value of @p value when the checkbox stats is changed and ask to be
6148 * notified of state changes:
6151 * For our second checkbox we are going to set an icon so we need to create
6154 * @note For simplicity we are using a rectangle as icon, but any evas object
6157 * And for our second checkbox we set the label, icon and state to true:
6160 * We now do some more setup:
6163 * And finally implement the callback that will be called when the first
6164 * checkbox's state changes. This callback will use @p data to print a
6167 * @note This work because @p data is @p value(from the main function) and @p
6168 * value is changed when the checkbox is changed.
6170 * Our example will look like this:
6171 * @image html screenshots/check_example_01.png
6172 * @image latex screenshots/check_example_01.eps
6174 * @example check_example_01.c
6177 * @defgroup Check Check
6179 * @brief The check widget allows for toggling a value between true and
6182 * Check objects are a lot like radio objects in layout and functionality
6183 * except they do not work as a group, but independently and only toggle the
6184 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
6185 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
6186 * returns the current state. For convenience, like the radio objects, you
6187 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
6190 * Signals that you can add callbacks for are:
6191 * "changed" - This is called whenever the user changes the state of one of
6192 * the check object(event_info is NULL).
6194 * @ref tutorial_check should give you a firm grasp of how to use this widget.
6198 * @brief Add a new Check object
6200 * @param parent The parent object
6201 * @return The new object or NULL if it cannot be created
6203 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6205 * @brief Set the text label of the check object
6207 * @param obj The check object
6208 * @param label The text label string in UTF-8
6210 * @deprecated use elm_object_text_set() instead.
6212 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6214 * @brief Get the text label of the check object
6216 * @param obj The check object
6217 * @return The text label string in UTF-8
6219 * @deprecated use elm_object_text_get() instead.
6221 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6223 * @brief Set the icon object of the check object
6225 * @param obj The check object
6226 * @param icon The icon object
6228 * Once the icon object is set, a previously set one will be deleted.
6229 * If you want to keep that old content object, use the
6230 * elm_check_icon_unset() function.
6232 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6234 * @brief Get the icon object of the check object
6236 * @param obj The check object
6237 * @return The icon object
6239 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6241 * @brief Unset the icon used for the check object
6243 * @param obj The check object
6244 * @return The icon object that was being used
6246 * Unparent and return the icon object which was set for this widget.
6248 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6250 * @brief Set the on/off state of the check object
6252 * @param obj The check object
6253 * @param state The state to use (1 == on, 0 == off)
6255 * This sets the state of the check. If set
6256 * with elm_check_state_pointer_set() the state of that variable is also
6257 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
6259 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
6261 * @brief Get the state of the check object
6263 * @param obj The check object
6264 * @return The boolean state
6266 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6268 * @brief Set a convenience pointer to a boolean to change
6270 * @param obj The check object
6271 * @param statep Pointer to the boolean to modify
6273 * This sets a pointer to a boolean, that, in addition to the check objects
6274 * state will also be modified directly. To stop setting the object pointed
6275 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
6276 * then when this is called, the check objects state will also be modified to
6277 * reflect the value of the boolean @p statep points to, just like calling
6278 * elm_check_state_set().
6280 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
6286 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6287 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6288 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6289 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6290 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6291 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6292 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
6293 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
6294 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6295 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
6296 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6297 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
6298 /* smart callbacks called:
6299 * "changed" - when the radio status is changed
6303 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6304 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6305 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
6306 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6307 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6308 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6309 EAPI void elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
6310 EAPI void elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
6312 /* available item styles:
6318 /* smart callbacks called:
6319 * "hide,finished" - when the previous page is hided
6322 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class;
6323 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func;
6324 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Item of Elm_Slideshow. Sub-type of Elm_Widget_Item */
6325 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj);
6326 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj);
6328 struct _Elm_Slideshow_Item_Class
6330 struct _Elm_Slideshow_Item_Class_Func
6332 SlideshowItemGetFunc get;
6333 SlideshowItemDelFunc del;
6337 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6338 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
6339 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);
6340 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
6341 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
6342 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
6343 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6344 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
6345 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6346 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
6347 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6348 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
6349 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6350 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6351 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6352 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
6353 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
6354 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6355 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
6356 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
6357 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6358 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
6359 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6360 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
6361 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6362 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
6363 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6364 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6365 /* smart callbacks called:
6366 * "changed" - when the slideshow switch to another item
6370 typedef enum _Elm_Fileselector_Mode
6372 ELM_FILESELECTOR_LIST = 0,
6373 ELM_FILESELECTOR_GRID,
6374 ELM_FILESELECTOR_LAST
6375 } Elm_Fileselector_Mode;
6377 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6378 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
6379 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6380 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
6381 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6382 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
6383 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6384 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6385 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
6386 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6387 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6388 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6389 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6390 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
6391 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6392 /* smart callbacks called:
6393 * "selected" - the user click on a file
6394 * "directory,open" - the list is populate with a new content. event_info is a directory.
6395 * "done" - the user click on the ok or cancel buttons
6399 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6400 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
6401 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6402 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
6403 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
6404 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6405 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6406 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6407 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6408 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6409 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6410 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
6411 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6412 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
6413 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6414 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6415 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6416 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
6417 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6418 /* smart callbacks called:
6420 /* available item styles:
6422 * wheel (simple style, no text, no progression, only pulse is available)
6426 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6427 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6428 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6429 /* smart callbacks called:
6433 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6434 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
6435 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6436 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
6437 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
6438 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
6439 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6440 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
6441 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6442 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
6443 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6444 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
6445 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6446 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
6447 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
6448 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6449 /* smart callbacks called:
6450 * "changed" - when the spinner value changes
6451 * "delay,changed" - when the spinner value changed, but a small time after a change (use this if you only want to respond to a change once the spinner is held still for a short while).
6453 /* available item styles:
6455 * vertical (two up/down buttons at the right side and text left aligned)
6459 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Item of Elm_Index. Sub-type of Elm_Widget_Item */
6461 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6462 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
6463 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6464 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
6465 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6466 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
6467 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
6468 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
6469 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
6470 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
6471 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);
6472 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
6473 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
6474 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6475 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
6476 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
6477 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
6478 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
6479 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
6480 EAPI void elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
6481 /* smart callbacks called:
6482 * "changed" - when the selected index item changes
6483 * "delay,changed" - when the selected index item changes, but after some small idle period
6484 * "selected" - when the user releases a finger and selects an item
6485 * "level,up" - when the user moves a finger from the first level to the second level
6486 * "level,down" - when the user moves a finger from the second level to the first level
6490 typedef enum _Elm_Photocam_Zoom_Mode
6492 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0,
6493 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT,
6494 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL,
6495 ELM_PHOTOCAM_ZOOM_MODE_LAST
6496 } Elm_Photocam_Zoom_Mode;
6498 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6499 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
6500 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6501 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
6502 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6503 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
6504 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6505 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
6506 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
6507 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
6508 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
6509 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
6510 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6511 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6512 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6513 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6514 /* smart callbacks called:
6515 * "clicked" - when image clicked
6516 * "press" - when mouse/finger held down initially on image
6517 * "longpressed" - when mouse/finger held for long time on image
6518 * "clicked,double" - when mouse/finger double-clicked
6519 * "load" - when photo load begins
6520 * "loaded" - when photo load done
6521 * "load,detail" - when detailed image load begins
6522 * "loaded,detail" - when detailed image load done
6523 * "zoom,start" - when zooming started
6524 * "zoom,stop" - when zooming stopped
6525 * "zoom,change" - when auto zoom mode changed zoom level
6526 * "scroll - the content has been scrolled (moved)
6527 * "scroll,anim,start" - scrolling animation has started
6528 * "scroll,anim,stop" - scrolling animation has stopped
6529 * "scroll,drag,start" - dragging the contents around has started
6530 * "scroll,drag,stop" - dragging the contents around has stopped
6534 typedef enum _Elm_Map_Zoom_Mode
6536 ELM_MAP_ZOOM_MODE_MANUAL,
6537 ELM_MAP_ZOOM_MODE_AUTO_FIT,
6538 ELM_MAP_ZOOM_MODE_AUTO_FILL,
6539 ELM_MAP_ZOOM_MODE_LAST
6540 } Elm_Map_Zoom_Mode;
6542 typedef enum _Elm_Map_Route_Sources
6544 ELM_MAP_ROUTE_SOURCE_YOURS,
6545 ELM_MAP_ROUTE_SOURCE_MONAV,
6546 ELM_MAP_ROUTE_SOURCE_ORS,
6547 ELM_MAP_ROUTE_SOURCE_LAST
6548 } Elm_Map_Route_Sources;
6550 typedef enum _Elm_Map_Name_Sources
6552 ELM_MAP_NAME_SOURCE_NOMINATIM,
6553 ELM_MAP_NAME_SOURCE_LAST
6554 } Elm_Map_Name_Sources;
6556 typedef enum _Elm_Map_Route_Type
6558 ELM_MAP_ROUTE_TYPE_MOTOCAR,
6559 ELM_MAP_ROUTE_TYPE_BICYCLE,
6560 ELM_MAP_ROUTE_TYPE_FOOT,
6561 ELM_MAP_ROUTE_TYPE_LAST
6562 } Elm_Map_Route_Type;
6564 typedef enum _Elm_Map_Route_Method
6566 ELM_MAP_ROUTE_METHOD_FASTEST,
6567 ELM_MAP_ROUTE_METHOD_SHORTEST,
6568 ELM_MAP_ROUTE_METHOD_LAST
6569 } Elm_Map_Route_Method;
6571 typedef enum _Elm_Map_Name_Method
6573 ELM_MAP_NAME_METHOD_SEARCH,
6574 ELM_MAP_NAME_METHOD_REVERSE,
6575 ELM_MAP_NAME_METHOD_LAST
6576 } Elm_Map_Name_Method;
6578 typedef struct _Elm_Map_Marker Elm_Map_Marker;
6579 typedef struct _Elm_Map_Marker_Class Elm_Map_Marker_Class;
6580 typedef struct _Elm_Map_Group_Class Elm_Map_Group_Class;
6581 typedef struct _Elm_Map_Route Elm_Map_Route;
6582 typedef struct _Elm_Map_Name Elm_Map_Name;
6583 typedef struct _Elm_Map_Track Elm_Map_Track;
6585 typedef Evas_Object *(*ElmMapMarkerGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
6586 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o);
6587 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
6588 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data);
6590 typedef char *(*ElmMapModuleSourceFunc) (void);
6591 typedef int (*ElmMapModuleZoomMinFunc) (void);
6592 typedef int (*ElmMapModuleZoomMaxFunc) (void);
6593 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
6594 typedef int (*ElmMapModuleRouteSourceFunc) (void);
6595 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
6596 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
6597 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
6598 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
6600 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6601 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
6602 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6603 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
6604 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6605 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
6606 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
6607 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
6608 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
6609 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6610 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
6611 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6612 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
6613 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);
6614 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);
6615 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
6616 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
6617 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);
6618 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);
6619 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
6620 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6621 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
6622 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6623 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6624 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
6625 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6626 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6627 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
6628 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
6629 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
6630 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
6631 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
6632 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
6633 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
6634 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
6635 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
6636 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
6637 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
6638 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
6639 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
6640 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6641 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
6642 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6643 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
6644 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6645 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
6646 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6647 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
6648 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6649 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
6650 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6651 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);
6652 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6653 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
6654 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
6655 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6656 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6657 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6658 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
6659 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
6660 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
6661 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
6662 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);
6663 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6664 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6666 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
6668 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
6670 /* smart callbacks called:
6671 * "clicked" - when image clicked
6672 * "press" - when mouse/finger held down initially on image
6673 * "longpressed" - when mouse/finger held for long time on image
6674 * "clicked,double" - when mouse/finger double-clicked
6675 * "load,details" - when detailed image load begins
6676 * "loaded,details" - when detailed image load done
6677 * "zoom,start" - when zooming started
6678 * "zoom,stop" - when zooming stopped
6679 * "zoom,change" - when auto zoom mode changed zoom level
6680 * "scroll - the content has been scrolled (moved)
6681 * "scroll,anim,start" - scrolling animation has started
6682 * "scroll,anim,stop" - scrolling animation has stopped
6683 * "scroll,drag,start" - dragging the contents around has started
6684 * "scroll,drag,stop" - dragging the contents around has stopped
6688 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
6690 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
6692 EAPI double elm_route_lon_min_get(Evas_Object *obj);
6693 EAPI double elm_route_lat_min_get(Evas_Object *obj);
6694 EAPI double elm_route_lon_max_get(Evas_Object *obj);
6695 EAPI double elm_route_lat_max_get(Evas_Object *obj);
6699 typedef enum _Elm_Panel_Orient
6701 ELM_PANEL_ORIENT_TOP,
6702 ELM_PANEL_ORIENT_BOTTOM,
6703 ELM_PANEL_ORIENT_LEFT,
6704 ELM_PANEL_ORIENT_RIGHT,
6707 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6708 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
6709 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6710 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6711 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6712 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6713 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
6714 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6715 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
6721 * Update the minimun height of the bar in the theme. No minimun should be set in the vertical theme
6722 * Add events (move, start ...)
6724 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6725 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6726 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6727 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6728 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6729 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6730 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6731 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6732 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
6733 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6734 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6735 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
6736 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6739 typedef enum _Elm_Flip_Mode
6741 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
6742 ELM_FLIP_ROTATE_X_CENTER_AXIS,
6743 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
6744 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
6746 ELM_FLIP_CUBE_RIGHT,
6750 ELM_FLIP_PAGE_RIGHT,
6754 typedef enum _Elm_Flip_Interaction
6756 ELM_FLIP_INTERACTION_NONE,
6757 ELM_FLIP_INTERACTION_ROTATE,
6758 ELM_FLIP_INTERACTION_CUBE,
6759 ELM_FLIP_INTERACTION_PAGE
6760 } Elm_Flip_Interaction;
6761 typedef enum _Elm_Flip_Direction
6763 ELM_FLIP_DIRECTION_UP,
6764 ELM_FLIP_DIRECTION_DOWN,
6765 ELM_FLIP_DIRECTION_LEFT,
6766 ELM_FLIP_DIRECTION_RIGHT
6767 } Elm_Flip_Direction;
6769 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6770 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6771 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6772 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6773 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6774 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6775 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6776 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6777 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
6778 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
6779 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
6780 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
6781 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
6782 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
6783 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
6784 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
6785 /* smart callbacks called:
6786 * "animate,begin" - when a flip animation was started
6787 * "animate,done" - when a flip animation is finished
6791 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6792 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
6793 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6794 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
6795 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6796 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
6797 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6798 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
6799 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6800 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6801 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
6802 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
6803 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
6804 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6805 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
6806 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6807 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
6808 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
6809 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
6810 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
6811 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6812 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6813 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6814 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6815 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
6816 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
6817 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6818 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6819 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6820 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
6821 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6822 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
6823 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
6824 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
6825 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6826 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);
6827 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6828 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6829 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);
6830 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6831 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);
6832 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
6833 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6834 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6835 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6836 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
6837 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6838 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6839 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6840 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);
6841 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);
6842 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);
6843 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);
6844 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);
6845 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);
6846 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
6847 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
6848 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
6849 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
6850 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6851 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
6852 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
6853 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
6854 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
6855 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
6856 EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
6857 EINA_DEPRECATED EAPI void elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
6858 EINA_DEPRECATED EAPI void elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
6861 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6862 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6863 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6864 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6865 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6868 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6869 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6870 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6871 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6872 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
6873 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6874 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
6875 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6876 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
6877 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6880 * @defgroup Flipselector Flip Selector
6882 * A flip selector is a widget to show a set of @b text items, one
6883 * at a time, with the same sheet switching style as the @ref Clock
6884 * "clock" widget, when one changes the current displaying sheet
6885 * (thus, the "flip" in the name).
6887 * User clicks to flip sheets which are @b held for some time will
6888 * make the flip selector to flip continuosly and automatically for
6889 * the user. The interval between flips will keep growing in time,
6890 * so that it helps the user to reach an item which is distant from
6891 * the current selection.
6893 * Smart callbacks one can register to:
6894 * - @c "selected" - when the widget's selected text item is changed
6895 * - @c "overflowed" - when the widget's current selection is changed
6896 * from the first item in its list to the last
6897 * - @c "underflowed" - when the widget's current selection is changed
6898 * from the last item in its list to the first
6900 * Available styles for it:
6903 * Here is an example on its usage:
6904 * @li @ref flipselector_example
6908 * @addtogroup Flipselector
6912 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
6915 * Add a new flip selector widget to the given parent Elementary
6916 * (container) widget
6918 * @param parent The parent object
6919 * @return a new flip selector widget handle or @c NULL, on errors
6921 * This function inserts a new flip selector widget on the canvas.
6923 * @ingroup Flipselector
6925 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6928 * Programmatically select the next item of a flip selector widget
6930 * @param obj The flipselector object
6932 * @note The selection will be animated. Also, if it reaches the
6933 * end of its list of member items, it will continue with the first
6936 * @ingroup Flipselector
6938 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
6941 * Programmatically select the previous item of a flip selector
6944 * @param obj The flipselector object
6946 * @note The selection will be animated. Also, if it reaches the
6947 * beginning of its list of member items, it will continue with the
6948 * last one backwards.
6950 * @ingroup Flipselector
6952 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
6955 * Append a (text) item to a flip selector widget
6957 * @param obj The flipselector object
6958 * @param label The (text) label of the new item
6959 * @param func Convenience callback function to take place when
6961 * @param data Data passed to @p func, above
6962 * @return A handle to the item added or @c NULL, on errors
6964 * The widget's list of labels to show will be appended with the
6965 * given value. If the user wishes so, a callback function pointer
6966 * can be passed, which will get called when this same item is
6969 * @note The current selection @b won't be modified by appending an
6970 * element to the list.
6972 * @note The maximum length of the text label is going to be
6973 * determined <b>by the widget's theme</b>. Strings larger than
6974 * that value are going to be @b truncated.
6976 * @ingroup Flipselector
6978 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
6981 * Prepend a (text) item to a flip selector widget
6983 * @param obj The flipselector object
6984 * @param label The (text) label of the new item
6985 * @param func Convenience callback function to take place when
6987 * @param data Data passed to @p func, above
6988 * @return A handle to the item added or @c NULL, on errors
6990 * The widget's list of labels to show will be prepended with the
6991 * given value. If the user wishes so, a callback function pointer
6992 * can be passed, which will get called when this same item is
6995 * @note The current selection @b won't be modified by prepending
6996 * an element to the list.
6998 * @note The maximum length of the text label is going to be
6999 * determined <b>by the widget's theme</b>. Strings larger than
7000 * that value are going to be @b truncated.
7002 * @ingroup Flipselector
7004 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
7007 * Get the internal list of items in a given flip selector widget.
7009 * @param obj The flipselector object
7010 * @return The list of items (#Elm_Flipselector_Item as data) or @c
7013 * This list is @b not to be modified in any way and must not be
7014 * freed. Use the list members with functions like
7015 * elm_flipselector_item_label_set(),
7016 * elm_flipselector_item_label_get(), elm_flipselector_item_del(),
7017 * elm_flipselector_item_del(),
7018 * elm_flipselector_item_selected_get(),
7019 * elm_flipselector_item_selected_set().
7021 * @warning This list is only valid until @p obj object's internal
7022 * items list is changed. It should be fetched again with another
7023 * call to this function when changes happen.
7025 * @ingroup Flipselector
7027 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7030 * Get the first item in the given flip selector widget's list of
7033 * @param obj The flipselector object
7034 * @return The first item or @c NULL, if it has no items (and on
7037 * @see elm_flipselector_item_append()
7038 * @see elm_flipselector_last_item_get()
7040 * @ingroup Flipselector
7042 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7045 * Get the last item in the given flip selector widget's list of
7048 * @param obj The flipselector object
7049 * @return The last item or @c NULL, if it has no items (and on
7052 * @see elm_flipselector_item_prepend()
7053 * @see elm_flipselector_first_item_get()
7055 * @ingroup Flipselector
7057 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7060 * Get the currently selected item in a flip selector widget.
7062 * @param obj The flipselector object
7063 * @return The selected item or @c NULL, if the widget has no items
7066 * @ingroup Flipselector
7068 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7071 * Set whether a given flip selector widget's item should be the
7072 * currently selected one.
7074 * @param item The flip selector item
7075 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
7077 * This sets whether @p item is or not the selected (thus, under
7078 * display) one. If @p item is different than one under display,
7079 * the latter will be unselected. If the @p item is set to be
7080 * unselected, on the other hand, the @b first item in the widget's
7081 * internal members list will be the new selected one.
7083 * @see elm_flipselector_item_selected_get()
7085 * @ingroup Flipselector
7087 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
7090 * Get whether a given flip selector widget's item is the currently
7093 * @param item The flip selector item
7094 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
7097 * @see elm_flipselector_item_selected_set()
7099 * @ingroup Flipselector
7101 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
7104 * Delete a given item from a flip selector widget.
7106 * @param item The item to delete
7108 * @ingroup Flipselector
7110 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
7113 * Get the label of a given flip selector widget's item.
7115 * @param item The item to get label from
7116 * @return The text label of @p item or @c NULL, on errors
7118 * @see elm_flipselector_item_label_set()
7120 * @ingroup Flipselector
7122 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
7125 * Set the label of a given flip selector widget's item.
7127 * @param item The item to set label on
7128 * @param label The text label string, in UTF-8 encoding
7130 * @see elm_flipselector_item_label_get()
7132 * @ingroup Flipselector
7134 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
7137 * Gets the item before @p item in a flip selector widget's
7138 * internal list of items.
7140 * @param item The item to fetch previous from
7141 * @return The item before the @p item, in its parent's list. If
7142 * there is no previous item for @p item or there's an
7143 * error, @c NULL is returned.
7145 * @see elm_flipselector_item_next_get()
7147 * @ingroup Flipselector
7149 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
7152 * Gets the item after @p item in a flip selector widget's
7153 * internal list of items.
7155 * @param item The item to fetch next from
7156 * @return The item after the @p item, in its parent's list. If
7157 * there is no next item for @p item or there's an
7158 * error, @c NULL is returned.
7160 * @see elm_flipselector_item_next_get()
7162 * @ingroup Flipselector
7164 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
7167 * Set the interval on time updates for an user mouse button hold
7168 * on a flip selector widget.
7170 * @param obj The flip selector object
7171 * @param interval The (first) interval value in seconds
7173 * This interval value is @b decreased while the user holds the
7174 * mouse pointer either flipping up or flipping doww a given flip
7177 * This helps the user to get to a given item distant from the
7178 * current one easier/faster, as it will start to flip quicker and
7179 * quicker on mouse button holds.
7181 * The calculation for the next flip interval value, starting from
7182 * the one set with this call, is the previous interval divided by
7183 * 1.05, so it decreases a little bit.
7185 * The default starting interval value for automatic flips is
7188 * @see elm_flipselector_interval_get()
7190 * @ingroup Flipselector
7192 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
7195 * Get the interval on time updates for an user mouse button hold
7196 * on a flip selector widget.
7198 * @param obj The flip selector object
7199 * @return The (first) interval value, in seconds, set on it
7201 * @see elm_flipselector_interval_set() for more details
7203 * @ingroup Flipselector
7205 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7212 * @addtogroup Animator Animator
7213 * @ingroup Elementary
7215 * @brief Functions to ease creation of animations.
7217 * elm_animator is designed to provide an easy way to create animations.
7218 * Creating an animation with elm_animator is as simple as setting a
7219 * duration, an operating callback and telling it to run the animation.
7220 * However that is not the full extent of elm_animator's ability, animations
7221 * can be paused and resumed, reversed and the animation need not be linear.
7223 * To run an animation you must specify at least a duration and operation
7224 * callback, not setting any other properties will create a linear animation
7225 * that runs once and is not reversed.
7227 * @ref elm_animator_example_page_01 "This" example should make all of that
7230 * @warning elm_animator is @b not a widget.
7234 * @brief Type of curve desired for animation.
7236 * The speed in which an animation happens doesn't have to be linear, some
7237 * animations will look better if they're accelerating or decelerating, so
7238 * elm_animator provides four options in this regard:
7239 * @image html elm_animator_curve_style.png
7240 * @image latex elm_animator_curve_style.eps width=\textwidth
7241 * As can be seen in the image the speed of the animation will be:
7242 * @li ELM_ANIMATOR_CURVE_LINEAR constant
7243 * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
7244 * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
7245 * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
7249 ELM_ANIMATOR_CURVE_LINEAR,
7250 ELM_ANIMATOR_CURVE_IN_OUT,
7251 ELM_ANIMATOR_CURVE_IN,
7252 ELM_ANIMATOR_CURVE_OUT
7253 } Elm_Animator_Curve_Style;
7254 typedef struct _Elm_Animator Elm_Animator;
7256 * Called back per loop of an elementary animators cycle
7257 * @param data user-data given to elm_animator_operation_callback_set()
7258 * @param animator the animator being run
7259 * @param double the position in the animation
7261 typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
7263 * Called back when an elementary animator finishes
7264 * @param data user-data given to elm_animator_completion_callback_set()
7266 typedef void (*Elm_Animator_Completion_Cb) (void *data);
7269 * @brief Create a new animator.
7271 * @param[in] parent Parent object
7273 * The @a parent argument can be set to NULL for no parent. If a parent is set
7274 * there is no need to call elm_animator_del(), when the parent is deleted it
7275 * will delete the animator.
7276 * @deprecated Use @ref Transit instead.
7279 EINA_DEPRECATED EAPI Elm_Animator* elm_animator_add(Evas_Object *parent);
7281 * Deletes the animator freeing any resources it used. If the animator was
7282 * created with a NULL parent this must be called, otherwise it will be
7283 * automatically called when the parent is deleted.
7285 * @param[in] animator Animator object
7286 * @deprecated Use @ref Transit instead.
7288 EINA_DEPRECATED EAPI void elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
7290 * Set the duration of the animation.
7292 * @param[in] animator Animator object
7293 * @param[in] duration Duration in second
7294 * @deprecated Use @ref Transit instead.
7296 EINA_DEPRECATED EAPI void elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
7298 * @brief Set the callback function for animator operation.
7300 * @param[in] animator Animator object
7301 * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
7302 * @param[in] data Callback function user argument
7304 * The @p func callback will be called with a frame value in range [0, 1] which
7305 * indicates how far along the animation should be. It is the job of @p func to
7306 * actually change the state of any object(or objects) that are being animated.
7307 * @deprecated Use @ref Transit instead.
7309 EINA_DEPRECATED EAPI void elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
7311 * Set the callback function for the when the animation ends.
7313 * @param[in] animator Animator object
7314 * @param[in] func Callback function pointe
7315 * @param[in] data Callback function user argument
7317 * @warning @a func will not be executed if elm_animator_stop() is called.
7318 * @deprecated Use @ref Transit instead.
7320 EINA_DEPRECATED EAPI void elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
7322 * @brief Stop animator.
7324 * @param[in] animator Animator object
7326 * If called before elm_animator_animate() it does nothing. If there is an
7327 * animation in progress the animation will be stopped(the operation callback
7328 * will not be executed again) and it can't be restarted using
7329 * elm_animator_resume().
7330 * @deprecated Use @ref Transit instead.
7332 EINA_DEPRECATED EAPI void elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
7334 * Set the animator repeat count.
7336 * @param[in] animator Animator object
7337 * @param[in] repeat_cnt Repeat count
7338 * @deprecated Use @ref Transit instead.
7340 EINA_DEPRECATED EAPI void elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
7342 * @brief Start animation.
7344 * @param[in] animator Animator object
7346 * This function starts the animation if the nescessary properties(duration
7347 * and operation callback) have been set. Once started the animation will
7348 * run until complete or elm_animator_stop() is called.
7349 * @deprecated Use @ref Transit instead.
7351 EINA_DEPRECATED EAPI void elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
7353 * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
7355 * @param[in] animator Animator object
7356 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
7357 * @deprecated Use @ref Transit instead.
7359 EINA_DEPRECATED EAPI void elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
7361 * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
7363 * @param[in] animator Animator object
7364 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
7365 * @deprecated Use @ref Transit instead.
7367 EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
7369 * @brief Sets wether the animation should be automatically reversed.
7371 * @param[in] animator Animator object
7372 * @param[in] reverse Reverse or not
7374 * This controls wether the animation will be run on reverse imediately after
7375 * running forward. When this is set together with repetition the animation
7376 * will run in reverse once for each time it ran forward.@n
7377 * Runnin an animation in reverse is accomplished by calling the operation
7378 * callback with a frame value starting at 1 and diminshing until 0.
7379 * @deprecated Use @ref Transit instead.
7381 EINA_DEPRECATED EAPI void elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
7383 * Gets wether the animation will automatically reversed
7385 * @param[in] animator Animator object
7386 * @deprecated Use @ref Transit instead.
7388 EINA_DEPRECATED EAPI Eina_Bool elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
7390 * Gets the status for the animator operation. The status of the animator @b
7391 * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
7392 * only informs if the animation was started and has not ended(either normally
7393 * or through elm_animator_stop()).
7395 * @param[in] animator Animator object
7396 * @deprecated Use @ref Transit instead.
7398 EINA_DEPRECATED EAPI Eina_Bool elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
7400 * Gets how many times the animation will be repeated
7402 * @param[in] animator Animator object
7403 * @deprecated Use @ref Transit instead.
7405 EINA_DEPRECATED EAPI unsigned int elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
7407 * Pause the animator.
7409 * @param[in] animator Animator object
7411 * This causes the animation to be temporarily stopped(the operation callback
7412 * will not be called). If the animation is not yet running this is a no-op.
7413 * Once an animation has been paused with this function it can be resumed
7414 * using elm_animator_resume().
7415 * @deprecated Use @ref Transit instead.
7417 EINA_DEPRECATED EAPI void elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
7419 * @brief Resumes the animator.
7421 * @param[in] animator Animator object
7423 * Resumes an animation that was paused using elm_animator_pause(), after
7424 * calling this function calls to the operation callback will happen
7425 * normally. If an animation is stopped by means of elm_animator_stop it
7426 * @b can't be restarted with this function.@n
7428 * @warning When an animation is resumed it doesn't start from where it was paused, it
7429 * will go to where it would have been if it had not been paused. If an
7430 * animation with a duration of 3 seconds is paused after 1 second for 1 second
7431 * it will resume as if it had ben animating for 2 seconds, the operating
7432 * callback will be called with a frame value of aproximately 2/3.
7433 * @deprecated Use @ref Transit instead.
7435 EINA_DEPRECATED EAPI void elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
7443 ELM_CALENDAR_UNIQUE,
7445 ELM_CALENDAR_WEEKLY,
7446 ELM_CALENDAR_MONTHLY,
7447 ELM_CALENDAR_ANNUALLY
7448 } Elm_Calendar_Mark_Repeat;
7449 typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark;
7451 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7452 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7453 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
7454 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7455 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
7456 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
7457 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
7458 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7459 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
7460 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
7461 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
7462 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
7463 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);
7464 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
7465 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7466 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7467 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
7468 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
7469 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
7470 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
7471 /* smart callbacks called:
7472 * changed - emitted when the user select a day or change the displayed
7477 typedef struct _Elm_Diskselector_Item Elm_Diskselector_Item;
7479 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7480 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7481 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
7482 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7483 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
7484 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7485 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
7486 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7487 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7488 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);
7489 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7490 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7491 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7492 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);
7493 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7494 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
7495 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7496 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7497 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
7498 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7499 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
7500 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7501 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
7502 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7503 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7504 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7505 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7506 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7507 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
7508 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);
7509 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7510 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
7511 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7512 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
7513 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7514 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7515 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
7516 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7517 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
7518 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7519 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
7520 /* smart callbacks called:
7521 * "selected" - when item is selected (scroller stops)
7525 * @page tutorial_colorselector Color selector example
7526 * @dontinclude colorselector_example_01.c
7528 * This example shows how to change the color of a rectangle using a color
7529 * selector. We aren't going to explain a lot of the code since it's the
7533 * Now that we have a window with background and a rectangle we can create
7534 * our color_selector and set it's initial color to fully opaque blue:
7537 * Next we tell ask to be notified whenever the color changes:
7540 * We follow that we some more run of the mill setup code:
7543 * And now get to the callback that sets the color of the rectangle:
7546 * This example will look like this:
7547 * @image html screenshots/colorselector_example_01.png
7548 * @image latex screenshots/colorselector_example_01.eps
7550 * @example colorselector_example_01.c
7553 * @defgroup Colorselector Colorselector
7557 * @brief Widget for user to select a color.
7559 * Signals that you can add callbacks for are:
7560 * "changed" - When the color value changes(event_info is NULL).
7562 * See @ref tutorial_colorselector.
7565 * @brief Add a new colorselector to the parent
7567 * @param parent The parent object
7568 * @return The new object or NULL if it cannot be created
7570 * @ingroup Colorselector
7572 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7574 * Set a color for the colorselector
7576 * @param obj Colorselector object
7577 * @param r r-value of color
7578 * @param g g-value of color
7579 * @param b b-value of color
7580 * @param a a-value of color
7582 * @ingroup Colorselector
7584 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
7586 * Get a color from the colorselector
7588 * @param obj Colorselector object
7589 * @param r integer pointer for r-value of color
7590 * @param g integer pointer for g-value of color
7591 * @param b integer pointer for b-value of color
7592 * @param a integer pointer for a-value of color
7594 * @ingroup Colorselector
7596 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
7601 /* Contextual Popup */
7602 typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
7604 typedef enum _Elm_Ctxpopup_Direction
7606 ELM_CTXPOPUP_DIRECTION_DOWN,
7607 ELM_CTXPOPUP_DIRECTION_RIGHT,
7608 ELM_CTXPOPUP_DIRECTION_LEFT,
7609 ELM_CTXPOPUP_DIRECTION_UP,
7610 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
7611 } Elm_Ctxpopup_Direction;
7613 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7614 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7615 EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
7616 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7617 EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
7618 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
7619 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7620 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7621 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
7622 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7623 Elm_Ctxpopup_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);
7624 EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7625 EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
7626 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7627 EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
7628 EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7629 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);
7630 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);
7631 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7632 /* smart callbacks called:
7633 * "dismissed" - the ctxpopup was dismissed
7639 * @defgroup Transit Transit
7640 * @ingroup Elementary
7642 * Transit is designed to apply various animated transition effects to @c
7643 * Evas_Object, such like translation, rotation, etc. For using these
7644 * effects, create an @ref Elm_Transit and add the desired transition effects.
7646 * Once the effects are added into transit, they will be automatically
7647 * managed (their callback will be called until the duration is ended, and
7648 * they will be deleted on completion).
7652 * Elm_Transit *trans = elm_transit_add();
7653 * elm_transit_object_add(trans, obj);
7654 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
7655 * elm_transit_duration_set(transit, 1);
7656 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
7657 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
7658 * elm_transit_repeat_times_set(transit, 3);
7661 * Some transition effects are used to change the properties of objects. They
7663 * @li @ref elm_transit_effect_translation_add
7664 * @li @ref elm_transit_effect_color_add
7665 * @li @ref elm_transit_effect_rotation_add
7666 * @li @ref elm_transit_effect_wipe_add
7667 * @li @ref elm_transit_effect_zoom_add
7668 * @li @ref elm_transit_effect_resizing_add
7670 * Other transition effects are used to make one object disappear and another
7671 * object appear on its old place. These effects are:
7673 * @li @ref elm_transit_effect_flip_add
7674 * @li @ref elm_transit_effect_resizable_flip_add
7675 * @li @ref elm_transit_effect_fade_add
7676 * @li @ref elm_transit_effect_blend_add
7678 * It's also possible to make a transition chain with @ref
7679 * elm_transit_chain_transit_add.
7681 * @warning We strongly recommend to use elm_transit just when edje can not do
7682 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
7683 * animations can be manipulated inside the theme.
7686 * @li @ref transit_example_01_explained
7687 * @li @ref transit_example_02_explained
7688 * @li @ref transit_example_03_c
7689 * @li @ref transit_example_04_c
7695 * @enum Elm_Transit_Tween_Mode
7697 * The type of acceleration used in the transition.
7701 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
7702 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
7703 over time, then decrease again
7705 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
7707 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
7709 } Elm_Transit_Tween_Mode;
7712 * @enum Elm_Transit_Effect_Flip_Axis
7714 * The axis where flip effect should be applied.
7718 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
7719 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
7720 } Elm_Transit_Effect_Flip_Axis;
7722 * @enum Elm_Transit_Effect_Wipe_Dir
7724 * The direction where the wipe effect should occur.
7728 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
7729 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
7730 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
7731 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
7732 } Elm_Transit_Effect_Wipe_Dir;
7733 /** @enum Elm_Transit_Effect_Wipe_Type
7735 * Whether the wipe effect should show or hide the object.
7739 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
7741 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
7743 } Elm_Transit_Effect_Wipe_Type;
7746 * @typedef Elm_Transit
7748 * The Transit created with elm_transit_add(). This type has the information
7749 * about the objects which the transition will be applied, and the
7750 * transition effects that will be used. It also contains info about
7751 * duration, number of repetitions, auto-reverse, etc.
7753 typedef struct _Elm_Transit Elm_Transit;
7754 typedef void Elm_Transit_Effect;
7756 * @typedef Elm_Transit_Effect_Transition_Cb
7758 * Transition callback called for this effect on each transition iteration.
7760 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
7762 * Elm_Transit_Effect_End_Cb
7764 * Transition callback called for this effect when the transition is over.
7766 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
7769 * Elm_Transit_Del_Cb
7771 * A callback called when the transit is deleted.
7773 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
7778 * @note Is not necessary to delete the transit object, it will be deleted at
7779 * the end of its operation.
7780 * @note The transit will start playing when the program enter in the main loop, is not
7781 * necessary to give a start to the transit.
7783 * @return The transit object.
7787 EAPI Elm_Transit *elm_transit_add(void);
7790 * Stops the animation and delete the @p transit object.
7792 * Call this function if you wants to stop the animation before the duration
7793 * time. Make sure the @p transit object is still alive with
7794 * elm_transit_del_cb_set() function.
7795 * All added effects will be deleted, calling its repective data_free_cb
7796 * functions. The function setted by elm_transit_del_cb_set() will be called.
7798 * @see elm_transit_del_cb_set()
7800 * @param transit The transit object to be deleted.
7803 * @warning Just call this function if you are sure the transit is alive.
7805 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
7808 * Add a new effect to the transit.
7810 * @note The cb function and the data are the key to the effect. If you try to
7811 * add an already added effect, nothing is done.
7812 * @note After the first addition of an effect in @p transit, if its
7813 * effect list become empty again, the @p transit will be killed by
7814 * elm_transit_del(transit) function.
7818 * Elm_Transit *transit = elm_transit_add();
7819 * elm_transit_effect_add(transit,
7820 * elm_transit_effect_blend_op,
7821 * elm_transit_effect_blend_context_new(),
7822 * elm_transit_effect_blend_context_free);
7825 * @param transit The transit object.
7826 * @param transition_cb The operation function. It is called when the
7827 * animation begins, it is the function that actually performs the animation.
7828 * It is called with the @p data, @p transit and the time progression of the
7829 * animation (a double value between 0.0 and 1.0).
7830 * @param effect The context data of the effect.
7831 * @param end_cb The function to free the context data, it will be called
7832 * at the end of the effect, it must finalize the animation and free the
7836 * @warning The transit free the context data at the and of the transition with
7837 * the data_free_cb function, do not use the context data in another transit.
7839 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);
7842 * Delete an added effect.
7844 * This function will remove the effect from the @p transit, calling the
7845 * data_free_cb to free the @p data.
7847 * @see elm_transit_effect_add()
7849 * @note If the effect is not found, nothing is done.
7850 * @note If the effect list become empty, this function will call
7851 * elm_transit_del(transit), that is, it will kill the @p transit.
7853 * @param transit The transit object.
7854 * @param transition_cb The operation function.
7855 * @param effect The context data of the effect.
7859 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);
7862 * Add new object to apply the effects.
7864 * @note After the first addition of an object in @p transit, if its
7865 * object list become empty again, the @p transit will be killed by
7866 * elm_transit_del(transit) function.
7867 * @note If the @p obj belongs to another transit, the @p obj will be
7868 * removed from it and it will only belong to the @p transit. If the old
7869 * transit stays without objects, it will die.
7870 * @note When you add an object into the @p transit, its state from
7871 * evas_object_pass_events_get(obj) is saved, and it is applied when the
7872 * transit ends, if you change this state whith evas_object_pass_events_set()
7873 * after add the object, this state will change again when @p transit stops to
7876 * @param transit The transit object.
7877 * @param obj Object to be animated.
7880 * @warning It is not allowed to add a new object after transit begins to go.
7882 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
7885 * Removes an added object from the transit.
7887 * @note If the @p obj is not in the @p transit, nothing is done.
7888 * @note If the list become empty, this function will call
7889 * elm_transit_del(transit), that is, it will kill the @p transit.
7891 * @param transit The transit object.
7892 * @param obj Object to be removed from @p transit.
7895 * @warning It is not allowed to remove objects after transit begins to go.
7897 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
7900 * Get the objects of the transit.
7902 * @param transit The transit object.
7903 * @return a Eina_List with the objects from the transit.
7907 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7910 * Enable/disable keeping up the objects states.
7911 * If it is not kept, the objects states will be reset when transition ends.
7913 * @note @p transit can not be NULL.
7914 * @note One state includes geometry, color, map data.
7916 * @param transit The transit object.
7917 * @param state_keep Keeping or Non Keeping.
7921 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
7924 * Get a value whether the objects states will be reset or not.
7926 * @note @p transit can not be NULL
7928 * @see elm_transit_objects_final_state_keep_set()
7930 * @param transit The transit object.
7931 * @return EINA_TRUE means the states of the objects will be reset.
7932 * If @p transit is NULL, EINA_FALSE is returned
7936 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7939 * Set the event enabled when transit is operating.
7941 * If @p enabled is EINA_TRUE, the objects of the transit will receives
7942 * events from mouse and keyboard during the animation.
7943 * @note When you add an object with elm_transit_object_add(), its state from
7944 * evas_object_pass_events_get(obj) is saved, and it is applied when the
7945 * transit ends, if you change this state with evas_object_pass_events_set()
7946 * after adding the object, this state will change again when @p transit stops
7949 * @param transit The transit object.
7950 * @param enabled Events are received when enabled is @c EINA_TRUE, and
7951 * ignored otherwise.
7955 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
7958 * Get the value of event enabled status.
7960 * @see elm_transit_event_enabled_set()
7962 * @param transit The Transit object
7963 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
7964 * EINA_FALSE is returned
7968 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7971 * Set the user-callback function when the transit is deleted.
7973 * @note Using this function twice will overwrite the first function setted.
7974 * @note the @p transit object will be deleted after call @p cb function.
7976 * @param transit The transit object.
7977 * @param cb Callback function pointer. This function will be called before
7978 * the deletion of the transit.
7979 * @param data Callback funtion user data. It is the @p op parameter.
7983 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
7986 * Set reverse effect automatically.
7988 * If auto reverse is setted, after running the effects with the progress
7989 * parameter from 0 to 1, it will call the effecs again with the progress
7990 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
7991 * where the duration was setted with the function elm_transit_add and
7992 * the repeat with the function elm_transit_repeat_times_set().
7994 * @param transit The transit object.
7995 * @param reverse EINA_TRUE means the auto_reverse is on.
7999 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
8002 * Get if the auto reverse is on.
8004 * @see elm_transit_auto_reverse_set()
8006 * @param transit The transit object.
8007 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
8008 * EINA_FALSE is returned
8012 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
8015 * Set the transit repeat count. Effect will be repeated by repeat count.
8017 * This function sets the number of repetition the transit will run after
8018 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
8019 * If the @p repeat is a negative number, it will repeat infinite times.
8021 * @note If this function is called during the transit execution, the transit
8022 * will run @p repeat times, ignoring the times it already performed.
8024 * @param transit The transit object
8025 * @param repeat Repeat count
8029 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
8032 * Get the transit repeat count.
8034 * @see elm_transit_repeat_times_set()
8036 * @param transit The Transit object.
8037 * @return The repeat count. If @p transit is NULL
8042 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
8045 * Set the transit animation acceleration type.
8047 * This function sets the tween mode of the transit that can be:
8048 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
8049 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
8050 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
8051 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
8053 * @param transit The transit object.
8054 * @param tween_mode The tween type.
8058 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
8061 * Get the transit animation acceleration type.
8063 * @note @p transit can not be NULL
8065 * @param transit The transit object.
8066 * @return The tween type. If @p transit is NULL
8067 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
8071 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
8074 * Set the transit animation time
8076 * @note @p transit can not be NULL
8078 * @param transit The transit object.
8079 * @param duration The animation time.
8083 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
8086 * Get the transit animation time
8088 * @note @p transit can not be NULL
8090 * @param transit The transit object.
8092 * @return The transit animation time.
8096 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
8099 * Starts the transition.
8100 * Once this API is called, the transit begins to measure the time.
8102 * @note @p transit can not be NULL
8104 * @param transit The transit object.
8108 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
8111 * Pause/Resume the transition.
8113 * If you call elm_transit_go again, the transit will be started from the
8114 * beginning, and will be unpaused.
8116 * @note @p transit can not be NULL
8118 * @param transit The transit object.
8119 * @param paused Whether the transition should be paused or not.
8123 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
8126 * Get the value of paused status.
8128 * @see elm_transit_paused_set()
8130 * @note @p transit can not be NULL
8132 * @param transit The transit object.
8133 * @return EINA_TRUE means transition is paused. If @p transit is NULL
8134 * EINA_FALSE is returned
8138 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
8141 * Get the time progression of the animation (a double value between 0.0 and 1.0).
8143 * The value returned is a fraction (current time / total time). It
8144 * represents the progression position relative to the total.
8146 * @note @p transit can not be NULL
8148 * @param transit The transit object.
8150 * @return The time progression value. If @p transit is NULL
8155 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
8158 * Makes the chain relationship between two transits.
8160 * @note @p transit can not be NULL. Transit would have multiple chain transits.
8161 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
8163 * @param transit The transit object.
8164 * @param chain_transit The chain transit object. This transit will be operated
8165 * after transit is done.
8167 * This function adds @p chain_transit transition to a chain after the @p
8168 * transit, and will be started as soon as @p transit ends. See @ref
8169 * transit_example_02_explained for a full example.
8173 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
8176 * Cut off the chain relationship between two transits.
8178 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
8179 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
8181 * @param transit The transit object.
8182 * @param chain_transit The chain transit object.
8184 * This function remove the @p chain_transit transition from the @p transit.
8188 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
8191 * Get the current chain transit list.
8193 * @note @p transit can not be NULL.
8195 * @param transit The transit object.
8196 * @return chain transit list.
8200 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
8203 * Add the Resizing Effect to Elm_Transit.
8205 * @note This API is one of the facades. It creates resizing effect context
8206 * and add it's required APIs to elm_transit_effect_add.
8208 * @see elm_transit_effect_add()
8210 * @param transit Transit object.
8211 * @param from_w Object width size when effect begins.
8212 * @param from_h Object height size when effect begins.
8213 * @param to_w Object width size when effect ends.
8214 * @param to_h Object height size when effect ends.
8215 * @return Resizing effect context data.
8219 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);
8222 * Add the Translation Effect to Elm_Transit.
8224 * @note This API is one of the facades. It creates translation effect context
8225 * and add it's required APIs to elm_transit_effect_add.
8227 * @see elm_transit_effect_add()
8229 * @param transit Transit object.
8230 * @param from_dx X Position variation when effect begins.
8231 * @param from_dy Y Position variation when effect begins.
8232 * @param to_dx X Position variation when effect ends.
8233 * @param to_dy Y Position variation when effect ends.
8234 * @return Translation effect context data.
8237 * @warning It is highly recommended just create a transit with this effect when
8238 * the window that the objects of the transit belongs has already been created.
8239 * This is because this effect needs the geometry information about the objects,
8240 * and if the window was not created yet, it can get a wrong information.
8242 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);
8245 * Add the Zoom Effect to Elm_Transit.
8247 * @note This API is one of the facades. It creates zoom effect context
8248 * and add it's required APIs to elm_transit_effect_add.
8250 * @see elm_transit_effect_add()
8252 * @param transit Transit object.
8253 * @param from_rate Scale rate when effect begins (1 is current rate).
8254 * @param to_rate Scale rate when effect ends.
8255 * @return Zoom effect context data.
8258 * @warning It is highly recommended just create a transit with this effect when
8259 * the window that the objects of the transit belongs has already been created.
8260 * This is because this effect needs the geometry information about the objects,
8261 * and if the window was not created yet, it can get a wrong information.
8263 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
8266 * Add the Flip Effect to Elm_Transit.
8268 * @note This API is one of the facades. It creates flip effect context
8269 * and add it's required APIs to elm_transit_effect_add.
8270 * @note This effect is applied to each pair of objects in the order they are listed
8271 * in the transit list of objects. The first object in the pair will be the
8272 * "front" object and the second will be the "back" object.
8274 * @see elm_transit_effect_add()
8276 * @param transit Transit object.
8277 * @param axis Flipping Axis(X or Y).
8278 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
8279 * @return Flip effect context data.
8282 * @warning It is highly recommended just create a transit with this effect when
8283 * the window that the objects of the transit belongs has already been created.
8284 * This is because this effect needs the geometry information about the objects,
8285 * and if the window was not created yet, it can get a wrong information.
8287 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
8290 * Add the Resizable Flip Effect to Elm_Transit.
8292 * @note This API is one of the facades. It creates resizable flip effect context
8293 * and add it's required APIs to elm_transit_effect_add.
8294 * @note This effect is applied to each pair of objects in the order they are listed
8295 * in the transit list of objects. The first object in the pair will be the
8296 * "front" object and the second will be the "back" object.
8298 * @see elm_transit_effect_add()
8300 * @param transit Transit object.
8301 * @param axis Flipping Axis(X or Y).
8302 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
8303 * @return Resizable flip effect context data.
8306 * @warning It is highly recommended just create a transit with this effect when
8307 * the window that the objects of the transit belongs has already been created.
8308 * This is because this effect needs the geometry information about the objects,
8309 * and if the window was not created yet, it can get a wrong information.
8311 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
8314 * Add the Wipe Effect to Elm_Transit.
8316 * @note This API is one of the facades. It creates wipe effect context
8317 * and add it's required APIs to elm_transit_effect_add.
8319 * @see elm_transit_effect_add()
8321 * @param transit Transit object.
8322 * @param type Wipe type. Hide or show.
8323 * @param dir Wipe Direction.
8324 * @return Wipe effect context data.
8327 * @warning It is highly recommended just create a transit with this effect when
8328 * the window that the objects of the transit belongs has already been created.
8329 * This is because this effect needs the geometry information about the objects,
8330 * and if the window was not created yet, it can get a wrong information.
8332 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
8335 * Add the Color Effect to Elm_Transit.
8337 * @note This API is one of the facades. It creates color effect context
8338 * and add it's required APIs to elm_transit_effect_add.
8340 * @see elm_transit_effect_add()
8342 * @param transit Transit object.
8343 * @param from_r RGB R when effect begins.
8344 * @param from_g RGB G when effect begins.
8345 * @param from_b RGB B when effect begins.
8346 * @param from_a RGB A when effect begins.
8347 * @param to_r RGB R when effect ends.
8348 * @param to_g RGB G when effect ends.
8349 * @param to_b RGB B when effect ends.
8350 * @param to_a RGB A when effect ends.
8351 * @return Color effect context data.
8355 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);
8358 * Add the Fade Effect to Elm_Transit.
8360 * @note This API is one of the facades. It creates fade effect context
8361 * and add it's required APIs to elm_transit_effect_add.
8362 * @note This effect is applied to each pair of objects in the order they are listed
8363 * in the transit list of objects. The first object in the pair will be the
8364 * "before" object and the second will be the "after" object.
8366 * @see elm_transit_effect_add()
8368 * @param transit Transit object.
8369 * @return Fade effect context data.
8372 * @warning It is highly recommended just create a transit with this effect when
8373 * the window that the objects of the transit belongs has already been created.
8374 * This is because this effect needs the color information about the objects,
8375 * and if the window was not created yet, it can get a wrong information.
8377 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
8380 * Add the Blend Effect to Elm_Transit.
8382 * @note This API is one of the facades. It creates blend effect context
8383 * and add it's required APIs to elm_transit_effect_add.
8384 * @note This effect is applied to each pair of objects in the order they are listed
8385 * in the transit list of objects. The first object in the pair will be the
8386 * "before" object and the second will be the "after" object.
8388 * @see elm_transit_effect_add()
8390 * @param transit Transit object.
8391 * @return Blend effect context data.
8394 * @warning It is highly recommended just create a transit with this effect when
8395 * the window that the objects of the transit belongs has already been created.
8396 * This is because this effect needs the color information about the objects,
8397 * and if the window was not created yet, it can get a wrong information.
8399 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
8402 * Add the Rotation Effect to Elm_Transit.
8404 * @note This API is one of the facades. It creates rotation effect context
8405 * and add it's required APIs to elm_transit_effect_add.
8407 * @see elm_transit_effect_add()
8409 * @param transit Transit object.
8410 * @param from_degree Degree when effect begins.
8411 * @param to_degree Degree when effect is ends.
8412 * @return Rotation effect context data.
8415 * @warning It is highly recommended just create a transit with this effect when
8416 * the window that the objects of the transit belongs has already been created.
8417 * This is because this effect needs the geometry information about the objects,
8418 * and if the window was not created yet, it can get a wrong information.
8420 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
8423 * Add the ImageAnimation Effect to Elm_Transit.
8425 * @note This API is one of the facades. It creates image animation effect context
8426 * and add it's required APIs to elm_transit_effect_add.
8427 * The @p images parameter is a list images paths. This list and
8428 * its contents will be deleted at the end of the effect by
8429 * elm_transit_effect_image_animation_context_free() function.
8433 * char buf[PATH_MAX];
8434 * Eina_List *images = NULL;
8435 * Elm_Transit *transi = elm_transit_add();
8437 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
8438 * images = eina_list_append(images, eina_stringshare_add(buf));
8440 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
8441 * images = eina_list_append(images, eina_stringshare_add(buf));
8442 * elm_transit_effect_image_animation_add(transi, images);
8446 * @see elm_transit_effect_add()
8448 * @param transit Transit object.
8449 * @param images Eina_List of images file paths. This list and
8450 * its contents will be deleted at the end of the effect by
8451 * elm_transit_effect_image_animation_context_free() function.
8452 * @return Image Animation effect context data.
8456 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
8462 typedef struct _Elm_Store Elm_Store;
8463 typedef struct _Elm_Store_DBsystem Elm_Store_DBsystem;
8464 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
8465 typedef struct _Elm_Store_Item Elm_Store_Item;
8466 typedef struct _Elm_Store_Item_DBsystem Elm_Store_Item_DBsystem;
8467 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
8468 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
8469 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
8470 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
8471 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
8472 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
8473 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
8474 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
8476 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
8477 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
8478 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
8479 typedef void (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
8480 typedef int (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
8481 typedef void (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
8482 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
8486 ELM_STORE_ITEM_MAPPING_NONE = 0,
8487 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
8488 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
8489 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
8490 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
8491 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
8492 // can add more here as needed by common apps
8493 ELM_STORE_ITEM_MAPPING_LAST
8494 } Elm_Store_Item_Mapping_Type;
8496 struct _Elm_Store_Item_Mapping_Icon
8498 // FIXME: allow edje file icons
8500 Elm_Icon_Lookup_Order lookup_order;
8501 Eina_Bool standard_name : 1;
8502 Eina_Bool no_scale : 1;
8503 Eina_Bool smooth : 1;
8504 Eina_Bool scale_up : 1;
8505 Eina_Bool scale_down : 1;
8508 struct _Elm_Store_Item_Mapping_Empty
8513 struct _Elm_Store_Item_Mapping_Photo
8518 struct _Elm_Store_Item_Mapping_Custom
8520 Elm_Store_Item_Mapping_Cb func;
8523 struct _Elm_Store_Item_Mapping
8525 Elm_Store_Item_Mapping_Type type;
8529 Elm_Store_Item_Mapping_Empty empty;
8530 Elm_Store_Item_Mapping_Icon icon;
8531 Elm_Store_Item_Mapping_Photo photo;
8532 Elm_Store_Item_Mapping_Custom custom;
8533 // add more types here
8537 struct _Elm_Store_Item_Info
8543 int pre_group_index;
8545 Elm_Genlist_Item_Class *item_class;
8546 const Elm_Store_Item_Mapping *mapping;
8551 struct _Elm_Store_Item_Info_Filesystem
8553 Elm_Store_Item_Info base;
8557 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
8558 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
8560 EAPI Elm_Store *elm_store_dbsystem_new(void);
8561 EAPI void elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
8562 EAPI void elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
8563 EAPI void elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
8564 EAPI void elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
8565 EAPI int elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8566 EAPI void *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8567 EAPI void elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
8568 EAPI int elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8569 EAPI Elm_Store_Item *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
8570 EAPI void elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8571 EAPI void elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
8572 EAPI void elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8573 EAPI void elm_store_free(Elm_Store *st);
8574 EAPI Elm_Store *elm_store_filesystem_new(void);
8575 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
8576 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8577 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8578 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
8579 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
8580 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8581 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
8582 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
8583 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
8584 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8585 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
8586 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
8587 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8588 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
8589 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8590 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8591 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8593 /* SegmentControl */
8594 typedef struct _Elm_Segment_Item Elm_Segment_Item;
8595 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8596 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
8597 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);
8598 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
8599 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8600 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8601 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8602 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8603 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
8604 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8605 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
8606 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
8607 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
8608 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8609 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
8610 /* smart callbacks called:
8611 * "changed" -when the user clicks on a segment item which is not previously
8612 * selected and get selected. The event_info parameter is the
8613 * segment item index.
8616 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
8617 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
8618 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
8619 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
8620 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
8621 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
8622 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
8623 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
8625 EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
8626 EAPI void elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
8628 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
8629 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
8630 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
8631 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
8632 EAPI void elm_video_play(Evas_Object *video);
8633 EAPI void elm_video_pause(Evas_Object *video);
8634 EAPI void elm_video_stop(Evas_Object *video);
8635 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
8636 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
8637 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
8638 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
8639 EAPI double elm_video_audio_level_get(Evas_Object *video);
8640 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
8641 EAPI double elm_video_play_position_get(Evas_Object *video);
8642 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
8643 EAPI double elm_video_play_length_get(Evas_Object *video);
8644 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
8645 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
8646 EAPI const char *elm_video_title_get(Evas_Object *video);
8648 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
8649 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
8651 // FIXME: incomplete - carousel. don't use this until this comment is removed
8652 typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
8653 EAPI Evas_Object *elm_carousel_add(Evas_Object *parent);
8654 EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
8655 EAPI void elm_carousel_item_del(Elm_Carousel_Item *item);
8656 EAPI void elm_carousel_item_select(Elm_Carousel_Item *item);
8657 /* smart callbacks called:
8658 * "clicked" - when the user clicks on a carousel item and becomes selected
8663 typedef enum _Elm_Datefield_ItemType
8665 ELM_DATEFIELD_YEAR = 0,
8666 ELM_DATEFIELD_MONTH,
8669 ELM_DATEFIELD_MINUTE,
8671 } Elm_Datefield_ItemType;
8673 EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
8674 EAPI void elm_datefield_format_set(Evas_Object *obj, const char *fmt);
8675 EAPI char *elm_datefield_format_get(const Evas_Object *obj);
8676 EAPI void elm_datefield_item_enabled_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, Eina_Bool enable);
8677 EAPI Eina_Bool elm_datefield_item_enabled_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8678 EAPI void elm_datefield_item_value_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value);
8679 EAPI int elm_datefield_item_value_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8680 EAPI void elm_datefield_item_min_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
8681 EAPI int elm_datefield_item_min_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8682 EAPI Eina_Bool elm_datefield_item_min_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8683 EAPI void elm_datefield_item_max_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
8684 EAPI int elm_datefield_item_max_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8685 EAPI Eina_Bool elm_datefield_item_max_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8687 /* smart callbacks called:
8688 * "changed" - when datefield value is changed, this signal is sent.
8691 ////////////////////// DEPRECATED ///////////////////////////////////
8693 typedef enum _Elm_Datefield_Layout
8695 ELM_DATEFIELD_LAYOUT_TIME,
8696 ELM_DATEFIELD_LAYOUT_DATE,
8697 ELM_DATEFIELD_LAYOUT_DATEANDTIME
8698 } Elm_Datefield_Layout;
8700 EINA_DEPRECATED EAPI void elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
8701 EINA_DEPRECATED EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
8702 EINA_DEPRECATED EAPI void elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
8703 EINA_DEPRECATED EAPI const char *elm_datefield_date_format_get(const Evas_Object *obj);
8704 EINA_DEPRECATED EAPI void elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
8705 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_time_mode_get(const Evas_Object *obj);
8706 EINA_DEPRECATED EAPI void elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
8707 EINA_DEPRECATED EAPI void elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
8708 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
8709 EINA_DEPRECATED EAPI void elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
8710 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
8711 EINA_DEPRECATED EAPI void elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
8712 EINA_DEPRECATED EAPI void elm_datefield_input_panel_state_callback_add(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value), void *data);
8713 EINA_DEPRECATED EAPI void elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
8714 /////////////////////////////////////////////////////////////////////
8717 typedef enum _Elm_Popup_Response
8719 ELM_POPUP_RESPONSE_NONE = -1,
8720 ELM_POPUP_RESPONSE_TIMEOUT = -2,
8721 ELM_POPUP_RESPONSE_OK = -3,
8722 ELM_POPUP_RESPONSE_CANCEL = -4,
8723 ELM_POPUP_RESPONSE_CLOSE = -5
8724 } Elm_Popup_Response;
8726 typedef enum _Elm_Popup_Mode
8728 ELM_POPUP_TYPE_NONE = 0,
8729 ELM_POPUP_TYPE_ALERT = (1 << 0)
8732 typedef enum _Elm_Popup_Orient
8734 ELM_POPUP_ORIENT_TOP,
8735 ELM_POPUP_ORIENT_CENTER,
8736 ELM_POPUP_ORIENT_BOTTOM,
8737 ELM_POPUP_ORIENT_LEFT,
8738 ELM_POPUP_ORIENT_RIGHT,
8739 ELM_POPUP_ORIENT_TOP_LEFT,
8740 ELM_POPUP_ORIENT_TOP_RIGHT,
8741 ELM_POPUP_ORIENT_BOTTOM_LEFT,
8742 ELM_POPUP_ORIENT_BOTTOM_RIGHT
8745 /* smart callbacks called:
8746 * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
8749 EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
8750 EAPI void elm_popup_desc_set(Evas_Object *obj, const char *text);
8751 EAPI const char *elm_popup_desc_get(Evas_Object *obj);
8752 EAPI void elm_popup_title_label_set(Evas_Object *obj, const char *text);
8753 EAPI const char *elm_popup_title_label_get(Evas_Object *obj);
8754 EAPI void elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
8755 EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
8756 EAPI void elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
8757 EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
8758 EAPI void elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text, ...);
8759 EAPI Evas_Object *elm_popup_with_buttons_add(Evas_Object *parent, const char *title, const char *desc_text,int no_of_buttons, const char *first_button_text, ... );
8760 EAPI void elm_popup_timeout_set(Evas_Object *obj, double timeout);
8761 EAPI void elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
8762 EAPI void elm_popup_response(Evas_Object *obj, int response_id);
8763 EAPI void elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
8764 EAPI int elm_popup_run(Evas_Object *obj);
8767 #define NAVIBAR_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
8768 #define NAVIBAR_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
8772 ELM_NAVIGATIONBAR_FUNCTION_BUTTON1,
8773 ELM_NAVIGATIONBAR_FUNCTION_BUTTON2,
8774 ELM_NAVIGATIONBAR_FUNCTION_BUTTON3,
8775 ELM_NAVIGATIONBAR_BACK_BUTTON
8776 } Elm_Navi_Button_Type;
8778 EAPI Evas_Object *elm_navigationbar_add(Evas_Object *parent);
8779 EAPI void elm_navigationbar_push(Evas_Object *obj, const char *title, Evas_Object *fn_btn1, Evas_Object *fn_btn2, Evas_Object *fn_btn3, Evas_Object *content);
8780 EAPI void elm_navigationbar_pop(Evas_Object *obj);
8781 EAPI void elm_navigationbar_to_content_pop(Evas_Object *obj, Evas_Object *content);
8782 EAPI void elm_navigationbar_title_label_set(Evas_Object *obj, Evas_Object *content, const char *title);
8783 EAPI const char *elm_navigationbar_title_label_get(Evas_Object *obj, Evas_Object *content);
8784 EAPI void elm_navigationbar_title_object_add(Evas_Object *obj, Evas_Object *content, Evas_Object *title_obj);
8785 EAPI Evas_Object *elm_navigationbar_title_object_get(Evas_Object *obj, Evas_Object *content);
8786 EAPI Eina_List *elm_navigationbar_title_object_list_get(Evas_Object *obj, Evas_Object *content);
8787 EAPI Evas_Object *elm_navigationbar_content_top_get(Evas_Object *obj);
8788 EAPI Evas_Object *elm_navigationbar_content_bottom_get(Evas_Object *obj);
8789 EAPI void elm_navigationbar_hidden_set(Evas_Object *obj, Eina_Bool hidden);
8790 EAPI void elm_navigationbar_title_button_set(Evas_Object *obj, Evas_Object *content, Evas_Object *button, Elm_Navi_Button_Type button_type);
8791 EAPI Evas_Object *elm_navigationbar_title_button_get(Evas_Object *obj, Evas_Object *content, Elm_Navi_Button_Type button_type);
8792 EAPI const char *elm_navigationbar_subtitle_label_get(Evas_Object *obj, Evas_Object *content);
8793 EAPI void elm_navigationbar_subtitle_label_set(Evas_Object *obj, Evas_Object *content, const char *subtitle);
8794 EAPI void elm_navigationbar_title_object_list_unset(Evas_Object *obj, Evas_Object *content, Eina_List **list);
8795 EAPI void elm_navigationbar_animation_disabled_set(Evas_Object *obj, Eina_Bool disable);
8796 EAPI void elm_navigationbar_title_object_visible_set(Evas_Object *obj, Evas_Object *content, Eina_Bool visible);
8797 Eina_Bool elm_navigationbar_title_object_visible_get(Evas_Object *obj, Evas_Object *content);
8798 EAPI void elm_navigationbar_title_icon_set(Evas_Object *obj, Evas_Object *content, Evas_Object *icon);
8799 EAPI Evas_Object *elm_navigationbar_title_icon_get(Evas_Object *obj, Evas_Object *content);
8802 #define NAVIBAR_EX_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
8803 #define NAVIBAR_EX_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
8807 ELM_NAVIGATIONBAR_EX_BACK_BUTTON,
8808 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON1,
8809 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON2,
8810 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON3,
8811 ELM_NAVIGATIONBAR_EX_MAX
8812 } Elm_Navi_ex_Button_Type;
8813 typedef struct _Elm_Navigationbar_ex_Item Elm_Navigationbar_ex_Item;
8815 EAPI Evas_Object *elm_navigationbar_ex_add(Evas_Object *parent);
8816 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_push(Evas_Object *obj, Evas_Object *content, const char *item_style);
8817 EAPI void elm_navigationbar_ex_item_pop(Evas_Object *obj);
8818 EAPI void elm_navigationbar_ex_item_promote(Elm_Navigationbar_ex_Item* item);
8819 EAPI void elm_navigationbar_ex_to_item_pop(Elm_Navigationbar_ex_Item* item);
8820 EAPI void elm_navigationbar_ex_item_title_label_set(Elm_Navigationbar_ex_Item *item, const char *title);
8821 EAPI const char *elm_navigationbar_ex_item_title_label_get(Elm_Navigationbar_ex_Item* item);
8822 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_top_get(const Evas_Object *obj);
8823 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_bottom_get(const Evas_Object *obj);
8824 EAPI void elm_navigationbar_ex_item_title_button_set(Elm_Navigationbar_ex_Item* item, char *btn_label, Evas_Object *icon, int button_type, Evas_Smart_Cb func, const void *data);
8825 EAPI Evas_Object *elm_navigationbar_ex_item_title_button_get(Elm_Navigationbar_ex_Item* item, int button_type);
8826 EAPI void elm_navigationbar_ex_item_title_object_set(Elm_Navigationbar_ex_Item* item, Evas_Object *title_obj);
8827 EAPI Evas_Object *elm_navigationbar_ex_item_title_object_unset(Elm_Navigationbar_ex_Item* item);
8828 EAPI void elm_navigationbar_ex_item_title_hidden_set(Elm_Navigationbar_ex_Item* item, Eina_Bool hidden);
8829 EAPI Evas_Object *elm_navigationbar_ex_item_title_object_get(Elm_Navigationbar_ex_Item* item);
8830 EAPI const char *elm_navigationbar_ex_item_subtitle_label_get(Elm_Navigationbar_ex_Item* item);
8831 EAPI void elm_navigationbar_ex_item_subtitle_label_set( Elm_Navigationbar_ex_Item* item, const char *subtitle);
8832 EAPI void elm_navigationbar_ex_item_style_set(Elm_Navigationbar_ex_Item* item, const char* item_style);
8833 EAPI const char *elm_navigationbar_ex_item_style_get(Elm_Navigationbar_ex_Item* item);
8834 EAPI Evas_Object *elm_navigationbar_ex_item_content_unset(Elm_Navigationbar_ex_Item* item);
8835 EAPI Evas_Object *elm_navigationbar_ex_item_content_get(Elm_Navigationbar_ex_Item* item);
8836 EAPI void elm_navigationbar_ex_delete_on_pop_set(Evas_Object *obj, Eina_Bool del_on_pop);
8837 EAPI Evas_Object *elm_navigationbar_ex_item_icon_get(Elm_Navigationbar_ex_Item* item);
8838 EAPI void elm_navigationbar_ex_item_icon_set(Elm_Navigationbar_ex_Item* item, Evas_Object *icon);
8839 EAPI Evas_Object *elm_navigationbar_ex_item_title_button_unset(Elm_Navigationbar_ex_Item* item, int button_type);
8840 EAPI void elm_navigationbar_ex_animation_disable_set(Evas_Object *obj, Eina_Bool disable);
8841 EAPI void elm_navigationbar_ex_title_object_visible_set(Elm_Navigationbar_ex_Item* item, Eina_Bool visible);
8842 Eina_Bool elm_navigationbar_ex_title_object_visible_get(Elm_Navigationbar_ex_Item* item);
8845 #define ELM_NAVIFRAME_ITEM_CONTENT "elm.swallow.content"
8846 #define ELM_NAVIFRAME_ITEM_ICON "elm.swallow.icon"
8847 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER "elm.swallow.optionheader"
8848 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER2 "elm.swallow.optionheader2"
8849 #define ELM_NAVIFRAME_ITEM_TITLE_LABEL "elm.text.title"
8850 #define ELM_NAVIFRAME_ITEM_PREV_BTN "elm.swallow.prev_btn"
8851 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_CLOSE "elm,state,optionheader,close", ""
8852 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_OPEN "elm,state,optionheader,open", ""
8853 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_CLOSE "elm,state,optionheader,instant_close", ""
8854 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_OPEN "elm,state,optionheader,instant_open", ""
8857 * @defgroup Naviframe Naviframe
8859 * @brief Naviframe is a kind of view manager for the applications.
8861 * Naviframe provides functions to switch different pages with stack
8862 * mechanism. It means if one page(item) needs to be changed to the new one,
8863 * then naviframe would push the new page to it's internal stack. Of course,
8864 * it can be back to the previous page by popping the top page. Naviframe
8865 * provides some transition effect while the pages are switching (same as
8868 * Since each item could keep the different styles, users could keep the
8869 * same look & feel for the pages or different styles for the items in it's
8872 * Signals that you can add callback for are:
8874 * @li "transition,finished" - When the transition is finished in changing
8876 * @li "title,clicked" - User clicked title area
8878 * Default contents parts for the naviframe items that you can use for are:
8880 * @li "elm.swallow.content" - The main content of the page
8881 * @li "elm.swallow.prev_btn" - The button to go to the previous page
8882 * @li "elm.swallow.next_btn" - The button to go to the next page
8884 * Default text parts of naviframe items that you can be used are:
8886 * @li "elm.text.title" - The title label in the title area
8888 * @ref tutorial_naviframe gives a good overview of the usage of the API.
8892 * @brief Add a new Naviframe object to the parent.
8894 * @param parent Parent object
8895 * @return New object or @c NULL, if it cannot be created
8897 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8899 * @brief Push a new item to the top of the naviframe stack (and show it).
8901 * @param obj The naviframe object
8902 * @param title_label The label in the title area. The name of the title
8903 * label part is "elm.text.title"
8904 * @param prev_btn The button to go to the previous item. If it is NULL,
8905 * then naviframe will create a back button automatically. The name of
8906 * the prev_btn part is "elm.swallow.prev_btn"
8907 * @param next_btn The button to go to the next item. Or It could be just an
8908 * extra function button. The name of the next_btn part is
8909 * "elm.swallow.next_btn"
8910 * @param content The main content object. The name of content part is
8911 * "elm.swallow.content"
8912 * @param item_style The current item style name. @c NULL would be default.
8913 * @return The created item or @c NULL upon failure.
8915 * The item pushed becomes one page of the naviframe, this item will be
8916 * deleted when it is popped.
8918 * @see also elm_naviframe_item_style_set()
8920 * The following styles are available for this item:
8923 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);
8925 * @brief Pop an item that is on top of the stack
8927 * @param obj The naviframe object
8928 * @return @c NULL or the content object(if the
8929 * elm_naviframe_content_preserve_on_pop_get is true).
8931 * This pops an item that is on the top(visible) of the naviframe, makes it
8932 * disappear, then deletes the item. The item that was underneath it on the
8933 * stack will become visible.
8935 * @see also elm_naviframe_content_preserve_on_pop_get()
8937 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
8939 * @brief Pop the items between the top and the above one on the given item.
8941 * @param it The naviframe item
8943 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
8945 * Promote an item already in the naviframe stack to the top of the stack
8947 * @param it The naviframe item
8949 * This will take the indicated item and promote it to the top of the stack
8950 * as if it had been pushed there. The item must already be inside the
8951 * naviframe stack to work.
8954 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
8956 * @brief Delete the given item instantly.
8958 * @param it The naviframe item
8960 * This just deletes the given item from the naviframe item list instantly.
8961 * So this would not emit any signals for view transitions but just change
8962 * the current view if the given item is a top one.
8965 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
8967 * @brief preserve the content objects when items are popped.
8969 * @param obj The naviframe object
8970 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
8972 * @see also elm_naviframe_content_preserve_on_pop_get()
8974 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
8976 * @brief Get a value whether preserve mode is enabled or not.
8978 * @param obj The naviframe object
8979 * @return If @c EINA_TRUE, preserve mode is enabled
8981 * @see also elm_naviframe_content_preserve_on_pop_set()
8983 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8985 * @brief Get a top item on the naviframe stack
8987 * @param obj The naviframe object
8988 * @return The top item on the naviframe stack or @c NULL, if the stack is
8991 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8993 * @brief Get a bottom item on the naviframe stack
8995 * @param obj The naviframe object
8996 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
8999 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9001 * @brief Set an item style
9003 * @param obj The naviframe item
9004 * @param item_style The current item style name. @c NULL would be default
9006 * The following styles are available for this item:
9009 * @see also elm_naviframe_item_style_get()
9011 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
9013 * @brief Get an item style
9015 * @param obj The naviframe item
9016 * @return The current item style name
9018 * @see also elm_naviframe_item_style_set()
9020 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
9022 * @brief Show/Hide the title area
9024 * @param it The naviframe item
9025 * @param visible If @c EINA_TRUE, title area will be visible, hidden
9028 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
9030 * @see also elm_naviframe_item_title_visible_get()
9032 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
9034 * @brief Get a value whether title area is visible or not.
9036 * @param it The naviframe item
9037 * @return If @c EINA_TRUE, title area is visible
9039 * @see also elm_naviframe_item_title_visible_set()
9041 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
9043 * @brief Set creating prev button automatically or not
9045 * @param obj The naviframe object
9046 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
9047 * be created internally when you pass the @c NULL to the prev_btn
9048 * parameter in elm_naviframe_item_push
9050 * @see also elm_naviframe_item_push()
9052 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
9054 * @brief Get a value whether prev button(back button) will be auto pushed or
9057 * @param obj The naviframe object
9058 * @return If @c EINA_TRUE, prev button will be auto pushed.
9060 * @see also elm_naviframe_item_push()
9061 * elm_naviframe_prev_btn_auto_pushed_set()
9063 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
9066 #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
9067 #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
9068 #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
9069 #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
9070 #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
9071 #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
9072 #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
9073 #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
9074 #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
9076 typedef enum _Elm_Controlbar_Mode_Type
9078 ELM_CONTROLBAR_MODE_DEFAULT = 0,
9079 ELM_CONTROLBAR_MODE_TRANSLUCENCE,
9080 ELM_CONTROLBAR_MODE_TRANSPARENCY,
9081 ELM_CONTROLBAR_MODE_LARGE,
9082 ELM_CONTROLBAR_MODE_SMALL,
9083 ELM_CONTROLBAR_MODE_LEFT,
9084 ELM_CONTROLBAR_MODE_RIGHT
9085 } Elm_Controlbar_Mode_Type;
9087 typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
9088 EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
9089 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
9090 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
9091 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, const char *icon_path, const char *label, Evas_Object *view);
9092 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, const char *icon_path, const char *label, Evas_Object *view);
9093 EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_append(Evas_Object *obj, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
9094 EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
9095 EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
9096 EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
9097 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
9098 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
9099 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
9100 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
9101 EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
9102 EAPI void elm_controlbar_item_del(Elm_Controlbar_Item *it);
9103 EAPI void elm_controlbar_item_select(Elm_Controlbar_Item *it);
9104 EAPI void elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
9105 EAPI Eina_Bool elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
9106 EAPI void elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
9107 EAPI Eina_Bool elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
9108 EAPI void elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
9109 EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
9110 EAPI void elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
9111 EAPI const char *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
9112 EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
9113 EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
9114 EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
9115 EAPI const Eina_List *elm_controlbar_items_get(const Evas_Object *obj);
9116 EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
9117 EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
9118 EAPI void elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
9119 EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
9120 EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
9121 EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
9122 EAPI void elm_controlbar_mode_set(Evas_Object *obj, int mode);
9123 EAPI void elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
9124 EAPI void elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
9125 EAPI void elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
9128 EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
9129 EAPI void elm_searchbar_text_set(Evas_Object *obj, const char *entry);
9130 EAPI const char *elm_searchbar_text_get(Evas_Object *obj);
9131 EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
9132 EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
9133 EAPI void elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
9134 EAPI void elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
9135 EAPI void elm_searchbar_clear(Evas_Object *obj);
9136 EAPI void elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
9138 EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
9139 EAPI void elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
9140 EAPI void elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
9141 EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
9144 EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
9145 EAPI void elm_nocontents_label_set(Evas_Object *obj, const char *label);
9146 EAPI const char *elm_nocontents_label_get(const Evas_Object *obj);
9147 EAPI void elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
9148 EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
9153 ELM_TICKERNOTI_ORIENT_TOP = 0,
9154 ELM_TICKERNOTI_ORIENT_BOTTOM,
9155 ELM_TICKERNOTI_ORIENT_LAST
9156 } Elm_Tickernoti_Orient;
9158 EAPI Evas_Object *elm_tickernoti_add (Evas_Object *parent);
9159 EAPI void elm_tickernoti_orient_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
9160 EAPI Elm_Tickernoti_Orient elm_tickernoti_orient_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
9161 EAPI int elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
9162 EAPI void elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
9163 EAPI Evas_Object *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
9164 /* #### Below APIs and data structures are going to be deprecated, announcment will be made soon ####*/
9167 ELM_TICKERNOTI_DEFAULT,
9168 ELM_TICKERNOTI_DETAILVIEW
9169 } Elm_Tickernoti_Mode;
9170 EAPI void elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
9171 EAPI const char *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
9172 EAPI void elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
9173 EAPI Evas_Object *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
9174 EAPI void elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
9175 EAPI Evas_Object *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
9176 EAPI Evas_Object *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
9177 EAPI void elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
9178 EAPI Elm_Tickernoti_Mode elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
9179 EAPI void elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
9180 EAPI Elm_Tickernoti_Orient elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
9181 EAPI void elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
9182 EAPI const char *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
9183 EAPI void elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
9184 EAPI Evas_Object *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
9185 EAPI void elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
9186 EAPI Evas_Object *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
9187 /* ############################################################################### */
9189 * Parts which can be used with elm_object_text_part_set() and
9190 * elm_object_text_part_get():
9192 * @li NULL/"default" - Operates on tickernoti content-text
9194 * Parts which can be used with elm_object_content_part_set() and
9195 * elm_object_content_part_get():
9197 * @li "icon" - Operates on tickernoti's icon
9198 * @li "button" - Operates on tickernoti's button
9200 * smart callbacks called:
9201 * @li "clicked" - emitted when tickernoti is clicked, except at the
9202 * swallow/button region, if any.
9203 * @li "hide" - emitted when the tickernoti is completely hidden. In case of
9204 * any hide animation, this signal is emitted after the animation.
9208 typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
9210 struct _Colorpalette_Color
9212 unsigned int r, g, b;
9215 EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
9216 EAPI void elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
9217 EAPI void elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
9218 /* smart callbacks called:
9219 * "clicked" - when image clicked
9223 EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
9224 EAPI void elm_editfield_label_set(Evas_Object *obj, const char *label);
9225 EAPI const char *elm_editfield_label_get(Evas_Object *obj);
9226 EAPI void elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
9227 EAPI const char *elm_editfield_guide_text_get(Evas_Object *obj);
9228 EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
9229 // EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
9230 EAPI void elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
9231 EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
9232 EAPI void elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
9233 EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
9234 EAPI void elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
9235 EAPI Eina_Bool elm_editfield_entry_single_line_get(Evas_Object *obj);
9236 EAPI void elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
9237 EAPI Eina_Bool elm_editfield_eraser_get(Evas_Object *obj);
9238 /* smart callbacks called:
9239 * "clicked" - when an editfield is clicked
9240 * "unfocused" - when an editfield is unfocused
9244 /* Sliding Drawer */
9245 typedef enum _Elm_SlidingDrawer_Pos
9247 ELM_SLIDINGDRAWER_BOTTOM,
9248 ELM_SLIDINGDRAWER_LEFT,
9249 ELM_SLIDINGDRAWER_RIGHT,
9250 ELM_SLIDINGDRAWER_TOP
9251 } Elm_SlidingDrawer_Pos;
9253 typedef struct _Elm_SlidingDrawer_Drag_Value
9256 } Elm_SlidingDrawer_Drag_Value;
9258 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_add(Evas_Object *parent);
9259 EINA_DEPRECATED EAPI void elm_slidingdrawer_content_set (Evas_Object *obj, Evas_Object *content);
9260 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_content_unset(Evas_Object *obj);
9261 EINA_DEPRECATED EAPI void elm_slidingdrawer_pos_set(Evas_Object *obj, Elm_SlidingDrawer_Pos pos);
9262 EINA_DEPRECATED EAPI void elm_slidingdrawer_max_drag_value_set(Evas_Object *obj, double dw, double dh);
9263 EINA_DEPRECATED EAPI void elm_slidingdrawer_drag_value_set(Evas_Object *obj, double dx, double dy);
9265 /* multibuttonentry */
9266 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
9267 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
9268 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent);
9269 EAPI const char *elm_multibuttonentry_label_get(Evas_Object *obj);
9270 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
9271 EAPI Evas_Object *elm_multibuttonentry_entry_get(Evas_Object *obj);
9272 EAPI const char * elm_multibuttonentry_guide_text_get(Evas_Object *obj);
9273 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
9274 EAPI int elm_multibuttonentry_contracted_state_get(Evas_Object *obj);
9275 EAPI void elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
9276 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
9277 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
9278 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
9279 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
9280 EAPI const Eina_List *elm_multibuttonentry_items_get(Evas_Object *obj);
9281 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(Evas_Object *obj);
9282 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(Evas_Object *obj);
9283 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(Evas_Object *obj);
9284 EAPI void elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
9285 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
9286 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
9287 EAPI void elm_multibuttonentry_items_del(Evas_Object *obj);
9288 EAPI const char *elm_multibuttonentry_item_label_get(Elm_Multibuttonentry_Item *item);
9289 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
9290 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
9291 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
9292 EAPI void *elm_multibuttonentry_item_data_get(Elm_Multibuttonentry_Item *item);
9293 EAPI void elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
9294 EAPI void elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
9295 /* smart callback called:
9296 * "selected" - This signal is emitted when the selected item of multibuttonentry is changed.
9297 * "added" - This signal is emitted when a new multibuttonentry item is added.
9298 * "deleted" - This signal is emitted when a multibuttonentry item is deleted.
9299 * "expanded" - This signal is emitted when a multibuttonentry is expanded.
9300 * "contracted" - This signal is emitted when a multibuttonentry is contracted.
9301 * "contracted,state,changed" - This signal is emitted when the contracted state of multibuttonentry is changed.
9302 * "item,selected" - This signal is emitted when the selected item of multibuttonentry is changed.
9303 * "item,added" - This signal is emitted when a new multibuttonentry item is added.
9304 * "item,deleted" - This signal is emitted when a multibuttonentry item is deleted.
9305 * "item,clicked" - This signal is emitted when a multibuttonentry item is clicked.
9306 * "clicked" - This signal is emitted when a multibuttonentry is clicked.
9307 * "unfocused" - This signal is emitted when a multibuttonentry is unfocused.
9309 /* available styles:
9314 typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
9315 EAPI Evas_Object *elm_stackedicon_add(Evas_Object *parent);
9316 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
9317 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
9318 EAPI void elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
9319 EAPI Eina_List *elm_stackedicon_item_list_get(Evas_Object *obj);
9320 /* smart callback called:
9321 * "expanded" - This signal is emitted when a stackedicon is expanded.
9322 * "clicked" - This signal is emitted when a stackedicon is clicked.
9324 /* available styles:
9329 typedef struct _Dialogue_Item Dialogue_Item;
9331 typedef enum _Elm_Dialoguegourp_Item_Style
9333 ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
9334 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
9335 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
9336 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
9337 ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
9338 ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
9339 ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
9340 ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
9341 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
9342 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
9343 ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
9344 } Elm_Dialoguegroup_Item_Style;
9346 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_add(Evas_Object *parent);
9347 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
9348 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
9349 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
9350 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
9351 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove(Dialogue_Item *item);
9352 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove_all(Evas_Object *obj);
9353 EINA_DEPRECATED EAPI void elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
9354 EINA_DEPRECATED EAPI const char *elm_dialoguegroup_title_get(Evas_Object *obj);
9355 EINA_DEPRECATED EAPI void elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
9356 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
9357 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
9358 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
9359 EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style elm_dialoguegroup_item_style_get(Dialogue_Item *item);
9360 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
9361 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
9366 ELM_DAYSELECTOR_SUN,
9367 ELM_DAYSELECTOR_MON,
9368 ELM_DAYSELECTOR_TUE,
9369 ELM_DAYSELECTOR_WED,
9370 ELM_DAYSELECTOR_THU,
9371 ELM_DAYSELECTOR_FRI,
9373 } Elm_DaySelector_Day;
9375 EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
9376 EAPI Eina_Bool elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
9377 EAPI void elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
9380 typedef struct _Imageslider_Item Elm_Imageslider_Item;
9381 typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
9382 EAPI Evas_Object *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9383 EAPI Elm_Imageslider_Item *elm_imageslider_item_append(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, void *data) EINA_ARG_NONNULL(1);
9384 EAPI Elm_Imageslider_Item *elm_imageslider_item_append_relative(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, unsigned int index, void *data) EINA_ARG_NONNULL(1);
9385 EAPI Elm_Imageslider_Item *elm_imageslider_item_prepend(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, void *data) EINA_ARG_NONNULL(1);
9386 EAPI void elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
9387 EAPI Elm_Imageslider_Item *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
9388 EAPI Eina_Bool elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
9389 EAPI void elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
9390 EAPI const char *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
9391 EAPI Elm_Imageslider_Item *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
9392 EAPI Elm_Imageslider_Item *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
9393 EAPI void elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
9394 EAPI void elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
9395 EAPI void elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
9396 EAPI void elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);