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 set 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 * Set a label of an object
928 * @param obj The Elementary object
929 * @param part The text part name to set (NULL for the default label)
930 * @param label The new text of the label
932 * @note Elementary objects may have many labels (e.g. Action Slider)
936 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
938 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
941 * Get a label of an object
943 * @param obj The Elementary object
944 * @param part The text part name to get (NULL for the default label)
945 * @return text of the label or NULL for any error
947 * @note Elementary objects may have many labels (e.g. Action Slider)
951 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
953 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
956 * Set a content of an object
958 * @param obj The Elementary object
959 * @param part The content part name to set (NULL for the default content)
960 * @param content The new content of the object
962 * @note Elementary objects may have many contents
966 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
968 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
971 * Get a content of an object
973 * @param obj The Elementary object
974 * @param item The content part name to get (NULL for the default content)
975 * @return content of the object or NULL for any error
977 * @note Elementary objects may have many contents
981 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
983 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
986 * Unset a content of an object
988 * @param obj The Elementary object
989 * @param item The content part name to unset (NULL for the default content)
991 * @note Elementary objects may have many contents
995 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
997 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1000 * Set a content of an object item
1002 * @param it The Elementary object item
1003 * @param part The content part name to set (NULL for the default content)
1004 * @param content The new content of the object item
1006 * @note Elementary object items may have many contents
1010 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1012 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1015 * Get a content of an object item
1017 * @param it The Elementary object item
1018 * @param part The content part name to unset (NULL for the default content)
1019 * @return content of the object item or NULL for any error
1021 * @note Elementary object items may have many contents
1025 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
1027 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1030 * Unset a content of an object item
1032 * @param it The Elementary object item
1033 * @param part The content part name to unset (NULL for the default content)
1035 * @note Elementary object items may have many contents
1039 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1041 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1044 * Set a label of an objec itemt
1046 * @param it The Elementary object item
1047 * @param part The text part name to set (NULL for the default label)
1048 * @param label The new text of the label
1050 * @note Elementary object items may have many labels
1054 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1056 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1059 * Get a label of an object
1061 * @param it The Elementary object item
1062 * @param part The text part name to get (NULL for the default label)
1063 * @return text of the label or NULL for any error
1065 * @note Elementary object items may have many labels
1069 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1072 * Set the text to read out when in accessibility mode
1074 * @param obj The object which is to be described
1075 * @param txt The text that describes the widget to people with poor or no vision
1079 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1082 * Set the text to read out when in accessibility mode
1084 * @param it The object item which is to be described
1085 * @param txt The text that describes the widget to people with poor or no vision
1089 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1092 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1095 * Get the data associated with an object item
1096 * @param it The object item
1097 * @return The data associated with @p it
1101 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1104 * Set the data associated with an object item
1105 * @param it The object item
1106 * @param data The data to be associated with @p it
1110 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1113 * Send a signal to the edje object of the widget item.
1115 * This function sends a signal to the edje object of the obj item. An
1116 * edje program can respond to a signal by specifying matching
1117 * 'signal' and 'source' fields.
1119 * @param it The Elementary object item
1120 * @param emission The signal's name.
1121 * @param source The signal's source.
1124 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1130 EAPI void elm_all_flush(void);
1131 EAPI int elm_cache_flush_interval_get(void);
1132 EAPI void elm_cache_flush_interval_set(int size);
1133 EAPI void elm_cache_flush_interval_all_set(int size);
1134 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1135 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1136 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1137 EAPI int elm_font_cache_get(void);
1138 EAPI void elm_font_cache_set(int size);
1139 EAPI void elm_font_cache_all_set(int size);
1140 EAPI int elm_image_cache_get(void);
1141 EAPI void elm_image_cache_set(int size);
1142 EAPI void elm_image_cache_all_set(int size);
1143 EAPI int elm_edje_file_cache_get(void);
1144 EAPI void elm_edje_file_cache_set(int size);
1145 EAPI void elm_edje_file_cache_all_set(int size);
1146 EAPI int elm_edje_collection_cache_get(void);
1147 EAPI void elm_edje_collection_cache_set(int size);
1148 EAPI void elm_edje_collection_cache_all_set(int size);
1151 * @defgroup Scaling Selective Widget Scaling
1153 * Different widgets can be scaled independently. These functions
1154 * allow you to manipulate this scaling on a per-widget basis. The
1155 * object and all its children get their scaling factors multiplied
1156 * by the scale factor set. This is multiplicative, in that if a
1157 * child also has a scale size set it is in turn multiplied by its
1158 * parent's scale size. @c 1.0 means ādon't scaleā, @c 2.0 is
1159 * double size, @c 0.5 is half, etc.
1161 * @ref general_functions_example_page "This" example contemplates
1162 * some of these functions.
1166 * Set the scaling factor for a given Elementary object
1168 * @param obj The Elementary to operate on
1169 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1174 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1177 * Get the scaling factor for a given Elementary object
1179 * @param obj The object
1180 * @return The scaling factor set by elm_object_scale_set()
1184 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1187 * @defgroup Password_last_show Password last input show
1189 * Last show feature of password mode enables user to view
1190 * the last input entered for few seconds before masking it.
1191 * These functions allow to set this feature in password mode
1192 * of entry widget and also allow to manipulate the duration
1193 * for which the input has to be visible.
1199 * Get show last setting of password mode.
1201 * This gets the show last input setting of password mode which might be
1202 * enabled or disabled.
1204 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1206 * @ingroup Password_last_show
1208 EAPI Eina_Bool elm_password_show_last_get(void);
1211 * Set show last setting in password mode.
1213 * This enables or disables show last setting of password mode.
1215 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1216 * @see elm_password_show_last_timeout_set()
1217 * @ingroup Password_last_show
1219 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1222 * Get's the timeout value in last show password mode.
1224 * This gets the time out value for which the last input entered in password
1225 * mode will be visible.
1227 * @return The timeout value of last show password mode.
1228 * @ingroup Password_last_show
1230 EAPI double elm_password_show_last_timeout_get(void);
1233 * Set's the timeout value in last show password mode.
1235 * This sets the time out value for which the last input entered in password
1236 * mode will be visible.
1238 * @param password_show_last_timeout The timeout value.
1239 * @see elm_password_show_last_set()
1240 * @ingroup Password_last_show
1242 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1248 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1249 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1250 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1251 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1253 * Set the style to use by a widget
1255 * Sets the style name that will define the appearance of a widget. Styles
1256 * vary from widget to widget and may also be defined by other themes
1257 * by means of extensions and overlays.
1259 * @param obj The Elementary widget to style
1260 * @param style The style name to use
1262 * @see elm_theme_extension_add()
1263 * @see elm_theme_overlay_add()
1267 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1269 * Get the style used by the widget
1271 * This gets the style being used for that widget. Note that the string
1272 * pointer is only valid as longas the object is valid and the style doesn't
1275 * @param obj The Elementary widget to query for its style
1276 * @return The style name used
1278 * @see elm_object_style_set()
1282 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1285 * @defgroup Styles Styles
1287 * Widgets can have different styles of look. These generic API's
1288 * set styles of widgets, if they support them (and if the theme(s)
1291 * @ref general_functions_example_page "This" example contemplates
1292 * some of these functions.
1296 * Set the disabled state of an Elementary object.
1298 * @param obj The Elementary object to operate on
1299 * @param disabled The state to put in in: @c EINA_TRUE for
1300 * disabled, @c EINA_FALSE for enabled
1302 * Elementary objects can be @b disabled, in which state they won't
1303 * receive input and, in general, will be themed differently from
1304 * their normal state, usually greyed out. Useful for contexts
1305 * where you don't want your users to interact with some of the
1306 * parts of you interface.
1308 * This sets the state for the widget, either disabling it or
1313 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1316 * Get the disabled state of an Elementary object.
1318 * @param obj The Elementary object to operate on
1319 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1320 * if it's enabled (or on errors)
1322 * This gets the state of the widget, which might be enabled or disabled.
1326 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1329 * @defgroup WidgetNavigation Widget Tree Navigation.
1331 * How to check if an Evas Object is an Elementary widget? How to
1332 * get the first elementary widget that is parent of the given
1333 * object? These are all covered in widget tree navigation.
1335 * @ref general_functions_example_page "This" example contemplates
1336 * some of these functions.
1339 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1342 * Get the first parent of the given object that is an Elementary
1345 * @param obj the Elementary object to query parent from.
1346 * @return the parent object that is an Elementary widget, or @c
1347 * NULL, if it was not found.
1349 * Use this to query for an object's parent widget.
1351 * @note Most of Elementary users wouldn't be mixing non-Elementary
1352 * smart objects in the objects tree of an application, as this is
1353 * an advanced usage of Elementary with Evas. So, except for the
1354 * application's window, which is the root of that tree, all other
1355 * objects would have valid Elementary widget parents.
1357 * @ingroup WidgetNavigation
1359 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1360 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1361 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1363 EAPI double elm_scale_get(void);
1364 EAPI void elm_scale_set(double scale);
1365 EAPI void elm_scale_all_set(double scale);
1367 EAPI Eina_Bool elm_mirrored_get(void);
1368 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1370 EAPI Eina_Bool elm_config_save(void);
1371 EAPI void elm_config_reload(void);
1373 EAPI const char *elm_profile_current_get(void);
1374 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1375 EAPI void elm_profile_dir_free(const char *p_dir);
1376 EAPI Eina_List *elm_profile_list_get(void);
1377 EAPI void elm_profile_list_free(Eina_List *l);
1378 EAPI void elm_profile_set(const char *profile);
1379 EAPI void elm_profile_all_set(const char *profile);
1381 EAPI const char *elm_engine_current_get(void);
1382 EAPI void elm_engine_set(const char *engine);
1384 typedef struct _Elm_Text_Class
1390 typedef struct _Elm_Font_Overlay
1392 const char *text_class;
1394 Evas_Font_Size size;
1397 typedef struct _Elm_Font_Properties
1401 } Elm_Font_Properties;
1403 EAPI const Eina_List *elm_text_classes_list_get(void);
1404 EAPI void elm_text_classes_list_free(const Eina_List *list);
1406 EAPI const Eina_List *elm_font_overlay_list_get(void);
1407 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1408 EAPI void elm_font_overlay_unset(const char *text_class);
1409 EAPI void elm_font_overlay_apply(void);
1410 EAPI void elm_font_overlay_all_apply(void);
1412 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
1413 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
1414 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
1415 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
1416 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
1417 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
1420 * @defgroup Fingers Fingers
1422 * Elementary is designed to be finger-friendly for touchscreens,
1423 * and so in addition to scaling for display resolution, it can
1424 * also scale based on finger "resolution" (or size). You can then
1425 * customize the granularity of the areas meant to receive clicks
1428 * Different profiles may have pre-set values for finger sizes.
1430 * @ref general_functions_example_page "This" example contemplates
1431 * some of these functions.
1435 * Get the configured "finger size"
1437 * @return The finger size
1439 * This gets the globally configured finger size, <b>in pixels</b>
1443 EAPI Evas_Coord elm_finger_size_get(void);
1444 EAPI void elm_finger_size_set(Evas_Coord size);
1445 EAPI void elm_finger_size_all_set(Evas_Coord size);
1448 * @defgroup Focus Focus
1450 * An Elementary application has, at all times, one (and only one)
1451 * @b focused object. This is what determines where the input
1452 * events go to within the application's window. Also, focused
1453 * objects can be decorated differently, in order to signal to the
1454 * user where the input is, at a given moment.
1456 * Elementary applications also have the concept of <b>focus
1457 * chain</b>: one can cycle through all the windows' focusable
1458 * objects by input (tab key) or programmatically. The default
1459 * focus chain for an application is the one define by the order in
1460 * which the widgets where added in code. One will cycle through
1461 * top level widgets, and, for each one containg sub-objects, cycle
1462 * through them all, before returning to the level
1463 * above. Elementary also allows one to set @b custom focus chains
1464 * for their applications.
1466 * Besides the focused decoration a widget may exhibit, when it
1467 * gets focus, Elementary has a @b global focus highlight object
1468 * that can be enabled for a window. If one chooses to do so, this
1469 * extra highlight effect will surround the current focused object,
1472 * @note Some Elementary widgets are @b unfocusable, after
1473 * creation, by their very nature: they are not meant to be
1474 * interacted with input events, but are there just for visual
1477 * @ref general_functions_example_page "This" example contemplates
1478 * some of these functions.
1481 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
1482 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
1483 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
1484 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
1487 * Get the whether an Elementary object has the focus or not.
1489 * @param obj The Elementary object to get the information from
1490 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
1491 * not (and on errors).
1493 * @see elm_object_focus()
1497 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1500 * Make a given Elementary object the focused one.
1502 * @param obj The Elementary object to make focused.
1504 * @note This object, if it can handle focus, will take the focus
1505 * away from the one who had it previously and will, for now on, be
1506 * the one receiving input events.
1508 * @see elm_object_focus_get()
1512 EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1515 * Remove the focus from an Elementary object
1517 * @param obj The Elementary to take focus from
1519 * This removes the focus from @p obj, passing it back to the
1520 * previous element in the focus chain list.
1522 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
1526 EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1529 * Set the ability for an Element object to be focused
1531 * @param obj The Elementary object to operate on
1532 * @param enable @c EINA_TRUE if the object can be focused, @c
1533 * EINA_FALSE if not (and on errors)
1535 * This sets whether the object @p obj is able to take focus or
1536 * not. Unfocusable objects do nothing when programmatically
1537 * focused, being the nearest focusable parent object the one
1538 * really getting focus. Also, when they receive mouse input, they
1539 * will get the event, but not take away the focus from where it
1544 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
1547 * Get whether an Elementary object is focusable or not
1549 * @param obj The Elementary object to operate on
1550 * @return @c EINA_TRUE if the object is allowed to be focused, @c
1551 * EINA_FALSE if not (and on errors)
1553 * @note Objects which are meant to be interacted with by input
1554 * events are created able to be focused, by default. All the
1559 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1561 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
1562 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1563 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1564 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1565 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1566 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
1567 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
1570 * Make the elementary object and its children to be unfocusable (or focusable).
1572 * @param obj The Elementary object to operate on
1573 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
1574 * @c EINA_FALSE for focusable.
1576 * This sets whether the object @p obj and its children objects
1577 * able to take focus or not. If the tree is unfocusable,
1578 * newest focused object which is not in this tree will get focus.
1579 * This API can be helpful for an object to be deleted.
1580 * When an object will be deleted soon, it and its children may not
1581 * want to get focus (by focus reverting or by other focus controls).
1582 * Then, just use this API before deleting.
1584 * @see elm_object_tree_unfocusable_get()
1588 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
1591 * Get whether an Elementary object and its children are unfocusable or not.
1593 * @param obj The Elementary object to get the information from
1594 * @return @c EINA_TRUE, if the tree is unfocussable,
1595 * @c EINA_FALSE if not (and on errors).
1597 * @see elm_object_tree_unfocusable_set()
1601 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
1603 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
1604 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
1605 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
1606 EAPI double elm_scroll_bounce_friction_get(void);
1607 EAPI void elm_scroll_bounce_friction_set(double friction);
1608 EAPI void elm_scroll_bounce_friction_all_set(double friction);
1609 EAPI double elm_scroll_page_scroll_friction_get(void);
1610 EAPI void elm_scroll_page_scroll_friction_set(double friction);
1611 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
1612 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
1613 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
1614 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
1615 EAPI double elm_scroll_zoom_friction_get(void);
1616 EAPI void elm_scroll_zoom_friction_set(double friction);
1617 EAPI void elm_scroll_zoom_friction_all_set(double friction);
1618 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
1619 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
1620 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
1621 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
1622 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
1623 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
1624 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
1625 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
1626 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
1627 EAPI double elm_scroll_thumbscroll_friction_get(void);
1628 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
1629 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
1630 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
1631 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
1632 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
1635 * Get the sensitivity amount which is be multiplied by the length of
1638 * @return the thumb scroll sensitivity friction
1640 * @ingroup Scrolling
1642 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
1645 * Set the sensitivity amount which is be multiplied by the length of
1648 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
1649 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
1652 * @see elm_thumbscroll_sensitivity_friction_get()
1653 * @note parameter value will get bound to 0.1 - 1.0 interval, always
1655 * @ingroup Scrolling
1657 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
1660 * Set the sensitivity amount which is be multiplied by the length of
1661 * mouse dragging, for all Elementary application windows.
1663 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
1664 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
1667 * @see elm_thumbscroll_sensitivity_friction_get()
1668 * @note parameter value will get bound to 0.1 - 1.0 interval, always
1670 * @ingroup Scrolling
1672 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
1678 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1679 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1680 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
1681 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
1682 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1683 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
1684 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1685 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1687 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1688 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);
1689 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);
1691 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1692 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
1695 * Adjust size of an element for finger usage.
1697 * @param times_w How many fingers should fit horizontally
1698 * @param w Pointer to the width size to adjust
1699 * @param times_h How many fingers should fit vertically
1700 * @param h Pointer to the height size to adjust
1702 * This takes width and height sizes (in pixels) as input and a
1703 * size multiple (which is how many fingers you want to place
1704 * within the area, being "finger" the size set by
1705 * elm_finger_size_set()), and adjusts the size to be large enough
1706 * to accommodate the resulting size -- if it doesn't already
1707 * accommodate it. On return the @p w and @p h sizes pointed to by
1708 * these parameters will be modified, on those conditions.
1710 * @note This is kind of a low level Elementary call, most useful
1711 * on size evaluation times for widgets. An external user wouldn't
1712 * be calling, most of the time.
1716 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
1718 EAPI double elm_longpress_timeout_get(void);
1719 EAPI void elm_longpress_timeout_set(double longpress_timeout);
1722 * don't use it unless you are sure
1724 EAPI void elm_object_tree_dump(const Evas_Object *top);
1725 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
1727 EAPI void elm_autocapitalization_allow_all_set(Eina_Bool autocap);
1728 EAPI void elm_autoperiod_allow_all_set(Eina_Bool autoperiod);
1733 * @defgroup Theme Theme
1735 * Elementary uses Edje to theme its widgets, naturally. But for the most
1736 * part this is hidden behind a simpler interface that lets the user set
1737 * extensions and choose the style of widgets in a much easier way.
1739 * Instead of thinking in terms of paths to Edje files and their groups
1740 * each time you want to change the appearance of a widget, Elementary
1741 * works so you can add any theme file with extensions or replace the
1742 * main theme at one point in the application, and then just set the style
1743 * of widgets with elm_object_style_set() and related functions. Elementary
1744 * will then look in its list of themes for a matching group and apply it,
1745 * and when the theme changes midway through the application, all widgets
1746 * will be updated accordingly.
1748 * There are three concepts you need to know to understand how Elementary
1749 * theming works: default theme, extensions and overlays.
1751 * Default theme, obviously enough, is the one that provides the default
1752 * look of all widgets. End users can change the theme used by Elementary
1753 * by setting the @c ELM_THEME environment variable before running an
1754 * application, or globally for all programs using the @c elementary_config
1755 * utility. Applications can change the default theme using elm_theme_set(),
1756 * but this can go against the user wishes, so it's not an adviced practice.
1758 * Ideally, applications should find everything they need in the already
1759 * provided theme, but there may be occasions when that's not enough and
1760 * custom styles are required to correctly express the idea. For this
1761 * cases, Elementary has extensions.
1763 * Extensions allow the application developer to write styles of its own
1764 * to apply to some widgets. This requires knowledge of how each widget
1765 * is themed, as extensions will always replace the entire group used by
1766 * the widget, so important signals and parts need to be there for the
1767 * object to behave properly (see documentation of Edje for details).
1768 * Once the theme for the extension is done, the application needs to add
1769 * it to the list of themes Elementary will look into, using
1770 * elm_theme_extension_add(), and set the style of the desired widgets as
1771 * he would normally with elm_object_style_set().
1773 * Overlays, on the other hand, can replace the look of all widgets by
1774 * overriding the default style. Like extensions, it's up to the application
1775 * developer to write the theme for the widgets it wants, the difference
1776 * being that when looking for the theme, Elementary will check first the
1777 * list of overlays, then the set theme and lastly the list of extensions,
1778 * so with overlays it's possible to replace the default view and every
1779 * widget will be affected. This is very much alike to setting the whole
1780 * theme for the application and will probably clash with the end user
1781 * options, not to mention the risk of ending up with not matching styles
1782 * across the program. Unless there's a very special reason to use them,
1783 * overlays should be avoided for the resons exposed before.
1785 * All these theme lists are handled by ::Elm_Theme instances. Elementary
1786 * keeps one default internally and every function that receives one of
1787 * these can be called with NULL to refer to this default (except for
1788 * elm_theme_free()). It's possible to create a new instance of a
1789 * ::Elm_Theme to set other theme for a specific widget (and all of its
1790 * children), but this is as discouraged, if not even more so, than using
1791 * overlays. Don't use this unless you really know what you are doing.
1793 * But to be less negative about things, you can look at the following
1795 * @li @ref theme_example_01 "Using extensions"
1796 * @li @ref theme_example_02 "Using overlays"
1801 * @typedef Elm_Theme
1803 * Opaque handler for the list of themes Elementary looks for when
1804 * rendering widgets.
1806 * Stay out of this unless you really know what you are doing. For most
1807 * cases, sticking to the default is all a developer needs.
1809 typedef struct _Elm_Theme Elm_Theme;
1812 * Create a new specific theme
1814 * This creates an empty specific theme that only uses the default theme. A
1815 * specific theme has its own private set of extensions and overlays too
1816 * (which are empty by default). Specific themes do not fall back to themes
1817 * of parent objects. They are not intended for this use. Use styles, overlays
1818 * and extensions when needed, but avoid specific themes unless there is no
1819 * other way (example: you want to have a preview of a new theme you are
1820 * selecting in a "theme selector" window. The preview is inside a scroller
1821 * and should display what the theme you selected will look like, but not
1822 * actually apply it yet. The child of the scroller will have a specific
1823 * theme set to show this preview before the user decides to apply it to all
1826 EAPI Elm_Theme *elm_theme_new(void);
1828 * Free a specific theme
1830 * @param th The theme to free
1832 * This frees a theme created with elm_theme_new().
1834 EAPI void elm_theme_free(Elm_Theme *th);
1836 * Copy the theme fom the source to the destination theme
1838 * @param th The source theme to copy from
1839 * @param thdst The destination theme to copy data to
1841 * This makes a one-time static copy of all the theme config, extensions
1842 * and overlays from @p th to @p thdst. If @p th references a theme, then
1843 * @p thdst is also set to reference it, with all the theme settings,
1844 * overlays and extensions that @p th had.
1846 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
1848 * Tell the source theme to reference the ref theme
1850 * @param th The theme that will do the referencing
1851 * @param thref The theme that is the reference source
1853 * This clears @p th to be empty and then sets it to refer to @p thref
1854 * so @p th acts as an override to @p thref, but where its overrides
1855 * don't apply, it will fall through to @pthref for configuration.
1857 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
1859 * Return the theme referred to
1861 * @param th The theme to get the reference from
1862 * @return The referenced theme handle
1864 * This gets the theme set as the reference theme by elm_theme_ref_set().
1865 * If no theme is set as a reference, NULL is returned.
1867 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
1869 * Return the default theme
1871 * @return The default theme handle
1873 * This returns the internal default theme setup handle that all widgets
1874 * use implicitly unless a specific theme is set. This is also often use
1875 * as a shorthand of NULL.
1877 EAPI Elm_Theme *elm_theme_default_get(void);
1879 * Prepends a theme overlay to the list of overlays
1881 * @param th The theme to add to, or if NULL, the default theme
1882 * @param item The Edje file path to be used
1884 * Use this if your application needs to provide some custom overlay theme
1885 * (An Edje file that replaces some default styles of widgets) where adding
1886 * new styles, or changing system theme configuration is not possible. Do
1887 * NOT use this instead of a proper system theme configuration. Use proper
1888 * configuration files, profiles, environment variables etc. to set a theme
1889 * so that the theme can be altered by simple confiugration by a user. Using
1890 * this call to achieve that effect is abusing the API and will create lots
1893 * @see elm_theme_extension_add()
1895 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
1897 * Delete a theme overlay from the list of overlays
1899 * @param th The theme to delete from, or if NULL, the default theme
1900 * @param item The name of the theme overlay
1902 * @see elm_theme_overlay_add()
1904 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
1906 * Appends a theme extension to the list of extensions.
1908 * @param th The theme to add to, or if NULL, the default theme
1909 * @param item The Edje file path to be used
1911 * This is intended when an application needs more styles of widgets or new
1912 * widget themes that the default does not provide (or may not provide). The
1913 * application has "extended" usage by coming up with new custom style names
1914 * for widgets for specific uses, but as these are not "standard", they are
1915 * not guaranteed to be provided by a default theme. This means the
1916 * application is required to provide these extra elements itself in specific
1917 * Edje files. This call adds one of those Edje files to the theme search
1918 * path to be search after the default theme. The use of this call is
1919 * encouraged when default styles do not meet the needs of the application.
1920 * Use this call instead of elm_theme_overlay_add() for almost all cases.
1922 * @see elm_object_style_set()
1924 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
1926 * Deletes a theme extension from the list of extensions.
1928 * @param th The theme to delete from, or if NULL, the default theme
1929 * @param item The name of the theme extension
1931 * @see elm_theme_extension_add()
1933 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
1935 * Set the theme search order for the given theme
1937 * @param th The theme to set the search order, or if NULL, the default theme
1938 * @param theme Theme search string
1940 * This sets the search string for the theme in path-notation from first
1941 * theme to search, to last, delimited by the : character. Example:
1943 * "shiny:/path/to/file.edj:default"
1945 * See the ELM_THEME environment variable for more information.
1947 * @see elm_theme_get()
1948 * @see elm_theme_list_get()
1950 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
1952 * Return the theme search order
1954 * @param th The theme to get the search order, or if NULL, the default theme
1955 * @return The internal search order path
1957 * This function returns a colon separated string of theme elements as
1958 * returned by elm_theme_list_get().
1960 * @see elm_theme_set()
1961 * @see elm_theme_list_get()
1963 EAPI const char *elm_theme_get(Elm_Theme *th);
1965 * Return a list of theme elements to be used in a theme.
1967 * @param th Theme to get the list of theme elements from.
1968 * @return The internal list of theme elements
1970 * This returns the internal list of theme elements (will only be valid as
1971 * long as the theme is not modified by elm_theme_set() or theme is not
1972 * freed by elm_theme_free(). This is a list of strings which must not be
1973 * altered as they are also internal. If @p th is NULL, then the default
1974 * theme element list is returned.
1976 * A theme element can consist of a full or relative path to a .edj file,
1977 * or a name, without extension, for a theme to be searched in the known
1978 * theme paths for Elemementary.
1980 * @see elm_theme_set()
1981 * @see elm_theme_get()
1983 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
1985 * Return the full patrh for a theme element
1987 * @param f The theme element name
1988 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
1989 * @return The full path to the file found.
1991 * This returns a string you should free with free() on success, NULL on
1992 * failure. This will search for the given theme element, and if it is a
1993 * full or relative path element or a simple searchable name. The returned
1994 * path is the full path to the file, if searched, and the file exists, or it
1995 * is simply the full path given in the element or a resolved path if
1996 * relative to home. The @p in_search_path boolean pointed to is set to
1997 * EINA_TRUE if the file was a searchable file andis in the search path,
1998 * and EINA_FALSE otherwise.
2000 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
2002 * Flush the current theme.
2004 * @param th Theme to flush
2006 * This flushes caches that let elementary know where to find theme elements
2007 * in the given theme. If @p th is NULL, then the default theme is flushed.
2008 * Call this function if source theme data has changed in such a way as to
2009 * make any caches Elementary kept invalid.
2011 EAPI void elm_theme_flush(Elm_Theme *th);
2013 * This flushes all themes (default and specific ones).
2015 * This will flush all themes in the current application context, by calling
2016 * elm_theme_flush() on each of them.
2018 EAPI void elm_theme_full_flush(void);
2020 * Set the theme for all elementary using applications on the current display
2022 * @param theme The name of the theme to use. Format same as the ELM_THEME
2023 * environment variable.
2025 EAPI void elm_theme_all_set(const char *theme);
2027 * Return a list of theme elements in the theme search path
2029 * @return A list of strings that are the theme element names.
2031 * This lists all available theme files in the standard Elementary search path
2032 * for theme elements, and returns them in alphabetical order as theme
2033 * element names in a list of strings. Free this with
2034 * elm_theme_name_available_list_free() when you are done with the list.
2036 EAPI Eina_List *elm_theme_name_available_list_new(void);
2038 * Free the list returned by elm_theme_name_available_list_new()
2040 * This frees the list of themes returned by
2041 * elm_theme_name_available_list_new(). Once freed the list should no longer
2042 * be used. a new list mys be created.
2044 EAPI void elm_theme_name_available_list_free(Eina_List *list);
2046 * Set a specific theme to be used for this object and its children
2048 * @param obj The object to set the theme on
2049 * @param th The theme to set
2051 * This sets a specific theme that will be used for the given object and any
2052 * child objects it has. If @p th is NULL then the theme to be used is
2053 * cleared and the object will inherit its theme from its parent (which
2054 * ultimately will use the default theme if no specific themes are set).
2056 * Use special themes with great care as this will annoy users and make
2057 * configuration difficult. Avoid any custom themes at all if it can be
2060 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
2062 * Get the specific theme to be used
2064 * @param obj The object to get the specific theme from
2065 * @return The specifc theme set.
2067 * This will return a specific theme set, or NULL if no specific theme is
2068 * set on that object. It will not return inherited themes from parents, only
2069 * the specific theme set for that specific object. See elm_object_theme_set()
2070 * for more information.
2072 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2078 typedef enum _Elm_Win_Type
2081 ELM_WIN_DIALOG_BASIC,
2088 ELM_WIN_DROPDOWN_MENU,
2091 ELM_WIN_NOTIFICATION,
2094 ELM_WIN_INLINED_IMAGE,
2097 typedef enum _Elm_Win_Keyboard_Mode
2099 ELM_WIN_KEYBOARD_UNKNOWN,
2100 ELM_WIN_KEYBOARD_OFF,
2101 ELM_WIN_KEYBOARD_ON,
2102 ELM_WIN_KEYBOARD_ALPHA,
2103 ELM_WIN_KEYBOARD_NUMERIC,
2104 ELM_WIN_KEYBOARD_PIN,
2105 ELM_WIN_KEYBOARD_PHONE_NUMBER,
2106 ELM_WIN_KEYBOARD_HEX,
2107 ELM_WIN_KEYBOARD_TERMINAL,
2108 ELM_WIN_KEYBOARD_PASSWORD,
2109 ELM_WIN_KEYBOARD_IP,
2110 ELM_WIN_KEYBOARD_HOST,
2111 ELM_WIN_KEYBOARD_FILE,
2112 ELM_WIN_KEYBOARD_URL,
2113 ELM_WIN_KEYBOARD_KEYPAD,
2114 ELM_WIN_KEYBOARD_J2ME
2115 } Elm_Win_Keyboard_Mode;
2117 typedef enum _Elm_Illume_Command
2119 ELM_ILLUME_COMMAND_FOCUS_BACK,
2120 ELM_ILLUME_COMMAND_FOCUS_FORWARD,
2121 ELM_ILLUME_COMMAND_FOCUS_HOME,
2122 ELM_ILLUME_COMMAND_CLOSE
2123 } Elm_Illume_Command;
2125 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
2126 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2127 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2128 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
2129 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2130 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
2131 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2132 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
2133 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
2134 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
2135 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
2136 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2137 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
2138 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2139 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
2140 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2141 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
2142 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2143 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
2144 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2145 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
2146 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2147 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
2148 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2149 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
2150 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2151 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
2152 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2153 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
2154 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
2155 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2156 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
2157 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2158 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
2159 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2160 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
2161 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2162 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
2163 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2164 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
2165 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2166 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
2167 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2168 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
2169 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
2170 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
2171 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
2172 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2173 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
2174 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2175 EAPI void elm_win_indicator_state_set(Evas_Object *obj, int show_state);
2176 EAPI int elm_win_indicator_state_get(Evas_Object *obj);
2178 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
2179 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
2180 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
2181 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
2182 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
2183 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
2184 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
2186 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
2187 * (blank mouse, private mouse obj, defaultmouse)
2190 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
2191 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2192 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
2193 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2195 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
2197 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
2198 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
2199 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
2200 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2201 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2202 /* available styles:
2207 /* X specific calls - won't work on non-x engines (return 0) */
2208 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2209 /* smart callbacks called:
2210 * "delete,request" - the user requested to delete the window
2211 * "focus,in" - window got focus
2212 * "focus,out" - window lost focus
2213 * "moved" - window that holds the canvas was moved
2219 * @brief Background object, used for setting a solid color, image or Edje
2220 * group as background to a window or any container object.
2222 * The bg object is used for setting a solid background to a window or
2223 * packing into any container object. It works just like an image, but has
2224 * some properties useful to a background, like setting it to tiled,
2225 * centered, scaled or stretched.
2227 * Here is some sample code using it:
2228 * @li @ref bg_01_example_page
2229 * @li @ref bg_02_example_page
2230 * @li @ref bg_03_example_page
2234 typedef enum _Elm_Bg_Option
2236 ELM_BG_OPTION_CENTER, /**< center the background */
2237 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
2238 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
2239 ELM_BG_OPTION_TILE /**< tile background at its original size */
2243 * Add a new background to the parent
2245 * @param parent The parent object
2246 * @return The new object or NULL if it cannot be created
2250 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2253 * Set the file (image or edje) used for the background
2255 * @param obj The bg object
2256 * @param file The file path
2257 * @param group Optional key (group in Edje) within the file
2259 * This sets the image file used in the background object. The image (or edje)
2260 * will be stretched (retaining aspect if its an image file) to completely fill
2261 * the bg object. This may mean some parts are not visible.
2263 * @note Once the image of @p obj is set, a previously set one will be deleted,
2264 * even if @p file is NULL.
2268 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
2271 * Get the file (image or edje) used for the background
2273 * @param obj The bg object
2274 * @param file The file path
2275 * @param group Optional key (group in Edje) within the file
2279 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2282 * Set the option used for the background image
2284 * @param obj The bg object
2285 * @param option The desired background option (TILE, SCALE)
2287 * This sets the option used for manipulating the display of the background
2288 * image. The image can be tiled or scaled.
2292 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
2295 * Get the option used for the background image
2297 * @param obj The bg object
2298 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
2302 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2304 * Set the option used for the background color
2306 * @param obj The bg object
2311 * This sets the color used for the background rectangle. Its range goes
2316 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
2318 * Get the option used for the background color
2320 * @param obj The bg object
2327 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
2330 * Set the overlay object used for the background object.
2332 * @param obj The bg object
2333 * @param overlay The overlay object
2335 * This provides a way for elm_bg to have an 'overlay' that will be on top
2336 * of the bg. Once the over object is set, a previously set one will be
2337 * deleted, even if you set the new one to NULL. If you want to keep that
2338 * old content object, use the elm_bg_overlay_unset() function.
2343 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
2346 * Get the overlay object used for the background object.
2348 * @param obj The bg object
2349 * @return The content that is being used
2351 * Return the content object which is set for this widget
2355 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2358 * Get the overlay object used for the background object.
2360 * @param obj The bg object
2361 * @return The content that was being used
2363 * Unparent and return the overlay object which was set for this widget
2367 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2370 * Set the size of the pixmap representation of the image.
2372 * This option just makes sense if an image is going to be set in the bg.
2374 * @param obj The bg object
2375 * @param w The new width of the image pixmap representation.
2376 * @param h The new height of the image pixmap representation.
2378 * This function sets a new size for pixmap representation of the given bg
2379 * image. It allows the image to be loaded already in the specified size,
2380 * reducing the memory usage and load time when loading a big image with load
2381 * size set to a smaller size.
2383 * NOTE: this is just a hint, the real size of the pixmap may differ
2384 * depending on the type of image being loaded, being bigger than requested.
2388 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
2389 /* smart callbacks called:
2393 typedef enum _Elm_Icon_Lookup_Order
2395 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
2396 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
2397 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
2398 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
2399 } Elm_Icon_Lookup_Order;
2401 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2402 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2403 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2404 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2405 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
2406 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2407 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2408 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2409 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
2410 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2411 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
2412 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
2413 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
2414 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2415 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
2416 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2417 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
2418 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2419 EAPI Eina_Bool elm_icon_anim_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2420 EAPI void elm_icon_anim_set(Evas_Object *obj, Eina_Bool anim) EINA_ARG_NONNULL(1);
2421 EAPI Eina_Bool elm_icon_anim_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2422 EAPI void elm_icon_anim_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
2423 EAPI Eina_Bool elm_icon_anim_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2425 /* smart callbacks called:
2426 * "clicked" - the user clicked the icon
2430 typedef enum _Elm_Image_Orient
2432 ELM_IMAGE_ORIENT_NONE,
2433 ELM_IMAGE_ROTATE_90_CW,
2434 ELM_IMAGE_ROTATE_180_CW,
2435 ELM_IMAGE_ROTATE_90_CCW,
2436 ELM_IMAGE_FLIP_HORIZONTAL,
2437 ELM_IMAGE_FLIP_VERTICAL,
2438 ELM_IMAGE_FLIP_TRANSPOSE,
2439 ELM_IMAGE_FLIP_TRANSVERSE
2441 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2442 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2443 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2444 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2445 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2446 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
2447 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
2448 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2449 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
2450 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
2451 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
2452 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2453 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
2454 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2455 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
2456 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2457 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
2458 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2459 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2460 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
2461 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2463 /* smart callbacks called:
2464 * "clicked" - the user clicked the image
2468 typedef void (*Elm_GLView_Func)(Evas_Object *obj);
2470 typedef enum _Elm_GLView_Mode
2472 ELM_GLVIEW_ALPHA = 1,
2473 ELM_GLVIEW_DEPTH = 2,
2474 ELM_GLVIEW_STENCIL = 4
2478 * Defines a policy for the glview resizing.
2480 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
2482 typedef enum _Elm_GLView_Resize_Policy
2484 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
2485 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
2486 } Elm_GLView_Resize_Policy;
2488 typedef enum _Elm_GLView_Render_Policy
2490 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
2491 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
2492 } Elm_GLView_Render_Policy;
2495 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2496 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2497 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2498 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2499 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
2500 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
2501 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
2502 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2503 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2504 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2505 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2506 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
2512 * A box arranges objects in a linear fashion, governed by a layout function
2513 * that defines the details of this arrangement.
2515 * By default, the box will use an internal function to set the layout to
2516 * a single row, either vertical or horizontal. This layout is affected
2517 * by a number of parameters, such as the homogeneous flag set by
2518 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
2519 * elm_box_align_set() and the hints set to each object in the box.
2521 * For this default layout, it's possible to change the orientation with
2522 * elm_box_horizontal_set(). The box will start in the vertical orientation,
2523 * placing its elements ordered from top to bottom. When horizontal is set,
2524 * the order will go from left to right. If the box is set to be
2525 * homogeneous, every object in it will be assigned the same space, that
2526 * of the largest object. Padding can be used to set some spacing between
2527 * the cell given to each object. The alignment of the box, set with
2528 * elm_box_align_set(), determines how the bounding box of all the elements
2529 * will be placed within the space given to the box widget itself.
2531 * The size hints of each object also affect how they are placed and sized
2532 * within the box. evas_object_size_hint_min_set() will give the minimum
2533 * size the object can have, and the box will use it as the basis for all
2534 * latter calculations. Elementary widgets set their own minimum size as
2535 * needed, so there's rarely any need to use it manually.
2537 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
2538 * used to tell whether the object will be allocated the minimum size it
2539 * needs or if the space given to it should be expanded. It's important
2540 * to realize that expanding the size given to the object is not the same
2541 * thing as resizing the object. It could very well end being a small
2542 * widget floating in a much larger empty space. If not set, the weight
2543 * for objects will normally be 0.0 for both axis, meaning the widget will
2544 * not be expanded. To take as much space possible, set the weight to
2545 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
2547 * Besides how much space each object is allocated, it's possible to control
2548 * how the widget will be placed within that space using
2549 * evas_object_size_hint_align_set(). By default, this value will be 0.5
2550 * for both axis, meaning the object will be centered, but any value from
2551 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
2552 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
2553 * is -1.0, means the object will be resized to fill the entire space it
2556 * In addition, customized functions to define the layout can be set, which
2557 * allow the application developer to organize the objects within the box
2558 * in any number of ways.
2560 * The special elm_box_layout_transition() function can be used
2561 * to switch from one layout to another, animating the motion of the
2562 * children of the box.
2564 * @note Objects should not be added to box objects using _add() calls.
2566 * Some examples on how to use boxes follow:
2567 * @li @ref box_example_01
2568 * @li @ref box_example_02
2573 * @typedef Elm_Box_Transition
2575 * Opaque handler containing the parameters to perform an animated
2576 * transition of the layout the box uses.
2578 * @see elm_box_transition_new()
2579 * @see elm_box_layout_set()
2580 * @see elm_box_layout_transition()
2582 typedef struct _Elm_Box_Transition Elm_Box_Transition;
2585 * Add a new box to the parent
2587 * By default, the box will be in vertical mode and non-homogeneous.
2589 * @param parent The parent object
2590 * @return The new object or NULL if it cannot be created
2592 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2594 * Set the horizontal orientation
2596 * By default, box object arranges their contents vertically from top to
2598 * By calling this function with @p horizontal as EINA_TRUE, the box will
2599 * become horizontal, arranging contents from left to right.
2601 * @note This flag is ignored if a custom layout function is set.
2603 * @param obj The box object
2604 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
2605 * EINA_FALSE = vertical)
2607 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
2609 * Get the horizontal orientation
2611 * @param obj The box object
2612 * @return EINA_TRUE if the box is set to horizintal mode, EINA_FALSE otherwise
2614 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2616 * Set the box to arrange its children homogeneously
2618 * If enabled, homogeneous layout makes all items the same size, according
2619 * to the size of the largest of its children.
2621 * @note This flag is ignored if a custom layout function is set.
2623 * @param obj The box object
2624 * @param homogeneous The homogeneous flag
2626 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
2628 * Get whether the box is using homogeneous mode or not
2630 * @param obj The box object
2631 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
2633 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2634 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
2635 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2637 * Add an object to the beginning of the pack list
2639 * Pack @p subobj into the box @p obj, placing it first in the list of
2640 * children objects. The actual position the object will get on screen
2641 * depends on the layout used. If no custom layout is set, it will be at
2642 * the top or left, depending if the box is vertical or horizontal,
2645 * @param obj The box object
2646 * @param subobj The object to add to the box
2648 * @see elm_box_pack_end()
2649 * @see elm_box_pack_before()
2650 * @see elm_box_pack_after()
2651 * @see elm_box_unpack()
2652 * @see elm_box_unpack_all()
2653 * @see elm_box_clear()
2655 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2657 * Add an object at the end of the pack list
2659 * Pack @p subobj into the box @p obj, placing it last in the list of
2660 * children objects. The actual position the object will get on screen
2661 * depends on the layout used. If no custom layout is set, it will be at
2662 * the bottom or right, depending if the box is vertical or horizontal,
2665 * @param obj The box object
2666 * @param subobj The object to add to the box
2668 * @see elm_box_pack_start()
2669 * @see elm_box_pack_before()
2670 * @see elm_box_pack_after()
2671 * @see elm_box_unpack()
2672 * @see elm_box_unpack_all()
2673 * @see elm_box_clear()
2675 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2677 * Adds an object to the box before the indicated object
2679 * This will add the @p subobj to the box indicated before the object
2680 * indicated with @p before. If @p before is not already in the box, results
2681 * are undefined. Before means either to the left of the indicated object or
2682 * above it depending on orientation.
2684 * @param obj The box object
2685 * @param subobj The object to add to the box
2686 * @param before The object before which to add it
2688 * @see elm_box_pack_start()
2689 * @see elm_box_pack_end()
2690 * @see elm_box_pack_after()
2691 * @see elm_box_unpack()
2692 * @see elm_box_unpack_all()
2693 * @see elm_box_clear()
2695 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
2697 * Adds an object to the box after the indicated object
2699 * This will add the @p subobj to the box indicated after the object
2700 * indicated with @p after. If @p after is not already in the box, results
2701 * are undefined. After means either to the right of the indicated object or
2702 * below it depending on orientation.
2704 * @param obj The box object
2705 * @param subobj The object to add to the box
2706 * @param after The object after which to add it
2708 * @see elm_box_pack_start()
2709 * @see elm_box_pack_end()
2710 * @see elm_box_pack_before()
2711 * @see elm_box_unpack()
2712 * @see elm_box_unpack_all()
2713 * @see elm_box_clear()
2715 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
2717 * Clear the box of all children
2719 * Remove all the elements contained by the box, deleting the respective
2722 * @param obj The box object
2724 * @see elm_box_unpack()
2725 * @see elm_box_unpack_all()
2727 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
2731 * Remove the object given by @p subobj from the box @p obj without
2734 * @param obj The box object
2736 * @see elm_box_unpack_all()
2737 * @see elm_box_clear()
2739 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2741 * Remove all items from the box, without deleting them
2743 * Clear the box from all children, but don't delete the respective objects.
2744 * If no other references of the box children exist, the objects will never
2745 * be deleted, and thus the application will leak the memory. Make sure
2746 * when using this function that you hold a reference to all the objects
2747 * in the box @p obj.
2749 * @param obj The box object
2751 * @see elm_box_clear()
2752 * @see elm_box_unpack()
2754 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
2756 * Retrieve a list of the objects packed into the box
2758 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
2759 * The order of the list corresponds to the packing order the box uses.
2761 * You must free this list with eina_list_free() once you are done with it.
2763 * @param obj The box object
2765 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2767 * Set the space (padding) between the box's elements.
2769 * Extra space in pixels that will be added between a box child and its
2770 * neighbors after its containing cell has been calculated. This padding
2771 * is set for all elements in the box, besides any possible padding that
2772 * individual elements may have through their size hints.
2774 * @param obj The box object
2775 * @param horizontal The horizontal space between elements
2776 * @param vertical The vertical space between elements
2778 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
2780 * Get the space (padding) between the box's elements.
2782 * @param obj The box object
2783 * @param horizontal The horizontal space between elements
2784 * @param vertical The vertical space between elements
2786 * @see elm_box_padding_set()
2788 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
2790 * Set the alignment of the whole bouding box of contents.
2792 * Sets how the bounding box containing all the elements of the box, after
2793 * their sizes and position has been calculated, will be aligned within
2794 * the space given for the whole box widget.
2796 * @param obj The box object
2797 * @param horizontal The horizontal alignment of elements
2798 * @param vertical The vertical alignment of elements
2800 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
2802 * Get the alignment of the whole bouding box of contents.
2804 * @param obj The box object
2805 * @param horizontal The horizontal alignment of elements
2806 * @param vertical The vertical alignment of elements
2808 * @see elm_box_align_set()
2810 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
2813 * Set the layout defining function to be used by the box
2815 * Whenever anything changes that requires the box in @p obj to recalculate
2816 * the size and position of its elements, the function @p cb will be called
2817 * to determine what the layout of the children will be.
2819 * Once a custom function is set, everything about the children layout
2820 * is defined by it. The flags set by elm_box_horizontal_set() and
2821 * elm_box_homogeneous_set() no longer have any meaning, and the values
2822 * given by elm_box_padding_set() and elm_box_align_set() are up to this
2823 * layout function to decide if they are used and how. These last two
2824 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
2825 * passed to @p cb. The @c Evas_Object the function receives is not the
2826 * Elementary widget, but the internal Evas Box it uses, so none of the
2827 * functions described here can be used on it.
2829 * Any of the layout functions in @c Evas can be used here, as well as the
2830 * special elm_box_layout_transition().
2832 * The final @p data argument received by @p cb is the same @p data passed
2833 * here, and the @p free_data function will be called to free it
2834 * whenever the box is destroyed or another layout function is set.
2836 * Setting @p cb to NULL will revert back to the default layout function.
2838 * @param obj The box object
2839 * @param cb The callback function used for layout
2840 * @param data Data that will be passed to layout function
2841 * @param free_data Function called to free @p data
2843 * @see elm_box_layout_transition()
2845 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);
2847 * Special layout function that animates the transition from one layout to another
2849 * Normally, when switching the layout function for a box, this will be
2850 * reflected immediately on screen on the next render, but it's also
2851 * possible to do this through an animated transition.
2853 * This is done by creating an ::Elm_Box_Transition and setting the box
2854 * layout to this function.
2858 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
2859 * evas_object_box_layout_vertical, // start
2860 * NULL, // data for initial layout
2861 * NULL, // free function for initial data
2862 * evas_object_box_layout_horizontal, // end
2863 * NULL, // data for final layout
2864 * NULL, // free function for final data
2865 * anim_end, // will be called when animation ends
2866 * NULL); // data for anim_end function\
2867 * elm_box_layout_set(box, elm_box_layout_transition, t,
2868 * elm_box_transition_free);
2871 * @note This function can only be used with elm_box_layout_set(). Calling
2872 * it directly will not have the expected results.
2874 * @see elm_box_transition_new
2875 * @see elm_box_transition_free
2876 * @see elm_box_layout_set
2878 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
2880 * Create a new ::Elm_Box_Transition to animate the switch of layouts
2882 * If you want to animate the change from one layout to another, you need
2883 * to set the layout function of the box to elm_box_layout_transition(),
2884 * passing as user data to it an instance of ::Elm_Box_Transition with the
2885 * necessary information to perform this animation. The free function to
2886 * set for the layout is elm_box_transition_free().
2888 * The parameters to create an ::Elm_Box_Transition sum up to how long
2889 * will it be, in seconds, a layout function to describe the initial point,
2890 * another for the final position of the children and one function to be
2891 * called when the whole animation ends. This last function is useful to
2892 * set the definitive layout for the box, usually the same as the end
2893 * layout for the animation, but could be used to start another transition.
2895 * @param start_layout The layout function that will be used to start the animation
2896 * @param start_layout_data The data to be passed the @p start_layout function
2897 * @param start_layout_free_data Function to free @p start_layout_data
2898 * @param end_layout The layout function that will be used to end the animation
2899 * @param end_layout_free_data The data to be passed the @p end_layout function
2900 * @param end_layout_free_data Function to free @p end_layout_data
2901 * @param transition_end_cb Callback function called when animation ends
2902 * @param transition_end_data Data to be passed to @p transition_end_cb
2903 * @return An instance of ::Elm_Box_Transition
2905 * @see elm_box_transition_new
2906 * @see elm_box_layout_transition
2908 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);
2910 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
2912 * This function is mostly useful as the @c free_data parameter in
2913 * elm_box_layout_set() when elm_box_layout_transition().
2915 * @param data The Elm_Box_Transition instance to be freed.
2917 * @see elm_box_transition_new
2918 * @see elm_box_layout_transition
2920 EAPI void elm_box_transition_free(void *data);
2927 * @defgroup Button Button
2929 * @image html widget/button/preview-00.png
2930 * @image html widget/button/preview-01.png
2931 * @image html widget/button/preview-02.png
2933 * This is a push-button. Press it and run some function. It can contain
2934 * a simple label and icon object and it also has an autorepeat feature.
2936 * This widgets emits the following signals:
2937 * @li "clicked": the user clicked the button (press/release).
2938 * @li "repeated": the user pressed the button without releasing it.
2939 * @li "pressed": button was pressed.
2940 * @li "unpressed": button was released after being pressed.
2941 * In all three cases, the @c event parameter of the callback will be
2944 * Also, defined in the default theme, the button has the following styles
2946 * @li default: a normal button.
2947 * @li anchor: Like default, but the button fades away when the mouse is not
2948 * over it, leaving only the text or icon.
2949 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
2950 * continuous look across its options.
2951 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
2953 * Follow through a complete example @ref button_example_01 "here".
2959 UIControlStateDefault,
2960 UIControlStateHighlighted,
2961 UIControlStateDisabled,
2962 UIControlStateFocused,
2963 UIControlStateReserved
2967 * Add a new button to the parent's canvas
2969 * @param parent The parent object
2970 * @return The new object or NULL if it cannot be created
2972 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2974 * Set the label used in the button
2976 * The passed @p label can be NULL to clean any existing text in it and
2977 * leave the button as an icon only object.
2979 * @param obj The button object
2980 * @param label The text will be written on the button
2981 * @deprecated use elm_object_text_set() instead.
2983 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
2985 * Get the label set for the button
2987 * The string returned is an internal pointer and should not be freed or
2988 * altered. It will also become invalid when the button is destroyed.
2989 * The string returned, if not NULL, is a stringshare, so if you need to
2990 * keep it around even after the button is destroyed, you can use
2991 * eina_stringshare_ref().
2993 * @param obj The button object
2994 * @return The text set to the label, or NULL if nothing is set
2995 * @deprecated use elm_object_text_set() instead.
2997 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2999 * Set the label for each state of button
3001 * The passed @p label can be NULL to clean any existing text in it and
3002 * leave the button as an icon only object for the state.
3004 * @param obj The button object
3005 * @param label The text will be written on the button
3006 * @param state The state of button
3010 EINA_DEPRECATED EAPI void elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlState state) EINA_ARG_NONNULL(1);
3012 * Get the label of button for each state
3014 * The string returned is an internal pointer and should not be freed or
3015 * altered. It will also become invalid when the button is destroyed.
3016 * The string returned, if not NULL, is a stringshare, so if you need to
3017 * keep it around even after the button is destroyed, you can use
3018 * eina_stringshare_ref().
3020 * @param obj The button object
3021 * @param state The state of button
3022 * @return The title of button for state
3026 EINA_DEPRECATED EAPI const char *elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) EINA_ARG_NONNULL(1);
3028 * Set the icon used for the button
3030 * Setting a new icon will delete any other that was previously set, making
3031 * any reference to them invalid. If you need to maintain the previous
3032 * object alive, unset it first with elm_button_icon_unset().
3034 * @param obj The button object
3035 * @param icon The icon object for the button
3037 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3039 * Get the icon used for the button
3041 * Return the icon object which is set for this widget. If the button is
3042 * destroyed or another icon is set, the returned object will be deleted
3043 * and any reference to it will be invalid.
3045 * @param obj The button object
3046 * @return The icon object that is being used
3048 * @see elm_button_icon_unset()
3050 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3052 * Remove the icon set without deleting it and return the object
3054 * This function drops the reference the button holds of the icon object
3055 * and returns this last object. It is used in case you want to remove any
3056 * icon, or set another one, without deleting the actual object. The button
3057 * will be left without an icon set.
3059 * @param obj The button object
3060 * @return The icon object that was being used
3062 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3064 * Turn on/off the autorepeat event generated when the button is kept pressed
3066 * When off, no autorepeat is performed and buttons emit a normal @c clicked
3067 * signal when they are clicked.
3069 * When on, keeping a button pressed will continuously emit a @c repeated
3070 * signal until the button is released. The time it takes until it starts
3071 * emitting the signal is given by
3072 * elm_button_autorepeat_initial_timeout_set(), and the time between each
3073 * new emission by elm_button_autorepeat_gap_timeout_set().
3075 * @param obj The button object
3076 * @param on A bool to turn on/off the event
3078 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
3080 * Get whether the autorepeat feature is enabled
3082 * @param obj The button object
3083 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
3085 * @see elm_button_autorepeat_set()
3087 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3089 * Set the initial timeout before the autorepeat event is generated
3091 * Sets the timeout, in seconds, since the button is pressed until the
3092 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
3093 * won't be any delay and the even will be fired the moment the button is
3096 * @param obj The button object
3097 * @param t Timeout in seconds
3099 * @see elm_button_autorepeat_set()
3100 * @see elm_button_autorepeat_gap_timeout_set()
3102 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
3104 * Get the initial timeout before the autorepeat event is generated
3106 * @param obj The button object
3107 * @return Timeout in seconds
3109 * @see elm_button_autorepeat_initial_timeout_set()
3111 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3113 * Set the interval between each generated autorepeat event
3115 * After the first @c repeated event is fired, all subsequent ones will
3116 * follow after a delay of @p t seconds for each.
3118 * @param obj The button object
3119 * @param t Interval in seconds
3121 * @see elm_button_autorepeat_initial_timeout_set()
3123 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
3125 * Get the interval between each generated autorepeat event
3127 * @param obj The button object
3128 * @return Interval in seconds
3130 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3136 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3137 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3138 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3139 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3140 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3141 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3142 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3143 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3144 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
3145 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
3146 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
3147 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3148 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3149 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3150 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3151 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3152 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3153 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3154 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3155 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3156 /* available styles:
3160 * hoversel_vertical_entry
3162 /* smart callbacks called:
3163 * "file,chosen" - the user has selected a path, whose string pointer comes
3167 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3168 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3169 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3170 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3171 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3172 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3173 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3174 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3175 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
3176 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
3177 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
3178 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3179 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3180 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3181 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3182 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3183 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3184 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3185 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3186 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3187 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
3188 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3190 /* scroller policy */
3191 typedef enum _Elm_Scroller_Policy
3193 ELM_SCROLLER_POLICY_AUTO = 0,
3194 ELM_SCROLLER_POLICY_ON,
3195 ELM_SCROLLER_POLICY_OFF,
3196 ELM_SCROLLER_POLICY_LAST
3197 } Elm_Scroller_Policy;
3199 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3200 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
3201 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3202 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3203 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
3204 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
3205 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);
3206 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
3207 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
3208 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);
3209 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
3210 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
3211 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
3212 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
3213 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
3214 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);
3215 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
3216 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
3217 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
3218 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
3219 EINA_DEPRECATED EAPI void elm_scroller_page_move_set(Evas_Object *obj, Eina_Bool set);
3220 /* smart callbacks called:
3221 * "edge,left" - the left edge of the content has been reached
3222 * "edge,right" - the right edge of the content has been reached
3223 * "edge,top" - the top edge of the content has been reached
3224 * "edge,bottom" - the bottom edge of the content has been reached
3225 * "scroll" - the content has been scrolled (moved)
3226 * "scroll,anim,start" - scrolling animation has started
3227 * "scroll,anim,stop" - scrolling animation has stopped
3228 * "scroll,drag,start" - dragging the contents around has started
3229 * "scroll,drag,stop" - dragging the contents around has stopped
3233 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3234 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 */
3235 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
3236 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
3237 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3238 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
3239 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3240 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
3241 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3242 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
3243 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);
3244 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
3245 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);
3246 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
3247 EINA_DEPRECATED EAPI void elm_label_wrap_mode_set(Evas_Object *obj, Eina_Bool wrapmode) EINA_ARG_NONNULL(1);
3248 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
3249 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
3250 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
3251 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
3252 /* available styles:
3256 /* smart callbacks called:
3260 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3261 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3262 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3263 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3264 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3265 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3266 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
3267 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
3268 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
3269 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3270 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
3271 /* smart callbacks called:
3272 * "changed" - Whenever the toggle value has been changed. Is not called
3273 * until the toggle is released by the cursor (assuming it has been triggered
3274 * by the cursor in the first place).
3278 * @page tutorial_frame Frame example
3279 * @dontinclude frame_example_01.c
3281 * In this example we are going to create 4 Frames with different styles and
3282 * add a rectangle of different color in each.
3284 * We start we the usual setup code:
3287 * And then create one rectangle:
3290 * To add it in our first frame, which since it doesn't have it's style
3291 * specifically set uses the default style:
3294 * And then create another rectangle:
3297 * To add it in our second frame, which uses the "pad_small" style, note that
3298 * even tough we are setting a text for this frame it won't be show, only the
3299 * default style shows the Frame's title:
3301 * @note The "pad_small", "pad_medium", "pad_large" and "pad_huge" styles are
3302 * very similar, their only difference is the size of the empty area around
3303 * the content of the frame.
3305 * And then create yet another rectangle:
3308 * To add it in our third frame, which uses the "outdent_top" style, note
3309 * that even tough we are setting a text for this frame it won't be show,
3310 * only the default style shows the Frame's title:
3313 * And then create one last rectangle:
3316 * To add it in our fourth and final frame, which uses the "outdent_bottom"
3317 * style, note that even tough we are setting a text for this frame it won't
3318 * be show, only the default style shows the Frame's title:
3321 * And now we are left with just some more setup code:
3324 * Our example will look like this:
3325 * @image html screenshots/frame_example_01.png
3326 * @image latex screenshots/frame_example_01.eps
3328 * @example frame_example_01.c
3331 * @defgroup Frame Frame
3333 * @brief Frame is a widget that holds some content and has a title.
3335 * The default look is a frame with a title, but Frame supports multple
3343 * @li outdent_bottom
3345 * Of all this styles only default shows the title. Frame emits no signals.
3347 * For a detailed example see the @ref tutorial_frame.
3352 * @brief Add a new frame to the parent
3354 * @param parent The parent object
3355 * @return The new object or NULL if it cannot be created
3357 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3359 * @brief Set the frame label
3361 * @param obj The frame object
3362 * @param label The label of this frame object
3364 * @deprecated use elm_object_text_set() instead.
3366 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3368 * @brief Get the frame label
3370 * @param obj The frame object
3372 * @return The label of this frame objet or NULL if unable to get frame
3374 * @deprecated use elm_object_text_get() instead.
3376 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3378 * @brief Set the content of the frame widget
3380 * Once the content object is set, a previously set one will be deleted.
3381 * If you want to keep that old content object, use the
3382 * elm_frame_content_unset() function.
3384 * @param obj The frame object
3385 * @param content The content will be filled in this frame object
3387 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
3389 * @brief Get the content of the frame widget
3391 * Return the content object which is set for this widget
3393 * @param obj The frame object
3394 * @return The content that is being used
3396 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3398 * @brief Unset the content of the frame widget
3400 * Unparent and return the content object which was set for this widget
3402 * @param obj The frame object
3403 * @return The content that was being used
3405 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3411 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3412 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
3413 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3414 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
3415 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3416 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
3417 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
3418 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
3419 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3420 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
3421 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
3422 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
3425 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class;
3426 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func;
3427 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Item of Elm_Gengrid. Sub-type of Elm_Widget_Item */
3428 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
3429 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
3430 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
3431 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj);
3433 struct _Elm_Gengrid_Item_Class
3435 const char *item_style;
3436 struct _Elm_Gengrid_Item_Class_Func
3438 GridItemLabelGetFunc label_get;
3439 GridItemIconGetFunc icon_get;
3440 GridItemStateGetFunc state_get;
3441 GridItemDelFunc del;
3445 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3446 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
3447 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
3448 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
3449 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
3451 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
3452 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3453 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
3454 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3455 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
3456 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3457 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
3458 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3459 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
3460 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
3461 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
3462 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
3463 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
3464 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
3465 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3467 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3468 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3470 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3471 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3472 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3473 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3474 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3475 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3476 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
3477 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3478 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
3479 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
3480 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
3481 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3482 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3483 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3484 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3485 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
3486 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3488 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
3489 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);
3490 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3491 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
3492 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3493 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
3494 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3495 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3496 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
3497 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3498 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
3499 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3501 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3502 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3503 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3505 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);
3506 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);
3507 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);
3508 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);
3509 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);
3510 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);
3511 /* smart callbacks called:
3513 * selected - User has selected an item.
3514 * unselected - User has unselected an item.
3515 * clicked,double - User has double-clicked or pressed enter on an item.
3516 * realized - An evas object for an item was built.
3517 * unrealized - An evas object for an item was deleted.
3518 * changed - An item has been added, removed, resized or moved,
3519 * or gengrid has been resized or horizontal property has been changed.
3520 * scroll - the content has been scrolled (moved).
3521 * "scroll,anim,start" - This is called when scrolling animation has started.
3522 * "scroll,anim,stop" - This is called when scrolling animation has stopped.
3523 * "scroll,drag,start" - dragging the contents around has started.
3524 * "scroll,drag,stop" - dragging the contents around has stopped.
3525 * drag - Gengrid is being dragged.
3526 * "drag,start,up" - Gengrid has been dragged (not scrolled) up.
3527 * "drag,start,down" - Gengrid has been dragged (not scrolled) down.
3528 * "drag,start,left" - Gengrid has been dragged (not scrolled) left.
3529 * "drag,start,rigth" - Gengrid has been dragged (nto scrolled) right.
3530 * "drag,stop" - Gengrid is not being dragged.
3534 * @defgroup Clock Clock
3536 * This is a @b digital clock widget. In its default theme, it has a
3537 * vintage "flipping numbers clock" appearance, which will animate
3538 * sheets of individual algarisms individually as time goes by.
3540 * A newly created clock will fetch system's time (already
3541 * considering local time adjustments) to start with, and will tick
3542 * accondingly. It may or may not show seconds.
3544 * Clocks have an @b edition mode. When in it, the sheets will
3545 * display extra arrow indications on the top and bottom and the
3546 * user may click on them to raise or lower the time values. After
3547 * it's told to exit edition mode, it will keep ticking with that
3548 * new time set (it keeps the difference from local time).
3550 * Also, when under edition mode, user clicks on the cited arrows
3551 * which are @b held for some time will make the clock to flip the
3552 * sheet, thus editing the time, continuosly and automatically for
3553 * the user. The interval between sheet flips will keep growing in
3554 * time, so that it helps the user to reach a time which is distant
3557 * The time display is, by default, in military mode (24h), but an
3558 * am/pm indicator may be optionally shown, too, when it will
3561 * Smart callbacks one can register to:
3562 * - "changed" - the clock's user changed the time
3564 * Here is an example on its usage:
3565 * @li @ref clock_example
3574 * Identifiers for which clock digits should be editable, when a
3575 * clock widget is in edition mode. Values may be ORed together to
3576 * make a mask, naturally.
3578 * @see elm_clock_edit_set()
3579 * @see elm_clock_digit_edit_set()
3581 typedef enum _Elm_Clock_Digedit
3583 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
3584 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
3585 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
3586 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
3587 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
3588 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
3589 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
3590 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
3591 } Elm_Clock_Digedit;
3594 * Add a new clock widget to the given parent Elementary
3595 * (container) object
3597 * @param parent The parent object
3598 * @return a new clock widget handle or @c NULL, on errors
3600 * This function inserts a new clock widget on the canvas.
3604 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3607 * Set a clock widget's time, programmatically
3609 * @param obj The clock widget object
3610 * @param hrs The hours to set
3611 * @param min The minutes to set
3612 * @param sec The secondes to set
3614 * This function updates the time that is showed by the clock
3617 * Values @b must be set within the following ranges:
3618 * - 0 - 23, for hours
3619 * - 0 - 59, for minutes
3620 * - 0 - 59, for seconds,
3622 * even if the clock is not in "military" mode.
3624 * @warning The behavior for values set out of those ranges is @b
3629 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
3632 * Get a clock widget's time values
3634 * @param obj The clock object
3635 * @param[out] hrs Pointer to the variable to get the hours value
3636 * @param[out] min Pointer to the variable to get the minutes value
3637 * @param[out] sec Pointer to the variable to get the seconds value
3639 * This function gets the time set for @p obj, returning
3640 * it on the variables passed as the arguments to function
3642 * @note Use @c NULL pointers on the time values you're not
3643 * interested in: they'll be ignored by the function.
3647 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
3650 * Set whether a given clock widget is under <b>edition mode</b> or
3651 * under (default) displaying-only mode.
3653 * @param obj The clock object
3654 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
3655 * put it back to "displaying only" mode
3657 * This function makes a clock's time to be editable or not <b>by
3658 * user interaction</b>. When in edition mode, clocks @b stop
3659 * ticking, until one brings them back to canonical mode. The
3660 * elm_clock_digit_edit_set() function will influence which digits
3661 * of the clock will be editable. By default, all of them will be
3662 * (#ELM_CLOCK_NONE).
3664 * @note am/pm sheets, if being shown, will @b always be editable
3665 * under edition mode.
3667 * @see elm_clock_edit_get()
3671 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
3674 * Retrieve whether a given clock widget is under <b>edition
3675 * mode</b> or under (default) displaying-only mode.
3677 * @param obj The clock object
3678 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
3681 * This function retrieves whether the clock's time can be edited
3682 * or not by user interaction.
3684 * @see elm_clock_edit_set() for more details
3688 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3691 * Set what digits of the given clock widget should be editable
3692 * when in edition mode.
3694 * @param obj The clock object
3695 * @param digedit Bit mask indicating the digits to be editable
3696 * (values in #Elm_Clock_Digedit).
3698 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
3699 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
3702 * @see elm_clock_digit_edit_get()
3706 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
3709 * Retrieve what digits of the given clock widget should be
3710 * editable when in edition mode.
3712 * @param obj The clock object
3713 * @return Bit mask indicating the digits to be editable
3714 * (values in #Elm_Clock_Digedit).
3716 * @see elm_clock_digit_edit_set() for more details
3720 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3723 * Set if the given clock widget must show hours in military or
3726 * @param obj The clock object
3727 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
3730 * This function sets if the clock must show hours in military or
3731 * am/pm mode. In some countries like Brazil the military mode
3732 * (00-24h-format) is used, in opposition to the USA, where the
3733 * am/pm mode is more commonly used.
3735 * @see elm_clock_show_am_pm_get()
3739 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
3742 * Get if the given clock widget shows hours in military or am/pm
3745 * @param obj The clock object
3746 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
3749 * This function gets if the clock shows hours in military or am/pm
3752 * @see elm_clock_show_am_pm_set() for more details
3756 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3759 * Set if the given clock widget must show time with seconds or not
3761 * @param obj The clock object
3762 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
3764 * This function sets if the given clock must show or not elapsed
3765 * seconds. By default, they are @b not shown.
3767 * @see elm_clock_show_seconds_get()
3771 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
3774 * Get whether the given clock widget is showing time with seconds
3777 * @param obj The clock object
3778 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
3780 * This function gets whether @p obj is showing or not the elapsed
3783 * @see elm_clock_show_seconds_set()
3787 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3790 * Set the interval on time updates for an user mouse button hold
3791 * on clock widgets' time edition.
3793 * @param obj The clock object
3794 * @param interval The (first) interval value in seconds
3796 * This interval value is @b decreased while the user holds the
3797 * mouse pointer either incrementing or decrementing a given the
3798 * clock digit's value.
3800 * This helps the user to get to a given time distant from the
3801 * current one easier/faster, as it will start to flip quicker and
3802 * quicker on mouse button holds.
3804 * The calculation for the next flip interval value, starting from
3805 * the one set with this call, is the previous interval divided by
3806 * 1.05, so it decreases a little bit.
3808 * The default starting interval value for automatic flips is
3811 * @see elm_clock_interval_get()
3815 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
3818 * Get the interval on time updates for an user mouse button hold
3819 * on clock widgets' time edition.
3821 * @param obj The clock object
3822 * @return The (first) interval value, in seconds, set on it
3824 * @see elm_clock_interval_set() for more details
3828 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3835 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3836 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
3837 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
3838 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
3839 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3840 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3841 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
3842 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
3843 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
3844 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
3845 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
3846 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
3847 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
3848 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
3849 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);
3850 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
3851 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
3852 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3853 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
3854 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
3855 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
3856 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3857 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3858 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
3859 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3860 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);
3861 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
3863 * @def elm_layout_icon_set
3864 * Convienience macro to set the icon object in a layout that follows the
3865 * Elementary naming convention for its parts.
3869 #define elm_layout_icon_set(_ly, _obj) \
3872 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
3873 if ((_obj)) sig = "elm,state,icon,visible"; \
3874 else sig = "elm,state,icon,hidden"; \
3875 elm_object_signal_emit((_ly), sig, "elm"); \
3879 * @def elm_layout_icon_get
3880 * Convienience macro to get the icon object from a layout that follows the
3881 * Elementary naming convention for its parts.
3885 #define elm_layout_icon_get(_ly) \
3886 elm_layout_content_get((_ly), "elm.swallow.icon")
3889 * @def elm_layout_end_set
3890 * Convienience macro to set the end object in a layout that follows the
3891 * Elementary naming convention for its parts.
3895 #define elm_layout_end_set(_ly, _obj) \
3898 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
3899 if ((_obj)) sig = "elm,state,end,visible"; \
3900 else sig = "elm,state,end,hidden"; \
3901 elm_object_signal_emit((_ly), sig, "elm"); \
3905 * @def elm_layout_end_get
3906 * Convienience macro to get the end object in a layout that follows the
3907 * Elementary naming convention for its parts.
3911 #define elm_layout_end_get(_ly) \
3912 elm_layout_content_get((_ly), "elm.swallow.end")
3915 * @def elm_layout_label_set
3916 * Convienience macro to set the label in a layout that follows the
3917 * Elementary naming convention for its parts.
3920 * @deprecate use elm_object_text_* instead.
3922 #define elm_layout_label_set(_ly, _txt) \
3923 elm_layout_text_set((_ly), "elm.text", (_txt))
3926 * @def elm_layout_label_get
3927 * Convienience macro to get the label in a layout that follows the
3928 * Elementary naming convention for its parts.
3931 * @deprecate use elm_object_text_* instead.
3933 #define elm_layout_label_get(_ly) \
3934 elm_layout_text_get((_ly), "elm.text")
3936 /* smart callbacks called:
3940 typedef enum _Elm_Notify_Orient
3942 ELM_NOTIFY_ORIENT_TOP,
3943 ELM_NOTIFY_ORIENT_CENTER,
3944 ELM_NOTIFY_ORIENT_BOTTOM,
3945 ELM_NOTIFY_ORIENT_LEFT,
3946 ELM_NOTIFY_ORIENT_RIGHT,
3947 ELM_NOTIFY_ORIENT_TOP_LEFT,
3948 ELM_NOTIFY_ORIENT_TOP_RIGHT,
3949 ELM_NOTIFY_ORIENT_BOTTOM_LEFT,
3950 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT,
3951 ELM_NOTIFY_ORIENT_LAST
3952 } Elm_Notify_Orient;
3953 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3954 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
3955 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3956 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3957 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3958 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3959 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
3960 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3961 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
3962 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3963 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
3964 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3965 /* smart callbacks called:
3966 * "timeout" - when timeout happens on notify and it's hidden
3967 * "block,clicked" - when it's hidden by a click outside of the notify's view
3971 typedef enum _Elm_Hover_Axis
3973 ELM_HOVER_AXIS_NONE,
3974 ELM_HOVER_AXIS_HORIZONTAL,
3975 ELM_HOVER_AXIS_VERTICAL,
3978 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3979 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
3980 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3981 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
3982 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3983 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
3984 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3985 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
3986 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
3987 /* available styles:
3993 /* smart callbacks called:
3994 * "clicked" - the user clicked the empty space in the hover to dismiss
3995 * "smart,changed" - a content object placed under the "smart"
3996 * policy was replaced to a new slot direction.
4000 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
4001 struct _Elm_Entry_Anchor_Info
4005 Evas_Coord x, y, w, h;
4007 typedef enum _Elm_Icon_Type
4014 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
4016 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4017 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
4018 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4019 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
4020 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4021 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
4022 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4023 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
4024 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4025 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4026 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
4027 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
4028 EINA_DEPRECATED EAPI void elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
4029 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4030 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
4031 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4032 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
4033 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
4034 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
4035 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
4036 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
4037 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
4038 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
4039 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
4040 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
4041 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
4042 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
4043 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
4044 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4045 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4046 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4047 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);
4048 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
4049 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4050 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
4051 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
4052 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
4053 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4054 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);
4055 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
4056 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4057 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);
4058 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);
4059 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);
4060 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);
4061 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);
4062 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);
4063 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
4064 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
4065 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
4066 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
4067 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
4068 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
4069 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4070 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
4071 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4072 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
4073 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
4074 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
4075 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
4076 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
4077 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
4078 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
4079 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
4080 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
4081 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
4082 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
4083 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
4084 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
4086 /* pre-made filters for entries */
4087 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
4088 struct _Elm_Entry_Filter_Limit_Size
4093 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
4094 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
4095 struct _Elm_Entry_Filter_Accept_Set
4097 const char *accepted;
4098 const char *rejected;
4100 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
4102 * Set the input panel layout of the entry
4104 * @param obj The entry object
4105 * @param layout layout type
4107 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
4109 * Get the input panel layout of the entry
4111 * @param obj The entry object
4112 * @return layout type
4114 * @see elm_entry_input_panel_layout_set
4116 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4118 * Set the autocapitalization type on the immodule.
4120 * @param obj The entry object
4121 * @param autocapital_type The type of autocapitalization
4123 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
4125 * Retrieve the autocapitalization type on the immodule.
4127 * @param obj The entry object
4128 * @return autocapitalization type
4130 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4132 * Sets the attribute to show the input panel automatically.
4134 * @param obj The entry object
4135 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
4137 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4139 * Retrieve the attribute to show the input panel automatically.
4141 * @param obj The entry object
4142 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
4144 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4146 EAPI void elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
4147 EAPI void elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
4148 EAPI void elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
4149 EAPI void elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
4150 EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
4151 EAPI void elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
4152 EAPI void elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
4154 EINA_DEPRECATED EAPI void elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
4155 EINA_DEPRECATED EAPI Evas_Coord elm_entry_wrap_width_get(const Evas_Object *obj);
4156 EINA_DEPRECATED EAPI void elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
4157 EINA_DEPRECATED EAPI void elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
4158 EINA_DEPRECATED EAPI void elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
4160 /* smart callbacks called:
4161 * "changed" - the text content changed
4162 * "selection,start" - the user started selecting text
4163 * "selection,changed" - the user modified the selection size/location
4164 * "selection,cleared" - the user cleared the selection
4165 * "selection,paste" - the user requested a paste of text
4166 * "selection,copy" - the user copied the text
4167 * "selection,cut" - the user cut the text
4168 * "cursor,changed" - the cursor changed position
4169 * "anchor,clicked" - achor called was clicked | event_info = Elm_Entry_Anchor_Info
4170 * "activated" - when the enter key is pressed (useful for single line)
4171 * "press" - when finger/mouse is pressed down
4172 * "clicked" - when finger/mouse is pressed and released (without a drag etc.)
4173 * "clicked,double" - when finger/mouse is double-pressed
4174 * "longpressed" - the entry has been longpressed
4175 * "focused" - the entry has received keyboard focus
4176 * "unfocused" - keyboard focus is gone
4179 /* composite widgets - these basically put together basic widgets above
4180 * in convenient packages that do more than basic stuff */
4184 * @defgroup Anchorview Anchorview
4186 * Anchorview is for displaying text that contains markup with anchors
4187 * like <c>\<a href=1234\>something\</\></c> in it.
4189 * Besides being styled differently, the anchorview widget provides the
4190 * necessary functionality so that clicking on these anchors brings up a
4191 * popup with user defined content such as "call", "add to contacts" or
4192 * "open web page". This popup is provided using the @ref Hover widget.
4194 * This widget is very similar to @ref Anchorblock, so refer to that
4195 * widget for an example. The only difference Anchorview has is that the
4196 * widget is already provided with scrolling functionality, so if the
4197 * text set to it is too large to fit in the given space, it will scroll,
4198 * whereas the @ref Anchorblock widget will keep growing to ensure all the
4199 * text can be displayed.
4201 * This widget emits the following signals:
4202 * @li "anchor,clicked": will be called when an anchor is clicked. The
4203 * @p event_info parameter on the callback will be a pointer of type
4204 * ::Elm_Entry_Anchorview_Info.
4206 * See @ref Anchorblock for an example on how to use both of them.
4215 * @typedef Elm_Entry_Anchorview_Info
4217 * The info sent in the callback for "anchor,clicked" signals emitted by
4218 * the Anchorview widget.
4220 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
4222 * @struct _Elm_Entry_Anchorview_Info
4224 * The info sent in the callback for "anchor,clicked" signals emitted by
4225 * the Anchorview widget.
4227 struct _Elm_Entry_Anchorview_Info
4229 const char *name; /**< Name of the anchor, as indicated in its href
4231 int button; /**< The mouse button used to click on it */
4232 Evas_Object *hover; /**< The hover object to use for the popup */
4234 Evas_Coord x, y, w, h;
4235 } anchor, /**< Geometry selection of text used as anchor */
4236 hover_parent; /**< Geometry of the object used as parent by the
4238 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
4239 for content on the left side of
4240 the hover. Before calling the
4241 callback, the widget will make the
4242 necessary calculations to check
4243 which sides are fit to be set with
4244 content, based on the position the
4245 hover is activated and its distance
4246 to the edges of its parent object
4248 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
4249 the right side of the hover.
4250 See @ref hover_left */
4251 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
4252 of the hover. See @ref hover_left */
4253 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
4254 below the hover. See @ref
4258 * Add a new Anchorview object
4260 * @param parent The parent object
4261 * @return The new object or NULL if it cannot be created
4263 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4265 * Set the text to show in the anchorview
4267 * Sets the text of the anchorview to @p text. This text can include markup
4268 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
4269 * text that will be specially styled and react to click events, ended with
4270 * either of \</a\> or \</\>. When clicked, the anchor will emit an
4271 * "anchor,clicked" signal that you can attach a callback to with
4272 * evas_object_smart_callback_add(). The name of the anchor given in the
4273 * event info struct will be the one set in the href attribute, in this
4276 * Other markup can be used to style the text in different ways, but it's
4277 * up to the style defined in the theme which tags do what.
4278 * @deprecated use elm_object_text_set() instead.
4280 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
4282 * Get the markup text set for the anchorview
4284 * Retrieves the text set on the anchorview, with markup tags included.
4286 * @param obj The anchorview object
4287 * @return The markup text set or @c NULL if nothing was set or an error
4289 * @deprecated use elm_object_text_set() instead.
4291 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4293 * Set the parent of the hover popup
4295 * Sets the parent object to use by the hover created by the anchorview
4296 * when an anchor is clicked. See @ref Hover for more details on this.
4297 * If no parent is set, the same anchorview object will be used.
4299 * @param obj The anchorview object
4300 * @param parent The object to use as parent for the hover
4302 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4304 * Get the parent of the hover popup
4306 * Get the object used as parent for the hover created by the anchorview
4307 * widget. See @ref Hover for more details on this.
4309 * @param obj The anchorview object
4310 * @return The object used as parent for the hover, NULL if none is set.
4312 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4314 * Set the style that the hover should use
4316 * When creating the popup hover, anchorview will request that it's
4317 * themed according to @p style.
4319 * @param obj The anchorview object
4320 * @param style The style to use for the underlying hover
4322 * @see elm_object_style_set()
4324 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4326 * Get the style that the hover should use
4328 * Get the style the hover created by anchorview will use.
4330 * @param obj The anchorview object
4331 * @return The style to use by the hover. NULL means the default is used.
4333 * @see elm_object_style_set()
4335 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4337 * Ends the hover popup in the anchorview
4339 * When an anchor is clicked, the anchorview widget will create a hover
4340 * object to use as a popup with user provided content. This function
4341 * terminates this popup, returning the anchorview to its normal state.
4343 * @param obj The anchorview object
4345 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
4347 * Set bouncing behaviour when the scrolled content reaches an edge
4349 * Tell the internal scroller object whether it should bounce or not
4350 * when it reaches the respective edges for each axis.
4352 * @param obj The anchorview object
4353 * @param h_bounce Whether to bounce or not in the horizontal axis
4354 * @param v_bounce Whether to bounce or not in the vertical axis
4356 * @see elm_scroller_bounce_set()
4358 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
4360 * Get the set bouncing behaviour of the internal scroller
4362 * Get whether the internal scroller should bounce when the edge of each
4363 * axis is reached scrolling.
4365 * @param obj The anchorview object
4366 * @param h_bounce Pointer where to store the bounce state of the horizontal
4368 * @param v_bounce Pointer where to store the bounce state of the vertical
4371 * @see elm_scroller_bounce_get()
4373 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
4375 * Appends a custom item provider to the given anchorview
4377 * Appends the given function to the list of items providers. This list is
4378 * called, one function at a time, with the given @p data pointer, the
4379 * anchorview object and, in the @p item parameter, the item name as
4380 * referenced in its href string. Following functions in the list will be
4381 * called in order until one of them returns something different to NULL,
4382 * which should be an Evas_Object which will be used in place of the item
4385 * Items in the markup text take the form \<item relsize=16x16 vsize=full
4386 * href=item/name\>\</item\>
4388 * @param obj The anchorview object
4389 * @param func The function to add to the list of providers
4390 * @param data User data that will be passed to the callback function
4392 * @see elm_entry_item_provider_append()
4394 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);
4396 * Prepend a custom item provider to the given anchorview
4398 * Like elm_anchorview_item_provider_append(), but it adds the function
4399 * @p func to the beginning of the list, instead of the end.
4401 * @param obj The anchorview object
4402 * @param func The function to add to the list of providers
4403 * @param data User data that will be passed to the callback function
4405 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);
4407 * Remove a custom item provider from the list of the given anchorview
4409 * Removes the function and data pairing that matches @p func and @p data.
4410 * That is, unless the same function and same user data are given, the
4411 * function will not be removed from the list. This allows us to add the
4412 * same callback several times, with different @p data pointers and be
4413 * able to remove them later without conflicts.
4415 * @param obj The anchorview object
4416 * @param func The function to remove from the list
4417 * @param data The data matching the function to remove from the list
4419 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);
4426 * @defgroup Anchorblock Anchorblock
4428 * Anchorblock 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 anchorblock 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 emits the following signals:
4437 * @li "anchor,clicked": will be called when an anchor is clicked. The
4438 * @p event_info parameter on the callback will be a pointer of type
4439 * ::Elm_Entry_Anchorblock_Info.
4445 * Since examples are usually better than plain words, we might as well
4446 * try @ref tutorial_anchorblock_example "one".
4449 * @page tutorial_anchorblock_example Anchorblock/Anchorview example
4450 * This exampel will show both Anchorblock and @ref Anchorview,
4451 * since both are very similar and it's easier to show them once and side
4452 * by side, so the difference is more clear.
4454 * We'll show the relevant snippets of the code here, but the full example
4455 * can be found here... sorry, @ref anchorblock_example_01.c "here".
4457 * As for the actual example, it's just a simple window with an anchorblock
4458 * and an anchorview, both containing the same text. After including
4459 * Elementary.h and declaring some functions we'll need, we jump to our
4460 * elm_main (see ELM_MAIN) and create our window.
4461 * @dontinclude anchorblock_example_01.c
4466 * With the needed variables declared, we'll create the window and a box to
4467 * hold our widgets, but we don't need to go through that here.
4469 * In order to make clear where the anchorblock ends and the anchorview
4470 * begins, they'll be each inside a @ref Frame. After creating the frame,
4471 * the anchorblock follows.
4472 * @skip elm_frame_add
4473 * @until elm_frame_content_set
4475 * Nothing out of the ordinary there. What's worth mentioning is the call
4476 * to elm_anchorblock_hover_parent_set(). We are telling our widget that
4477 * when an anchor is clicked, the hover for the popup will cover the entire
4478 * window. This affects the area that will be obscured by the hover and
4479 * where clicking will dismiss it, as well as the calculations it does to
4480 * inform the best locations where to insert the popups content.
4481 * Other than that, the code is pretty standard. We also need to set our
4482 * callback for when an anchor is clicked, since it's our task to populate
4483 * the popup. There's no default for it.
4485 * The anchorview is no different, we only change a few things so it looks
4487 * @until elm_frame_content_set
4489 * Then we run, so stuff works and close our main function in the usual way.
4492 * Now, a little note. Normally you would use either one of anchorblock or
4493 * anchorview, set your one callback to clicks and do your stuff in there.
4494 * In this example, however, there are a few tricks to make it easier to
4495 * show both widgets in one go (and to save me some typing). So we have
4496 * two callbacks, one per widget, that will call a common function to do
4497 * the rest. The trick is using ::Elm_Entry_Anchorblock_Info for the
4498 * anchorview too, since both are equal, and passing a callback to use
4499 * for our buttons to end the hover, because each widget has a different
4501 * @until _anchorview_clicked_cb
4504 * The meat of our popup is in the following function. We check what kind
4505 * of menu we need to show, based on the name set to the anchor in the
4506 * markup text. If there's no type (something went wrong, no valid contact
4507 * in the address list) we are just putting a button that does nothing, but
4508 * it's perfectly reasonable to just end the hover and call it quits.
4510 * Our popup will consist of one main button in the middle of our hover,
4511 * and possibly a secondary button and a list of other options. We'll create
4512 * first our main button and check what kind of popup we need afterwards.
4515 * @until eina_stringshare_add
4518 * Each button has two callbacks, one is our hack to close the hover
4519 * properly based on which widget it belongs to, the other a simple
4520 * printf that will show the action with the anchors own data. This is
4521 * not how you would usually do it. Instead, the common case is to have
4522 * one callback for the button that will know which function to call to end
4523 * things, but since we are doing it this way it's worth noting that
4524 * smart callbacks will be called in reverse in respect to the order they
4525 * were added, and since our @c btn_end_cb will close the hover, and thus
4526 * delete our buttons, the other callback wouldn't be called if we had
4529 * After our telephone popup, there are a few others that are practically
4530 * the same, so they won't be shown here.
4532 * Once we are done with that, it's time to place our actions into our
4533 * hover. Main button goes in the middle without much questioning, and then
4534 * we see if we have a secondary button and a box of extra options.
4535 * Because I said so, secondary button goes on either side and box of
4536 * options either on top or below the main one, but to choose which
4537 * exactly, we use the hints our callback info has, which saves us from
4538 * having to do the math and see which side has more space available, with
4539 * a little special case where we delete our extra stuff if there's nowhere
4543 * @skip evas_object_smart
4544 * @until evas_object_del(box)
4548 * The example will look like this:
4549 * @image html screenshots/anchorblock_01.png
4550 * @image latex screenshots/anchorblock_01.eps
4552 * @example anchorblock_example_01.c
4555 * @addtogroup Anchorblock
4559 * @typedef Elm_Entry_Anchorblock_Info
4561 * The info sent in the callback for "anchor,clicked" signals emitted by
4562 * the Anchorblock widget.
4564 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
4566 * @struct _Elm_Entry_Anchorblock_Info
4568 * The info sent in the callback for "anchor,clicked" signals emitted by
4569 * the Anchorblock widget.
4571 struct _Elm_Entry_Anchorblock_Info
4573 const char *name; /**< Name of the anchor, as indicated in its href
4575 int button; /**< The mouse button used to click on it */
4576 Evas_Object *hover; /**< The hover object to use for the popup */
4578 Evas_Coord x, y, w, h;
4579 } anchor, /**< Geometry selection of text used as anchor */
4580 hover_parent; /**< Geometry of the object used as parent by the
4582 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
4583 for content on the left side of
4584 the hover. Before calling the
4585 callback, the widget will make the
4586 necessary calculations to check
4587 which sides are fit to be set with
4588 content, based on the position the
4589 hover is activated and its distance
4590 to the edges of its parent object
4592 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
4593 the right side of the hover.
4594 See @ref hover_left */
4595 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
4596 of the hover. See @ref hover_left */
4597 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
4598 below the hover. See @ref
4602 * Add a new Anchorblock object
4604 * @param parent The parent object
4605 * @return The new object or NULL if it cannot be created
4607 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4609 * Set the text to show in the anchorblock
4611 * Sets the text of the anchorblock to @p text. This text can include markup
4612 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
4613 * of text that will be specially styled and react to click events, ended
4614 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
4615 * "anchor,clicked" signal that you can attach a callback to with
4616 * evas_object_smart_callback_add(). The name of the anchor given in the
4617 * event info struct will be the one set in the href attribute, in this
4620 * Other markup can be used to style the text in different ways, but it's
4621 * up to the style defined in the theme which tags do what.
4622 * @deprecated use elm_object_text_set() instead.
4624 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
4626 * Get the markup text set for the anchorblock
4628 * Retrieves the text set on the anchorblock, with markup tags included.
4630 * @param obj The anchorblock object
4631 * @return The markup text set or @c NULL if nothing was set or an error
4633 * @deprecated use elm_object_text_set() instead.
4635 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4637 * Set the parent of the hover popup
4639 * Sets the parent object to use by the hover created by the anchorblock
4640 * when an anchor is clicked. See @ref Hover for more details on this.
4642 * @param obj The anchorblock object
4643 * @param parent The object to use as parent for the hover
4645 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4647 * Get the parent of the hover popup
4649 * Get the object used as parent for the hover created by the anchorblock
4650 * widget. See @ref Hover for more details on this.
4651 * If no parent is set, the same anchorblock object will be used.
4653 * @param obj The anchorblock object
4654 * @return The object used as parent for the hover, NULL if none is set.
4656 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4658 * Set the style that the hover should use
4660 * When creating the popup hover, anchorblock will request that it's
4661 * themed according to @p style.
4663 * @param obj The anchorblock object
4664 * @param style The style to use for the underlying hover
4666 * @see elm_object_style_set()
4668 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4670 * Get the style that the hover should use
4672 * Get the style the hover created by anchorblock will use.
4674 * @param obj The anchorblock object
4675 * @return The style to use by the hover. NULL means the default is used.
4677 * @see elm_object_style_set()
4679 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4681 * Ends the hover popup in the anchorblock
4683 * When an anchor is clicked, the anchorblock widget will create a hover
4684 * object to use as a popup with user provided content. This function
4685 * terminates this popup, returning the anchorblock to its normal state.
4687 * @param obj The anchorblock object
4689 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
4691 * Appends a custom item provider to the given anchorblock
4693 * Appends the given function to the list of items providers. This list is
4694 * called, one function at a time, with the given @p data pointer, the
4695 * anchorblock object and, in the @p item parameter, the item name as
4696 * referenced in its href string. Following functions in the list will be
4697 * called in order until one of them returns something different to NULL,
4698 * which should be an Evas_Object which will be used in place of the item
4701 * Items in the markup text take the form \<item relsize=16x16 vsize=full
4702 * href=item/name\>\</item\>
4704 * @param obj The anchorblock object
4705 * @param func The function to add to the list of providers
4706 * @param data User data that will be passed to the callback function
4708 * @see elm_entry_item_provider_append()
4710 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);
4712 * Prepend a custom item provider to the given anchorblock
4714 * Like elm_anchorblock_item_provider_append(), but it adds the function
4715 * @p func to the beginning of the list, instead of the end.
4717 * @param obj The anchorblock object
4718 * @param func The function to add to the list of providers
4719 * @param data User data that will be passed to the callback function
4721 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);
4723 * Remove a custom item provider from the list of the given anchorblock
4725 * Removes the function and data pairing that matches @p func and @p data.
4726 * That is, unless the same function and same user data are given, the
4727 * function will not be removed from the list. This allows us to add the
4728 * same callback several times, with different @p data pointers and be
4729 * able to remove them later without conflicts.
4731 * @param obj The anchorblock object
4732 * @param func The function to remove from the list
4733 * @param data The data matching the function to remove from the list
4735 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);
4741 * @defgroup Bubble Bubble
4743 * @brief The Bubble is a widget to show text similarly to how speech is
4744 * represented in comics.
4746 * The bubble widget contains 5 important visual elements:
4747 * @li The frame is a rectangle with rounded rectangles and an "arrow".
4748 * @li The @p icon is an image to which the frame's arrow points to.
4749 * @li The @p label is a text which appears to the right of the icon if the
4750 * corner is "top_left" or "bottom_left" and is right aligned to the frame
4752 * @li The @p info is a text which appears to the right of the label. Info's
4753 * font is of a ligther color than label.
4754 * @li The @p content is an evas object that is shown inside the frame.
4756 * The position of the arrow, icon, label and info depends on which corner is
4757 * selected. The four available corners are:
4758 * @li "top_left" - Default
4761 * @li "bottom_right"
4763 * Signals that you can add callbacks for are:
4764 * @li "clicked" - This is called when a user has clicked the bubble.
4766 * For an example of using a buble see @ref bubble_01_example_page "this".
4771 * Add a new bubble to the parent
4773 * @param parent The parent object
4774 * @return The new object or NULL if it cannot be created
4776 * This function adds a text bubble to the given parent evas object.
4778 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4780 * Set the label of the bubble
4782 * @param obj The bubble object
4783 * @param label The string to set in the label
4785 * This function sets the title of the bubble. Where this appears depends on
4786 * the selected corner.
4787 * @deprecated use elm_object_text_set() instead.
4789 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
4791 * Get the label of the bubble
4793 * @param obj The bubble object
4794 * @return The string of set in the label
4796 * This function gets the title of the bubble.
4797 * @deprecated use elm_object_text_set() instead.
4799 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4801 * Set the info of the bubble
4803 * @param obj The bubble object
4804 * @param info The given info about the bubble
4806 * This function sets the info of the bubble. Where this appears depends on
4807 * the selected corner.
4808 * @deprecated use elm_object_text_set() instead.
4810 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
4812 * Get the info of the bubble
4814 * @param obj The bubble object
4816 * @return The "info" string of the bubble
4818 * This function gets the info text.
4819 * @deprecated use elm_object_text_set() instead.
4821 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4823 * Set the content to be shown in the bubble
4825 * Once the content object is set, a previously set one will be deleted.
4826 * If you want to keep the old content object, use the
4827 * elm_bubble_content_unset() function.
4829 * @param obj The bubble object
4830 * @param content The given content of the bubble
4832 * This function sets the content shown on the middle of the bubble.
4834 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4836 * Get the content shown in the bubble
4838 * Return the content object which is set for this widget.
4840 * @param obj The bubble object
4841 * @return The content that is being used
4843 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4845 * Unset the content shown in the bubble
4847 * Unparent and return the content object which was set for this widget.
4849 * @param obj The bubble object
4850 * @return The content that was being used
4852 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4854 * Set the icon of the bubble
4856 * Once the icon object is set, a previously set one will be deleted.
4857 * If you want to keep the old content object, use the
4858 * elm_icon_content_unset() function.
4860 * @param obj The bubble object
4861 * @param icon The given icon for the bubble
4863 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
4865 * Get the icon of the bubble
4867 * @param obj The bubble object
4868 * @return The icon for the bubble
4870 * This function gets the icon shown on the top left of bubble.
4872 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4874 * Unset the icon of the bubble
4876 * Unparent and return the icon object which was set for this widget.
4878 * @param obj The bubble object
4879 * @return The icon that was being used
4881 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4883 * Set the corner of the bubble
4885 * @param obj The bubble object.
4886 * @param corner The given corner for the bubble.
4888 * This function sets the corner of the bubble. The corner will be used to
4889 * determine where the arrow in the frame points to and where label, icon and
4892 * Possible values for corner are:
4893 * @li "top_left" - Default
4896 * @li "bottom_right"
4898 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
4900 * Get the corner of the bubble
4902 * @param obj The bubble object.
4903 * @return The given corner for the bubble.
4905 * This function gets the selected corner of the bubble.
4907 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4909 EINA_DEPRECATED EAPI void elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
4910 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4917 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4918 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
4919 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4920 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
4921 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
4922 /* smart callbacks called:
4923 * "clicked" - the user clicked the icon
4924 * "drag,start" - Someone started dragging the image out of the object
4925 * "drag,end" - Dragged item was dropped (somewhere)
4929 /** @defgroup Elm_Gesture_Layer Gesture Layer */
4931 * @enum _Elm_Gesture_Types
4932 * Emum of supported gesture types.
4933 * @ingroup Elm_Gesture_Layer
4935 enum _Elm_Gesture_Types
4937 ELM_GESTURE_FIRST = 0,
4939 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
4940 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
4941 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
4942 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
4944 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
4946 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
4947 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
4949 ELM_GESTURE_ZOOM, /**< Zoom */
4950 ELM_GESTURE_ROTATE, /**< Rotate */
4956 * @typedef Elm_Gesture_Types
4957 * Type for Emum of supported gesture types.
4958 * @ingroup Elm_Gesture_Layer
4960 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
4963 * @enum _Elm_Gesture_State
4964 * Emum of gesture states.
4965 * @ingroup Elm_Gesture_Layer
4967 enum _Elm_Gesture_State
4969 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
4970 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
4971 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
4972 ELM_GESTURE_STATE_END, /**< Gesture completed */
4973 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
4976 * @typedef Elm_Gesture_State
4978 * @ingroup Elm_Gesture_Layer
4980 typedef enum _Elm_Gesture_State Elm_Gesture_State;
4983 * @struct _Elm_Gesture_Taps_Info
4984 * Struct holds taps info for user
4985 * @ingroup Elm_Gesture_Layer
4987 struct _Elm_Gesture_Taps_Info
4989 Evas_Coord x, y; /**< Holds center point between fingers */
4990 unsigned int n; /**< Number of fingers tapped */
4991 unsigned int timestamp; /**< event timestamp */
4995 * @typedef Elm_Gesture_Taps_Info
4996 * holds taps info for user
4997 * @ingroup Elm_Gesture_Layer
4999 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
5002 * @struct _Elm_Gesture_Momentum_Info
5003 * Struct holds momentum info for user
5004 * x1 and y1 are not necessarily in sync
5005 * x1 holds x value of x direction starting point
5006 * and same holds for y1.
5007 * This is noticeable when doing V-shape movement
5008 * @ingroup Elm_Gesture_Layer
5010 struct _Elm_Gesture_Momentum_Info
5011 { /* Report line ends, timestamps, and momentum computed */
5012 Evas_Coord x1; /**< Final-swipe direction starting point on X */
5013 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
5014 Evas_Coord x2; /**< Final-swipe direction ending point on X */
5015 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
5017 unsigned int tx; /**< Timestamp of start of final x-swipe */
5018 unsigned int ty; /**< Timestamp of start of final y-swipe */
5020 Evas_Coord mx; /**< Momentum on X */
5021 Evas_Coord my; /**< Momentum on Y */
5023 unsigned int n; /**< Number of fingers */
5027 * @typedef Elm_Gesture_Momentum_Info
5028 * holds momentum info for user
5029 * @ingroup Elm_Gesture_Layer
5031 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
5034 * @struct _Elm_Gesture_Line_Info
5035 * Struct holds line info for user
5036 * @ingroup Elm_Gesture_Layer
5038 struct _Elm_Gesture_Line_Info
5039 { /* Report line ends, timestamps, and momentum computed */
5040 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
5041 /* FIXME should be radians, bot degrees */
5042 double angle; /**< Angle (direction) of lines */
5046 * @typedef _Elm_Gesture_Line_Info
5047 * Holds line info for user
5048 * @ingroup Elm_Gesture_Layer
5050 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
5053 * @struct _Elm_Gesture_Zoom_Info
5054 * Struct holds zoom info for user
5055 * @ingroup Elm_Gesture_Layer
5057 struct _Elm_Gesture_Zoom_Info
5059 Evas_Coord x, y; /**< Holds zoom center point reported to user */
5060 Evas_Coord radius; /**< Holds radius between fingers reported to user */
5061 double zoom; /**< Zoom value: 1.0 means no zoom */
5062 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
5066 * @typedef Elm_Gesture_Zoom_Info
5067 * Holds zoom info for user
5068 * @ingroup Elm_Gesture_Layer
5070 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
5073 * @struct _Elm_Gesture_Rotate_Info
5074 * Struct holds rotation info for user
5075 * @ingroup Elm_Gesture_Layer
5077 struct _Elm_Gesture_Rotate_Info
5079 Evas_Coord x, y; /**< Holds zoom center point reported to user */
5080 Evas_Coord radius; /**< Holds radius between fingers reported to user */
5081 double base_angle; /**< Holds start-angle */
5082 double angle; /**< Rotation value: 0.0 means no rotation */
5083 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
5087 * @typedef Elm_Gesture_Rotate_Info
5088 * Holds rotation info for user
5089 * @ingroup Elm_Gesture_Layer
5091 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
5094 * @typedef Elm_Gesture_Event_Cb
5095 * User callback used to stream gesture info from gesture layer
5096 * @param data user data
5097 * @param event_info gesture report info
5098 * Returns a flag field to be applied on the causing event.
5099 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
5100 * upon the event, in an irreversible way.
5102 * @ingroup Elm_Gesture_Layer
5104 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
5107 * Use function to set callbacks to be notified about
5108 * change of state of gesture.
5109 * When a user registers a callback with this function
5110 * this means this gesture has to be tested.
5112 * When ALL callbacks for a gesture are set to NULL
5113 * it means user isn't interested in gesture-state
5114 * and it will not be tested.
5116 * @param obj Pointer to gesture-layer.
5117 * @param idx The gesture you would like to track its state.
5118 * @param cb callback function pointer.
5119 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
5120 * @param data user info to be sent to callback (usually, Smart Data)
5122 * @ingroup Elm_Gesture_Layer
5124 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);
5127 * Call this function to get repeat-events settings.
5129 * @param obj Pointer to gesture-layer.
5131 * @return repeat events settings.
5132 * @see elm_gesture_layer_hold_events_set()
5133 * @ingroup Elm_Gesture_Layer
5135 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5138 * This function called in order to make gesture-layer repeat events.
5139 * Set this of you like to get the raw events only if gestures were not detected.
5140 * Clear this if you like gesture layer to fwd events as testing gestures.
5142 * @param obj Pointer to gesture-layer.
5143 * @param r Repeat: TRUE/FALSE
5145 * @ingroup Elm_Gesture_Layer
5147 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
5150 * This function sets step-value for zoom action.
5151 * Set step to any positive value.
5152 * Cancel step setting by setting to 0.0
5154 * @param obj Pointer to gesture-layer.
5155 * @param s new zoom step value.
5157 * @ingroup Elm_Gesture_Layer
5159 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
5162 * This function sets step-value for rotate action.
5163 * Set step to any positive value.
5164 * Cancel step setting by setting to 0.0
5166 * @param obj Pointer to gesture-layer.
5167 * @param s new roatate step value.
5169 * @ingroup Elm_Gesture_Layer
5171 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
5174 * This function called to attach gesture-layer to an Evas_Object.
5175 * @param obj Pointer to gesture-layer.
5176 * @param t Pointer to underlying object (AKA Target)
5178 * @return TRUE, FALSE on success, failure.
5180 * @ingroup Elm_Gesture_Layer
5182 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
5185 * Call this function to construct a new gesture-layer object.
5186 * This does not activate the gesture layer. You have to
5187 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
5189 * @param parent the parent object.
5191 * @return Pointer to new gesture-layer object.
5193 * @ingroup Elm_Gesture_Layer
5195 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5198 typedef enum _Elm_Thumb_Animation_Setting
5200 ELM_THUMB_ANIMATION_START = 0, /* Play animation once */
5201 ELM_THUMB_ANIMATION_LOOP, /* Keep playing animation until stop is requested */
5202 ELM_THUMB_ANIMATION_STOP,
5203 ELM_THUMB_ANIMATION_LAST
5204 } Elm_Thumb_Animation_Setting;
5206 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5207 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
5208 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
5209 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
5210 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
5211 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
5212 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5213 EAPI void *elm_thumb_ethumb_client_get(void);
5214 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
5215 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
5216 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5217 /* available styles:
5221 /* smart callbacks called:
5222 * "clicked" - This is called when a user has clicked the thumb without dragging around.
5223 * "clicked,double" - This is called when a user has double-clicked the thumb.
5224 * "press" - This is called when a user has pressed down the thumb.
5225 * "generate,start" - The thumbnail generation started.
5226 * "generate,stop" - The generation process stopped.
5227 * "generate,error" - The generation failed.
5228 * "load,error" - The thumbnail image loading failed.
5232 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5233 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5234 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5235 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
5236 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5237 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5238 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5239 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5240 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5241 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5242 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
5243 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
5244 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5245 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5246 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5247 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);
5248 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
5249 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5250 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
5251 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
5252 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);
5253 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);
5254 /* smart callbacks called:
5255 * "clicked" - the user clicked the hoversel button and popped up the sel
5256 * "selected" - an item in the hoversel list is selected
5257 * "dismissed" - the hover is dismissed
5261 typedef enum _Elm_Toolbar_Shrink_Mode
5263 ELM_TOOLBAR_SHRINK_NONE, /**< set toolbar minimun size to fit all the items */
5264 ELM_TOOLBAR_SHRINK_HIDE, /**< hide excess items */
5265 ELM_TOOLBAR_SHRINK_SCROLL, /**< allow accessing excess items through a scroller */
5266 ELM_TOOLBAR_SHRINK_MENU /**< inserts a button to pop up a menu with excess items */
5267 } Elm_Toolbar_Shrink_Mode;
5269 typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item */
5270 typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /** State of a Elm_Toolbar_Item */
5272 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5273 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
5274 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5275 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5276 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5277 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
5278 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5279 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);
5280 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);
5281 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);
5282 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);
5283 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5284 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5285 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5286 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5287 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5288 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
5289 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5290 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5291 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5292 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
5293 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5294 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
5295 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5296 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5297 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5298 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5299 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
5300 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5301 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5302 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5303 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5304 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
5305 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5306 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
5307 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5308 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5309 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5310 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5311 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5312 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
5313 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5314 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
5315 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5316 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
5317 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5318 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);
5319 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
5320 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
5321 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5322 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5323 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5324 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5325 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
5326 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);
5327 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5328 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
5329 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5330 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
5331 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5332 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5333 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
5334 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5335 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5336 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5337 /* smart callbacks called:
5338 * "clicked" - when the user clicks on a toolbar item and becomes selected
5340 /* available styles:
5342 * transparent (no background or shadow, just show the provided content)
5346 EAPI double elm_tooltip_delay_get(void);
5347 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
5348 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
5349 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
5350 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
5351 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);
5352 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5353 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
5354 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5355 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
5356 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5357 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5358 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
5359 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5360 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5361 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5364 EAPI int elm_cursor_engine_only_get(void);
5365 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
5368 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
5369 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5370 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
5371 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5372 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
5373 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
5374 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5375 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5376 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);
5377 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
5378 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5379 EAPI void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
5380 EAPI const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5381 EAPI const Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5382 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5383 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5384 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5385 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5386 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
5387 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5388 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5389 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5390 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5391 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
5392 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5393 EAPI const Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
5394 EAPI const Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
5395 EAPI const Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
5396 EAPI const Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5397 EAPI const Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5399 /* smart callbacks called:
5400 * "clicked" - the user clicked the empty space in the menu to dismiss. event_info is NULL.
5404 typedef enum _Elm_List_Mode
5406 ELM_LIST_COMPRESS = 0,
5412 typedef struct _Elm_List_Item Elm_List_Item; /**< Item of Elm_List. Sub-type of Elm_Widget_Item */
5413 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5414 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);
5415 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);
5416 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);
5417 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);
5418 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);
5419 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5420 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
5421 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
5422 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5423 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
5424 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5425 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5426 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5427 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
5428 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5429 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5430 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5431 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5432 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
5433 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5434 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5435 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5436 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5437 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5438 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5439 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5440 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5441 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5442 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
5443 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5444 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
5445 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5446 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5447 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
5448 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5449 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5450 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
5451 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);
5452 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5453 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
5454 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5455 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
5456 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5457 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5458 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
5459 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5460 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5461 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5462 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5463 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5464 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5465 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5466 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
5467 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);
5468 /* smart callbacks called:
5469 * "clicked,double" - when the user double-clicked an item
5470 * "selected" - when the user selected an item
5471 * "unselected" - when the user selected an item
5472 * "longpressed" - an item in the hoversel list is long-pressed
5473 * "scroll,edge,top" - the list is scrolled until the top edge
5474 * "scroll,edge,bottom" - the list is scrolled until the bottom edge
5475 * "scroll,edge,left" - the list is scrolled until the left edge
5476 * "scroll,edge,right" - the list is scrolled until the right edge
5480 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5481 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5482 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5483 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5484 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5485 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5486 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
5487 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5488 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5489 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
5490 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5491 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
5492 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5493 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
5494 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5495 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);
5496 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);
5497 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5498 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5499 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
5500 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
5501 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
5502 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5503 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
5504 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5505 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
5506 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5507 /* smart callbacks called:
5508 * "changed" - Whenever the slider value is changed by the user.
5509 * "slider,drag,start" - dragging the slider indicator around has started
5510 * "slider,drag,stop" - dragging the slider indicator around has stopped
5511 * "delay,changed" - A short time after the value is changed by the user.
5512 * This will be called only when the user stops dragging for a very short
5513 * period or when they release their finger/mouse, so it avoids possibly
5514 * expensive reactions to the value change.
5521 * @addtogroup Actionslider Actionslider
5523 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
5524 * properties. The indicator is the element the user drags to choose a label.
5525 * When the position is set with magnet, when released the indicator will be
5526 * moved to it if it's nearest the magnetized position.
5528 * @note By default all positions are set as enabled.
5530 * Signals that you can add callbacks for are:
5532 * "selected" - when user selects an enabled position (the label is passed
5535 * "pos_changed" - when the indicator reaches any of the positions("left",
5536 * "right" or "center").
5538 * See an example of actionslider usage @ref actionslider_example_page "here"
5542 typedef enum _Elm_Actionslider_Indicator_Pos
5544 ELM_ACTIONSLIDER_INDICATOR_NONE,
5545 ELM_ACTIONSLIDER_INDICATOR_LEFT,
5546 ELM_ACTIONSLIDER_INDICATOR_RIGHT,
5547 ELM_ACTIONSLIDER_INDICATOR_CENTER
5548 } Elm_Actionslider_Indicator_Pos;
5550 typedef enum _Elm_Actionslider_Magnet_Pos
5552 ELM_ACTIONSLIDER_MAGNET_NONE = 0,
5553 ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
5554 ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
5555 ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
5556 ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
5557 ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
5558 } Elm_Actionslider_Magnet_Pos;
5560 typedef enum _Elm_Actionslider_Label_Pos
5562 ELM_ACTIONSLIDER_LABEL_LEFT,
5563 ELM_ACTIONSLIDER_LABEL_RIGHT,
5564 ELM_ACTIONSLIDER_LABEL_CENTER,
5565 ELM_ACTIONSLIDER_LABEL_BUTTON
5566 } Elm_Actionslider_Label_Pos;
5568 /* smart callbacks called:
5569 * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
5573 * Add a new actionslider to the parent.
5575 * @param parent The parent object
5576 * @return The new actionslider object or NULL if it cannot be created
5578 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5581 * Set actionslider label.
5583 * @param[in] obj The actionslider object
5584 * @param[in] pos The position of the label.
5585 * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
5586 * @param label The label which is going to be set.
5588 EAPI void elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
5590 * Get actionslider labels.
5592 * @param obj The actionslider object
5593 * @param left_label A char** to place the left_label of @p obj into.
5594 * @param center_label A char** to place the center_label of @p obj into.
5595 * @param right_label A char** to place the right_label of @p obj into.
5597 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);
5599 * Get actionslider selected label.
5601 * @param obj The actionslider object
5602 * @return The selected label
5604 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5606 * Set actionslider indicator position.
5608 * @param obj The actionslider object.
5609 * @param pos The position of the indicator.
5611 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
5613 * Get actionslider indicator position.
5615 * @param obj The actionslider object.
5616 * @return The position of the indicator.
5618 EAPI Elm_Actionslider_Indicator_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5620 * Set actionslider magnet position. To make multiple positions magnets @c or
5621 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
5623 * @param obj The actionslider object.
5624 * @param pos Bit mask indicating the magnet positions.
5626 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
5628 * Get actionslider magnet position.
5630 * @param obj The actionslider object.
5631 * @return The positions with magnet property.
5633 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5635 * Set actionslider enabled position. To set multiple positions as enabled @c or
5636 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
5638 * @note All the positions are enabled by default.
5640 * @param obj The actionslider object.
5641 * @param pos Bit mask indicating the enabled positions.
5643 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
5645 * Get actionslider enabled position.
5647 * @param obj The actionslider object.
5648 * @return The enabled positions.
5650 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5652 * Set the label used on the indicator.
5654 * @param obj The actionslider object
5655 * @param label The label to be set on the indicator.
5656 * @deprecated use elm_object_text_set() instead.
5658 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5660 * Get the label used on the indicator object.
5662 * @param obj The actionslider object
5663 * @return The indicator label
5664 * @deprecated use elm_object_text_get() instead.
5666 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5669 * Hold actionslider object movement.
5671 * @param[in] obj The actionslider object
5672 * @param[in] flag Actionslider hold/release
5673 * (EINA_TURE = hold/EIN_FALSE = release)
5675 * @ingroup Actionslider
5677 EAPI void elm_actionslider_hold(Evas_Object *obj, Eina_Bool flag) EINA_ARG_NONNULL(1);
5685 typedef enum _Elm_Genlist_Item_Flags
5687 ELM_GENLIST_ITEM_NONE = 0,
5688 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0),
5689 ELM_GENLIST_ITEM_GROUP = (1 << 1)
5690 } Elm_Genlist_Item_Flags;
5691 typedef enum _Elm_Genlist_Item_Field_Flags
5693 ELM_GENLIST_ITEM_FIELD_ALL = 0,
5694 ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
5695 ELM_GENLIST_ITEM_FIELD_ICON = (1 << 1),
5696 ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
5697 } Elm_Genlist_Item_Field_Flags;
5698 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;
5699 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
5700 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
5701 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
5702 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
5703 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
5704 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj);
5705 typedef void (*GenlistItemMovedFunc) ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
5707 struct _Elm_Genlist_Item_Class
5709 const char *item_style;
5711 GenlistItemLabelGetFunc label_get;
5712 GenlistItemIconGetFunc icon_get;
5713 GenlistItemStateGetFunc state_get;
5714 GenlistItemDelFunc del;
5715 GenlistItemMovedFunc moved;
5717 const char *edit_item_style;
5718 const char *mode_item_style;
5720 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5721 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5722 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
5723 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5724 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
5725 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5726 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
5727 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5728 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
5729 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5730 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
5731 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5732 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
5733 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5734 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5735 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5736 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5737 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5738 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
5739 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5740 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
5741 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5742 /* operations to add items */
5743 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);
5744 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);
5745 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);
5746 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);
5747 /* operations to retrieve existing items */
5748 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5749 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5750 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5751 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);
5752 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5753 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5754 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
5755 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);
5756 /* available item styles:
5758 * default_style - The text part is a textblock
5760 * icon_top_text_bottom
5762 /* Genlist Item operation */
5763 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5764 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5765 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5766 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5767 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5768 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5769 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5770 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
5771 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5772 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5773 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5774 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5775 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
5776 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5777 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5778 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5779 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5780 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5781 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5782 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5783 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5784 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5785 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
5786 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5787 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5788 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5789 EAPI void elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
5790 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
5791 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
5792 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
5793 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);
5794 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5795 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
5796 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5797 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
5798 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5799 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5800 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
5801 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5802 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5803 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5804 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
5805 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
5806 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5807 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5808 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
5809 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5810 /* Signals that you can add callbacks for are:
5811 * "clicked,double" - This is called when a user has double-clicked an item.
5812 * The event_info parameter is the genlist item that was
5814 * "selected" - This is called when a user has made an item selected. The
5815 * event_info parameter is the genlist item that was selected.
5816 * "unselected" - This is called when a user has made an item unselected. The
5817 * event_info parameter is the genlist item that was unselected.
5818 * "expanded" - This is called when elm_genlist_item_expanded_set() is called
5819 * and the item is now meant to be expanded. The event_info parameter is the
5820 * genlist item that was indicated to expand. It is the job of this callback
5821 * to then fill in the child items.
5822 * "contracted" - This is called when elm_genlist_item_expanded_set() is called
5823 * and the item is now meant to be contracted. The event_info parameter is
5824 * the genlist item that was indicated to contract. It is the job of this
5825 * callback to then delete the child items.
5826 * "expand,request" - This is called when a user has indicated they want to
5827 * expand a tree branch item. The callback should decide if the item can
5828 * expand (has any children) and then call elm_genlist_item_expanded_set()
5829 * appropriately to set the state. The event_info parameter is the genlist
5830 * item that was indicated to expand.
5831 * "contract,request" - This is called when a user has indicated they want to
5832 * contract a tree branch item. The callback should decide if the item can
5833 * contract (has any children) and then call elm_genlist_item_expanded_set()
5834 * appropriately to set the state. The event_info parameter is the genlist
5835 * item that was indicated to contract.
5836 * "realized" - This is called when the item in the list is created as a real
5837 * evas object. event_info parameter is the genlist item that was created.
5838 * The object may be deleted at any time, so it is up to the caller to
5839 * not use the object pointer from elm_genlist_item_object_get() in a way
5840 * where it may point to freed objects.
5841 * "unrealized" - This is called just before an item is unrealized. After
5842 * this call icon objects provided will be deleted and the item object
5843 * itself delete or be put into a floating cache.
5844 * "drag,start,up" - This is called when the item in the list has been dragged
5845 * (not scrolled) up.
5846 * "drag,start,down" - This is called when the item in the list has been dragged
5847 * (not scrolled) down.
5848 * "drag,start,left" - This is called when the item in the list has been dragged i
5849 * (not scrolled) left.
5850 * "drag,start,right" - This is called when the item in the list has been dragged
5851 * (not scrolled) right.
5852 * "drag,stop" - This is called when the item in the list has stopped being
5854 * "drag" - This is called when the item in the list is being dragged.
5855 * "longpressed" - This is called when the item is pressed for a certain amount
5856 * of time. By default it's 1 second.
5857 * "scroll,anim,start" - This is called when scrolling animation has started.
5858 * "scroll,anim,stop" - This is called when scrolling animation has stopped.
5859 * "scroll,drag,start" - This is called when dragging the content has started.
5860 * "scroll,drag,stop" - This is called when dragging the content has stopped.
5861 * "scroll,edge,top" - This is called when the genlist is scrolled until the
5863 * "scroll,edge,bottom" - This is called when the genlist is scrolled until the
5865 * "scroll,edge,left" - This is called when the genlist is scrolled until the
5867 * "scroll,edge,right" - This is called when the genlist is scrolled until the
5869 * "multi,swipe,left" - This is called when the genlist is multi-touch swiped
5871 * "multi,swipe,right" - This is called when the genlist is multi-touch swiped
5873 * "multi,swipe,up" - This is called when the genlist is multi-touch swiped up.
5874 * "multi,swipe,down" - This is called when the genlist is multi-touch swiped
5876 * "multi,pinch,out" - This is called when the genlist is multi-touch pinched
5878 * "multi,pinch,in" - This is called when the genlist is multi-touch pinched in.
5881 EAPI void elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
5882 EAPI Eina_Bool elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5883 EAPI void elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
5884 EAPI Eina_Bool elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
5885 EAPI void elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
5886 EAPI void elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
5887 EAPI void elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
5888 EAPI void elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
5889 EAPI void elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
5890 EAPI Eina_Bool elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5893 * @page tutorial_check Check example
5894 * @dontinclude check_example_01.c
5896 * This example will show 2 checkboxes, one with just a label and the second
5897 * one with both a label and an icon. This example also ilustrates how to
5898 * have the checkbox change the value of a variable and how to react to those
5901 * We will start with the usual setup code:
5904 * And now we create our first checkbox, set its label, tell it to change
5905 * the value of @p value when the checkbox stats is changed and ask to be
5906 * notified of state changes:
5909 * For our second checkbox we are going to set an icon so we need to create
5912 * @note For simplicity we are using a rectangle as icon, but any evas object
5915 * And for our second checkbox we set the label, icon and state to true:
5918 * We now do some more setup:
5921 * And finally implement the callback that will be called when the first
5922 * checkbox's state changes. This callback will use @p data to print a
5925 * @note This work because @p data is @p value(from the main function) and @p
5926 * value is changed when the checkbox is changed.
5928 * Our example will look like this:
5929 * @image html screenshots/check_example_01.png
5930 * @image latex screenshots/check_example_01.eps
5932 * @example check_example_01.c
5935 * @defgroup Check Check
5937 * @brief The check widget allows for toggling a value between true and
5940 * Check objects are a lot like radio objects in layout and functionality
5941 * except they do not work as a group, but independently and only toggle the
5942 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
5943 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
5944 * returns the current state. For convenience, like the radio objects, you
5945 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
5948 * Signals that you can add callbacks for are:
5949 * "changed" - This is called whenever the user changes the state of one of
5950 * the check object(event_info is NULL).
5952 * @ref tutorial_check should give you a firm grasp of how to use this widget.
5956 * @brief Add a new Check object
5958 * @param parent The parent object
5959 * @return The new object or NULL if it cannot be created
5961 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5963 * @brief Set the text label of the check object
5965 * @param obj The check object
5966 * @param label The text label string in UTF-8
5968 * @deprecated use elm_object_text_set() instead.
5970 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5972 * @brief Get the text label of the check object
5974 * @param obj The check object
5975 * @return The text label string in UTF-8
5977 * @deprecated use elm_object_text_get() instead.
5979 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5981 * @brief Set the icon object of the check object
5983 * @param obj The check object
5984 * @param icon The icon object
5986 * Once the icon object is set, a previously set one will be deleted.
5987 * If you want to keep that old content object, use the
5988 * elm_check_icon_unset() function.
5990 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5992 * @brief Get the icon object of the check object
5994 * @param obj The check object
5995 * @return The icon object
5997 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5999 * @brief Unset the icon used for the check object
6001 * @param obj The check object
6002 * @return The icon object that was being used
6004 * Unparent and return the icon object which was set for this widget.
6006 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6008 * @brief Set the on/off state of the check object
6010 * @param obj The check object
6011 * @param state The state to use (1 == on, 0 == off)
6013 * This sets the state of the check. If set
6014 * with elm_check_state_pointer_set() the state of that variable is also
6015 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
6017 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
6019 * @brief Get the state of the check object
6021 * @param obj The check object
6022 * @return The boolean state
6024 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6026 * @brief Set a convenience pointer to a boolean to change
6028 * @param obj The check object
6029 * @param statep Pointer to the boolean to modify
6031 * This sets a pointer to a boolean, that, in addition to the check objects
6032 * state will also be modified directly. To stop setting the object pointed
6033 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
6034 * then when this is called, the check objects state will also be modified to
6035 * reflect the value of the boolean @p statep points to, just like calling
6036 * elm_check_state_set().
6038 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
6044 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6045 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6046 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6047 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6048 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6049 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6050 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
6051 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
6052 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6053 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
6054 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6055 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
6056 /* smart callbacks called:
6057 * "changed" - when the radio status is changed
6061 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6062 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6063 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
6064 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6065 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6066 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6067 EAPI void elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
6068 EAPI void elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
6070 /* available item styles:
6076 /* smart callbacks called:
6077 * "hide,finished" - when the previous page is hided
6080 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class;
6081 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func;
6082 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Item of Elm_Slideshow. Sub-type of Elm_Widget_Item */
6083 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj);
6084 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj);
6086 struct _Elm_Slideshow_Item_Class
6088 struct _Elm_Slideshow_Item_Class_Func
6090 SlideshowItemGetFunc get;
6091 SlideshowItemDelFunc del;
6095 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6096 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
6097 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);
6098 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
6099 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
6100 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
6101 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6102 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
6103 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6104 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
6105 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6106 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
6107 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6108 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6109 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6110 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
6111 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
6112 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6113 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
6114 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
6115 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6116 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
6117 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6118 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
6119 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6120 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
6121 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6122 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6123 /* smart callbacks called:
6124 * "changed" - when the slideshow switch to another item
6128 typedef enum _Elm_Fileselector_Mode
6130 ELM_FILESELECTOR_LIST = 0,
6131 ELM_FILESELECTOR_GRID,
6132 ELM_FILESELECTOR_LAST
6133 } Elm_Fileselector_Mode;
6135 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6136 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
6137 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6138 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
6139 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6140 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
6141 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6142 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6143 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
6144 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6145 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6146 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6147 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6148 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
6149 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6150 /* smart callbacks called:
6151 * "selected" - the user click on a file
6152 * "directory,open" - the list is populate with a new content. event_info is a directory.
6153 * "done" - the user click on the ok or cancel buttons
6157 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6158 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
6159 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6160 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
6161 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
6162 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6163 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6164 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6165 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6166 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6167 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6168 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
6169 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6170 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
6171 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6172 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6173 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6174 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
6175 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6176 /* smart callbacks called:
6178 /* available item styles:
6180 * wheel (simple style, no text, no progression, only pulse is available)
6184 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6185 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6186 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6187 /* smart callbacks called:
6191 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6192 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
6193 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6194 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
6195 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
6196 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
6197 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6198 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
6199 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6200 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
6201 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6202 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
6203 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6204 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
6205 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
6206 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6207 /* smart callbacks called:
6208 * "changed" - when the spinner value changes
6209 * "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).
6211 /* available item styles:
6213 * vertical (two up/down buttons at the right side and text left aligned)
6217 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Item of Elm_Index. Sub-type of Elm_Widget_Item */
6219 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6220 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
6221 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6222 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
6223 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6224 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
6225 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
6226 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
6227 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
6228 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
6229 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);
6230 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
6231 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
6232 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6233 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
6234 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
6235 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
6236 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
6237 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
6238 EAPI void elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
6239 /* smart callbacks called:
6240 * "changed" - when the selected index item changes
6241 * "delay,changed" - when the selected index item changes, but after some small idle period
6242 * "selected" - when the user releases a finger and selects an item
6243 * "level,up" - when the user moves a finger from the first level to the second level
6244 * "level,down" - when the user moves a finger from the second level to the first level
6248 typedef enum _Elm_Photocam_Zoom_Mode
6250 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0,
6251 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT,
6252 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL,
6253 ELM_PHOTOCAM_ZOOM_MODE_LAST
6254 } Elm_Photocam_Zoom_Mode;
6256 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6257 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
6258 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6259 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
6260 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6261 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
6262 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6263 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
6264 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
6265 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
6266 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
6267 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
6268 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6269 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6270 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6271 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6272 /* smart callbacks called:
6273 * "clicked" - when image clicked
6274 * "press" - when mouse/finger held down initially on image
6275 * "longpressed" - when mouse/finger held for long time on image
6276 * "clicked,double" - when mouse/finger double-clicked
6277 * "load" - when photo load begins
6278 * "loaded" - when photo load done
6279 * "load,detail" - when detailed image load begins
6280 * "loaded,detail" - when detailed image load done
6281 * "zoom,start" - when zooming started
6282 * "zoom,stop" - when zooming stopped
6283 * "zoom,change" - when auto zoom mode changed zoom level
6284 * "scroll - the content has been scrolled (moved)
6285 * "scroll,anim,start" - scrolling animation has started
6286 * "scroll,anim,stop" - scrolling animation has stopped
6287 * "scroll,drag,start" - dragging the contents around has started
6288 * "scroll,drag,stop" - dragging the contents around has stopped
6292 typedef enum _Elm_Map_Zoom_Mode
6294 ELM_MAP_ZOOM_MODE_MANUAL,
6295 ELM_MAP_ZOOM_MODE_AUTO_FIT,
6296 ELM_MAP_ZOOM_MODE_AUTO_FILL,
6297 ELM_MAP_ZOOM_MODE_LAST
6298 } Elm_Map_Zoom_Mode;
6300 typedef enum _Elm_Map_Route_Sources
6302 ELM_MAP_ROUTE_SOURCE_YOURS,
6303 ELM_MAP_ROUTE_SOURCE_MONAV,
6304 ELM_MAP_ROUTE_SOURCE_ORS,
6305 ELM_MAP_ROUTE_SOURCE_LAST
6306 } Elm_Map_Route_Sources;
6308 typedef enum _Elm_Map_Name_Sources
6310 ELM_MAP_NAME_SOURCE_NOMINATIM,
6311 ELM_MAP_NAME_SOURCE_LAST
6312 } Elm_Map_Name_Sources;
6314 typedef enum _Elm_Map_Route_Type
6316 ELM_MAP_ROUTE_TYPE_MOTOCAR,
6317 ELM_MAP_ROUTE_TYPE_BICYCLE,
6318 ELM_MAP_ROUTE_TYPE_FOOT,
6319 ELM_MAP_ROUTE_TYPE_LAST
6320 } Elm_Map_Route_Type;
6322 typedef enum _Elm_Map_Route_Method
6324 ELM_MAP_ROUTE_METHOD_FASTEST,
6325 ELM_MAP_ROUTE_METHOD_SHORTEST,
6326 ELM_MAP_ROUTE_METHOD_LAST
6327 } Elm_Map_Route_Method;
6329 typedef enum _Elm_Map_Name_Method
6331 ELM_MAP_NAME_METHOD_SEARCH,
6332 ELM_MAP_NAME_METHOD_REVERSE,
6333 ELM_MAP_NAME_METHOD_LAST
6334 } Elm_Map_Name_Method;
6336 typedef struct _Elm_Map_Marker Elm_Map_Marker;
6337 typedef struct _Elm_Map_Marker_Class Elm_Map_Marker_Class;
6338 typedef struct _Elm_Map_Group_Class Elm_Map_Group_Class;
6339 typedef struct _Elm_Map_Route Elm_Map_Route;
6340 typedef struct _Elm_Map_Name Elm_Map_Name;
6341 typedef struct _Elm_Map_Track Elm_Map_Track;
6343 typedef Evas_Object *(*ElmMapMarkerGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
6344 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o);
6345 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
6346 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data);
6348 typedef char *(*ElmMapModuleSourceFunc) (void);
6349 typedef int (*ElmMapModuleZoomMinFunc) (void);
6350 typedef int (*ElmMapModuleZoomMaxFunc) (void);
6351 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
6352 typedef int (*ElmMapModuleRouteSourceFunc) (void);
6353 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
6354 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
6355 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
6356 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
6358 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6359 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
6360 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6361 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
6362 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6363 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
6364 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
6365 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
6366 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
6367 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6368 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
6369 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6370 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
6371 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);
6372 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);
6373 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
6374 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
6375 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);
6376 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);
6377 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
6378 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6379 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
6380 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6381 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6382 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
6383 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6384 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6385 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
6386 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
6387 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
6388 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
6389 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
6390 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
6391 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
6392 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
6393 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
6394 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
6395 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
6396 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
6397 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
6398 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6399 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
6400 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6401 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
6402 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6403 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
6404 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6405 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
6406 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6407 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
6408 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6409 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);
6410 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6411 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
6412 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
6413 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6414 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6415 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6416 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
6417 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
6418 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
6419 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
6420 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);
6421 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6422 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6424 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
6426 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
6428 /* smart callbacks called:
6429 * "clicked" - when image clicked
6430 * "press" - when mouse/finger held down initially on image
6431 * "longpressed" - when mouse/finger held for long time on image
6432 * "clicked,double" - when mouse/finger double-clicked
6433 * "load,details" - when detailed image load begins
6434 * "loaded,details" - when detailed image load done
6435 * "zoom,start" - when zooming started
6436 * "zoom,stop" - when zooming stopped
6437 * "zoom,change" - when auto zoom mode changed zoom level
6438 * "scroll - the content has been scrolled (moved)
6439 * "scroll,anim,start" - scrolling animation has started
6440 * "scroll,anim,stop" - scrolling animation has stopped
6441 * "scroll,drag,start" - dragging the contents around has started
6442 * "scroll,drag,stop" - dragging the contents around has stopped
6446 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
6448 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
6450 EAPI double elm_route_lon_min_get(Evas_Object *obj);
6451 EAPI double elm_route_lat_min_get(Evas_Object *obj);
6452 EAPI double elm_route_lon_max_get(Evas_Object *obj);
6453 EAPI double elm_route_lat_max_get(Evas_Object *obj);
6457 typedef enum _Elm_Panel_Orient
6459 ELM_PANEL_ORIENT_TOP,
6460 ELM_PANEL_ORIENT_BOTTOM,
6461 ELM_PANEL_ORIENT_LEFT,
6462 ELM_PANEL_ORIENT_RIGHT,
6465 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6466 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
6467 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6468 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6469 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6470 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6471 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
6472 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6473 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
6479 * Update the minimun height of the bar in the theme. No minimun should be set in the vertical theme
6480 * Add events (move, start ...)
6482 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6483 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6484 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6485 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6486 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6487 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6488 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6489 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6490 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
6491 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6492 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6493 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
6494 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6497 typedef enum _Elm_Flip_Mode
6499 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
6500 ELM_FLIP_ROTATE_X_CENTER_AXIS,
6501 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
6502 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
6504 ELM_FLIP_CUBE_RIGHT,
6508 ELM_FLIP_PAGE_RIGHT,
6512 typedef enum _Elm_Flip_Interaction
6514 ELM_FLIP_INTERACTION_NONE,
6515 ELM_FLIP_INTERACTION_ROTATE,
6516 ELM_FLIP_INTERACTION_CUBE,
6517 ELM_FLIP_INTERACTION_PAGE
6518 } Elm_Flip_Interaction;
6519 typedef enum _Elm_Flip_Direction
6521 ELM_FLIP_DIRECTION_UP,
6522 ELM_FLIP_DIRECTION_DOWN,
6523 ELM_FLIP_DIRECTION_LEFT,
6524 ELM_FLIP_DIRECTION_RIGHT
6525 } Elm_Flip_Direction;
6527 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6528 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6529 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6530 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6531 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6532 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6533 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6534 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6535 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
6536 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
6537 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
6538 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
6539 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
6540 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
6541 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
6542 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
6543 /* smart callbacks called:
6544 * "animate,begin" - when a flip animation was started
6545 * "animate,done" - when a flip animation is finished
6549 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6550 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
6551 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6552 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
6553 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6554 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
6555 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6556 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
6557 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6558 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6559 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
6560 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
6561 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
6562 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6563 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
6564 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6565 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
6566 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
6567 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
6568 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
6569 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6570 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6571 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6572 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6573 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
6574 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
6575 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6576 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6577 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6578 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
6579 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6580 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
6581 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
6582 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
6583 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6584 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);
6585 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6586 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6587 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);
6588 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6589 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);
6590 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
6591 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6592 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6593 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6594 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
6595 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6596 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6597 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6598 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);
6599 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);
6600 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);
6601 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);
6602 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);
6603 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);
6604 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
6605 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
6606 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
6607 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
6608 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6609 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
6610 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
6611 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
6612 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
6613 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
6614 EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
6615 EINA_DEPRECATED EAPI void elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
6616 EINA_DEPRECATED EAPI void elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
6619 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6620 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6621 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6622 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6623 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6626 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6627 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6628 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6629 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6630 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
6631 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6632 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
6633 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6634 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
6635 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6638 * @defgroup Flipselector Flip Selector
6640 * A flip selector is a widget to show a set of @b text items, one
6641 * at a time, with the same sheet switching style as the @ref Clock
6642 * "clock" widget, when one changes the current displaying sheet
6643 * (thus, the "flip" in the name).
6645 * User clicks to flip sheets which are @b held for some time will
6646 * make the flip selector to flip continuosly and automatically for
6647 * the user. The interval between flips will keep growing in time,
6648 * so that it helps the user to reach an item which is distant from
6649 * the current selection.
6651 * Smart callbacks one can register to:
6652 * - @c "selected" - when the widget's selected text item is changed
6653 * - @c "overflowed" - when the widget's current selection is changed
6654 * from the first item in its list to the last
6655 * - @c "underflowed" - when the widget's current selection is changed
6656 * from the last item in its list to the first
6658 * Available styles for it:
6661 * Here is an example on its usage:
6662 * @li @ref flipselector_example
6666 * @addtogroup Flipselector
6670 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
6673 * Add a new flip selector widget to the given parent Elementary
6674 * (container) widget
6676 * @param parent The parent object
6677 * @return a new flip selector widget handle or @c NULL, on errors
6679 * This function inserts a new flip selector widget on the canvas.
6681 * @ingroup Flipselector
6683 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6686 * Programmatically select the next item of a flip selector widget
6688 * @param obj The flipselector object
6690 * @note The selection will be animated. Also, if it reaches the
6691 * end of its list of member items, it will continue with the first
6694 * @ingroup Flipselector
6696 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
6699 * Programmatically select the previous item of a flip selector
6702 * @param obj The flipselector object
6704 * @note The selection will be animated. Also, if it reaches the
6705 * beginning of its list of member items, it will continue with the
6706 * last one backwards.
6708 * @ingroup Flipselector
6710 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
6713 * Append a (text) item to a flip selector widget
6715 * @param obj The flipselector object
6716 * @param label The (text) label of the new item
6717 * @param func Convenience callback function to take place when
6719 * @param data Data passed to @p func, above
6720 * @return A handle to the item added or @c NULL, on errors
6722 * The widget's list of labels to show will be appended with the
6723 * given value. If the user wishes so, a callback function pointer
6724 * can be passed, which will get called when this same item is
6727 * @note The current selection @b won't be modified by appending an
6728 * element to the list.
6730 * @note The maximum length of the text label is going to be
6731 * determined <b>by the widget's theme</b>. Strings larger than
6732 * that value are going to be @b truncated.
6734 * @ingroup Flipselector
6736 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
6739 * Prepend a (text) item to a flip selector widget
6741 * @param obj The flipselector object
6742 * @param label The (text) label of the new item
6743 * @param func Convenience callback function to take place when
6745 * @param data Data passed to @p func, above
6746 * @return A handle to the item added or @c NULL, on errors
6748 * The widget's list of labels to show will be prepended with the
6749 * given value. If the user wishes so, a callback function pointer
6750 * can be passed, which will get called when this same item is
6753 * @note The current selection @b won't be modified by prepending
6754 * an element to the list.
6756 * @note The maximum length of the text label is going to be
6757 * determined <b>by the widget's theme</b>. Strings larger than
6758 * that value are going to be @b truncated.
6760 * @ingroup Flipselector
6762 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
6765 * Get the internal list of items in a given flip selector widget.
6767 * @param obj The flipselector object
6768 * @return The list of items (#Elm_Flipselector_Item as data) or @c
6771 * This list is @b not to be modified in any way and must not be
6772 * freed. Use the list members with functions like
6773 * elm_flipselector_item_label_set(),
6774 * elm_flipselector_item_label_get(), elm_flipselector_item_del(),
6775 * elm_flipselector_item_del(),
6776 * elm_flipselector_item_selected_get(),
6777 * elm_flipselector_item_selected_set().
6779 * @warning This list is only valid until @p obj object's internal
6780 * items list is changed. It should be fetched again with another
6781 * call to this function when changes happen.
6783 * @ingroup Flipselector
6785 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6788 * Get the first item in the given flip selector widget's list of
6791 * @param obj The flipselector object
6792 * @return The first item or @c NULL, if it has no items (and on
6795 * @see elm_flipselector_item_append()
6796 * @see elm_flipselector_last_item_get()
6798 * @ingroup Flipselector
6800 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6803 * Get the last item in the given flip selector widget's list of
6806 * @param obj The flipselector object
6807 * @return The last item or @c NULL, if it has no items (and on
6810 * @see elm_flipselector_item_prepend()
6811 * @see elm_flipselector_first_item_get()
6813 * @ingroup Flipselector
6815 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6818 * Get the currently selected item in a flip selector widget.
6820 * @param obj The flipselector object
6821 * @return The selected item or @c NULL, if the widget has no items
6824 * @ingroup Flipselector
6826 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6829 * Set whether a given flip selector widget's item should be the
6830 * currently selected one.
6832 * @param item The flip selector item
6833 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
6835 * This sets whether @p item is or not the selected (thus, under
6836 * display) one. If @p item is different than one under display,
6837 * the latter will be unselected. If the @p item is set to be
6838 * unselected, on the other hand, the @b first item in the widget's
6839 * internal members list will be the new selected one.
6841 * @see elm_flipselector_item_selected_get()
6843 * @ingroup Flipselector
6845 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6848 * Get whether a given flip selector widget's item is the currently
6851 * @param item The flip selector item
6852 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
6855 * @see elm_flipselector_item_selected_set()
6857 * @ingroup Flipselector
6859 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6862 * Delete a given item from a flip selector widget.
6864 * @param item The item to delete
6866 * @ingroup Flipselector
6868 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6871 * Get the label of a given flip selector widget's item.
6873 * @param item The item to get label from
6874 * @return The text label of @p item or @c NULL, on errors
6876 * @see elm_flipselector_item_label_set()
6878 * @ingroup Flipselector
6880 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6883 * Set the label of a given flip selector widget's item.
6885 * @param item The item to set label on
6886 * @param label The text label string, in UTF-8 encoding
6888 * @see elm_flipselector_item_label_get()
6890 * @ingroup Flipselector
6892 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
6895 * Gets the item before @p item in a flip selector widget's
6896 * internal list of items.
6898 * @param item The item to fetch previous from
6899 * @return The item before the @p item, in its parent's list. If
6900 * there is no previous item for @p item or there's an
6901 * error, @c NULL is returned.
6903 * @see elm_flipselector_item_next_get()
6905 * @ingroup Flipselector
6907 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6910 * Gets the item after @p item in a flip selector widget's
6911 * internal list of items.
6913 * @param item The item to fetch next from
6914 * @return The item after the @p item, in its parent's list. If
6915 * there is no next item for @p item or there's an
6916 * error, @c NULL is returned.
6918 * @see elm_flipselector_item_next_get()
6920 * @ingroup Flipselector
6922 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
6925 * Set the interval on time updates for an user mouse button hold
6926 * on a flip selector widget.
6928 * @param obj The flip selector object
6929 * @param interval The (first) interval value in seconds
6931 * This interval value is @b decreased while the user holds the
6932 * mouse pointer either flipping up or flipping doww a given flip
6935 * This helps the user to get to a given item distant from the
6936 * current one easier/faster, as it will start to flip quicker and
6937 * quicker on mouse button holds.
6939 * The calculation for the next flip interval value, starting from
6940 * the one set with this call, is the previous interval divided by
6941 * 1.05, so it decreases a little bit.
6943 * The default starting interval value for automatic flips is
6946 * @see elm_flipselector_interval_get()
6948 * @ingroup Flipselector
6950 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
6953 * Get the interval on time updates for an user mouse button hold
6954 * on a flip selector widget.
6956 * @param obj The flip selector object
6957 * @return The (first) interval value, in seconds, set on it
6959 * @see elm_flipselector_interval_set() for more details
6961 * @ingroup Flipselector
6963 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6970 * @addtogroup Animator Animator
6971 * @ingroup Elementary
6973 * @brief Functions to ease creation of animations.
6975 * elm_animator is designed to provide an easy way to create animations.
6976 * Creating an animation with elm_animator is as simple as setting a
6977 * duration, an operating callback and telling it to run the animation.
6978 * However that is not the full extent of elm_animator's ability, animations
6979 * can be paused and resumed, reversed and the animation need not be linear.
6981 * To run an animation you must specify at least a duration and operation
6982 * callback, not setting any other properties will create a linear animation
6983 * that runs once and is not reversed.
6985 * @ref elm_animator_example_page_01 "This" example should make all of that
6988 * @warning elm_animator is @b not a widget.
6992 * @brief Type of curve desired for animation.
6994 * The speed in which an animation happens doesn't have to be linear, some
6995 * animations will look better if they're accelerating or decelerating, so
6996 * elm_animator provides four options in this regard:
6997 * @image html elm_animator_curve_style.png
6998 * @image latex elm_animator_curve_style.eps width=\textwidth
6999 * As can be seen in the image the speed of the animation will be:
7000 * @li ELM_ANIMATOR_CURVE_LINEAR constant
7001 * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
7002 * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
7003 * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
7007 ELM_ANIMATOR_CURVE_LINEAR,
7008 ELM_ANIMATOR_CURVE_IN_OUT,
7009 ELM_ANIMATOR_CURVE_IN,
7010 ELM_ANIMATOR_CURVE_OUT
7011 } Elm_Animator_Curve_Style;
7012 typedef struct _Elm_Animator Elm_Animator;
7014 * Called back per loop of an elementary animators cycle
7015 * @param data user-data given to elm_animator_operation_callback_set()
7016 * @param animator the animator being run
7017 * @param double the position in the animation
7019 typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
7021 * Called back when an elementary animator finishes
7022 * @param data user-data given to elm_animator_completion_callback_set()
7024 typedef void (*Elm_Animator_Completion_Cb) (void *data);
7027 * @brief Create a new animator.
7029 * @param[in] parent Parent object
7031 * The @a parent argument can be set to NULL for no parent. If a parent is set
7032 * there is no need to call elm_animator_del(), when the parent is deleted it
7033 * will delete the animator.
7034 * @deprecated Use @ref Transit instead.
7037 EINA_DEPRECATED EAPI Elm_Animator* elm_animator_add(Evas_Object *parent);
7039 * Deletes the animator freeing any resources it used. If the animator was
7040 * created with a NULL parent this must be called, otherwise it will be
7041 * automatically called when the parent is deleted.
7043 * @param[in] animator Animator object
7044 * @deprecated Use @ref Transit instead.
7046 EINA_DEPRECATED EAPI void elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
7048 * Set the duration of the animation.
7050 * @param[in] animator Animator object
7051 * @param[in] duration Duration in second
7052 * @deprecated Use @ref Transit instead.
7054 EINA_DEPRECATED EAPI void elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
7056 * @brief Set the callback function for animator operation.
7058 * @param[in] animator Animator object
7059 * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
7060 * @param[in] data Callback function user argument
7062 * The @p func callback will be called with a frame value in range [0, 1] which
7063 * indicates how far along the animation should be. It is the job of @p func to
7064 * actually change the state of any object(or objects) that are being animated.
7065 * @deprecated Use @ref Transit instead.
7067 EINA_DEPRECATED EAPI void elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
7069 * Set the callback function for the when the animation ends.
7071 * @param[in] animator Animator object
7072 * @param[in] func Callback function pointe
7073 * @param[in] data Callback function user argument
7075 * @warning @a func will not be executed if elm_animator_stop() is called.
7076 * @deprecated Use @ref Transit instead.
7078 EINA_DEPRECATED EAPI void elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
7080 * @brief Stop animator.
7082 * @param[in] animator Animator object
7084 * If called before elm_animator_animate() it does nothing. If there is an
7085 * animation in progress the animation will be stopped(the operation callback
7086 * will not be executed again) and it can't be restarted using
7087 * elm_animator_resume().
7088 * @deprecated Use @ref Transit instead.
7090 EINA_DEPRECATED EAPI void elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
7092 * Set the animator repeat count.
7094 * @param[in] animator Animator object
7095 * @param[in] repeat_cnt Repeat count
7096 * @deprecated Use @ref Transit instead.
7098 EINA_DEPRECATED EAPI void elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
7100 * @brief Start animation.
7102 * @param[in] animator Animator object
7104 * This function starts the animation if the nescessary properties(duration
7105 * and operation callback) have been set. Once started the animation will
7106 * run until complete or elm_animator_stop() is called.
7107 * @deprecated Use @ref Transit instead.
7109 EINA_DEPRECATED EAPI void elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
7111 * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
7113 * @param[in] animator Animator object
7114 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
7115 * @deprecated Use @ref Transit instead.
7117 EINA_DEPRECATED EAPI void elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
7119 * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
7121 * @param[in] animator Animator object
7122 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
7123 * @deprecated Use @ref Transit instead.
7125 EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
7127 * @brief Sets wether the animation should be automatically reversed.
7129 * @param[in] animator Animator object
7130 * @param[in] reverse Reverse or not
7132 * This controls wether the animation will be run on reverse imediately after
7133 * running forward. When this is set together with repetition the animation
7134 * will run in reverse once for each time it ran forward.@n
7135 * Runnin an animation in reverse is accomplished by calling the operation
7136 * callback with a frame value starting at 1 and diminshing until 0.
7137 * @deprecated Use @ref Transit instead.
7139 EINA_DEPRECATED EAPI void elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
7141 * Gets wether the animation will automatically reversed
7143 * @param[in] animator Animator object
7144 * @deprecated Use @ref Transit instead.
7146 EINA_DEPRECATED EAPI Eina_Bool elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
7148 * Gets the status for the animator operation. The status of the animator @b
7149 * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
7150 * only informs if the animation was started and has not ended(either normally
7151 * or through elm_animator_stop()).
7153 * @param[in] animator Animator object
7154 * @deprecated Use @ref Transit instead.
7156 EINA_DEPRECATED EAPI Eina_Bool elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
7158 * Gets how many times the animation will be repeated
7160 * @param[in] animator Animator object
7161 * @deprecated Use @ref Transit instead.
7163 EINA_DEPRECATED EAPI unsigned int elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
7165 * Pause the animator.
7167 * @param[in] animator Animator object
7169 * This causes the animation to be temporarily stopped(the operation callback
7170 * will not be called). If the animation is not yet running this is a no-op.
7171 * Once an animation has been paused with this function it can be resumed
7172 * using elm_animator_resume().
7173 * @deprecated Use @ref Transit instead.
7175 EINA_DEPRECATED EAPI void elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
7177 * @brief Resumes the animator.
7179 * @param[in] animator Animator object
7181 * Resumes an animation that was paused using elm_animator_pause(), after
7182 * calling this function calls to the operation callback will happen
7183 * normally. If an animation is stopped by means of elm_animator_stop it
7184 * @b can't be restarted with this function.@n
7186 * @warning When an animation is resumed it doesn't start from where it was paused, it
7187 * will go to where it would have been if it had not been paused. If an
7188 * animation with a duration of 3 seconds is paused after 1 second for 1 second
7189 * it will resume as if it had ben animating for 2 seconds, the operating
7190 * callback will be called with a frame value of aproximately 2/3.
7191 * @deprecated Use @ref Transit instead.
7193 EINA_DEPRECATED EAPI void elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
7201 ELM_CALENDAR_UNIQUE,
7203 ELM_CALENDAR_WEEKLY,
7204 ELM_CALENDAR_MONTHLY,
7205 ELM_CALENDAR_ANNUALLY
7206 } Elm_Calendar_Mark_Repeat;
7207 typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark;
7209 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7210 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7211 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
7212 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7213 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
7214 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
7215 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
7216 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7217 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
7218 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
7219 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
7220 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
7221 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);
7222 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
7223 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7224 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7225 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
7226 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
7227 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
7228 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
7229 /* smart callbacks called:
7230 * changed - emitted when the user select a day or change the displayed
7235 typedef struct _Elm_Diskselector_Item Elm_Diskselector_Item;
7237 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7238 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7239 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
7240 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7241 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
7242 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7243 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
7244 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7245 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7246 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);
7247 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7248 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7249 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7250 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);
7251 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7252 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
7253 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7254 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7255 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
7256 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7257 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
7258 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7259 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
7260 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7261 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7262 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7263 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7264 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7265 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
7266 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);
7267 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7268 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
7269 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7270 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
7271 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7272 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7273 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
7274 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7275 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
7276 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7277 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
7278 /* smart callbacks called:
7279 * "selected" - when item is selected (scroller stops)
7283 * @page tutorial_colorselector Color selector example
7284 * @dontinclude colorselector_example_01.c
7286 * This example shows how to change the color of a rectangle using a color
7287 * selector. We aren't going to explain a lot of the code since it's the
7291 * Now that we have a window with background and a rectangle we can create
7292 * our color_selector and set it's initial color to fully opaque blue:
7295 * Next we tell ask to be notified whenever the color changes:
7298 * We follow that we some more run of the mill setup code:
7301 * And now get to the callback that sets the color of the rectangle:
7304 * This example will look like this:
7305 * @image html screenshots/colorselector_example_01.png
7306 * @image latex screenshots/colorselector_example_01.eps
7308 * @example colorselector_example_01.c
7311 * @defgroup Colorselector Colorselector
7315 * @brief Widget for user to select a color.
7317 * Signals that you can add callbacks for are:
7318 * "changed" - When the color value changes(event_info is NULL).
7320 * See @ref tutorial_colorselector.
7323 * @brief Add a new colorselector to the parent
7325 * @param parent The parent object
7326 * @return The new object or NULL if it cannot be created
7328 * @ingroup Colorselector
7330 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7332 * Set a color for the colorselector
7334 * @param obj Colorselector object
7335 * @param r r-value of color
7336 * @param g g-value of color
7337 * @param b b-value of color
7338 * @param a a-value of color
7340 * @ingroup Colorselector
7342 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
7344 * Get a color from the colorselector
7346 * @param obj Colorselector object
7347 * @param r integer pointer for r-value of color
7348 * @param g integer pointer for g-value of color
7349 * @param b integer pointer for b-value of color
7350 * @param a integer pointer for a-value of color
7352 * @ingroup Colorselector
7354 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
7359 /* Contextual Popup */
7360 typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
7362 typedef enum _Elm_Ctxpopup_Direction
7364 ELM_CTXPOPUP_DIRECTION_DOWN,
7365 ELM_CTXPOPUP_DIRECTION_RIGHT,
7366 ELM_CTXPOPUP_DIRECTION_LEFT,
7367 ELM_CTXPOPUP_DIRECTION_UP,
7368 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
7369 } Elm_Ctxpopup_Direction;
7371 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7372 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7373 EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
7374 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7375 EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
7376 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
7377 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7378 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7379 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
7380 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7381 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);
7382 EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7383 EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
7384 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7385 EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
7386 EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7387 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);
7388 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);
7389 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7390 /* smart callbacks called:
7391 * "dismissed" - the ctxpopup was dismissed
7397 * @defgroup Transit Transit
7398 * @ingroup Elementary
7400 * Transit is designed to apply various animated transition effects to @c
7401 * Evas_Object, such like translation, rotation, etc. For using these
7402 * effects, create an @ref Elm_Transit and add the desired transition effects.
7404 * Once the effects are added into transit, they will be automatically
7405 * managed (their callback will be called until the duration is ended, and
7406 * they will be deleted on completion).
7410 * Elm_Transit *trans = elm_transit_add();
7411 * elm_transit_object_add(trans, obj);
7412 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
7413 * elm_transit_duration_set(transit, 1);
7414 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
7415 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
7416 * elm_transit_repeat_times_set(transit, 3);
7419 * Some transition effects are used to change the properties of objects. They
7421 * @li @ref elm_transit_effect_translation_add
7422 * @li @ref elm_transit_effect_color_add
7423 * @li @ref elm_transit_effect_rotation_add
7424 * @li @ref elm_transit_effect_wipe_add
7425 * @li @ref elm_transit_effect_zoom_add
7426 * @li @ref elm_transit_effect_resizing_add
7428 * Other transition effects are used to make one object disappear and another
7429 * object appear on its old place. These effects are:
7431 * @li @ref elm_transit_effect_flip_add
7432 * @li @ref elm_transit_effect_resizable_flip_add
7433 * @li @ref elm_transit_effect_fade_add
7434 * @li @ref elm_transit_effect_blend_add
7436 * It's also possible to make a transition chain with @ref
7437 * elm_transit_chain_transit_add.
7439 * @warning We strongly recommend to use elm_transit just when edje can not do
7440 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
7441 * animations can be manipulated inside the theme.
7444 * @li @ref transit_example_01_explained
7445 * @li @ref transit_example_02_explained
7446 * @li @ref transit_example_03_c
7447 * @li @ref transit_example_04_c
7453 * @enum Elm_Transit_Tween_Mode
7455 * The type of acceleration used in the transition.
7459 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
7460 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
7461 over time, then decrease again
7463 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
7465 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
7467 } Elm_Transit_Tween_Mode;
7470 * @enum Elm_Transit_Effect_Flip_Axis
7472 * The axis where flip effect should be applied.
7476 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
7477 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
7478 } Elm_Transit_Effect_Flip_Axis;
7480 * @enum Elm_Transit_Effect_Wipe_Dir
7482 * The direction where the wipe effect should occur.
7486 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
7487 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
7488 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
7489 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
7490 } Elm_Transit_Effect_Wipe_Dir;
7491 /** @enum Elm_Transit_Effect_Wipe_Type
7493 * Whether the wipe effect should show or hide the object.
7497 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
7499 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
7501 } Elm_Transit_Effect_Wipe_Type;
7504 * @typedef Elm_Transit
7506 * The Transit created with elm_transit_add(). This type has the information
7507 * about the objects which the transition will be applied, and the
7508 * transition effects that will be used. It also contains info about
7509 * duration, number of repetitions, auto-reverse, etc.
7511 typedef struct _Elm_Transit Elm_Transit;
7512 typedef void Elm_Transit_Effect;
7514 * @typedef Elm_Transit_Effect_Transition_Cb
7516 * Transition callback called for this effect on each transition iteration.
7518 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
7520 * Elm_Transit_Effect_End_Cb
7522 * Transition callback called for this effect when the transition is over.
7524 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
7527 * Elm_Transit_Del_Cb
7529 * A callback called when the transit is deleted.
7531 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
7536 * @note Is not necessary to delete the transit object, it will be deleted at
7537 * the end of its operation.
7538 * @note The transit will start playing when the program enter in the main loop, is not
7539 * necessary to give a start to the transit.
7541 * @return The transit object.
7545 EAPI Elm_Transit *elm_transit_add(void);
7548 * Stops the animation and delete the @p transit object.
7550 * Call this function if you wants to stop the animation before the duration
7551 * time. Make sure the @p transit object is still alive with
7552 * elm_transit_del_cb_set() function.
7553 * All added effects will be deleted, calling its repective data_free_cb
7554 * functions. The function setted by elm_transit_del_cb_set() will be called.
7556 * @see elm_transit_del_cb_set()
7558 * @param transit The transit object to be deleted.
7561 * @warning Just call this function if you are sure the transit is alive.
7563 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
7566 * Add a new effect to the transit.
7568 * @note The cb function and the data are the key to the effect. If you try to
7569 * add an already added effect, nothing is done.
7570 * @note After the first addition of an effect in @p transit, if its
7571 * effect list become empty again, the @p transit will be killed by
7572 * elm_transit_del(transit) function.
7576 * Elm_Transit *transit = elm_transit_add();
7577 * elm_transit_effect_add(transit,
7578 * elm_transit_effect_blend_op,
7579 * elm_transit_effect_blend_context_new(),
7580 * elm_transit_effect_blend_context_free);
7583 * @param transit The transit object.
7584 * @param transition_cb The operation function. It is called when the
7585 * animation begins, it is the function that actually performs the animation.
7586 * It is called with the @p data, @p transit and the time progression of the
7587 * animation (a double value between 0.0 and 1.0).
7588 * @param effect The context data of the effect.
7589 * @param end_cb The function to free the context data, it will be called
7590 * at the end of the effect, it must finalize the animation and free the
7594 * @warning The transit free the context data at the and of the transition with
7595 * the data_free_cb function, do not use the context data in another transit.
7597 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);
7600 * Delete an added effect.
7602 * This function will remove the effect from the @p transit, calling the
7603 * data_free_cb to free the @p data.
7605 * @see elm_transit_effect_add()
7607 * @note If the effect is not found, nothing is done.
7608 * @note If the effect list become empty, this function will call
7609 * elm_transit_del(transit), that is, it will kill the @p transit.
7611 * @param transit The transit object.
7612 * @param transition_cb The operation function.
7613 * @param effect The context data of the effect.
7617 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);
7620 * Add new object to apply the effects.
7622 * @note After the first addition of an object in @p transit, if its
7623 * object list become empty again, the @p transit will be killed by
7624 * elm_transit_del(transit) function.
7625 * @note If the @p obj belongs to another transit, the @p obj will be
7626 * removed from it and it will only belong to the @p transit. If the old
7627 * transit stays without objects, it will die.
7628 * @note When you add an object into the @p transit, its state from
7629 * evas_object_pass_events_get(obj) is saved, and it is applied when the
7630 * transit ends, if you change this state whith evas_object_pass_events_set()
7631 * after add the object, this state will change again when @p transit stops to
7634 * @param transit The transit object.
7635 * @param obj Object to be animated.
7638 * @warning It is not allowed to add a new object after transit begins to go.
7640 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
7643 * Removes an added object from the transit.
7645 * @note If the @p obj is not in the @p transit, nothing is done.
7646 * @note If the list become empty, this function will call
7647 * elm_transit_del(transit), that is, it will kill the @p transit.
7649 * @param transit The transit object.
7650 * @param obj Object to be removed from @p transit.
7653 * @warning It is not allowed to remove objects after transit begins to go.
7655 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
7658 * Get the objects of the transit.
7660 * @param transit The transit object.
7661 * @return a Eina_List with the objects from the transit.
7665 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7668 * Enable/disable keeping up the objects states.
7669 * If it is not kept, the objects states will be reset when transition ends.
7671 * @note @p transit can not be NULL.
7672 * @note One state includes geometry, color, map data.
7674 * @param transit The transit object.
7675 * @param state_keep Keeping or Non Keeping.
7679 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
7682 * Get a value whether the objects states will be reset or not.
7684 * @note @p transit can not be NULL
7686 * @see elm_transit_objects_final_state_keep_set()
7688 * @param transit The transit object.
7689 * @return EINA_TRUE means the states of the objects will be reset.
7690 * If @p transit is NULL, EINA_FALSE is returned
7694 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7697 * Set the event enabled when transit is operating.
7699 * If @p enabled is EINA_TRUE, the objects of the transit will receives
7700 * events from mouse and keyboard during the animation.
7701 * @note When you add an object with elm_transit_object_add(), its state from
7702 * evas_object_pass_events_get(obj) is saved, and it is applied when the
7703 * transit ends, if you change this state with evas_object_pass_events_set()
7704 * after adding the object, this state will change again when @p transit stops
7707 * @param transit The transit object.
7708 * @param enabled Events are received when enabled is @c EINA_TRUE, and
7709 * ignored otherwise.
7713 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
7716 * Get the value of event enabled status.
7718 * @see elm_transit_event_enabled_set()
7720 * @param transit The Transit object
7721 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
7722 * EINA_FALSE is returned
7726 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7729 * Set the user-callback function when the transit is deleted.
7731 * @note Using this function twice will overwrite the first function setted.
7732 * @note the @p transit object will be deleted after call @p cb function.
7734 * @param transit The transit object.
7735 * @param cb Callback function pointer. This function will be called before
7736 * the deletion of the transit.
7737 * @param data Callback funtion user data. It is the @p op parameter.
7741 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
7744 * Set reverse effect automatically.
7746 * If auto reverse is setted, after running the effects with the progress
7747 * parameter from 0 to 1, it will call the effecs again with the progress
7748 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
7749 * where the duration was setted with the function elm_transit_add and
7750 * the repeat with the function elm_transit_repeat_times_set().
7752 * @param transit The transit object.
7753 * @param reverse EINA_TRUE means the auto_reverse is on.
7757 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
7760 * Get if the auto reverse is on.
7762 * @see elm_transit_auto_reverse_set()
7764 * @param transit The transit object.
7765 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
7766 * EINA_FALSE is returned
7770 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7773 * Set the transit repeat count. Effect will be repeated by repeat count.
7775 * This function sets the number of repetition the transit will run after
7776 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
7777 * If the @p repeat is a negative number, it will repeat infinite times.
7779 * @note If this function is called during the transit execution, the transit
7780 * will run @p repeat times, ignoring the times it already performed.
7782 * @param transit The transit object
7783 * @param repeat Repeat count
7787 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
7790 * Get the transit repeat count.
7792 * @see elm_transit_repeat_times_set()
7794 * @param transit The Transit object.
7795 * @return The repeat count. If @p transit is NULL
7800 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7803 * Set the transit animation acceleration type.
7805 * This function sets the tween mode of the transit that can be:
7806 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
7807 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
7808 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
7809 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
7811 * @param transit The transit object.
7812 * @param tween_mode The tween type.
7816 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
7819 * Get the transit animation acceleration type.
7821 * @note @p transit can not be NULL
7823 * @param transit The transit object.
7824 * @return The tween type. If @p transit is NULL
7825 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
7829 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7832 * Set the transit animation time
7834 * @note @p transit can not be NULL
7836 * @param transit The transit object.
7837 * @param duration The animation time.
7841 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
7844 * Get the transit animation time
7846 * @note @p transit can not be NULL
7848 * @param transit The transit object.
7850 * @return The transit animation time.
7854 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7857 * Starts the transition.
7858 * Once this API is called, the transit begins to measure the time.
7860 * @note @p transit can not be NULL
7862 * @param transit The transit object.
7866 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
7869 * Pause/Resume the transition.
7871 * If you call elm_transit_go again, the transit will be started from the
7872 * beginning, and will be unpaused.
7874 * @note @p transit can not be NULL
7876 * @param transit The transit object.
7877 * @param paused Whether the transition should be paused or not.
7881 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
7884 * Get the value of paused status.
7886 * @see elm_transit_paused_set()
7888 * @note @p transit can not be NULL
7890 * @param transit The transit object.
7891 * @return EINA_TRUE means transition is paused. If @p transit is NULL
7892 * EINA_FALSE is returned
7896 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7899 * Get the time progression of the animation (a double value between 0.0 and 1.0).
7901 * The value returned is a fraction (current time / total time). It
7902 * represents the progression position relative to the total.
7904 * @note @p transit can not be NULL
7906 * @param transit The transit object.
7908 * @return The time progression value. If @p transit is NULL
7913 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
7916 * Makes the chain relationship between two transits.
7918 * @note @p transit can not be NULL. Transit would have multiple chain transits.
7919 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
7921 * @param transit The transit object.
7922 * @param chain_transit The chain transit object. This transit will be operated
7923 * after transit is done.
7925 * This function adds @p chain_transit transition to a chain after the @p
7926 * transit, and will be started as soon as @p transit ends. See @ref
7927 * transit_example_02_explained for a full example.
7931 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
7934 * Cut off the chain relationship between two transits.
7936 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
7937 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
7939 * @param transit The transit object.
7940 * @param chain_transit The chain transit object.
7942 * This function remove the @p chain_transit transition from the @p transit.
7946 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
7949 * Get the current chain transit list.
7951 * @note @p transit can not be NULL.
7953 * @param transit The transit object.
7954 * @return chain transit list.
7958 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
7961 * Add the Resizing Effect to Elm_Transit.
7963 * @note This API is one of the facades. It creates resizing effect context
7964 * and add it's required APIs to elm_transit_effect_add.
7966 * @see elm_transit_effect_add()
7968 * @param transit Transit object.
7969 * @param from_w Object width size when effect begins.
7970 * @param from_h Object height size when effect begins.
7971 * @param to_w Object width size when effect ends.
7972 * @param to_h Object height size when effect ends.
7973 * @return Resizing effect context data.
7977 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);
7980 * Add the Translation Effect to Elm_Transit.
7982 * @note This API is one of the facades. It creates translation effect context
7983 * and add it's required APIs to elm_transit_effect_add.
7985 * @see elm_transit_effect_add()
7987 * @param transit Transit object.
7988 * @param from_dx X Position variation when effect begins.
7989 * @param from_dy Y Position variation when effect begins.
7990 * @param to_dx X Position variation when effect ends.
7991 * @param to_dy Y Position variation when effect ends.
7992 * @return Translation effect context data.
7995 * @warning It is highly recommended just create a transit with this effect when
7996 * the window that the objects of the transit belongs has already been created.
7997 * This is because this effect needs the geometry information about the objects,
7998 * and if the window was not created yet, it can get a wrong information.
8000 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);
8003 * Add the Zoom Effect to Elm_Transit.
8005 * @note This API is one of the facades. It creates zoom effect context
8006 * and add it's required APIs to elm_transit_effect_add.
8008 * @see elm_transit_effect_add()
8010 * @param transit Transit object.
8011 * @param from_rate Scale rate when effect begins (1 is current rate).
8012 * @param to_rate Scale rate when effect ends.
8013 * @return Zoom effect context data.
8016 * @warning It is highly recommended just create a transit with this effect when
8017 * the window that the objects of the transit belongs has already been created.
8018 * This is because this effect needs the geometry information about the objects,
8019 * and if the window was not created yet, it can get a wrong information.
8021 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
8024 * Add the Flip Effect to Elm_Transit.
8026 * @note This API is one of the facades. It creates flip effect context
8027 * and add it's required APIs to elm_transit_effect_add.
8028 * @note This effect is applied to each pair of objects in the order they are listed
8029 * in the transit list of objects. The first object in the pair will be the
8030 * "front" object and the second will be the "back" object.
8032 * @see elm_transit_effect_add()
8034 * @param transit Transit object.
8035 * @param axis Flipping Axis(X or Y).
8036 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
8037 * @return Flip effect context data.
8040 * @warning It is highly recommended just create a transit with this effect when
8041 * the window that the objects of the transit belongs has already been created.
8042 * This is because this effect needs the geometry information about the objects,
8043 * and if the window was not created yet, it can get a wrong information.
8045 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
8048 * Add the Resizable Flip Effect to Elm_Transit.
8050 * @note This API is one of the facades. It creates resizable flip effect context
8051 * and add it's required APIs to elm_transit_effect_add.
8052 * @note This effect is applied to each pair of objects in the order they are listed
8053 * in the transit list of objects. The first object in the pair will be the
8054 * "front" object and the second will be the "back" object.
8056 * @see elm_transit_effect_add()
8058 * @param transit Transit object.
8059 * @param axis Flipping Axis(X or Y).
8060 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
8061 * @return Resizable flip effect context data.
8064 * @warning It is highly recommended just create a transit with this effect when
8065 * the window that the objects of the transit belongs has already been created.
8066 * This is because this effect needs the geometry information about the objects,
8067 * and if the window was not created yet, it can get a wrong information.
8069 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
8072 * Add the Wipe Effect to Elm_Transit.
8074 * @note This API is one of the facades. It creates wipe effect context
8075 * and add it's required APIs to elm_transit_effect_add.
8077 * @see elm_transit_effect_add()
8079 * @param transit Transit object.
8080 * @param type Wipe type. Hide or show.
8081 * @param dir Wipe Direction.
8082 * @return Wipe effect context data.
8085 * @warning It is highly recommended just create a transit with this effect when
8086 * the window that the objects of the transit belongs has already been created.
8087 * This is because this effect needs the geometry information about the objects,
8088 * and if the window was not created yet, it can get a wrong information.
8090 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
8093 * Add the Color Effect to Elm_Transit.
8095 * @note This API is one of the facades. It creates color effect context
8096 * and add it's required APIs to elm_transit_effect_add.
8098 * @see elm_transit_effect_add()
8100 * @param transit Transit object.
8101 * @param from_r RGB R when effect begins.
8102 * @param from_g RGB G when effect begins.
8103 * @param from_b RGB B when effect begins.
8104 * @param from_a RGB A when effect begins.
8105 * @param to_r RGB R when effect ends.
8106 * @param to_g RGB G when effect ends.
8107 * @param to_b RGB B when effect ends.
8108 * @param to_a RGB A when effect ends.
8109 * @return Color effect context data.
8113 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);
8116 * Add the Fade Effect to Elm_Transit.
8118 * @note This API is one of the facades. It creates fade effect context
8119 * and add it's required APIs to elm_transit_effect_add.
8120 * @note This effect is applied to each pair of objects in the order they are listed
8121 * in the transit list of objects. The first object in the pair will be the
8122 * "before" object and the second will be the "after" object.
8124 * @see elm_transit_effect_add()
8126 * @param transit Transit object.
8127 * @return Fade effect context data.
8130 * @warning It is highly recommended just create a transit with this effect when
8131 * the window that the objects of the transit belongs has already been created.
8132 * This is because this effect needs the color information about the objects,
8133 * and if the window was not created yet, it can get a wrong information.
8135 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
8138 * Add the Blend Effect to Elm_Transit.
8140 * @note This API is one of the facades. It creates blend effect context
8141 * and add it's required APIs to elm_transit_effect_add.
8142 * @note This effect is applied to each pair of objects in the order they are listed
8143 * in the transit list of objects. The first object in the pair will be the
8144 * "before" object and the second will be the "after" object.
8146 * @see elm_transit_effect_add()
8148 * @param transit Transit object.
8149 * @return Blend effect context data.
8152 * @warning It is highly recommended just create a transit with this effect when
8153 * the window that the objects of the transit belongs has already been created.
8154 * This is because this effect needs the color information about the objects,
8155 * and if the window was not created yet, it can get a wrong information.
8157 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
8160 * Add the Rotation Effect to Elm_Transit.
8162 * @note This API is one of the facades. It creates rotation effect context
8163 * and add it's required APIs to elm_transit_effect_add.
8165 * @see elm_transit_effect_add()
8167 * @param transit Transit object.
8168 * @param from_degree Degree when effect begins.
8169 * @param to_degree Degree when effect is ends.
8170 * @return Rotation effect context data.
8173 * @warning It is highly recommended just create a transit with this effect when
8174 * the window that the objects of the transit belongs has already been created.
8175 * This is because this effect needs the geometry information about the objects,
8176 * and if the window was not created yet, it can get a wrong information.
8178 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
8181 * Add the ImageAnimation Effect to Elm_Transit.
8183 * @note This API is one of the facades. It creates image animation effect context
8184 * and add it's required APIs to elm_transit_effect_add.
8185 * The @p images parameter is a list images paths. This list and
8186 * its contents will be deleted at the end of the effect by
8187 * elm_transit_effect_image_animation_context_free() function.
8191 * char buf[PATH_MAX];
8192 * Eina_List *images = NULL;
8193 * Elm_Transit *transi = elm_transit_add();
8195 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
8196 * images = eina_list_append(images, eina_stringshare_add(buf));
8198 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
8199 * images = eina_list_append(images, eina_stringshare_add(buf));
8200 * elm_transit_effect_image_animation_add(transi, images);
8204 * @see elm_transit_effect_add()
8206 * @param transit Transit object.
8207 * @param images Eina_List of images file paths. This list and
8208 * its contents will be deleted at the end of the effect by
8209 * elm_transit_effect_image_animation_context_free() function.
8210 * @return Image Animation effect context data.
8214 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
8220 typedef struct _Elm_Store Elm_Store;
8221 typedef struct _Elm_Store_DBsystem Elm_Store_DBsystem;
8222 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
8223 typedef struct _Elm_Store_Item Elm_Store_Item;
8224 typedef struct _Elm_Store_Item_DBsystem Elm_Store_Item_DBsystem;
8225 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
8226 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
8227 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
8228 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
8229 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
8230 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
8231 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
8232 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
8234 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
8235 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
8236 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
8237 typedef void (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
8238 typedef int (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
8239 typedef void (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
8240 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
8244 ELM_STORE_ITEM_MAPPING_NONE = 0,
8245 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
8246 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
8247 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
8248 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
8249 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
8250 // can add more here as needed by common apps
8251 ELM_STORE_ITEM_MAPPING_LAST
8252 } Elm_Store_Item_Mapping_Type;
8254 struct _Elm_Store_Item_Mapping_Icon
8256 // FIXME: allow edje file icons
8258 Elm_Icon_Lookup_Order lookup_order;
8259 Eina_Bool standard_name : 1;
8260 Eina_Bool no_scale : 1;
8261 Eina_Bool smooth : 1;
8262 Eina_Bool scale_up : 1;
8263 Eina_Bool scale_down : 1;
8266 struct _Elm_Store_Item_Mapping_Empty
8271 struct _Elm_Store_Item_Mapping_Photo
8276 struct _Elm_Store_Item_Mapping_Custom
8278 Elm_Store_Item_Mapping_Cb func;
8281 struct _Elm_Store_Item_Mapping
8283 Elm_Store_Item_Mapping_Type type;
8287 Elm_Store_Item_Mapping_Empty empty;
8288 Elm_Store_Item_Mapping_Icon icon;
8289 Elm_Store_Item_Mapping_Photo photo;
8290 Elm_Store_Item_Mapping_Custom custom;
8291 // add more types here
8295 struct _Elm_Store_Item_Info
8301 int pre_group_index;
8303 Elm_Genlist_Item_Class *item_class;
8304 const Elm_Store_Item_Mapping *mapping;
8309 struct _Elm_Store_Item_Info_Filesystem
8311 Elm_Store_Item_Info base;
8315 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
8316 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
8318 EAPI Elm_Store *elm_store_dbsystem_new(void);
8319 EAPI void elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
8320 EAPI void elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
8321 EAPI void elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
8322 EAPI void elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
8323 EAPI int elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8324 EAPI void *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8325 EAPI void elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
8326 EAPI int elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8327 EAPI Elm_Store_Item *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
8328 EAPI void elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8329 EAPI void elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
8330 EAPI void elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8331 EAPI void elm_store_free(Elm_Store *st);
8332 EAPI Elm_Store *elm_store_filesystem_new(void);
8333 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
8334 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8335 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8336 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
8337 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
8338 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8339 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
8340 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
8341 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
8342 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8343 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
8344 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
8345 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8346 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
8347 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8348 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8349 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8351 /* SegmentControl */
8352 typedef struct _Elm_Segment_Item Elm_Segment_Item;
8353 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8354 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
8355 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);
8356 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
8357 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8358 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8359 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8360 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8361 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
8362 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8363 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
8364 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
8365 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
8366 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8367 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
8368 /* smart callbacks called:
8369 * "changed" -when the user clicks on a segment item which is not previously
8370 * selected and get selected. The event_info parameter is the
8371 * segment item index.
8374 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
8375 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
8376 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
8377 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
8378 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
8379 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
8380 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
8381 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
8383 EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
8384 EAPI void elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
8386 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
8387 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
8388 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
8389 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
8390 EAPI void elm_video_play(Evas_Object *video);
8391 EAPI void elm_video_pause(Evas_Object *video);
8392 EAPI void elm_video_stop(Evas_Object *video);
8393 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
8394 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
8395 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
8396 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
8397 EAPI double elm_video_audio_level_get(Evas_Object *video);
8398 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
8399 EAPI double elm_video_play_position_get(Evas_Object *video);
8400 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
8401 EAPI double elm_video_play_length_get(Evas_Object *video);
8402 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
8403 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
8404 EAPI const char *elm_video_title_get(Evas_Object *video);
8406 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
8407 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
8409 // FIXME: incomplete - carousel. don't use this until this comment is removed
8410 typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
8411 EAPI Evas_Object *elm_carousel_add(Evas_Object *parent);
8412 EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
8413 EAPI void elm_carousel_item_del(Elm_Carousel_Item *item);
8414 EAPI void elm_carousel_item_select(Elm_Carousel_Item *item);
8415 /* smart callbacks called:
8416 * "clicked" - when the user clicks on a carousel item and becomes selected
8421 typedef enum _Elm_Datefield_ItemType
8423 ELM_DATEFIELD_YEAR = 0,
8424 ELM_DATEFIELD_MONTH,
8427 ELM_DATEFIELD_MINUTE,
8429 } Elm_Datefield_ItemType;
8431 EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
8432 EAPI void elm_datefield_format_set(Evas_Object *obj, const char *fmt);
8433 EAPI char *elm_datefield_format_get(const Evas_Object *obj);
8434 EAPI void elm_datefield_item_enabled_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, Eina_Bool enable);
8435 EAPI Eina_Bool elm_datefield_item_enabled_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8436 EAPI void elm_datefield_item_value_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value);
8437 EAPI int elm_datefield_item_value_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8438 EAPI void elm_datefield_item_min_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
8439 EAPI int elm_datefield_item_min_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8440 EAPI Eina_Bool elm_datefield_item_min_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8441 EAPI void elm_datefield_item_max_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
8442 EAPI int elm_datefield_item_max_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8443 EAPI Eina_Bool elm_datefield_item_max_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8445 /* smart callbacks called:
8446 * "changed" - when datefield value is changed, this signal is sent.
8449 ////////////////////// DEPRECATED ///////////////////////////////////
8451 typedef enum _Elm_Datefield_Layout
8453 ELM_DATEFIELD_LAYOUT_TIME,
8454 ELM_DATEFIELD_LAYOUT_DATE,
8455 ELM_DATEFIELD_LAYOUT_DATEANDTIME
8456 } Elm_Datefield_Layout;
8458 EINA_DEPRECATED EAPI void elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
8459 EINA_DEPRECATED EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
8460 EINA_DEPRECATED EAPI void elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
8461 EINA_DEPRECATED EAPI const char *elm_datefield_date_format_get(const Evas_Object *obj);
8462 EINA_DEPRECATED EAPI void elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
8463 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_time_mode_get(const Evas_Object *obj);
8464 EINA_DEPRECATED EAPI void elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
8465 EINA_DEPRECATED EAPI void elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
8466 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
8467 EINA_DEPRECATED EAPI void elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
8468 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
8469 EINA_DEPRECATED EAPI void elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
8470 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);
8471 EINA_DEPRECATED EAPI void elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
8472 /////////////////////////////////////////////////////////////////////
8475 typedef enum _Elm_Popup_Response
8477 ELM_POPUP_RESPONSE_NONE = -1,
8478 ELM_POPUP_RESPONSE_TIMEOUT = -2,
8479 ELM_POPUP_RESPONSE_OK = -3,
8480 ELM_POPUP_RESPONSE_CANCEL = -4,
8481 ELM_POPUP_RESPONSE_CLOSE = -5
8482 } Elm_Popup_Response;
8484 typedef enum _Elm_Popup_Mode
8486 ELM_POPUP_TYPE_NONE = 0,
8487 ELM_POPUP_TYPE_ALERT = (1 << 0)
8490 typedef enum _Elm_Popup_Orient
8492 ELM_POPUP_ORIENT_TOP,
8493 ELM_POPUP_ORIENT_CENTER,
8494 ELM_POPUP_ORIENT_BOTTOM,
8495 ELM_POPUP_ORIENT_LEFT,
8496 ELM_POPUP_ORIENT_RIGHT,
8497 ELM_POPUP_ORIENT_TOP_LEFT,
8498 ELM_POPUP_ORIENT_TOP_RIGHT,
8499 ELM_POPUP_ORIENT_BOTTOM_LEFT,
8500 ELM_POPUP_ORIENT_BOTTOM_RIGHT
8503 /* smart callbacks called:
8504 * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
8507 EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
8508 EAPI void elm_popup_desc_set(Evas_Object *obj, const char *text);
8509 EAPI const char *elm_popup_desc_get(Evas_Object *obj);
8510 EAPI void elm_popup_title_label_set(Evas_Object *obj, const char *text);
8511 EAPI const char *elm_popup_title_label_get(Evas_Object *obj);
8512 EAPI void elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
8513 EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
8514 EAPI void elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
8515 EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
8516 EAPI void elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text, ...);
8517 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, ... );
8518 EAPI void elm_popup_timeout_set(Evas_Object *obj, double timeout);
8519 EAPI void elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
8520 EAPI void elm_popup_response(Evas_Object *obj, int response_id);
8521 EAPI void elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
8522 EAPI int elm_popup_run(Evas_Object *obj);
8525 #define NAVIBAR_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
8526 #define NAVIBAR_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
8530 ELM_NAVIGATIONBAR_FUNCTION_BUTTON1,
8531 ELM_NAVIGATIONBAR_FUNCTION_BUTTON2,
8532 ELM_NAVIGATIONBAR_FUNCTION_BUTTON3,
8533 ELM_NAVIGATIONBAR_BACK_BUTTON
8534 } Elm_Navi_Button_Type;
8536 EAPI Evas_Object *elm_navigationbar_add(Evas_Object *parent);
8537 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);
8538 EAPI void elm_navigationbar_pop(Evas_Object *obj);
8539 EAPI void elm_navigationbar_to_content_pop(Evas_Object *obj, Evas_Object *content);
8540 EAPI void elm_navigationbar_title_label_set(Evas_Object *obj, Evas_Object *content, const char *title);
8541 EAPI const char *elm_navigationbar_title_label_get(Evas_Object *obj, Evas_Object *content);
8542 EAPI void elm_navigationbar_title_object_add(Evas_Object *obj, Evas_Object *content, Evas_Object *title_obj);
8543 EAPI Evas_Object *elm_navigationbar_title_object_get(Evas_Object *obj, Evas_Object *content);
8544 EAPI Eina_List *elm_navigationbar_title_object_list_get(Evas_Object *obj, Evas_Object *content);
8545 EAPI Evas_Object *elm_navigationbar_content_top_get(Evas_Object *obj);
8546 EAPI Evas_Object *elm_navigationbar_content_bottom_get(Evas_Object *obj);
8547 EAPI void elm_navigationbar_hidden_set(Evas_Object *obj, Eina_Bool hidden);
8548 EAPI void elm_navigationbar_title_button_set(Evas_Object *obj, Evas_Object *content, Evas_Object *button, Elm_Navi_Button_Type button_type);
8549 EAPI Evas_Object *elm_navigationbar_title_button_get(Evas_Object *obj, Evas_Object *content, Elm_Navi_Button_Type button_type);
8550 EAPI const char *elm_navigationbar_subtitle_label_get(Evas_Object *obj, Evas_Object *content);
8551 EAPI void elm_navigationbar_subtitle_label_set(Evas_Object *obj, Evas_Object *content, const char *subtitle);
8552 EAPI void elm_navigationbar_title_object_list_unset(Evas_Object *obj, Evas_Object *content, Eina_List **list);
8553 EAPI void elm_navigationbar_animation_disabled_set(Evas_Object *obj, Eina_Bool disable);
8554 EAPI void elm_navigationbar_title_object_visible_set(Evas_Object *obj, Evas_Object *content, Eina_Bool visible);
8555 Eina_Bool elm_navigationbar_title_object_visible_get(Evas_Object *obj, Evas_Object *content);
8556 EAPI void elm_navigationbar_title_icon_set(Evas_Object *obj, Evas_Object *content, Evas_Object *icon);
8557 EAPI Evas_Object *elm_navigationbar_title_icon_get(Evas_Object *obj, Evas_Object *content);
8560 #define NAVIBAR_EX_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
8561 #define NAVIBAR_EX_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
8565 ELM_NAVIGATIONBAR_EX_BACK_BUTTON,
8566 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON1,
8567 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON2,
8568 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON3,
8569 ELM_NAVIGATIONBAR_EX_MAX
8570 } Elm_Navi_ex_Button_Type;
8571 typedef struct _Elm_Navigationbar_ex_Item Elm_Navigationbar_ex_Item;
8573 EAPI Evas_Object *elm_navigationbar_ex_add(Evas_Object *parent);
8574 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_push(Evas_Object *obj, Evas_Object *content, const char *item_style);
8575 EAPI void elm_navigationbar_ex_item_pop(Evas_Object *obj);
8576 EAPI void elm_navigationbar_ex_item_promote(Elm_Navigationbar_ex_Item* item);
8577 EAPI void elm_navigationbar_ex_to_item_pop(Elm_Navigationbar_ex_Item* item);
8578 EAPI void elm_navigationbar_ex_item_title_label_set(Elm_Navigationbar_ex_Item *item, const char *title);
8579 EAPI const char *elm_navigationbar_ex_item_title_label_get(Elm_Navigationbar_ex_Item* item);
8580 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_top_get(const Evas_Object *obj);
8581 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_bottom_get(const Evas_Object *obj);
8582 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);
8583 EAPI Evas_Object *elm_navigationbar_ex_item_title_button_get(Elm_Navigationbar_ex_Item* item, int button_type);
8584 EAPI void elm_navigationbar_ex_item_title_object_set(Elm_Navigationbar_ex_Item* item, Evas_Object *title_obj);
8585 EAPI Evas_Object *elm_navigationbar_ex_item_title_object_unset(Elm_Navigationbar_ex_Item* item);
8586 EAPI void elm_navigationbar_ex_item_title_hidden_set(Elm_Navigationbar_ex_Item* item, Eina_Bool hidden);
8587 EAPI Evas_Object *elm_navigationbar_ex_item_title_object_get(Elm_Navigationbar_ex_Item* item);
8588 EAPI const char *elm_navigationbar_ex_item_subtitle_label_get(Elm_Navigationbar_ex_Item* item);
8589 EAPI void elm_navigationbar_ex_item_subtitle_label_set( Elm_Navigationbar_ex_Item* item, const char *subtitle);
8590 EAPI void elm_navigationbar_ex_item_style_set(Elm_Navigationbar_ex_Item* item, const char* item_style);
8591 EAPI const char *elm_navigationbar_ex_item_style_get(Elm_Navigationbar_ex_Item* item);
8592 EAPI Evas_Object *elm_navigationbar_ex_item_content_unset(Elm_Navigationbar_ex_Item* item);
8593 EAPI Evas_Object *elm_navigationbar_ex_item_content_get(Elm_Navigationbar_ex_Item* item);
8594 EAPI void elm_navigationbar_ex_delete_on_pop_set(Evas_Object *obj, Eina_Bool del_on_pop);
8595 EAPI Evas_Object *elm_navigationbar_ex_item_icon_get(Elm_Navigationbar_ex_Item* item);
8596 EAPI void elm_navigationbar_ex_item_icon_set(Elm_Navigationbar_ex_Item* item, Evas_Object *icon);
8597 EAPI Evas_Object *elm_navigationbar_ex_item_title_button_unset(Elm_Navigationbar_ex_Item* item, int button_type);
8598 EAPI void elm_navigationbar_ex_animation_disable_set(Evas_Object *obj, Eina_Bool disable);
8599 EAPI void elm_navigationbar_ex_title_object_visible_set(Elm_Navigationbar_ex_Item* item, Eina_Bool visible);
8600 Eina_Bool elm_navigationbar_ex_title_object_visible_get(Elm_Navigationbar_ex_Item* item);
8603 #define ELM_NAVIFRAME_ITEM_CONTENT "elm.swallow.content"
8604 #define ELM_NAVIFRAME_ITEM_ICON "elm.swallow.icon"
8605 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER "elm.swallow.optionheader"
8606 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER2 "elm.swallow.optionheader2"
8607 #define ELM_NAVIFRAME_ITEM_TITLE_LABEL "elm.text.title"
8608 #define ELM_NAVIFRAME_ITEM_PREV_BTN "elm.swallow.prev_btn"
8609 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_CLOSE "elm,state,optionheader,close", ""
8610 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_OPEN "elm,state,optionheader,open", ""
8611 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_CLOSE "elm,state,optionheader,instant_close", ""
8612 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_OPEN "elm,state,optionheader,instant_open", ""
8615 * @defgroup Naviframe Naviframe
8617 * @brief Naviframe is a kind of view manager for the applications.
8619 * Naviframe provides functions to switch different pages with stack
8620 * mechanism. It means if one page(item) needs to be changed to the new one,
8621 * then naviframe would push the new page to it's internal stack. Of course,
8622 * it can be back to the previous page by popping the top page. Naviframe
8623 * provides some transition effect while the pages are switching (same as
8626 * Since each item could keep the different styles, users could keep the
8627 * same look & feel for the pages or different styles for the items in it's
8630 * Signals that you can add callback for are:
8632 * @li "transition,finished" - When the transition is finished in changing
8634 * @li "title,clicked" - User clicked title area
8636 * Default contents parts for the naviframe items that you can use for are:
8638 * @li "elm.swallow.content" - The main content of the page
8639 * @li "elm.swallow.prev_btn" - The button to go to the previous page
8640 * @li "elm.swallow.next_btn" - The button to go to the next page
8642 * Default text parts of naviframe items that you can be used are:
8644 * @li "elm.text.title" - The title label in the title area
8646 * @ref tutorial_naviframe gives a good overview of the usage of the API.
8650 * @brief Add a new Naviframe object to the parent.
8652 * @param parent Parent object
8653 * @return New object or @c NULL, if it cannot be created
8655 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8657 * @brief Push a new item to the top of the naviframe stack (and show it).
8659 * @param obj The naviframe object
8660 * @param title_label The label in the title area. The name of the title
8661 * label part is "elm.text.title"
8662 * @param prev_btn The button to go to the previous item. If it is NULL,
8663 * then naviframe will create a back button automatically. The name of
8664 * the prev_btn part is "elm.swallow.prev_btn"
8665 * @param next_btn The button to go to the next item. Or It could be just an
8666 * extra function button. The name of the next_btn part is
8667 * "elm.swallow.next_btn"
8668 * @param content The main content object. The name of content part is
8669 * "elm.swallow.content"
8670 * @param item_style The current item style name. @c NULL would be default.
8671 * @return The created item or @c NULL upon failure.
8673 * The item pushed becomes one page of the naviframe, this item will be
8674 * deleted when it is popped.
8676 * @see also elm_naviframe_item_style_set()
8678 * The following styles are available for this item:
8681 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);
8683 * @brief Pop an item that is on top of the stack
8685 * @param obj The naviframe object
8686 * @return @c NULL or the content object(if the
8687 * elm_naviframe_content_preserve_on_pop_get is true).
8689 * This pops an item that is on the top(visible) of the naviframe, makes it
8690 * disappear, then deletes the item. The item that was underneath it on the
8691 * stack will become visible.
8693 * @see also elm_naviframe_content_preserve_on_pop_get()
8695 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
8697 * @brief Pop the items between the top and the above one on the given item.
8699 * @param it The naviframe item
8701 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
8703 * Promote an item already in the naviframe stack to the top of the stack
8705 * @param it The naviframe item
8707 * This will take the indicated item and promote it to the top of the stack
8708 * as if it had been pushed there. The item must already be inside the
8709 * naviframe stack to work.
8712 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
8714 * @brief Delete the given item instantly.
8716 * @param it The naviframe item
8718 * This just deletes the given item from the naviframe item list instantly.
8719 * So this would not emit any signals for view transitions but just change
8720 * the current view if the given item is a top one.
8723 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
8725 * @brief preserve the content objects when items are popped.
8727 * @param obj The naviframe object
8728 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
8730 * @see also elm_naviframe_content_preserve_on_pop_get()
8732 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
8734 * @brief Get a value whether preserve mode is enabled or not.
8736 * @param obj The naviframe object
8737 * @return If @c EINA_TRUE, preserve mode is enabled
8739 * @see also elm_naviframe_content_preserve_on_pop_set()
8741 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8743 * @brief Get a top item on the naviframe stack
8745 * @param obj The naviframe object
8746 * @return The top item on the naviframe stack or @c NULL, if the stack is
8749 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8751 * @brief Get a bottom item on the naviframe stack
8753 * @param obj The naviframe object
8754 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
8757 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8759 * @brief Set an item style
8761 * @param obj The naviframe item
8762 * @param item_style The current item style name. @c NULL would be default
8764 * The following styles are available for this item:
8767 * @see also elm_naviframe_item_style_get()
8769 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
8771 * @brief Get an item style
8773 * @param obj The naviframe item
8774 * @return The current item style name
8776 * @see also elm_naviframe_item_style_set()
8778 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
8780 * @brief Show/Hide the title area
8782 * @param it The naviframe item
8783 * @param visible If @c EINA_TRUE, title area will be visible, hidden
8786 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
8788 * @see also elm_naviframe_item_title_visible_get()
8790 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
8792 * @brief Get a value whether title area is visible or not.
8794 * @param it The naviframe item
8795 * @return If @c EINA_TRUE, title area is visible
8797 * @see also elm_naviframe_item_title_visible_set()
8799 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
8801 * @brief Set creating prev button automatically or not
8803 * @param obj The naviframe object
8804 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
8805 * be created internally when you pass the @c NULL to the prev_btn
8806 * parameter in elm_naviframe_item_push
8808 * @see also elm_naviframe_item_push()
8810 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
8812 * @brief Get a value whether prev button(back button) will be auto pushed or
8815 * @param obj The naviframe object
8816 * @return If @c EINA_TRUE, prev button will be auto pushed.
8818 * @see also elm_naviframe_item_push()
8819 * elm_naviframe_prev_btn_auto_pushed_set()
8821 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
8824 #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
8825 #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
8826 #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
8827 #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
8828 #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
8829 #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
8830 #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
8831 #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
8832 #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
8834 typedef enum _Elm_Controlbar_Mode_Type
8836 ELM_CONTROLBAR_MODE_DEFAULT = 0,
8837 ELM_CONTROLBAR_MODE_TRANSLUCENCE,
8838 ELM_CONTROLBAR_MODE_TRANSPARENCY,
8839 ELM_CONTROLBAR_MODE_LARGE,
8840 ELM_CONTROLBAR_MODE_SMALL,
8841 ELM_CONTROLBAR_MODE_LEFT,
8842 ELM_CONTROLBAR_MODE_RIGHT
8843 } Elm_Controlbar_Mode_Type;
8845 typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
8846 EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
8847 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
8848 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
8849 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);
8850 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);
8851 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);
8852 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);
8853 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);
8854 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);
8855 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
8856 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
8857 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
8858 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
8859 EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
8860 EAPI void elm_controlbar_item_del(Elm_Controlbar_Item *it);
8861 EAPI void elm_controlbar_item_select(Elm_Controlbar_Item *it);
8862 EAPI void elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
8863 EAPI Eina_Bool elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
8864 EAPI void elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
8865 EAPI Eina_Bool elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
8866 EAPI void elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
8867 EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
8868 EAPI void elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
8869 EAPI const char *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
8870 EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
8871 EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
8872 EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
8873 EAPI const Eina_List *elm_controlbar_items_get(const Evas_Object *obj);
8874 EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
8875 EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
8876 EAPI void elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
8877 EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
8878 EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
8879 EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
8880 EAPI void elm_controlbar_mode_set(Evas_Object *obj, int mode);
8881 EAPI void elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
8882 EAPI void elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
8883 EAPI void elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
8886 EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
8887 EAPI void elm_searchbar_text_set(Evas_Object *obj, const char *entry);
8888 EAPI const char *elm_searchbar_text_get(Evas_Object *obj);
8889 EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
8890 EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
8891 EAPI void elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
8892 EAPI void elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
8893 EAPI void elm_searchbar_clear(Evas_Object *obj);
8894 EAPI void elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
8896 EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
8897 EAPI void elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
8898 EAPI void elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
8899 EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
8902 EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
8903 EAPI void elm_nocontents_label_set(Evas_Object *obj, const char *label);
8904 EAPI const char *elm_nocontents_label_get(const Evas_Object *obj);
8905 EAPI void elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
8906 EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
8911 ELM_TICKERNOTI_ORIENT_TOP = 0,
8912 ELM_TICKERNOTI_ORIENT_BOTTOM,
8913 ELM_TICKERNOTI_ORIENT_LAST
8914 } Elm_Tickernoti_Orient;
8916 EAPI Evas_Object *elm_tickernoti_add (Evas_Object *parent);
8917 EAPI void elm_tickernoti_orient_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
8918 EAPI Elm_Tickernoti_Orient elm_tickernoti_orient_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8919 EAPI int elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8920 EAPI void elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
8921 EAPI Evas_Object *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8922 /* #### Below APIs and data structures are going to be deprecated, announcment will be made soon ####*/
8925 ELM_TICKERNOTI_DEFAULT,
8926 ELM_TICKERNOTI_DETAILVIEW
8927 } Elm_Tickernoti_Mode;
8928 EAPI void elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8929 EAPI const char *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
8930 EAPI void elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
8931 EAPI Evas_Object *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8932 EAPI void elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
8933 EAPI Evas_Object *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8934 EAPI Evas_Object *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8935 EAPI void elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
8936 EAPI Elm_Tickernoti_Mode elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8937 EAPI void elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
8938 EAPI Elm_Tickernoti_Orient elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8939 EAPI void elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
8940 EAPI const char *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8941 EAPI void elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
8942 EAPI Evas_Object *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8943 EAPI void elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
8944 EAPI Evas_Object *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
8945 /* ############################################################################### */
8947 * Parts which can be used with elm_object_text_part_set() and
8948 * elm_object_text_part_get():
8950 * @li NULL/"default" - Operates on tickernoti content-text
8952 * Parts which can be used with elm_object_content_part_set() and
8953 * elm_object_content_part_get():
8955 * @li "icon" - Operates on tickernoti's icon
8956 * @li "button" - Operates on tickernoti's button
8958 * smart callbacks called:
8959 * @li "clicked" - emitted when tickernoti is clicked, except at the
8960 * swallow/button region, if any.
8961 * @li "hide" - emitted when the tickernoti is completely hidden. In case of
8962 * any hide animation, this signal is emitted after the animation.
8966 typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
8968 struct _Colorpalette_Color
8970 unsigned int r, g, b;
8973 EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
8974 EAPI void elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
8975 EAPI void elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
8976 /* smart callbacks called:
8977 * "clicked" - when image clicked
8981 EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
8982 EAPI void elm_editfield_label_set(Evas_Object *obj, const char *label);
8983 EAPI const char *elm_editfield_label_get(Evas_Object *obj);
8984 EAPI void elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
8985 EAPI const char *elm_editfield_guide_text_get(Evas_Object *obj);
8986 EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
8987 // EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
8988 EAPI void elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
8989 EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
8990 EAPI void elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
8991 EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
8992 EAPI void elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
8993 EAPI Eina_Bool elm_editfield_entry_single_line_get(Evas_Object *obj);
8994 EAPI void elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
8995 EAPI Eina_Bool elm_editfield_eraser_get(Evas_Object *obj);
8996 /* smart callbacks called:
8997 * "clicked" - when an editfield is clicked
8998 * "unfocused" - when an editfield is unfocused
9002 /* Sliding Drawer */
9003 typedef enum _Elm_SlidingDrawer_Pos
9005 ELM_SLIDINGDRAWER_BOTTOM,
9006 ELM_SLIDINGDRAWER_LEFT,
9007 ELM_SLIDINGDRAWER_RIGHT,
9008 ELM_SLIDINGDRAWER_TOP
9009 } Elm_SlidingDrawer_Pos;
9011 typedef struct _Elm_SlidingDrawer_Drag_Value
9014 } Elm_SlidingDrawer_Drag_Value;
9016 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_add(Evas_Object *parent);
9017 EINA_DEPRECATED EAPI void elm_slidingdrawer_content_set (Evas_Object *obj, Evas_Object *content);
9018 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_content_unset(Evas_Object *obj);
9019 EINA_DEPRECATED EAPI void elm_slidingdrawer_pos_set(Evas_Object *obj, Elm_SlidingDrawer_Pos pos);
9020 EINA_DEPRECATED EAPI void elm_slidingdrawer_max_drag_value_set(Evas_Object *obj, double dw, double dh);
9021 EINA_DEPRECATED EAPI void elm_slidingdrawer_drag_value_set(Evas_Object *obj, double dx, double dy);
9023 /* multibuttonentry */
9024 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
9025 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
9026 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent);
9027 EAPI const char *elm_multibuttonentry_label_get(Evas_Object *obj);
9028 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
9029 EAPI Evas_Object *elm_multibuttonentry_entry_get(Evas_Object *obj);
9030 EAPI const char * elm_multibuttonentry_guide_text_get(Evas_Object *obj);
9031 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
9032 EAPI int elm_multibuttonentry_contracted_state_get(Evas_Object *obj);
9033 EAPI void elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
9034 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
9035 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
9036 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
9037 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
9038 EAPI const Eina_List *elm_multibuttonentry_items_get(Evas_Object *obj);
9039 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(Evas_Object *obj);
9040 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(Evas_Object *obj);
9041 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(Evas_Object *obj);
9042 EAPI void elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
9043 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
9044 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
9045 EAPI void elm_multibuttonentry_items_del(Evas_Object *obj);
9046 EAPI const char *elm_multibuttonentry_item_label_get(Elm_Multibuttonentry_Item *item);
9047 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
9048 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
9049 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
9050 EAPI void *elm_multibuttonentry_item_data_get(Elm_Multibuttonentry_Item *item);
9051 EAPI void elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
9052 EAPI void elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
9053 /* smart callback called:
9054 * "selected" - This signal is emitted when the selected item of multibuttonentry is changed.
9055 * "added" - This signal is emitted when a new multibuttonentry item is added.
9056 * "deleted" - This signal is emitted when a multibuttonentry item is deleted.
9057 * "expanded" - This signal is emitted when a multibuttonentry is expanded.
9058 * "contracted" - This signal is emitted when a multibuttonentry is contracted.
9059 * "contracted,state,changed" - This signal is emitted when the contracted state of multibuttonentry is changed.
9060 * "item,selected" - This signal is emitted when the selected item of multibuttonentry is changed.
9061 * "item,added" - This signal is emitted when a new multibuttonentry item is added.
9062 * "item,deleted" - This signal is emitted when a multibuttonentry item is deleted.
9063 * "item,clicked" - This signal is emitted when a multibuttonentry item is clicked.
9064 * "clicked" - This signal is emitted when a multibuttonentry is clicked.
9065 * "unfocused" - This signal is emitted when a multibuttonentry is unfocused.
9067 /* available styles:
9072 typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
9073 EAPI Evas_Object *elm_stackedicon_add(Evas_Object *parent);
9074 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
9075 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
9076 EAPI void elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
9077 EAPI Eina_List *elm_stackedicon_item_list_get(Evas_Object *obj);
9078 /* smart callback called:
9079 * "expanded" - This signal is emitted when a stackedicon is expanded.
9080 * "clicked" - This signal is emitted when a stackedicon is clicked.
9082 /* available styles:
9087 typedef struct _Dialogue_Item Dialogue_Item;
9089 typedef enum _Elm_Dialoguegourp_Item_Style
9091 ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
9092 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
9093 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
9094 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
9095 ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
9096 ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
9097 ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
9098 ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
9099 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
9100 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
9101 ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
9102 } Elm_Dialoguegroup_Item_Style;
9104 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_add(Evas_Object *parent);
9105 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
9106 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
9107 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
9108 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
9109 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove(Dialogue_Item *item);
9110 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove_all(Evas_Object *obj);
9111 EINA_DEPRECATED EAPI void elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
9112 EINA_DEPRECATED EAPI const char *elm_dialoguegroup_title_get(Evas_Object *obj);
9113 EINA_DEPRECATED EAPI void elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
9114 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
9115 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
9116 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
9117 EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style elm_dialoguegroup_item_style_get(Dialogue_Item *item);
9118 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
9119 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
9124 ELM_DAYSELECTOR_SUN,
9125 ELM_DAYSELECTOR_MON,
9126 ELM_DAYSELECTOR_TUE,
9127 ELM_DAYSELECTOR_WED,
9128 ELM_DAYSELECTOR_THU,
9129 ELM_DAYSELECTOR_FRI,
9131 } Elm_DaySelector_Day;
9133 EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
9134 EAPI Eina_Bool elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
9135 EAPI void elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
9138 typedef struct _Imageslider_Item Elm_Imageslider_Item;
9139 typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
9140 EAPI Evas_Object *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9141 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);
9142 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);
9143 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);
9144 EAPI void elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
9145 EAPI Elm_Imageslider_Item *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
9146 EAPI Eina_Bool elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
9147 EAPI void elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
9148 EAPI const char *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
9149 EAPI Elm_Imageslider_Item *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
9150 EAPI Elm_Imageslider_Item *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
9151 EAPI void elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
9152 EAPI void elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
9153 EAPI void elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
9154 EAPI void elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);