3 * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
8 @brief Elementary Widget Library
13 @image html elementary.png
17 @section intro What is Elementary?
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
22 It is meant to make the programmers work almost brainless but give them lots
25 @li @ref Start - Go here to quickly get started with writing Apps
27 @section organization Organization
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers which hold the widgets.
34 @section license License
36 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
37 all files in the source tree.
39 @section ack Acknowledgements
40 There is a lot that goes into making a widget set, and they don't happen out of
41 nothing. It's like trying to make everyone everywhere happy, regardless of age,
42 gender, race or nationality - and that is really tough. So thanks to people and
43 organisations behind this, as listed in the @ref authors page.
48 * @defgroup Start Getting Started
50 * To write an Elementary app, you can get started with the following:
53 #include <Elementary.h>
55 elm_main(int argc, char **argv)
57 // create window(s) here and do any application init
58 elm_run(); // run main loop
59 elm_shutdown(); // after mainloop finishes running, shutdown
60 return 0; // exit 0 for exit code
65 * To use autotools (which helps in many ways in the long run, like being able
66 * to immediately create releases of your software directly from your tree
67 * and ensure everything needed to build it is there) you will need a
68 * configure.ac, Makefile.am and autogen.sh file.
73 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
75 AC_CONFIG_SRCDIR(configure.ac)
76 AM_CONFIG_HEADER(config.h)
78 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
79 PKG_CHECK_MODULES([ELEMENTARY], elementary)
86 AUTOMAKE_OPTIONS = 1.4 foreign
87 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
89 INCLUDES = -I$(top_srcdir)
93 myapp_SOURCES = main.c
94 myapp_LDADD = @ELEMENTARY_LIBS@
95 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
102 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
103 echo "Running autoheader..." ; autoheader || exit 1
104 echo "Running autoconf..." ; autoconf || exit 1
105 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
109 * To generate all the things needed to bootstrap just run:
115 * This will generate Makefile.in's, the confgure script and everything else.
116 * After this it works like all normal autotools projects:
123 * Note sudo was assumed to get root permissions, as this would install in
124 * /usr/local which is system-owned. Use any way you like to gain root, or
125 * specify a different prefix with configure:
128 ./confiugre --prefix=$HOME/mysoftware
131 * Also remember that autotools buys you some useful commands like:
136 * This uninstalls the software after it was installed with "make install".
137 * It is very useful to clear up what you built if you wish to clean the
144 * This firstly checks if your build tree is "clean" and ready for
145 * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
146 * ready to upload and distribute to the world, that contains the generated
147 * Makefile.in's and configure script. The users do not need to run
148 * autogen.sh - just configure and on. They don't need autotools installed.
149 * This tarball also builds cleanly, has all the sources it needs to build
150 * included (that is sources for your application, not libraries it depends
151 * on like Elementary). It builds cleanly in a buildroot and does not
152 * contain any files that are temporarily generated like binaries and other
153 * build-generated files, so the tarball is clean, and no need to worry
154 * about cleaning up your tree before packaging.
160 * This cleans up all build files (binaries, objects etc.) from the tree.
166 * This cleans out all files from the build and from configure's output too.
169 make maintainer-clean
172 * This deletes all the files autogen.sh will produce so the tree is clean
173 * to be put into a revision-control system (like CVS, SVN or GIT for example).
175 * There is a more advanced way of making use of the quicklaunch infrastructure
176 * in Elementary (which will not be covered here due to its more advanced
179 * Now let's actually create an interactive "Hello World" gui that you can
180 * click the ok button to exit. It's more code because this now does something
181 * much more significant, but it's still very simple:
184 #include <Elementary.h>
187 on_done(void *data, Evas_Object *obj, void *event_info)
189 // quit the mainloop (elm_run function will return)
194 elm_main(int argc, char **argv)
196 Evas_Object *win, *bg, *box, *lab, *btn;
198 // new window - do the usual and give it a name (hello) and title (Hello)
199 win = elm_win_util_standard_add("hello", "Hello");
200 // when the user clicks "close" on a window there is a request to delete
201 evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
203 // add a box object - default is vertical. a box holds children in a row,
204 // either horizontally or vertically. nothing more.
205 box = elm_box_add(win);
206 // make the box hotizontal
207 elm_box_horizontal_set(box, EINA_TRUE);
208 // add object as a resize object for the window (controls window minimum
209 // size as well as gets resized if window is resized)
210 elm_win_resize_object_add(win, box);
211 evas_object_show(box);
213 // add a label widget, set the text and put it in the pad frame
214 lab = elm_label_add(win);
215 // set default text of the label
216 elm_object_text_set(lab, "Hello out there world!");
217 // pack the label at the end of the box
218 elm_box_pack_end(box, lab);
219 evas_object_show(lab);
222 btn = elm_button_add(win);
223 // set default text of button to "OK"
224 elm_object_text_set(btn, "OK");
225 // pack the button at the end of the box
226 elm_box_pack_end(box, btn);
227 evas_object_show(btn);
228 // call on_done when button is clicked
229 evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
231 // now we are done, show the window
232 evas_object_show(win);
234 // run the mainloop and process events and callbacks
244 @page authors Authors
245 @author Carsten Haitzler <raster@@rasterman.com>
246 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
247 @author Cedric Bail <cedric.bail@@free.fr>
248 @author Vincent Torri <vtorri@@univ-evry.fr>
249 @author Daniel Kolesa <quaker66@@gmail.com>
250 @author Jaime Thomas <avi.thomas@@gmail.com>
251 @author Swisscom - http://www.swisscom.ch/
252 @author Christopher Michael <devilhorns@@comcast.net>
253 @author Marco Trevisan (TreviƱo) <mail@@3v1n0.net>
254 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
255 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
256 @author Brian Wang <brian.wang.0721@@gmail.com>
257 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
258 @author Samsung Electronics <tbd>
259 @author Samsung SAIT <tbd>
260 @author Brett Nash <nash@@nash.id.au>
261 @author Bruno Dilly <bdilly@@profusion.mobi>
262 @author Rafael Fonseca <rfonseca@@profusion.mobi>
263 @author Chuneon Park <hermet@@hermet.pe.kr>
264 @author Woohyun Jung <wh0705.jung@@samsung.com>
265 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
266 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
267 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
268 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
269 @author Gustavo Lima Chaves <glima@@profusion.mobi>
270 @author Fabiano FidĆŖncio <fidencio@@profusion.mobi>
271 @author Tiago FalcĆ£o <tiago@@profusion.mobi>
272 @author Otavio Pontes <otavio@@profusion.mobi>
273 @author Viktor Kojouharov <vkojouharov@@gmail.com>
274 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
275 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
276 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
277 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
278 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
279 @author Jihoon Kim <jihoon48.kim@@samsung.com>
280 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
281 @author Tom Hacohen <tom@@stosb.com>
282 @author Aharon Hillel <a.hillel@@partner.samsung.com>
283 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
284 @author Shinwoo Kim <kimcinoo@@gmail.com>
285 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
286 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
287 @author Sung W. Park <sungwoo@gmail.com>
288 @author Thierry el Borgi <thierry@substantiel.fr>
289 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
290 @author Chanwook Jung <joey.jung@samsung.com>
291 @author Hyoyoung Chang <hyoyoung.chang@samsung.com>
292 @author Guillaume "Kuri" Friloux <guillaume.friloux@asp64.com>
293 @author Kim Yunhan <spbear@gmail.com>
295 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
296 contact with the developers and maintainers.
304 * @brief Elementary's API
309 @ELM_UNIX_DEF@ ELM_UNIX
310 @ELM_WIN32_DEF@ ELM_WIN32
311 @ELM_WINCE_DEF@ ELM_WINCE
312 @ELM_EDBUS_DEF@ ELM_EDBUS
313 @ELM_EFREET_DEF@ ELM_EFREET
314 @ELM_ETHUMB_DEF@ ELM_ETHUMB
315 @ELM_EMAP_DEF@ ELM_EMAP
316 @ELM_DEBUG_DEF@ ELM_DEBUG
317 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
318 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
320 /* Standard headers for standard system calls etc. */
325 #include <sys/types.h>
326 #include <sys/stat.h>
327 #include <sys/time.h>
328 #include <sys/param.h>
341 # ifdef ELM_LIBINTL_H
342 # include <libintl.h>
353 #if defined (ELM_WIN32) || defined (ELM_WINCE)
356 # define alloca _alloca
367 #include <Ecore_Evas.h>
368 #include <Ecore_File.h>
369 #include <Ecore_IMF.h>
378 # include <Efreet_Mime.h>
379 # include <Efreet_Trash.h>
383 # include <Ethumb_Client.h>
395 # ifdef ELEMENTARY_BUILD
397 # define EAPI __declspec(dllexport)
400 # endif /* ! DLL_EXPORT */
402 # define EAPI __declspec(dllimport)
403 # endif /* ! EFL_EVAS_BUILD */
407 # define EAPI __attribute__ ((visibility("default")))
414 #endif /* ! _WIN32 */
417 /* allow usage from c++ */
422 #define ELM_VERSION_MAJOR @VMAJ@
423 #define ELM_VERSION_MINOR @VMIN@
425 typedef struct _Elm_Version
433 EAPI extern Elm_Version *elm_version;
436 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
437 #define ELM_PI 3.14159265358979323846
440 * @defgroup General General
442 * @brief General Elementary API. Functions that don't relate to
443 * Elementary objects specifically.
445 * Here are documented functions which init/shutdown the library,
446 * that apply to generic Elementary objects, that deal with
447 * configuration, et cetera.
449 * @ref general_functions_example_page "This" example contemplates
450 * some of these functions.
454 * @addtogroup General
459 * Defines couple of standard Evas_Object layers to be used
460 * with evas_object_layer_set().
462 * @note whenever extending with new values, try to keep some padding
463 * to siblings so there is room for further extensions.
465 typedef enum _Elm_Object_Layer
467 ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
468 ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
469 ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
470 ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
471 ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
472 ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
475 /**************************************************************************/
476 EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
479 * Emitted when any Elementary's policy value is changed.
481 EAPI extern int ELM_EVENT_POLICY_CHANGED;
484 * @typedef Elm_Event_Policy_Changed
486 * Data on the event when an Elementary policy has changed
488 typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
491 * @struct _Elm_Event_Policy_Changed
493 * Data on the event when an Elementary policy has changed
495 struct _Elm_Event_Policy_Changed
497 unsigned int policy; /**< the policy identifier */
498 int new_value; /**< value the policy had before the change */
499 int old_value; /**< new value the policy got */
503 * Policy identifiers.
505 typedef enum _Elm_Policy
507 ELM_POLICY_QUIT, /**< under which circumstances the application
508 * should quit automatically. @see
512 } Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set()
515 typedef enum _Elm_Policy_Quit
517 ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
519 ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
521 * window is closed */
522 } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
524 typedef enum _Elm_Focus_Direction
528 } Elm_Focus_Direction;
530 typedef enum _Elm_Text_Format
532 ELM_TEXT_FORMAT_PLAIN_UTF8,
533 ELM_TEXT_FORMAT_MARKUP_UTF8
537 * Line wrapping types.
539 typedef enum _Elm_Wrap_Type
541 ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
542 ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
543 ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
544 ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
550 ELM_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
551 ELM_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
552 ELM_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
553 ELM_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
554 ELM_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
555 ELM_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
556 ELM_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
557 ELM_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
558 ELM_INPUT_PANEL_LAYOUT_INVALID
559 } Elm_Input_Panel_Layout;
563 ELM_AUTOCAPITAL_TYPE_NONE,
564 ELM_AUTOCAPITAL_TYPE_WORD,
565 ELM_AUTOCAPITAL_TYPE_SENTENCE,
566 ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
567 } Elm_Autocapital_Type;
570 * @typedef Elm_Object_Item
571 * An Elementary Object item handle.
574 typedef struct _Elm_Object_Item Elm_Object_Item;
578 * Called back when a widget's tooltip is activated and needs content.
579 * @param data user-data given to elm_object_tooltip_content_cb_set()
580 * @param obj owner widget.
582 typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj);
585 * Called back when a widget's item tooltip is activated and needs content.
586 * @param data user-data given to elm_object_tooltip_content_cb_set()
587 * @param obj owner widget.
588 * @param item context dependent item. As an example, if tooltip was
589 * set on Elm_List_Item, then it is of this type.
591 typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, void *item);
593 typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
595 #ifndef ELM_LIB_QUICKLAUNCH
596 #define ELM_MAIN() int main(int argc, char **argv) {elm_init(argc, argv); return elm_main(argc, argv);} /**< macro to be used after the elm_main() function */
598 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
601 /**************************************************************************/
605 * Initialize Elementary
607 * @param[in] argc System's argument count value
608 * @param[in] argv System's pointer to array of argument strings
609 * @return The init counter value.
611 * This function initializes Elementary and increments a counter of
612 * the number of calls to it. It returns the new counter's value.
614 * @warning This call is exported only for use by the @c ELM_MAIN()
615 * macro. There is no need to use this if you use this macro (which
616 * is highly advisable). An elm_main() should contain the entry
617 * point code for your application, having the same prototype as
618 * elm_init(), and @b not being static (putting the @c EAPI symbol
619 * in front of its type declaration is advisable). The @c
620 * ELM_MAIN() call should be placed just after it.
623 * @dontinclude bg_example_01.c
627 * See the full @ref bg_example_01_c "example".
629 * @see elm_shutdown().
632 EAPI int elm_init(int argc, char **argv);
635 * Shut down Elementary
637 * @return The init counter value.
639 * This should be called at the end of your application, just
640 * before it ceases to do any more processing. This will clean up
641 * any permanent resources your application may have allocated via
642 * Elementary that would otherwise persist.
644 * @see elm_init() for an example
648 EAPI int elm_shutdown(void);
651 * Run Elementary's main loop
653 * This call should be issued just after all initialization is
654 * completed. This function will not return until elm_exit() is
655 * called. It will keep looping, running the main
656 * (event/processing) loop for Elementary.
658 * @see elm_init() for an example
662 EAPI void elm_run(void);
665 * Exit Elementary's main loop
667 * If this call is issued, it will flag the main loop to cease
668 * processing and return back to its parent function (usually your
669 * elm_main() function).
671 * @see elm_init() for an example. There, just after a request to
672 * close the window comes, the main loop will be left.
674 * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
675 * applications, you'll be able to get this function called automatically for you.
679 EAPI void elm_exit(void);
682 * Provide information in order to make Elementary determine the @b
683 * run time location of the software in question, so other data files
684 * such as images, sound files, executable utilities, libraries,
685 * modules and locale files can be found.
687 * @param mainfunc This is your application's main function name,
688 * whose binary's location is to be found. Providing @c NULL
689 * will make Elementary not to use it
690 * @param dom This will be used as the application's "domain", in the
691 * form of a prefix to any environment variables that may
692 * override prefix detection and the directory name, inside the
693 * standard share or data directories, where the software's
694 * data files will be looked for.
695 * @param checkfile This is an (optional) magic file's path to check
696 * for existence (and it must be located in the data directory,
697 * under the share directory provided above). Its presence will
698 * help determine the prefix found was correct. Pass @c NULL if
699 * the check is not to be done.
701 * This function allows one to re-locate the application somewhere
702 * else after compilation, if the developer wishes for easier
703 * distribution of pre-compiled binaries.
705 * The prefix system is designed to locate where the given software is
706 * installed (under a common path prefix) at run time and then report
707 * specific locations of this prefix and common directories inside
708 * this prefix like the binary, library, data and locale directories,
709 * through the @c elm_app_*_get() family of functions.
711 * Call elm_app_info_set() early on before you change working
712 * directory or anything about @c argv[0], so it gets accurate
715 * It will then try and trace back which file @p mainfunc comes from,
716 * if provided, to determine the application's prefix directory.
718 * The @p dom parameter provides a string prefix to prepend before
719 * environment variables, allowing a fallback to @b specific
720 * environment variables to locate the software. You would most
721 * probably provide a lowercase string there, because it will also
722 * serve as directory domain, explained next. For environment
723 * variables purposes, this string is made uppercase. For example if
724 * @c "myapp" is provided as the prefix, then the program would expect
725 * @c "MYAPP_PREFIX" as a master environment variable to specify the
726 * exact install prefix for the software, or more specific environment
727 * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
728 * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
729 * the user or scripts before launching. If not provided (@c NULL),
730 * environment variables will not be used to override compiled-in
731 * defaults or auto detections.
733 * The @p dom string also provides a subdirectory inside the system
734 * shared data directory for data files. For example, if the system
735 * directory is @c /usr/local/share, then this directory name is
736 * appended, creating @c /usr/local/share/myapp, if it @p was @c
737 * "myapp". It is expected that the application installs data files in
740 * The @p checkfile is a file name or path of something inside the
741 * share or data directory to be used to test that the prefix
742 * detection worked. For example, your app will install a wallpaper
743 * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
744 * check that this worked, provide @c "images/wallpaper.jpg" as the @p
747 * @see elm_app_compile_bin_dir_set()
748 * @see elm_app_compile_lib_dir_set()
749 * @see elm_app_compile_data_dir_set()
750 * @see elm_app_compile_locale_set()
751 * @see elm_app_prefix_dir_get()
752 * @see elm_app_bin_dir_get()
753 * @see elm_app_lib_dir_get()
754 * @see elm_app_data_dir_get()
755 * @see elm_app_locale_dir_get()
757 EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
760 * Provide information on the @b fallback application's binaries
761 * directory, in scenarios where they get overriden by
762 * elm_app_info_set().
764 * @param dir The path to the default binaries directory (compile time
767 * @note Elementary will as well use this path to determine actual
768 * names of binaries' directory paths, maybe changing it to be @c
769 * something/local/bin instead of @c something/bin, only, for
772 * @warning You should call this function @b before
773 * elm_app_info_set().
775 EAPI void elm_app_compile_bin_dir_set(const char *dir);
778 * Provide information on the @b fallback application's libraries
779 * directory, on scenarios where they get overriden by
780 * elm_app_info_set().
782 * @param dir The path to the default libraries directory (compile
785 * @note Elementary will as well use this path to determine actual
786 * names of libraries' directory paths, maybe changing it to be @c
787 * something/lib32 or @c something/lib64 instead of @c something/lib,
790 * @warning You should call this function @b before
791 * elm_app_info_set().
793 EAPI void elm_app_compile_lib_dir_set(const char *dir);
796 * Provide information on the @b fallback application's data
797 * directory, on scenarios where they get overriden by
798 * elm_app_info_set().
800 * @param dir The path to the default data directory (compile time
803 * @note Elementary will as well use this path to determine actual
804 * names of data directory paths, maybe changing it to be @c
805 * something/local/share instead of @c something/share, only, for
808 * @warning You should call this function @b before
809 * elm_app_info_set().
811 EAPI void elm_app_compile_data_dir_set(const char *dir);
814 * Provide information on the @b fallback application's locale
815 * directory, on scenarios where they get overriden by
816 * elm_app_info_set().
818 * @param dir The path to the default locale directory (compile time
821 * @warning You should call this function @b before
822 * elm_app_info_set().
824 EAPI void elm_app_compile_locale_set(const char *dir);
827 * Retrieve the application's run time prefix directory, as set by
828 * elm_app_info_set() and the way (environment) the application was
831 * @return The directory prefix the application is actually using.
833 EAPI const char *elm_app_prefix_dir_get(void);
836 * Retrieve the application's run time binaries prefix directory, as
837 * set by elm_app_info_set() and the way (environment) the application
840 * @return The binaries directory prefix the application is actually
843 EAPI const char *elm_app_bin_dir_get(void);
846 * Retrieve the application's run time libraries prefix directory, as
847 * set by elm_app_info_set() and the way (environment) the application
850 * @return The libraries directory prefix the application is actually
853 EAPI const char *elm_app_lib_dir_get(void);
856 * Retrieve the application's run time data prefix directory, as
857 * set by elm_app_info_set() and the way (environment) the application
860 * @return The data directory prefix the application is actually
863 EAPI const char *elm_app_data_dir_get(void);
866 * Retrieve the application's run time locale prefix directory, as
867 * set by elm_app_info_set() and the way (environment) the application
870 * @return The locale directory prefix the application is actually
873 EAPI const char *elm_app_locale_dir_get(void);
875 EAPI void elm_quicklaunch_mode_set(Eina_Bool ql_on);
876 EAPI Eina_Bool elm_quicklaunch_mode_get(void);
877 EAPI int elm_quicklaunch_init(int argc, char **argv);
878 EAPI int elm_quicklaunch_sub_init(int argc, char **argv);
879 EAPI int elm_quicklaunch_sub_shutdown(void);
880 EAPI int elm_quicklaunch_shutdown(void);
881 EAPI void elm_quicklaunch_seed(void);
882 EAPI Eina_Bool elm_quicklaunch_prepare(int argc, char **argv);
883 EAPI Eina_Bool elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
884 EAPI void elm_quicklaunch_cleanup(void);
885 EAPI int elm_quicklaunch_fallback(int argc, char **argv);
886 EAPI char *elm_quicklaunch_exe_path_get(const char *exe);
888 EAPI Eina_Bool elm_need_efreet(void);
889 EAPI Eina_Bool elm_need_e_dbus(void);
890 EAPI Eina_Bool elm_need_ethumb(void);
893 * Set a new policy's value (for a given policy group/identifier).
895 * @param policy policy identifier, as in @ref Elm_Policy.
896 * @param value policy value, which depends on the identifier
898 * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
900 * Elementary policies define applications' behavior,
901 * somehow. These behaviors are divided in policy groups (see
902 * #Elm_Policy enumeration). This call will emit the Ecore event
903 * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
904 * handlers. An #Elm_Event_Policy_Changed struct will be passed,
907 * @note Currently, we have only one policy identifier/group
908 * (#ELM_POLICY_QUIT), which has two possible values.
912 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
915 * Gets the policy value for given policy identifier.
917 * @param policy policy identifier, as in #Elm_Policy.
918 * @return The currently set policy value, for that
919 * identifier. Will be @c 0 if @p policy passed is invalid.
923 EAPI int elm_policy_get(unsigned int policy);
926 * Change the language of the current application
928 * The @p lang passed must be the full name of the locale to use, for
929 * example "en_US.utf8" or "es_ES@euro".
931 * Changing language with this function will make Elementary run through
932 * all its widgets, translating strings set with
933 * elm_object_domain_translatable_text_part_set(). This way, an entire
934 * UI can have its language changed without having to restart the program.
936 * For more complex cases, like having formatted strings that need
937 * translation, widgets will also emit a "language,changed" signal that
938 * the user can listen to to manually translate the text.
940 * @param lang Language to set, must be the full name of the locale
944 EAPI void elm_language_set(const char *lang);
947 * Set a label of an object
949 * @param obj The Elementary object
950 * @param part The text part name to set (NULL for the default label)
951 * @param label The new text of the label
953 * @note Elementary objects may have many labels (e.g. Action Slider)
957 EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
959 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
962 * Get a label of an object
964 * @param obj The Elementary object
965 * @param part The text part name to get (NULL for the default label)
966 * @return text of the label or NULL for any error
968 * @note Elementary objects may have many labels (e.g. Action Slider)
972 EAPI const char *elm_object_text_part_get(const Evas_Object *obj, const char *part);
974 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
977 * Set a content of an object
979 * @param obj The Elementary object
980 * @param part The content part name to set (NULL for the default content)
981 * @param content The new content of the object
983 * @note Elementary objects may have many contents
987 EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
989 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
992 * Get a content of an object
994 * @param obj The Elementary object
995 * @param item The content part name to get (NULL for the default content)
996 * @return content of the object or NULL for any error
998 * @note Elementary objects may have many contents
1002 EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1004 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
1007 * Unset a content of an object
1009 * @param obj The Elementary object
1010 * @param item The content part name to unset (NULL for the default content)
1012 * @note Elementary objects may have many contents
1016 EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1018 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1021 * Set a content of an object item
1023 * @param it The Elementary object item
1024 * @param part The content part name to set (NULL for the default content)
1025 * @param content The new content of the object item
1027 * @note Elementary object items may have many contents
1031 EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1033 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1036 * Get a content of an object item
1038 * @param it The Elementary object item
1039 * @param part The content part name to unset (NULL for the default content)
1040 * @return content of the object item or NULL for any error
1042 * @note Elementary object items may have many contents
1046 EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1048 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1051 * Unset a content of an object item
1053 * @param it The Elementary object item
1054 * @param part The content part name to unset (NULL for the default content)
1056 * @note Elementary object items may have many contents
1060 EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1062 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1065 * Set a label of an object item
1067 * @param it The Elementary object item
1068 * @param part The text part name to set (NULL for the default label)
1069 * @param label The new text of the label
1071 * @note Elementary object items may have many labels
1075 EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1077 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1080 * Get a label of an object item
1082 * @param it The Elementary object item
1083 * @param part The text part name to get (NULL for the default label)
1084 * @return text of the label or NULL for any error
1086 * @note Elementary object items may have many labels
1090 EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1092 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1095 * Set the text to read out when in accessibility mode
1097 * @param obj The object which is to be described
1098 * @param txt The text that describes the widget to people with poor or no vision
1102 EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1105 * Set the text to read out when in accessibility mode
1107 * @param it The object item which is to be described
1108 * @param txt The text that describes the widget to people with poor or no vision
1112 EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1115 * Get the data associated with an object item
1116 * @param it The object item
1117 * @return The data associated with @p it
1121 EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1124 * Set the data associated with an object item
1125 * @param it The object item
1126 * @param data The data to be associated with @p it
1130 EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1133 * Send a signal to the edje object of the widget item.
1135 * This function sends a signal to the edje object of the obj item. An
1136 * edje program can respond to a signal by specifying matching
1137 * 'signal' and 'source' fields.
1139 * @param it The Elementary object item
1140 * @param emission The signal's name.
1141 * @param source The signal's source.
1144 EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1151 * @defgroup Caches Caches
1153 * These are functions which let one fine-tune some cache values for
1154 * Elementary applications, thus allowing for performance adjustments.
1160 * @brief Flush all caches.
1162 * Frees all data that was in cache and is not currently being used to reduce
1163 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1164 * to calling all of the following functions:
1165 * @li edje_file_cache_flush()
1166 * @li edje_collection_cache_flush()
1167 * @li eet_clearcache()
1168 * @li evas_image_cache_flush()
1169 * @li evas_font_cache_flush()
1170 * @li evas_render_dump()
1171 * @note Evas caches are flushed for every canvas associated with a window.
1175 EAPI void elm_all_flush(void);
1178 * Get the configured cache flush interval time
1180 * This gets the globally configured cache flush interval time, in
1183 * @return The cache flush interval time
1186 * @see elm_all_flush()
1188 EAPI int elm_cache_flush_interval_get(void);
1191 * Set the configured cache flush interval time
1193 * This sets the globally configured cache flush interval time, in ticks
1195 * @param size The cache flush interval time
1198 * @see elm_all_flush()
1200 EAPI void elm_cache_flush_interval_set(int size);
1203 * Set the configured cache flush interval time for all applications on the
1206 * This sets the globally configured cache flush interval time -- in ticks
1207 * -- for all applications on the display.
1209 * @param size The cache flush interval time
1212 EAPI void elm_cache_flush_interval_all_set(int size);
1215 * Get the configured cache flush enabled state
1217 * This gets the globally configured cache flush state - if it is enabled
1218 * or not. When cache flushing is enabled, elementary will regularly
1219 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1220 * memory and allow usage to re-seed caches and data in memory where it
1221 * can do so. An idle application will thus minimise its memory usage as
1222 * data will be freed from memory and not be re-loaded as it is idle and
1223 * not rendering or doing anything graphically right now.
1225 * @return The cache flush state
1228 * @see elm_all_flush()
1230 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
1233 * Set the configured cache flush enabled state
1235 * This sets the globally configured cache flush enabled state.
1237 * @param size The cache flush enabled state
1240 * @see elm_all_flush()
1242 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
1245 * Set the configured cache flush enabled state for all applications on the
1248 * This sets the globally configured cache flush enabled state for all
1249 * applications on the display.
1251 * @param size The cache flush enabled state
1254 EAPI void elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1257 * Get the configured font cache size
1259 * This gets the globally configured font cache size, in bytes.
1261 * @return The font cache size
1264 EAPI int elm_font_cache_get(void);
1267 * Set the configured font cache size
1269 * This sets the globally configured font cache size, in bytes
1271 * @param size The font cache size
1274 EAPI void elm_font_cache_set(int size);
1277 * Set the configured font cache size for all applications on the
1280 * This sets the globally configured font cache size -- in bytes
1281 * -- for all applications on the display.
1283 * @param size The font cache size
1286 EAPI void elm_font_cache_all_set(int size);
1289 * Get the configured image cache size
1291 * This gets the globally configured image cache size, in bytes
1293 * @return The image cache size
1296 EAPI int elm_image_cache_get(void);
1299 * Set the configured image cache size
1301 * This sets the globally configured image cache size, in bytes
1303 * @param size The image cache size
1306 EAPI void elm_image_cache_set(int size);
1309 * Set the configured image cache size for all applications on the
1312 * This sets the globally configured image cache size -- in bytes
1313 * -- for all applications on the display.
1315 * @param size The image cache size
1318 EAPI void elm_image_cache_all_set(int size);
1321 * Get the configured edje file cache size.
1323 * This gets the globally configured edje file cache size, in number
1326 * @return The edje file cache size
1329 EAPI int elm_edje_file_cache_get(void);
1332 * Set the configured edje file cache size
1334 * This sets the globally configured edje file cache size, in number
1337 * @param size The edje file cache size
1340 EAPI void elm_edje_file_cache_set(int size);
1343 * Set the configured edje file cache size for all applications on the
1346 * This sets the globally configured edje file cache size -- in number
1347 * of files -- for all applications on the display.
1349 * @param size The edje file cache size
1352 EAPI void elm_edje_file_cache_all_set(int size);
1355 * Get the configured edje collections (groups) cache size.
1357 * This gets the globally configured edje collections cache size, in
1358 * number of collections.
1360 * @return The edje collections cache size
1363 EAPI int elm_edje_collection_cache_get(void);
1366 * Set the configured edje collections (groups) cache size
1368 * This sets the globally configured edje collections cache size, in
1369 * number of collections.
1371 * @param size The edje collections cache size
1374 EAPI void elm_edje_collection_cache_set(int size);
1377 * Set the configured edje collections (groups) cache size for all
1378 * applications on the display
1380 * This sets the globally configured edje collections cache size -- in
1381 * number of collections -- for all applications on the display.
1383 * @param size The edje collections cache size
1386 EAPI void elm_edje_collection_cache_all_set(int size);
1393 * @defgroup Scaling Widget Scaling
1395 * Different widgets can be scaled independently. These functions
1396 * allow you to manipulate this scaling on a per-widget basis. The
1397 * object and all its children get their scaling factors multiplied
1398 * by the scale factor set. This is multiplicative, in that if a
1399 * child also has a scale size set it is in turn multiplied by its
1400 * parent's scale size. @c 1.0 means ādon't scaleā, @c 2.0 is
1401 * double size, @c 0.5 is half, etc.
1403 * @ref general_functions_example_page "This" example contemplates
1404 * some of these functions.
1408 * Set the scaling factor for a given Elementary object
1410 * @param obj The Elementary to operate on
1411 * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1416 EAPI void elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1419 * Get the scaling factor for a given Elementary object
1421 * @param obj The object
1422 * @return The scaling factor set by elm_object_scale_set()
1426 EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1429 * @defgroup Password_last_show Password last input show
1431 * Last show feature of password mode enables user to view
1432 * the last input entered for few seconds before masking it.
1433 * These functions allow to set this feature in password mode
1434 * of entry widget and also allow to manipulate the duration
1435 * for which the input has to be visible.
1441 * Get show last setting of password mode.
1443 * This gets the show last input setting of password mode which might be
1444 * enabled or disabled.
1446 * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1448 * @ingroup Password_last_show
1450 EAPI Eina_Bool elm_password_show_last_get(void);
1453 * Set show last setting in password mode.
1455 * This enables or disables show last setting of password mode.
1457 * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1458 * @see elm_password_show_last_timeout_set()
1459 * @ingroup Password_last_show
1461 EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1464 * Get's the timeout value in last show password mode.
1466 * This gets the time out value for which the last input entered in password
1467 * mode will be visible.
1469 * @return The timeout value of last show password mode.
1470 * @ingroup Password_last_show
1472 EAPI double elm_password_show_last_timeout_get(void);
1475 * Set's the timeout value in last show password mode.
1477 * This sets the time out value for which the last input entered in password
1478 * mode will be visible.
1480 * @param password_show_last_timeout The timeout value.
1481 * @see elm_password_show_last_set()
1482 * @ingroup Password_last_show
1484 EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1490 EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1491 EAPI void elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1492 EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1493 EAPI void elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1495 * Set the style to use by a widget
1497 * Sets the style name that will define the appearance of a widget. Styles
1498 * vary from widget to widget and may also be defined by other themes
1499 * by means of extensions and overlays.
1501 * @param obj The Elementary widget to style
1502 * @param style The style name to use
1504 * @see elm_theme_extension_add()
1505 * @see elm_theme_extension_del()
1506 * @see elm_theme_overlay_add()
1507 * @see elm_theme_overlay_del()
1511 EAPI void elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1513 * Get the style used by the widget
1515 * This gets the style being used for that widget. Note that the string
1516 * pointer is only valid as longas the object is valid and the style doesn't
1519 * @param obj The Elementary widget to query for its style
1520 * @return The style name used
1522 * @see elm_object_style_set()
1526 EAPI const char *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1529 * @defgroup Styles Styles
1531 * Widgets can have different styles of look. These generic API's
1532 * set styles of widgets, if they support them (and if the theme(s)
1535 * @ref general_functions_example_page "This" example contemplates
1536 * some of these functions.
1540 * Set the disabled state of an Elementary object.
1542 * @param obj The Elementary object to operate on
1543 * @param disabled The state to put in in: @c EINA_TRUE for
1544 * disabled, @c EINA_FALSE for enabled
1546 * Elementary objects can be @b disabled, in which state they won't
1547 * receive input and, in general, will be themed differently from
1548 * their normal state, usually greyed out. Useful for contexts
1549 * where you don't want your users to interact with some of the
1550 * parts of you interface.
1552 * This sets the state for the widget, either disabling it or
1557 EAPI void elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1560 * Get the disabled state of an Elementary object.
1562 * @param obj The Elementary object to operate on
1563 * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1564 * if it's enabled (or on errors)
1566 * This gets the state of the widget, which might be enabled or disabled.
1570 EAPI Eina_Bool elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1573 * @defgroup WidgetNavigation Widget Tree Navigation.
1575 * How to check if an Evas Object is an Elementary widget? How to
1576 * get the first elementary widget that is parent of the given
1577 * object? These are all covered in widget tree navigation.
1579 * @ref general_functions_example_page "This" example contemplates
1580 * some of these functions.
1584 * Check if the given Evas Object is an Elementary widget.
1586 * @param obj the object to query.
1587 * @return @c EINA_TRUE if it is an elementary widget variant,
1588 * @c EINA_FALSE otherwise
1589 * @ingroup WidgetNavigation
1591 EAPI Eina_Bool elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1594 * Get the first parent of the given object that is an Elementary
1597 * @param obj the Elementary object to query parent from.
1598 * @return the parent object that is an Elementary widget, or @c
1599 * NULL, if it was not found.
1601 * Use this to query for an object's parent widget.
1603 * @note Most of Elementary users wouldn't be mixing non-Elementary
1604 * smart objects in the objects tree of an application, as this is
1605 * an advanced usage of Elementary with Evas. So, except for the
1606 * application's window, which is the root of that tree, all other
1607 * objects would have valid Elementary widget parents.
1609 * @ingroup WidgetNavigation
1611 EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1612 EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1613 EAPI const char *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1615 EAPI double elm_scale_get(void);
1616 EAPI void elm_scale_set(double scale);
1617 EAPI void elm_scale_all_set(double scale);
1619 EAPI Eina_Bool elm_mirrored_get(void);
1620 EAPI void elm_mirrored_set(Eina_Bool mirrored);
1622 EAPI Eina_Bool elm_config_save(void);
1623 EAPI void elm_config_reload(void);
1625 EAPI const char *elm_profile_current_get(void);
1626 EAPI const char *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1627 EAPI void elm_profile_dir_free(const char *p_dir);
1628 EAPI Eina_List *elm_profile_list_get(void);
1629 EAPI void elm_profile_list_free(Eina_List *l);
1630 EAPI void elm_profile_set(const char *profile);
1631 EAPI void elm_profile_all_set(const char *profile);
1633 EAPI const char *elm_engine_current_get(void);
1634 EAPI void elm_engine_set(const char *engine);
1636 typedef struct _Elm_Text_Class
1642 typedef struct _Elm_Font_Overlay
1644 const char *text_class;
1646 Evas_Font_Size size;
1649 typedef struct _Elm_Font_Properties
1653 } Elm_Font_Properties;
1655 EAPI const Eina_List *elm_text_classes_list_get(void);
1656 EAPI void elm_text_classes_list_free(const Eina_List *list);
1658 EAPI const Eina_List *elm_font_overlay_list_get(void);
1659 EAPI void elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1660 EAPI void elm_font_overlay_unset(const char *text_class);
1661 EAPI void elm_font_overlay_apply(void);
1662 EAPI void elm_font_overlay_all_apply(void);
1664 EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
1665 EAPI void elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
1666 EAPI const char *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
1667 EAPI void elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
1668 EAPI Eina_Hash *elm_font_available_hash_add(Eina_List *list);
1669 EAPI void elm_font_available_hash_del(Eina_Hash *hash);
1672 * @defgroup Fingers Fingers
1674 * Elementary is designed to be finger-friendly for touchscreens,
1675 * and so in addition to scaling for display resolution, it can
1676 * also scale based on finger "resolution" (or size). You can then
1677 * customize the granularity of the areas meant to receive clicks
1680 * Different profiles may have pre-set values for finger sizes.
1682 * @ref general_functions_example_page "This" example contemplates
1683 * some of these functions.
1687 * Get the configured "finger size"
1689 * @return The finger size
1691 * This gets the globally configured finger size, <b>in pixels</b>
1695 EAPI Evas_Coord elm_finger_size_get(void);
1696 EAPI void elm_finger_size_set(Evas_Coord size);
1697 EAPI void elm_finger_size_all_set(Evas_Coord size);
1700 * @defgroup Focus Focus
1702 * An Elementary application has, at all times, one (and only one)
1703 * @b focused object. This is what determines where the input
1704 * events go to within the application's window. Also, focused
1705 * objects can be decorated differently, in order to signal to the
1706 * user where the input is, at a given moment.
1708 * Elementary applications also have the concept of <b>focus
1709 * chain</b>: one can cycle through all the windows' focusable
1710 * objects by input (tab key) or programmatically. The default
1711 * focus chain for an application is the one define by the order in
1712 * which the widgets where added in code. One will cycle through
1713 * top level widgets, and, for each one containg sub-objects, cycle
1714 * through them all, before returning to the level
1715 * above. Elementary also allows one to set @b custom focus chains
1716 * for their applications.
1718 * Besides the focused decoration a widget may exhibit, when it
1719 * gets focus, Elementary has a @b global focus highlight object
1720 * that can be enabled for a window. If one chooses to do so, this
1721 * extra highlight effect will surround the current focused object,
1724 * @note Some Elementary widgets are @b unfocusable, after
1725 * creation, by their very nature: they are not meant to be
1726 * interacted with input events, but are there just for visual
1729 * @ref general_functions_example_page "This" example contemplates
1730 * some of these functions.
1734 * Get the enable status of the focus highlight
1736 * This gets whether the highlight on focused objects is enabled or not
1739 EAPI Eina_Bool elm_focus_highlight_enabled_get(void);
1742 * Set the enable status of the focus highlight
1744 * Set whether to show or not the highlight on focused objects
1745 * @param enable Enable highlight if EINA_TRUE, disable otherwise
1748 EAPI void elm_focus_highlight_enabled_set(Eina_Bool enable);
1751 * Get the enable status of the highlight animation
1753 * Get whether the focus highlight, if enabled, will animate its switch from
1754 * one object to the next
1757 EAPI Eina_Bool elm_focus_highlight_animate_get(void);
1760 * Set the enable status of the highlight animation
1762 * Set whether the focus highlight, if enabled, will animate its switch from
1763 * one object to the next
1764 * @param animate Enable animation if EINA_TRUE, disable otherwise
1767 EAPI void elm_focus_highlight_animate_set(Eina_Bool animate);
1770 * Get the whether an Elementary object has the focus or not.
1772 * @param obj The Elementary object to get the information from
1773 * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
1774 * not (and on errors).
1776 * @see elm_object_focus()
1780 EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1783 * Make a given Elementary object the focused one.
1785 * @param obj The Elementary object to make focused.
1787 * @note This object, if it can handle focus, will take the focus
1788 * away from the one who had it previously and will, for now on, be
1789 * the one receiving input events.
1791 * @see elm_object_focus_get()
1795 EAPI void elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1798 * Remove the focus from an Elementary object
1800 * @param obj The Elementary to take focus from
1802 * This removes the focus from @p obj, passing it back to the
1803 * previous element in the focus chain list.
1805 * @see elm_object_focus() and elm_object_focus_custom_chain_get()
1809 EAPI void elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
1812 * Set the ability for an Element object to be focused
1814 * @param obj The Elementary object to operate on
1815 * @param enable @c EINA_TRUE if the object can be focused, @c
1816 * EINA_FALSE if not (and on errors)
1818 * This sets whether the object @p obj is able to take focus or
1819 * not. Unfocusable objects do nothing when programmatically
1820 * focused, being the nearest focusable parent object the one
1821 * really getting focus. Also, when they receive mouse input, they
1822 * will get the event, but not take away the focus from where it
1827 EAPI void elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
1830 * Get whether an Elementary object is focusable or not
1832 * @param obj The Elementary object to operate on
1833 * @return @c EINA_TRUE if the object is allowed to be focused, @c
1834 * EINA_FALSE if not (and on errors)
1836 * @note Objects which are meant to be interacted with by input
1837 * events are created able to be focused, by default. All the
1842 EAPI Eina_Bool elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1845 * Set custom focus chain.
1847 * This function overwrites any previous custom focus chain within
1848 * the list of objects. The previous list will be deleted and this list
1849 * will be managed by elementary. After it is set, don't modify it.
1851 * @note On focus cycle, only will be evaluated children of this container.
1853 * @param obj The container object
1854 * @param objs Chain of objects to pass focus
1857 EAPI void elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
1860 * Unset a custom focus chain on a given Elementary widget
1862 * @param obj The container object to remove focus chain from
1864 * Any focus chain previously set on @p obj (for its child objects)
1865 * is removed entirely after this call.
1869 EAPI void elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
1872 * Get custom focus chain
1874 * @param obj The container object
1877 EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1880 * Append object to custom focus chain.
1882 * @note If relative_child equal to NULL or not in custom chain, the object
1883 * will be added in end.
1885 * @note On focus cycle, only will be evaluated children of this container.
1887 * @param obj The container object
1888 * @param child The child to be added in custom chain
1889 * @param relative_child The relative object to position the child
1892 EAPI void elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1895 * Prepend object to custom focus chain.
1897 * @note If relative_child equal to NULL or not in custom chain, the object
1898 * will be added in begin.
1900 * @note On focus cycle, only will be evaluated children of this container.
1902 * @param obj The container object
1903 * @param child The child to be added in custom chain
1904 * @param relative_child The relative object to position the child
1907 EAPI void elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
1910 * Give focus to next object in object tree.
1912 * Give focus to next object in focus chain of one object sub-tree.
1913 * If the last object of chain already have focus, the focus will go to the
1914 * first object of chain.
1916 * @param obj The object root of sub-tree
1917 * @param dir Direction to cycle the focus
1921 EAPI void elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
1924 * Give focus to near object in one direction.
1926 * Give focus to near object in direction of one object.
1927 * If none focusable object in given direction, the focus will not change.
1929 * @param obj The reference object
1930 * @param x Horizontal component of direction to focus
1931 * @param y Vertical component of direction to focus
1935 EAPI void elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
1938 * Make the elementary object and its children to be unfocusable
1941 * @param obj The Elementary object to operate on
1942 * @param tree_unfocusable @c EINA_TRUE for unfocusable,
1943 * @c EINA_FALSE for focusable.
1945 * This sets whether the object @p obj and its children objects
1946 * are able to take focus or not. If the tree is set as unfocusable,
1947 * newest focused object which is not in this tree will get focus.
1948 * This API can be helpful for an object to be deleted.
1949 * When an object will be deleted soon, it and its children may not
1950 * want to get focus (by focus reverting or by other focus controls).
1951 * Then, just use this API before deleting.
1953 * @see elm_object_tree_unfocusable_get()
1957 EAPI void elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
1960 * Get whether an Elementary object and its children are unfocusable or not.
1962 * @param obj The Elementary object to get the information from
1963 * @return @c EINA_TRUE, if the tree is unfocussable,
1964 * @c EINA_FALSE if not (and on errors).
1966 * @see elm_object_tree_unfocusable_set()
1970 EAPI Eina_Bool elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
1972 EAPI Eina_Bool elm_scroll_bounce_enabled_get(void);
1973 EAPI void elm_scroll_bounce_enabled_set(Eina_Bool enabled);
1974 EAPI void elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
1975 EAPI double elm_scroll_bounce_friction_get(void);
1976 EAPI void elm_scroll_bounce_friction_set(double friction);
1977 EAPI void elm_scroll_bounce_friction_all_set(double friction);
1978 EAPI double elm_scroll_page_scroll_friction_get(void);
1979 EAPI void elm_scroll_page_scroll_friction_set(double friction);
1980 EAPI void elm_scroll_page_scroll_friction_all_set(double friction);
1981 EAPI double elm_scroll_bring_in_scroll_friction_get(void);
1982 EAPI void elm_scroll_bring_in_scroll_friction_set(double friction);
1983 EAPI void elm_scroll_bring_in_scroll_friction_all_set(double friction);
1984 EAPI double elm_scroll_zoom_friction_get(void);
1985 EAPI void elm_scroll_zoom_friction_set(double friction);
1986 EAPI void elm_scroll_zoom_friction_all_set(double friction);
1987 EAPI Eina_Bool elm_scroll_thumbscroll_enabled_get(void);
1988 EAPI void elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
1989 EAPI void elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
1990 EAPI unsigned int elm_scroll_thumbscroll_threshold_get(void);
1991 EAPI void elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
1992 EAPI void elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
1993 EAPI double elm_scroll_thumbscroll_momentum_threshold_get(void);
1994 EAPI void elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
1995 EAPI void elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
1996 EAPI double elm_scroll_thumbscroll_friction_get(void);
1997 EAPI void elm_scroll_thumbscroll_friction_set(double friction);
1998 EAPI void elm_scroll_thumbscroll_friction_all_set(double friction);
1999 EAPI double elm_scroll_thumbscroll_border_friction_get(void);
2000 EAPI void elm_scroll_thumbscroll_border_friction_set(double friction);
2001 EAPI void elm_scroll_thumbscroll_border_friction_all_set(double friction);
2004 * Get the sensitivity amount which is be multiplied by the length of
2007 * @return the thumb scroll sensitivity friction
2009 * @ingroup Scrolling
2011 EAPI double elm_scroll_thumbscroll_sensitivity_friction_get(void);
2014 * Set the sensitivity amount which is be multiplied by the length of
2017 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2018 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2021 * @see elm_thumbscroll_sensitivity_friction_get()
2022 * @note parameter value will get bound to 0.1 - 1.0 interval, always
2024 * @ingroup Scrolling
2026 EAPI void elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
2029 * Set the sensitivity amount which is be multiplied by the length of
2030 * mouse dragging, for all Elementary application windows.
2032 * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2033 * minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2036 * @see elm_thumbscroll_sensitivity_friction_get()
2037 * @note parameter value will get bound to 0.1 - 1.0 interval, always
2039 * @ingroup Scrolling
2041 EAPI void elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
2047 EAPI void elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2048 EAPI void elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2049 EAPI void elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2050 EAPI void elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2051 EAPI void elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2052 EAPI void elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2053 EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2054 EAPI Eina_Bool elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2056 EAPI void elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2057 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);
2058 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);
2060 EAPI void elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
2061 EAPI void *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
2064 * Adjust size of an element for finger usage.
2066 * @param times_w How many fingers should fit horizontally
2067 * @param w Pointer to the width size to adjust
2068 * @param times_h How many fingers should fit vertically
2069 * @param h Pointer to the height size to adjust
2071 * This takes width and height sizes (in pixels) as input and a
2072 * size multiple (which is how many fingers you want to place
2073 * within the area, being "finger" the size set by
2074 * elm_finger_size_set()), and adjusts the size to be large enough
2075 * to accommodate the resulting size -- if it doesn't already
2076 * accommodate it. On return the @p w and @p h sizes pointed to by
2077 * these parameters will be modified, on those conditions.
2079 * @note This is kind of a low level Elementary call, most useful
2080 * on size evaluation times for widgets. An external user wouldn't
2081 * be calling, most of the time.
2085 EAPI void elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
2087 EAPI double elm_longpress_timeout_get(void);
2088 EAPI void elm_longpress_timeout_set(double longpress_timeout);
2091 * don't use it unless you are sure
2093 EAPI void elm_object_tree_dump(const Evas_Object *top);
2094 EAPI void elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
2096 EAPI void elm_autocapitalization_allow_all_set(Eina_Bool autocap);
2097 EAPI void elm_autoperiod_allow_all_set(Eina_Bool autoperiod);
2102 * @defgroup Theme Theme
2104 * Elementary uses Edje to theme its widgets, naturally. But for the most
2105 * part this is hidden behind a simpler interface that lets the user set
2106 * extensions and choose the style of widgets in a much easier way.
2108 * Instead of thinking in terms of paths to Edje files and their groups
2109 * each time you want to change the appearance of a widget, Elementary
2110 * works so you can add any theme file with extensions or replace the
2111 * main theme at one point in the application, and then just set the style
2112 * of widgets with elm_object_style_set() and related functions. Elementary
2113 * will then look in its list of themes for a matching group and apply it,
2114 * and when the theme changes midway through the application, all widgets
2115 * will be updated accordingly.
2117 * There are three concepts you need to know to understand how Elementary
2118 * theming works: default theme, extensions and overlays.
2120 * Default theme, obviously enough, is the one that provides the default
2121 * look of all widgets. End users can change the theme used by Elementary
2122 * by setting the @c ELM_THEME environment variable before running an
2123 * application, or globally for all programs using the @c elementary_config
2124 * utility. Applications can change the default theme using elm_theme_set(),
2125 * but this can go against the user wishes, so it's not an adviced practice.
2127 * Ideally, applications should find everything they need in the already
2128 * provided theme, but there may be occasions when that's not enough and
2129 * custom styles are required to correctly express the idea. For this
2130 * cases, Elementary has extensions.
2132 * Extensions allow the application developer to write styles of its own
2133 * to apply to some widgets. This requires knowledge of how each widget
2134 * is themed, as extensions will always replace the entire group used by
2135 * the widget, so important signals and parts need to be there for the
2136 * object to behave properly (see documentation of Edje for details).
2137 * Once the theme for the extension is done, the application needs to add
2138 * it to the list of themes Elementary will look into, using
2139 * elm_theme_extension_add(), and set the style of the desired widgets as
2140 * he would normally with elm_object_style_set().
2142 * Overlays, on the other hand, can replace the look of all widgets by
2143 * overriding the default style. Like extensions, it's up to the application
2144 * developer to write the theme for the widgets it wants, the difference
2145 * being that when looking for the theme, Elementary will check first the
2146 * list of overlays, then the set theme and lastly the list of extensions,
2147 * so with overlays it's possible to replace the default view and every
2148 * widget will be affected. This is very much alike to setting the whole
2149 * theme for the application and will probably clash with the end user
2150 * options, not to mention the risk of ending up with not matching styles
2151 * across the program. Unless there's a very special reason to use them,
2152 * overlays should be avoided for the resons exposed before.
2154 * All these theme lists are handled by ::Elm_Theme instances. Elementary
2155 * keeps one default internally and every function that receives one of
2156 * these can be called with NULL to refer to this default (except for
2157 * elm_theme_free()). It's possible to create a new instance of a
2158 * ::Elm_Theme to set other theme for a specific widget (and all of its
2159 * children), but this is as discouraged, if not even more so, than using
2160 * overlays. Don't use this unless you really know what you are doing.
2162 * But to be less negative about things, you can look at the following
2164 * @li @ref theme_example_01 "Using extensions"
2165 * @li @ref theme_example_02 "Using overlays"
2170 * @typedef Elm_Theme
2172 * Opaque handler for the list of themes Elementary looks for when
2173 * rendering widgets.
2175 * Stay out of this unless you really know what you are doing. For most
2176 * cases, sticking to the default is all a developer needs.
2178 typedef struct _Elm_Theme Elm_Theme;
2181 * Create a new specific theme
2183 * This creates an empty specific theme that only uses the default theme. A
2184 * specific theme has its own private set of extensions and overlays too
2185 * (which are empty by default). Specific themes do not fall back to themes
2186 * of parent objects. They are not intended for this use. Use styles, overlays
2187 * and extensions when needed, but avoid specific themes unless there is no
2188 * other way (example: you want to have a preview of a new theme you are
2189 * selecting in a "theme selector" window. The preview is inside a scroller
2190 * and should display what the theme you selected will look like, but not
2191 * actually apply it yet. The child of the scroller will have a specific
2192 * theme set to show this preview before the user decides to apply it to all
2195 EAPI Elm_Theme *elm_theme_new(void);
2197 * Free a specific theme
2199 * @param th The theme to free
2201 * This frees a theme created with elm_theme_new().
2203 EAPI void elm_theme_free(Elm_Theme *th);
2205 * Copy the theme fom the source to the destination theme
2207 * @param th The source theme to copy from
2208 * @param thdst The destination theme to copy data to
2210 * This makes a one-time static copy of all the theme config, extensions
2211 * and overlays from @p th to @p thdst. If @p th references a theme, then
2212 * @p thdst is also set to reference it, with all the theme settings,
2213 * overlays and extensions that @p th had.
2215 EAPI void elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
2217 * Tell the source theme to reference the ref theme
2219 * @param th The theme that will do the referencing
2220 * @param thref The theme that is the reference source
2222 * This clears @p th to be empty and then sets it to refer to @p thref
2223 * so @p th acts as an override to @p thref, but where its overrides
2224 * don't apply, it will fall through to @pthref for configuration.
2226 EAPI void elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
2228 * Return the theme referred to
2230 * @param th The theme to get the reference from
2231 * @return The referenced theme handle
2233 * This gets the theme set as the reference theme by elm_theme_ref_set().
2234 * If no theme is set as a reference, NULL is returned.
2236 EAPI Elm_Theme *elm_theme_ref_get(Elm_Theme *th);
2238 * Return the default theme
2240 * @return The default theme handle
2242 * This returns the internal default theme setup handle that all widgets
2243 * use implicitly unless a specific theme is set. This is also often use
2244 * as a shorthand of NULL.
2246 EAPI Elm_Theme *elm_theme_default_get(void);
2248 * Prepends a theme overlay to the list of overlays
2250 * @param th The theme to add to, or if NULL, the default theme
2251 * @param item The Edje file path to be used
2253 * Use this if your application needs to provide some custom overlay theme
2254 * (An Edje file that replaces some default styles of widgets) where adding
2255 * new styles, or changing system theme configuration is not possible. Do
2256 * NOT use this instead of a proper system theme configuration. Use proper
2257 * configuration files, profiles, environment variables etc. to set a theme
2258 * so that the theme can be altered by simple confiugration by a user. Using
2259 * this call to achieve that effect is abusing the API and will create lots
2262 * @see elm_theme_extension_add()
2264 EAPI void elm_theme_overlay_add(Elm_Theme *th, const char *item);
2266 * Delete a theme overlay from the list of overlays
2268 * @param th The theme to delete from, or if NULL, the default theme
2269 * @param item The name of the theme overlay
2271 * @see elm_theme_overlay_add()
2273 EAPI void elm_theme_overlay_del(Elm_Theme *th, const char *item);
2275 * Appends a theme extension to the list of extensions.
2277 * @param th The theme to add to, or if NULL, the default theme
2278 * @param item The Edje file path to be used
2280 * This is intended when an application needs more styles of widgets or new
2281 * widget themes that the default does not provide (or may not provide). The
2282 * application has "extended" usage by coming up with new custom style names
2283 * for widgets for specific uses, but as these are not "standard", they are
2284 * not guaranteed to be provided by a default theme. This means the
2285 * application is required to provide these extra elements itself in specific
2286 * Edje files. This call adds one of those Edje files to the theme search
2287 * path to be search after the default theme. The use of this call is
2288 * encouraged when default styles do not meet the needs of the application.
2289 * Use this call instead of elm_theme_overlay_add() for almost all cases.
2291 * @see elm_object_style_set()
2293 EAPI void elm_theme_extension_add(Elm_Theme *th, const char *item);
2295 * Deletes a theme extension from the list of extensions.
2297 * @param th The theme to delete from, or if NULL, the default theme
2298 * @param item The name of the theme extension
2300 * @see elm_theme_extension_add()
2302 EAPI void elm_theme_extension_del(Elm_Theme *th, const char *item);
2304 * Set the theme search order for the given theme
2306 * @param th The theme to set the search order, or if NULL, the default theme
2307 * @param theme Theme search string
2309 * This sets the search string for the theme in path-notation from first
2310 * theme to search, to last, delimited by the : character. Example:
2312 * "shiny:/path/to/file.edj:default"
2314 * See the ELM_THEME environment variable for more information.
2316 * @see elm_theme_get()
2317 * @see elm_theme_list_get()
2319 EAPI void elm_theme_set(Elm_Theme *th, const char *theme);
2321 * Return the theme search order
2323 * @param th The theme to get the search order, or if NULL, the default theme
2324 * @return The internal search order path
2326 * This function returns a colon separated string of theme elements as
2327 * returned by elm_theme_list_get().
2329 * @see elm_theme_set()
2330 * @see elm_theme_list_get()
2332 EAPI const char *elm_theme_get(Elm_Theme *th);
2334 * Return a list of theme elements to be used in a theme.
2336 * @param th Theme to get the list of theme elements from.
2337 * @return The internal list of theme elements
2339 * This returns the internal list of theme elements (will only be valid as
2340 * long as the theme is not modified by elm_theme_set() or theme is not
2341 * freed by elm_theme_free(). This is a list of strings which must not be
2342 * altered as they are also internal. If @p th is NULL, then the default
2343 * theme element list is returned.
2345 * A theme element can consist of a full or relative path to a .edj file,
2346 * or a name, without extension, for a theme to be searched in the known
2347 * theme paths for Elemementary.
2349 * @see elm_theme_set()
2350 * @see elm_theme_get()
2352 EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
2354 * Return the full patrh for a theme element
2356 * @param f The theme element name
2357 * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
2358 * @return The full path to the file found.
2360 * This returns a string you should free with free() on success, NULL on
2361 * failure. This will search for the given theme element, and if it is a
2362 * full or relative path element or a simple searchable name. The returned
2363 * path is the full path to the file, if searched, and the file exists, or it
2364 * is simply the full path given in the element or a resolved path if
2365 * relative to home. The @p in_search_path boolean pointed to is set to
2366 * EINA_TRUE if the file was a searchable file andis in the search path,
2367 * and EINA_FALSE otherwise.
2369 EAPI char *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
2371 * Flush the current theme.
2373 * @param th Theme to flush
2375 * This flushes caches that let elementary know where to find theme elements
2376 * in the given theme. If @p th is NULL, then the default theme is flushed.
2377 * Call this function if source theme data has changed in such a way as to
2378 * make any caches Elementary kept invalid.
2380 EAPI void elm_theme_flush(Elm_Theme *th);
2382 * This flushes all themes (default and specific ones).
2384 * This will flush all themes in the current application context, by calling
2385 * elm_theme_flush() on each of them.
2387 EAPI void elm_theme_full_flush(void);
2389 * Set the theme for all elementary using applications on the current display
2391 * @param theme The name of the theme to use. Format same as the ELM_THEME
2392 * environment variable.
2394 EAPI void elm_theme_all_set(const char *theme);
2396 * Return a list of theme elements in the theme search path
2398 * @return A list of strings that are the theme element names.
2400 * This lists all available theme files in the standard Elementary search path
2401 * for theme elements, and returns them in alphabetical order as theme
2402 * element names in a list of strings. Free this with
2403 * elm_theme_name_available_list_free() when you are done with the list.
2405 EAPI Eina_List *elm_theme_name_available_list_new(void);
2407 * Free the list returned by elm_theme_name_available_list_new()
2409 * This frees the list of themes returned by
2410 * elm_theme_name_available_list_new(). Once freed the list should no longer
2411 * be used. a new list mys be created.
2413 EAPI void elm_theme_name_available_list_free(Eina_List *list);
2415 * Set a specific theme to be used for this object and its children
2417 * @param obj The object to set the theme on
2418 * @param th The theme to set
2420 * This sets a specific theme that will be used for the given object and any
2421 * child objects it has. If @p th is NULL then the theme to be used is
2422 * cleared and the object will inherit its theme from its parent (which
2423 * ultimately will use the default theme if no specific themes are set).
2425 * Use special themes with great care as this will annoy users and make
2426 * configuration difficult. Avoid any custom themes at all if it can be
2429 EAPI void elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
2431 * Get the specific theme to be used
2433 * @param obj The object to get the specific theme from
2434 * @return The specifc theme set.
2436 * This will return a specific theme set, or NULL if no specific theme is
2437 * set on that object. It will not return inherited themes from parents, only
2438 * the specific theme set for that specific object. See elm_object_theme_set()
2439 * for more information.
2441 EAPI Elm_Theme *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2447 typedef enum _Elm_Win_Type
2450 ELM_WIN_DIALOG_BASIC,
2457 ELM_WIN_DROPDOWN_MENU,
2460 ELM_WIN_NOTIFICATION,
2463 ELM_WIN_INLINED_IMAGE,
2466 typedef enum _Elm_Win_Keyboard_Mode
2468 ELM_WIN_KEYBOARD_UNKNOWN,
2469 ELM_WIN_KEYBOARD_OFF,
2470 ELM_WIN_KEYBOARD_ON,
2471 ELM_WIN_KEYBOARD_ALPHA,
2472 ELM_WIN_KEYBOARD_NUMERIC,
2473 ELM_WIN_KEYBOARD_PIN,
2474 ELM_WIN_KEYBOARD_PHONE_NUMBER,
2475 ELM_WIN_KEYBOARD_HEX,
2476 ELM_WIN_KEYBOARD_TERMINAL,
2477 ELM_WIN_KEYBOARD_PASSWORD,
2478 ELM_WIN_KEYBOARD_IP,
2479 ELM_WIN_KEYBOARD_HOST,
2480 ELM_WIN_KEYBOARD_FILE,
2481 ELM_WIN_KEYBOARD_URL,
2482 ELM_WIN_KEYBOARD_KEYPAD,
2483 ELM_WIN_KEYBOARD_J2ME
2484 } Elm_Win_Keyboard_Mode;
2486 typedef enum _Elm_Illume_Command
2488 ELM_ILLUME_COMMAND_FOCUS_BACK,
2489 ELM_ILLUME_COMMAND_FOCUS_FORWARD,
2490 ELM_ILLUME_COMMAND_FOCUS_HOME,
2491 ELM_ILLUME_COMMAND_CLOSE
2492 } Elm_Illume_Command;
2494 EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
2495 EAPI void elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2496 EAPI void elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
2497 EAPI void elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
2498 EAPI const char *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2499 EAPI void elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
2500 EAPI Eina_Bool elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2501 EAPI void elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
2502 EAPI void elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
2503 EAPI void elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
2504 EAPI void elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
2505 EAPI Eina_Bool elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2506 EAPI void elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
2507 EAPI Eina_Bool elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2508 EAPI void elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
2509 EAPI Eina_Bool elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2510 EAPI void elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
2511 EAPI Eina_Bool elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2512 EAPI void elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
2513 EAPI Eina_Bool elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2514 EAPI void elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
2515 EAPI Eina_Bool elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2516 EAPI void elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
2517 EAPI Eina_Bool elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2518 EAPI void elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
2519 EAPI Eina_Bool elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2520 EAPI void elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
2521 EAPI int elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2522 EAPI void elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
2523 EAPI void elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
2524 EAPI int elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2525 EAPI void elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
2526 EAPI Eina_Bool elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2527 EAPI void elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
2528 EAPI Eina_Bool elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2529 EAPI void elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
2530 EAPI Eina_Bool elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2531 EAPI void elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
2532 EAPI int elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2533 EAPI void elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
2534 EAPI int elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2535 EAPI void elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
2536 EAPI int elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2537 EAPI void elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
2538 EAPI void elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
2539 EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
2540 EAPI void elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
2541 EAPI Eina_Bool elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2542 EAPI void elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
2543 EAPI const char *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2544 EAPI void elm_win_indicator_state_set(Evas_Object *obj, int show_state);
2545 EAPI int elm_win_indicator_state_get(Evas_Object *obj);
2547 * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
2548 * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
2549 * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
2550 * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
2551 * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
2552 * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
2553 * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
2555 * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
2556 * (blank mouse, private mouse obj, defaultmouse)
2559 EAPI void elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
2560 EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2561 EAPI void elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
2562 EAPI Eina_Bool elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2564 EAPI void elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
2566 EAPI Evas_Object *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
2567 EAPI void elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
2568 EAPI void elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
2569 EAPI Evas_Object *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2570 EAPI Evas_Object *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2571 /* available styles:
2576 /* X specific calls - won't work on non-x engines (return 0) */
2577 EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2578 /* smart callbacks called:
2579 * "delete,request" - the user requested to delete the window
2580 * "focus,in" - window got focus
2581 * "focus,out" - window lost focus
2582 * "moved" - window that holds the canvas was moved
2588 * @brief Background object, used for setting a solid color, image or Edje
2589 * group as background to a window or any container object.
2591 * The bg object is used for setting a solid background to a window or
2592 * packing into any container object. It works just like an image, but has
2593 * some properties useful to a background, like setting it to tiled,
2594 * centered, scaled or stretched.
2596 * Here is some sample code using it:
2597 * @li @ref bg_01_example_page
2598 * @li @ref bg_02_example_page
2599 * @li @ref bg_03_example_page
2603 typedef enum _Elm_Bg_Option
2605 ELM_BG_OPTION_CENTER, /**< center the background */
2606 ELM_BG_OPTION_SCALE, /**< scale the background retaining aspect ratio */
2607 ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
2608 ELM_BG_OPTION_TILE /**< tile background at its original size */
2612 * Add a new background to the parent
2614 * @param parent The parent object
2615 * @return The new object or NULL if it cannot be created
2619 EAPI Evas_Object *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2622 * Set the file (image or edje) used for the background
2624 * @param obj The bg object
2625 * @param file The file path
2626 * @param group Optional key (group in Edje) within the file
2628 * This sets the image file used in the background object. The image (or edje)
2629 * will be stretched (retaining aspect if its an image file) to completely fill
2630 * the bg object. This may mean some parts are not visible.
2632 * @note Once the image of @p obj is set, a previously set one will be deleted,
2633 * even if @p file is NULL.
2637 EAPI void elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
2640 * Get the file (image or edje) used for the background
2642 * @param obj The bg object
2643 * @param file The file path
2644 * @param group Optional key (group in Edje) within the file
2648 EAPI void elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2651 * Set the option used for the background image
2653 * @param obj The bg object
2654 * @param option The desired background option (TILE, SCALE)
2656 * This sets the option used for manipulating the display of the background
2657 * image. The image can be tiled or scaled.
2661 EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
2664 * Get the option used for the background image
2666 * @param obj The bg object
2667 * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
2671 EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2673 * Set the option used for the background color
2675 * @param obj The bg object
2680 * This sets the color used for the background rectangle. Its range goes
2685 EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
2687 * Get the option used for the background color
2689 * @param obj The bg object
2696 EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
2699 * Set the overlay object used for the background object.
2701 * @param obj The bg object
2702 * @param overlay The overlay object
2704 * This provides a way for elm_bg to have an 'overlay' that will be on top
2705 * of the bg. Once the over object is set, a previously set one will be
2706 * deleted, even if you set the new one to NULL. If you want to keep that
2707 * old content object, use the elm_bg_overlay_unset() function.
2712 EAPI void elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
2715 * Get the overlay object used for the background object.
2717 * @param obj The bg object
2718 * @return The content that is being used
2720 * Return the content object which is set for this widget
2724 EAPI Evas_Object *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2727 * Get the overlay object used for the background object.
2729 * @param obj The bg object
2730 * @return The content that was being used
2732 * Unparent and return the overlay object which was set for this widget
2736 EAPI Evas_Object *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2739 * Set the size of the pixmap representation of the image.
2741 * This option just makes sense if an image is going to be set in the bg.
2743 * @param obj The bg object
2744 * @param w The new width of the image pixmap representation.
2745 * @param h The new height of the image pixmap representation.
2747 * This function sets a new size for pixmap representation of the given bg
2748 * image. It allows the image to be loaded already in the specified size,
2749 * reducing the memory usage and load time when loading a big image with load
2750 * size set to a smaller size.
2752 * NOTE: this is just a hint, the real size of the pixmap may differ
2753 * depending on the type of image being loaded, being bigger than requested.
2757 EAPI void elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
2758 /* smart callbacks called:
2762 typedef enum _Elm_Icon_Lookup_Order
2764 ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
2765 ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
2766 ELM_ICON_LOOKUP_FDO, /**< icon look up order: freedesktop */
2767 ELM_ICON_LOOKUP_THEME /**< icon look up order: theme */
2768 } Elm_Icon_Lookup_Order;
2770 EAPI Evas_Object *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2771 EAPI Eina_Bool elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2772 EAPI void elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2773 EAPI void elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2774 EAPI Eina_Bool elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
2775 EAPI const char *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2776 EAPI void elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2777 EAPI Eina_Bool elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2778 EAPI void elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
2779 EAPI Eina_Bool elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2780 EAPI void elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
2781 EAPI void elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
2782 EAPI void elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
2783 EAPI Eina_Bool elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2784 EAPI void elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
2785 EAPI int elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2786 EAPI void elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
2787 EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2788 EAPI Eina_Bool elm_icon_anim_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2789 EAPI void elm_icon_anim_set(Evas_Object *obj, Eina_Bool anim) EINA_ARG_NONNULL(1);
2790 EAPI Eina_Bool elm_icon_anim_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2791 EAPI void elm_icon_anim_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
2792 EAPI Eina_Bool elm_icon_anim_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2794 /* smart callbacks called:
2795 * "clicked" - the user clicked the icon
2799 typedef enum _Elm_Image_Orient
2801 ELM_IMAGE_ORIENT_NONE,
2802 ELM_IMAGE_ROTATE_90_CW,
2803 ELM_IMAGE_ROTATE_180_CW,
2804 ELM_IMAGE_ROTATE_90_CCW,
2805 ELM_IMAGE_FLIP_HORIZONTAL,
2806 ELM_IMAGE_FLIP_VERTICAL,
2807 ELM_IMAGE_FLIP_TRANSPOSE,
2808 ELM_IMAGE_FLIP_TRANSVERSE
2810 EAPI Evas_Object *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2811 EAPI Eina_Bool elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
2812 EAPI void elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
2813 EAPI void elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
2814 EAPI Eina_Bool elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2815 EAPI void elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
2816 EAPI void elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
2817 EAPI Eina_Bool elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2818 EAPI void elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
2819 EAPI void elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
2820 EAPI void elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
2821 EAPI Eina_Bool elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2822 EAPI void elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
2823 EAPI int elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2824 EAPI void elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
2825 EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2826 EAPI void elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
2827 EAPI Eina_Bool elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2828 EAPI Evas_Object *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2829 EAPI void elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
2830 EAPI Eina_Bool elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2832 /* smart callbacks called:
2833 * "clicked" - the user clicked the image
2837 typedef void (*Elm_GLView_Func)(Evas_Object *obj);
2839 typedef enum _Elm_GLView_Mode
2841 ELM_GLVIEW_ALPHA = 1,
2842 ELM_GLVIEW_DEPTH = 2,
2843 ELM_GLVIEW_STENCIL = 4
2847 * Defines a policy for the glview resizing.
2849 * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
2851 typedef enum _Elm_GLView_Resize_Policy
2853 ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1, /**< Resize the internal surface along with the image */
2854 ELM_GLVIEW_RESIZE_POLICY_SCALE = 2 /**< Only reize the internal image and not the surface */
2855 } Elm_GLView_Resize_Policy;
2857 typedef enum _Elm_GLView_Render_Policy
2859 ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1, /**< Render only when there is a need for redrawing */
2860 ELM_GLVIEW_RENDER_POLICY_ALWAYS = 2 /**< Render always even when it is not visible */
2861 } Elm_GLView_Render_Policy;
2864 EAPI Evas_Object *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2865 EAPI void elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
2866 EAPI void elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
2867 EAPI Evas_GL_API *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2868 EAPI Eina_Bool elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
2869 EAPI Eina_Bool elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
2870 EAPI Eina_Bool elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
2871 EAPI void elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2872 EAPI void elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2873 EAPI void elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2874 EAPI void elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func func) EINA_ARG_NONNULL(1);
2875 EAPI void elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
2881 * A box arranges objects in a linear fashion, governed by a layout function
2882 * that defines the details of this arrangement.
2884 * By default, the box will use an internal function to set the layout to
2885 * a single row, either vertical or horizontal. This layout is affected
2886 * by a number of parameters, such as the homogeneous flag set by
2887 * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
2888 * elm_box_align_set() and the hints set to each object in the box.
2890 * For this default layout, it's possible to change the orientation with
2891 * elm_box_horizontal_set(). The box will start in the vertical orientation,
2892 * placing its elements ordered from top to bottom. When horizontal is set,
2893 * the order will go from left to right. If the box is set to be
2894 * homogeneous, every object in it will be assigned the same space, that
2895 * of the largest object. Padding can be used to set some spacing between
2896 * the cell given to each object. The alignment of the box, set with
2897 * elm_box_align_set(), determines how the bounding box of all the elements
2898 * will be placed within the space given to the box widget itself.
2900 * The size hints of each object also affect how they are placed and sized
2901 * within the box. evas_object_size_hint_min_set() will give the minimum
2902 * size the object can have, and the box will use it as the basis for all
2903 * latter calculations. Elementary widgets set their own minimum size as
2904 * needed, so there's rarely any need to use it manually.
2906 * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
2907 * used to tell whether the object will be allocated the minimum size it
2908 * needs or if the space given to it should be expanded. It's important
2909 * to realize that expanding the size given to the object is not the same
2910 * thing as resizing the object. It could very well end being a small
2911 * widget floating in a much larger empty space. If not set, the weight
2912 * for objects will normally be 0.0 for both axis, meaning the widget will
2913 * not be expanded. To take as much space possible, set the weight to
2914 * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
2916 * Besides how much space each object is allocated, it's possible to control
2917 * how the widget will be placed within that space using
2918 * evas_object_size_hint_align_set(). By default, this value will be 0.5
2919 * for both axis, meaning the object will be centered, but any value from
2920 * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
2921 * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
2922 * is -1.0, means the object will be resized to fill the entire space it
2925 * In addition, customized functions to define the layout can be set, which
2926 * allow the application developer to organize the objects within the box
2927 * in any number of ways.
2929 * The special elm_box_layout_transition() function can be used
2930 * to switch from one layout to another, animating the motion of the
2931 * children of the box.
2933 * @note Objects should not be added to box objects using _add() calls.
2935 * Some examples on how to use boxes follow:
2936 * @li @ref box_example_01
2937 * @li @ref box_example_02
2942 * @typedef Elm_Box_Transition
2944 * Opaque handler containing the parameters to perform an animated
2945 * transition of the layout the box uses.
2947 * @see elm_box_transition_new()
2948 * @see elm_box_layout_set()
2949 * @see elm_box_layout_transition()
2951 typedef struct _Elm_Box_Transition Elm_Box_Transition;
2954 * Add a new box to the parent
2956 * By default, the box will be in vertical mode and non-homogeneous.
2958 * @param parent The parent object
2959 * @return The new object or NULL if it cannot be created
2961 EAPI Evas_Object *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
2963 * Set the horizontal orientation
2965 * By default, box object arranges their contents vertically from top to
2967 * By calling this function with @p horizontal as EINA_TRUE, the box will
2968 * become horizontal, arranging contents from left to right.
2970 * @note This flag is ignored if a custom layout function is set.
2972 * @param obj The box object
2973 * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
2974 * EINA_FALSE = vertical)
2976 EAPI void elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
2978 * Get the horizontal orientation
2980 * @param obj The box object
2981 * @return EINA_TRUE if the box is set to horizintal mode, EINA_FALSE otherwise
2983 EAPI Eina_Bool elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2985 * Set the box to arrange its children homogeneously
2987 * If enabled, homogeneous layout makes all items the same size, according
2988 * to the size of the largest of its children.
2990 * @note This flag is ignored if a custom layout function is set.
2992 * @param obj The box object
2993 * @param homogeneous The homogeneous flag
2995 EAPI void elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
2997 * Get whether the box is using homogeneous mode or not
2999 * @param obj The box object
3000 * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
3002 EAPI Eina_Bool elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3003 EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
3004 EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3006 * Add an object to the beginning of the pack list
3008 * Pack @p subobj into the box @p obj, placing it first in the list of
3009 * children objects. The actual position the object will get on screen
3010 * depends on the layout used. If no custom layout is set, it will be at
3011 * the top or left, depending if the box is vertical or horizontal,
3014 * @param obj The box object
3015 * @param subobj The object to add to the box
3017 * @see elm_box_pack_end()
3018 * @see elm_box_pack_before()
3019 * @see elm_box_pack_after()
3020 * @see elm_box_unpack()
3021 * @see elm_box_unpack_all()
3022 * @see elm_box_clear()
3024 EAPI void elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3026 * Add an object at the end of the pack list
3028 * Pack @p subobj into the box @p obj, placing it last in the list of
3029 * children objects. The actual position the object will get on screen
3030 * depends on the layout used. If no custom layout is set, it will be at
3031 * the bottom or right, depending if the box is vertical or horizontal,
3034 * @param obj The box object
3035 * @param subobj The object to add to the box
3037 * @see elm_box_pack_start()
3038 * @see elm_box_pack_before()
3039 * @see elm_box_pack_after()
3040 * @see elm_box_unpack()
3041 * @see elm_box_unpack_all()
3042 * @see elm_box_clear()
3044 EAPI void elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3046 * Adds an object to the box before the indicated object
3048 * This will add the @p subobj to the box indicated before the object
3049 * indicated with @p before. If @p before is not already in the box, results
3050 * are undefined. Before means either to the left of the indicated object or
3051 * above it depending on orientation.
3053 * @param obj The box object
3054 * @param subobj The object to add to the box
3055 * @param before The object before which to add it
3057 * @see elm_box_pack_start()
3058 * @see elm_box_pack_end()
3059 * @see elm_box_pack_after()
3060 * @see elm_box_unpack()
3061 * @see elm_box_unpack_all()
3062 * @see elm_box_clear()
3064 EAPI void elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
3066 * Adds an object to the box after the indicated object
3068 * This will add the @p subobj to the box indicated after the object
3069 * indicated with @p after. If @p after is not already in the box, results
3070 * are undefined. After means either to the right of the indicated object or
3071 * below it depending on orientation.
3073 * @param obj The box object
3074 * @param subobj The object to add to the box
3075 * @param after The object after which to add it
3077 * @see elm_box_pack_start()
3078 * @see elm_box_pack_end()
3079 * @see elm_box_pack_before()
3080 * @see elm_box_unpack()
3081 * @see elm_box_unpack_all()
3082 * @see elm_box_clear()
3084 EAPI void elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
3086 * Clear the box of all children
3088 * Remove all the elements contained by the box, deleting the respective
3091 * @param obj The box object
3093 * @see elm_box_unpack()
3094 * @see elm_box_unpack_all()
3096 EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3100 * Remove the object given by @p subobj from the box @p obj without
3103 * @param obj The box object
3105 * @see elm_box_unpack_all()
3106 * @see elm_box_clear()
3108 EAPI void elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3110 * Remove all items from the box, without deleting them
3112 * Clear the box from all children, but don't delete the respective objects.
3113 * If no other references of the box children exist, the objects will never
3114 * be deleted, and thus the application will leak the memory. Make sure
3115 * when using this function that you hold a reference to all the objects
3116 * in the box @p obj.
3118 * @param obj The box object
3120 * @see elm_box_clear()
3121 * @see elm_box_unpack()
3123 EAPI void elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
3125 * Retrieve a list of the objects packed into the box
3127 * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
3128 * The order of the list corresponds to the packing order the box uses.
3130 * You must free this list with eina_list_free() once you are done with it.
3132 * @param obj The box object
3134 EAPI const Eina_List *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3136 * Set the space (padding) between the box's elements.
3138 * Extra space in pixels that will be added between a box child and its
3139 * neighbors after its containing cell has been calculated. This padding
3140 * is set for all elements in the box, besides any possible padding that
3141 * individual elements may have through their size hints.
3143 * @param obj The box object
3144 * @param horizontal The horizontal space between elements
3145 * @param vertical The vertical space between elements
3147 EAPI void elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
3149 * Get the space (padding) between the box's elements.
3151 * @param obj The box object
3152 * @param horizontal The horizontal space between elements
3153 * @param vertical The vertical space between elements
3155 * @see elm_box_padding_set()
3157 EAPI void elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
3159 * Set the alignment of the whole bouding box of contents.
3161 * Sets how the bounding box containing all the elements of the box, after
3162 * their sizes and position has been calculated, will be aligned within
3163 * the space given for the whole box widget.
3165 * @param obj The box object
3166 * @param horizontal The horizontal alignment of elements
3167 * @param vertical The vertical alignment of elements
3169 EAPI void elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
3171 * Get the alignment of the whole bouding box of contents.
3173 * @param obj The box object
3174 * @param horizontal The horizontal alignment of elements
3175 * @param vertical The vertical alignment of elements
3177 * @see elm_box_align_set()
3179 EAPI void elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
3182 * Set the layout defining function to be used by the box
3184 * Whenever anything changes that requires the box in @p obj to recalculate
3185 * the size and position of its elements, the function @p cb will be called
3186 * to determine what the layout of the children will be.
3188 * Once a custom function is set, everything about the children layout
3189 * is defined by it. The flags set by elm_box_horizontal_set() and
3190 * elm_box_homogeneous_set() no longer have any meaning, and the values
3191 * given by elm_box_padding_set() and elm_box_align_set() are up to this
3192 * layout function to decide if they are used and how. These last two
3193 * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
3194 * passed to @p cb. The @c Evas_Object the function receives is not the
3195 * Elementary widget, but the internal Evas Box it uses, so none of the
3196 * functions described here can be used on it.
3198 * Any of the layout functions in @c Evas can be used here, as well as the
3199 * special elm_box_layout_transition().
3201 * The final @p data argument received by @p cb is the same @p data passed
3202 * here, and the @p free_data function will be called to free it
3203 * whenever the box is destroyed or another layout function is set.
3205 * Setting @p cb to NULL will revert back to the default layout function.
3207 * @param obj The box object
3208 * @param cb The callback function used for layout
3209 * @param data Data that will be passed to layout function
3210 * @param free_data Function called to free @p data
3212 * @see elm_box_layout_transition()
3214 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);
3216 * Special layout function that animates the transition from one layout to another
3218 * Normally, when switching the layout function for a box, this will be
3219 * reflected immediately on screen on the next render, but it's also
3220 * possible to do this through an animated transition.
3222 * This is done by creating an ::Elm_Box_Transition and setting the box
3223 * layout to this function.
3227 * Elm_Box_Transition *t = elm_box_transition_new(1.0,
3228 * evas_object_box_layout_vertical, // start
3229 * NULL, // data for initial layout
3230 * NULL, // free function for initial data
3231 * evas_object_box_layout_horizontal, // end
3232 * NULL, // data for final layout
3233 * NULL, // free function for final data
3234 * anim_end, // will be called when animation ends
3235 * NULL); // data for anim_end function\
3236 * elm_box_layout_set(box, elm_box_layout_transition, t,
3237 * elm_box_transition_free);
3240 * @note This function can only be used with elm_box_layout_set(). Calling
3241 * it directly will not have the expected results.
3243 * @see elm_box_transition_new
3244 * @see elm_box_transition_free
3245 * @see elm_box_layout_set
3247 EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
3249 * Create a new ::Elm_Box_Transition to animate the switch of layouts
3251 * If you want to animate the change from one layout to another, you need
3252 * to set the layout function of the box to elm_box_layout_transition(),
3253 * passing as user data to it an instance of ::Elm_Box_Transition with the
3254 * necessary information to perform this animation. The free function to
3255 * set for the layout is elm_box_transition_free().
3257 * The parameters to create an ::Elm_Box_Transition sum up to how long
3258 * will it be, in seconds, a layout function to describe the initial point,
3259 * another for the final position of the children and one function to be
3260 * called when the whole animation ends. This last function is useful to
3261 * set the definitive layout for the box, usually the same as the end
3262 * layout for the animation, but could be used to start another transition.
3264 * @param start_layout The layout function that will be used to start the animation
3265 * @param start_layout_data The data to be passed the @p start_layout function
3266 * @param start_layout_free_data Function to free @p start_layout_data
3267 * @param end_layout The layout function that will be used to end the animation
3268 * @param end_layout_free_data The data to be passed the @p end_layout function
3269 * @param end_layout_free_data Function to free @p end_layout_data
3270 * @param transition_end_cb Callback function called when animation ends
3271 * @param transition_end_data Data to be passed to @p transition_end_cb
3272 * @return An instance of ::Elm_Box_Transition
3274 * @see elm_box_transition_new
3275 * @see elm_box_layout_transition
3277 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);
3279 * Free a Elm_Box_Transition instance created with elm_box_transition_new().
3281 * This function is mostly useful as the @c free_data parameter in
3282 * elm_box_layout_set() when elm_box_layout_transition().
3284 * @param data The Elm_Box_Transition instance to be freed.
3286 * @see elm_box_transition_new
3287 * @see elm_box_layout_transition
3289 EAPI void elm_box_transition_free(void *data);
3296 * @defgroup Button Button
3298 * @image html widget/button/preview-00.png
3299 * @image html widget/button/preview-01.png
3300 * @image html widget/button/preview-02.png
3302 * This is a push-button. Press it and run some function. It can contain
3303 * a simple label and icon object and it also has an autorepeat feature.
3305 * This widgets emits the following signals:
3306 * @li "clicked": the user clicked the button (press/release).
3307 * @li "repeated": the user pressed the button without releasing it.
3308 * @li "pressed": button was pressed.
3309 * @li "unpressed": button was released after being pressed.
3310 * In all three cases, the @c event parameter of the callback will be
3313 * Also, defined in the default theme, the button has the following styles
3315 * @li default: a normal button.
3316 * @li anchor: Like default, but the button fades away when the mouse is not
3317 * over it, leaving only the text or icon.
3318 * @li hoversel_vertical: Internally used by @ref Hoversel to give a
3319 * continuous look across its options.
3320 * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
3322 * Follow through a complete example @ref button_example_01 "here".
3328 UIControlStateDefault,
3329 UIControlStateHighlighted,
3330 UIControlStateDisabled,
3331 UIControlStateFocused,
3332 UIControlStateReserved
3336 * Add a new button to the parent's canvas
3338 * @param parent The parent object
3339 * @return The new object or NULL if it cannot be created
3341 EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3343 * Set the label used in the button
3345 * The passed @p label can be NULL to clean any existing text in it and
3346 * leave the button as an icon only object.
3348 * @param obj The button object
3349 * @param label The text will be written on the button
3350 * @deprecated use elm_object_text_set() instead.
3352 EINA_DEPRECATED EAPI void elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3354 * Get the label set for the button
3356 * The string returned is an internal pointer and should not be freed or
3357 * altered. It will also become invalid when the button is destroyed.
3358 * The string returned, if not NULL, is a stringshare, so if you need to
3359 * keep it around even after the button is destroyed, you can use
3360 * eina_stringshare_ref().
3362 * @param obj The button object
3363 * @return The text set to the label, or NULL if nothing is set
3364 * @deprecated use elm_object_text_set() instead.
3366 EINA_DEPRECATED EAPI const char *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3368 * Set the label for each state of button
3370 * The passed @p label can be NULL to clean any existing text in it and
3371 * leave the button as an icon only object for the state.
3373 * @param obj The button object
3374 * @param label The text will be written on the button
3375 * @param state The state of button
3379 EINA_DEPRECATED EAPI void elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlState state) EINA_ARG_NONNULL(1);
3381 * Get the label of button for each state
3383 * The string returned is an internal pointer and should not be freed or
3384 * altered. It will also become invalid when the button is destroyed.
3385 * The string returned, if not NULL, is a stringshare, so if you need to
3386 * keep it around even after the button is destroyed, you can use
3387 * eina_stringshare_ref().
3389 * @param obj The button object
3390 * @param state The state of button
3391 * @return The title of button for state
3395 EINA_DEPRECATED EAPI const char *elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) EINA_ARG_NONNULL(1);
3397 * Set the icon used for the button
3399 * Setting a new icon will delete any other that was previously set, making
3400 * any reference to them invalid. If you need to maintain the previous
3401 * object alive, unset it first with elm_button_icon_unset().
3403 * @param obj The button object
3404 * @param icon The icon object for the button
3406 EAPI void elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3408 * Get the icon used for the button
3410 * Return the icon object which is set for this widget. If the button is
3411 * destroyed or another icon is set, the returned object will be deleted
3412 * and any reference to it will be invalid.
3414 * @param obj The button object
3415 * @return The icon object that is being used
3417 * @see elm_button_icon_unset()
3419 EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3421 * Remove the icon set without deleting it and return the object
3423 * This function drops the reference the button holds of the icon object
3424 * and returns this last object. It is used in case you want to remove any
3425 * icon, or set another one, without deleting the actual object. The button
3426 * will be left without an icon set.
3428 * @param obj The button object
3429 * @return The icon object that was being used
3431 EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3433 * Turn on/off the autorepeat event generated when the button is kept pressed
3435 * When off, no autorepeat is performed and buttons emit a normal @c clicked
3436 * signal when they are clicked.
3438 * When on, keeping a button pressed will continuously emit a @c repeated
3439 * signal until the button is released. The time it takes until it starts
3440 * emitting the signal is given by
3441 * elm_button_autorepeat_initial_timeout_set(), and the time between each
3442 * new emission by elm_button_autorepeat_gap_timeout_set().
3444 * @param obj The button object
3445 * @param on A bool to turn on/off the event
3447 EAPI void elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
3449 * Get whether the autorepeat feature is enabled
3451 * @param obj The button object
3452 * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
3454 * @see elm_button_autorepeat_set()
3456 EAPI Eina_Bool elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3458 * Set the initial timeout before the autorepeat event is generated
3460 * Sets the timeout, in seconds, since the button is pressed until the
3461 * first @c repeated signal is emitted. If @p t is 0.0 or less, there
3462 * won't be any delay and the even will be fired the moment the button is
3465 * @param obj The button object
3466 * @param t Timeout in seconds
3468 * @see elm_button_autorepeat_set()
3469 * @see elm_button_autorepeat_gap_timeout_set()
3471 EAPI void elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
3473 * Get the initial timeout before the autorepeat event is generated
3475 * @param obj The button object
3476 * @return Timeout in seconds
3478 * @see elm_button_autorepeat_initial_timeout_set()
3480 EAPI double elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3482 * Set the interval between each generated autorepeat event
3484 * After the first @c repeated event is fired, all subsequent ones will
3485 * follow after a delay of @p t seconds for each.
3487 * @param obj The button object
3488 * @param t Interval in seconds
3490 * @see elm_button_autorepeat_initial_timeout_set()
3492 EAPI void elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
3494 * Get the interval between each generated autorepeat event
3496 * @param obj The button object
3497 * @return Interval in seconds
3499 EAPI double elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3505 EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3506 EINA_DEPRECATED EAPI void elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3507 EINA_DEPRECATED EAPI const char *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3508 EAPI void elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3509 EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3510 EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3511 EAPI void elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3512 EAPI const char *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3513 EAPI void elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
3514 EAPI void elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
3515 EAPI void elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
3516 EAPI const char *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3517 EAPI void elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3518 EAPI Eina_Bool elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3519 EAPI void elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3520 EAPI Eina_Bool elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3521 EAPI void elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3522 EAPI Eina_Bool elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3523 EAPI void elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3524 EAPI Eina_Bool elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3525 /* available styles:
3529 * hoversel_vertical_entry
3531 /* smart callbacks called:
3532 * "file,chosen" - the user has selected a path, whose string pointer comes
3536 EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3537 EINA_DEPRECATED EAPI void elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3538 EINA_DEPRECATED EAPI const char *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3539 EAPI void elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3540 EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3541 EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3542 EAPI void elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3543 EAPI const char *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3544 EAPI void elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
3545 EAPI void elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
3546 EAPI void elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
3547 EAPI const char *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3548 EAPI void elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3549 EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3550 EAPI void elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3551 EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3552 EAPI void elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3553 EAPI Eina_Bool elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3554 EAPI void elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
3555 EAPI Eina_Bool elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3556 EAPI void elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
3557 EAPI const char *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3559 /* scroller policy */
3560 typedef enum _Elm_Scroller_Policy
3562 ELM_SCROLLER_POLICY_AUTO = 0,
3563 ELM_SCROLLER_POLICY_ON,
3564 ELM_SCROLLER_POLICY_OFF,
3565 ELM_SCROLLER_POLICY_LAST
3566 } Elm_Scroller_Policy;
3568 EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3569 EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
3570 EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3571 EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3572 EAPI void elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
3573 EAPI void elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
3574 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);
3575 EAPI void elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
3576 EAPI void elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
3577 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);
3578 EAPI void elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
3579 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
3580 EAPI void elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
3581 EAPI void elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
3582 EAPI void elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
3583 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);
3584 EAPI void elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
3585 EAPI Eina_Bool elm_scroller_propagate_events_get(const Evas_Object *obj);
3586 EAPI void elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
3587 EAPI void elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
3588 EINA_DEPRECATED EAPI void elm_scroller_page_move_set(Evas_Object *obj, Eina_Bool set);
3589 /* smart callbacks called:
3590 * "edge,left" - the left edge of the content has been reached
3591 * "edge,right" - the right edge of the content has been reached
3592 * "edge,top" - the top edge of the content has been reached
3593 * "edge,bottom" - the bottom edge of the content has been reached
3594 * "scroll" - the content has been scrolled (moved)
3595 * "scroll,anim,start" - scrolling animation has started
3596 * "scroll,anim,stop" - scrolling animation has stopped
3597 * "scroll,drag,start" - dragging the contents around has started
3598 * "scroll,drag,stop" - dragging the contents around has stopped
3602 EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3603 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 */
3604 EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
3605 EAPI void elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
3606 EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3607 EAPI void elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
3608 EAPI Evas_Coord elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3609 EAPI void elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
3610 EAPI Evas_Coord elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3611 EAPI void elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
3612 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);
3613 EAPI void elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
3614 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);
3615 EAPI void elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
3616 EINA_DEPRECATED EAPI void elm_label_wrap_mode_set(Evas_Object *obj, Eina_Bool wrapmode) EINA_ARG_NONNULL(1);
3617 EAPI void elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
3618 EAPI Eina_Bool elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
3619 EAPI void elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
3620 EAPI double elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
3621 /* available styles:
3625 /* smart callbacks called:
3629 EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3630 EINA_DEPRECATED EAPI void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3631 EINA_DEPRECATED EAPI const char *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3632 EAPI void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
3633 EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3634 EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3635 EAPI void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
3636 EAPI void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
3637 EAPI void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
3638 EAPI Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3639 EAPI void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
3640 /* smart callbacks called:
3641 * "changed" - Whenever the toggle value has been changed. Is not called
3642 * until the toggle is released by the cursor (assuming it has been triggered
3643 * by the cursor in the first place).
3647 * @page tutorial_frame Frame example
3648 * @dontinclude frame_example_01.c
3650 * In this example we are going to create 4 Frames with different styles and
3651 * add a rectangle of different color in each.
3653 * We start we the usual setup code:
3656 * And then create one rectangle:
3659 * To add it in our first frame, which since it doesn't have it's style
3660 * specifically set uses the default style:
3663 * And then create another rectangle:
3666 * To add it in our second frame, which uses the "pad_small" style, note that
3667 * even tough we are setting a text for this frame it won't be show, only the
3668 * default style shows the Frame's title:
3670 * @note The "pad_small", "pad_medium", "pad_large" and "pad_huge" styles are
3671 * very similar, their only difference is the size of the empty area around
3672 * the content of the frame.
3674 * And then create yet another rectangle:
3677 * To add it in our third frame, which uses the "outdent_top" style, note
3678 * that even tough we are setting a text for this frame it won't be show,
3679 * only the default style shows the Frame's title:
3682 * And then create one last rectangle:
3685 * To add it in our fourth and final frame, which uses the "outdent_bottom"
3686 * style, note that even tough we are setting a text for this frame it won't
3687 * be show, only the default style shows the Frame's title:
3690 * And now we are left with just some more setup code:
3693 * Our example will look like this:
3694 * @image html screenshots/frame_example_01.png
3695 * @image latex screenshots/frame_example_01.eps
3697 * @example frame_example_01.c
3700 * @defgroup Frame Frame
3702 * @brief Frame is a widget that holds some content and has a title.
3704 * The default look is a frame with a title, but Frame supports multple
3712 * @li outdent_bottom
3714 * Of all this styles only default shows the title. Frame emits no signals.
3716 * For a detailed example see the @ref tutorial_frame.
3721 * @brief Add a new frame to the parent
3723 * @param parent The parent object
3724 * @return The new object or NULL if it cannot be created
3726 EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3728 * @brief Set the frame label
3730 * @param obj The frame object
3731 * @param label The label of this frame object
3733 * @deprecated use elm_object_text_set() instead.
3735 EINA_DEPRECATED EAPI void elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
3737 * @brief Get the frame label
3739 * @param obj The frame object
3741 * @return The label of this frame objet or NULL if unable to get frame
3743 * @deprecated use elm_object_text_get() instead.
3745 EINA_DEPRECATED EAPI const char *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3747 * @brief Set the content of the frame widget
3749 * Once the content object is set, a previously set one will be deleted.
3750 * If you want to keep that old content object, use the
3751 * elm_frame_content_unset() function.
3753 * @param obj The frame object
3754 * @param content The content will be filled in this frame object
3756 EAPI void elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
3758 * @brief Get the content of the frame widget
3760 * Return the content object which is set for this widget
3762 * @param obj The frame object
3763 * @return The content that is being used
3765 EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3767 * @brief Unset the content of the frame widget
3769 * Unparent and return the content object which was set for this widget
3771 * @param obj The frame object
3772 * @return The content that was being used
3774 EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
3780 EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3781 EAPI void elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
3782 EAPI Eina_Bool elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3783 EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
3784 EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3785 EAPI void elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
3786 EAPI void elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
3787 EAPI void elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
3788 EAPI void elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3789 EAPI void elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
3790 EAPI void elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
3791 EAPI void elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
3794 typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class;
3795 typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func;
3796 typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Item of Elm_Gengrid. Sub-type of Elm_Widget_Item */
3797 typedef char *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
3798 typedef Evas_Object *(*GridItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
3799 typedef Eina_Bool (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
3800 typedef void (*GridItemDelFunc) (void *data, Evas_Object *obj);
3802 struct _Elm_Gengrid_Item_Class
3804 const char *item_style;
3805 struct _Elm_Gengrid_Item_Class_Func
3807 GridItemLabelGetFunc label_get;
3808 GridItemIconGetFunc icon_get;
3809 GridItemStateGetFunc state_get;
3810 GridItemDelFunc del;
3814 EAPI Evas_Object *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3815 EAPI void elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
3816 EAPI void elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
3817 EAPI void elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
3818 EAPI void elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
3820 EAPI void elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
3821 EAPI Eina_Bool elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3822 EAPI void elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
3823 EAPI Eina_Bool elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3824 EAPI void elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
3825 EAPI Eina_Bool elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3826 EAPI void elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
3827 EAPI Eina_Bool elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3828 EAPI void elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
3829 EAPI void elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
3830 EAPI void elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
3831 EAPI void elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
3832 EAPI void elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
3833 EAPI void elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
3834 EAPI Eina_Bool elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3836 EAPI Elm_Gengrid_Item *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3837 EAPI Elm_Gengrid_Item *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3839 EAPI Elm_Gengrid_Item *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3840 EAPI Elm_Gengrid_Item *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3841 EAPI Evas_Object *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3842 EAPI void elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3843 EAPI void elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3844 EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3845 EAPI void elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
3846 EAPI void *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3847 EAPI void elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
3848 EAPI void elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
3849 EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
3850 EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3851 EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3852 EAPI void elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3853 EAPI void elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3854 EAPI void elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
3855 EAPI Eina_Bool elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3857 EAPI void elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
3858 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);
3859 EAPI void elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3860 EAPI void elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
3861 EAPI const char *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3862 EAPI void elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
3863 EAPI const char *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3864 EAPI void elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3865 EAPI void elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
3866 EAPI const char *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3867 EAPI void elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
3868 EAPI Eina_Bool elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
3870 EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
3871 EAPI Elm_Gengrid_Item *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3872 EAPI const Eina_List *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3874 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);
3875 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);
3876 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);
3877 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);
3878 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);
3879 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);
3880 /* smart callbacks called:
3882 * selected - User has selected an item.
3883 * unselected - User has unselected an item.
3884 * clicked,double - User has double-clicked or pressed enter on an item.
3885 * realized - An evas object for an item was built.
3886 * unrealized - An evas object for an item was deleted.
3887 * changed - An item has been added, removed, resized or moved,
3888 * or gengrid has been resized or horizontal property has been changed.
3889 * scroll - the content has been scrolled (moved).
3890 * "scroll,anim,start" - This is called when scrolling animation has started.
3891 * "scroll,anim,stop" - This is called when scrolling animation has stopped.
3892 * "scroll,drag,start" - dragging the contents around has started.
3893 * "scroll,drag,stop" - dragging the contents around has stopped.
3894 * drag - Gengrid is being dragged.
3895 * "drag,start,up" - Gengrid has been dragged (not scrolled) up.
3896 * "drag,start,down" - Gengrid has been dragged (not scrolled) down.
3897 * "drag,start,left" - Gengrid has been dragged (not scrolled) left.
3898 * "drag,start,rigth" - Gengrid has been dragged (nto scrolled) right.
3899 * "drag,stop" - Gengrid is not being dragged.
3903 * @defgroup Clock Clock
3905 * This is a @b digital clock widget. In its default theme, it has a
3906 * vintage "flipping numbers clock" appearance, which will animate
3907 * sheets of individual algarisms individually as time goes by.
3909 * A newly created clock will fetch system's time (already
3910 * considering local time adjustments) to start with, and will tick
3911 * accondingly. It may or may not show seconds.
3913 * Clocks have an @b edition mode. When in it, the sheets will
3914 * display extra arrow indications on the top and bottom and the
3915 * user may click on them to raise or lower the time values. After
3916 * it's told to exit edition mode, it will keep ticking with that
3917 * new time set (it keeps the difference from local time).
3919 * Also, when under edition mode, user clicks on the cited arrows
3920 * which are @b held for some time will make the clock to flip the
3921 * sheet, thus editing the time, continuosly and automatically for
3922 * the user. The interval between sheet flips will keep growing in
3923 * time, so that it helps the user to reach a time which is distant
3926 * The time display is, by default, in military mode (24h), but an
3927 * am/pm indicator may be optionally shown, too, when it will
3930 * Smart callbacks one can register to:
3931 * - "changed" - the clock's user changed the time
3933 * Here is an example on its usage:
3934 * @li @ref clock_example
3943 * Identifiers for which clock digits should be editable, when a
3944 * clock widget is in edition mode. Values may be ORed together to
3945 * make a mask, naturally.
3947 * @see elm_clock_edit_set()
3948 * @see elm_clock_digit_edit_set()
3950 typedef enum _Elm_Clock_Digedit
3952 ELM_CLOCK_NONE = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
3953 ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
3954 ELM_CLOCK_HOUR_UNIT = 1 << 1, /**< Unit algarism of hours value should be editable */
3955 ELM_CLOCK_MIN_DECIMAL = 1 << 2, /**< Decimal algarism of minutes value should be editable */
3956 ELM_CLOCK_MIN_UNIT = 1 << 3, /**< Unit algarism of minutes value should be editable */
3957 ELM_CLOCK_SEC_DECIMAL = 1 << 4, /**< Decimal algarism of seconds value should be editable */
3958 ELM_CLOCK_SEC_UNIT = 1 << 5, /**< Unit algarism of seconds value should be editable */
3959 ELM_CLOCK_ALL = (1 << 6) - 1 /**< All digits should be editable */
3960 } Elm_Clock_Digedit;
3963 * Add a new clock widget to the given parent Elementary
3964 * (container) object
3966 * @param parent The parent object
3967 * @return a new clock widget handle or @c NULL, on errors
3969 * This function inserts a new clock widget on the canvas.
3973 EAPI Evas_Object *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
3976 * Set a clock widget's time, programmatically
3978 * @param obj The clock widget object
3979 * @param hrs The hours to set
3980 * @param min The minutes to set
3981 * @param sec The secondes to set
3983 * This function updates the time that is showed by the clock
3986 * Values @b must be set within the following ranges:
3987 * - 0 - 23, for hours
3988 * - 0 - 59, for minutes
3989 * - 0 - 59, for seconds,
3991 * even if the clock is not in "military" mode.
3993 * @warning The behavior for values set out of those ranges is @b
3998 EAPI void elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
4001 * Get a clock widget's time values
4003 * @param obj The clock object
4004 * @param[out] hrs Pointer to the variable to get the hours value
4005 * @param[out] min Pointer to the variable to get the minutes value
4006 * @param[out] sec Pointer to the variable to get the seconds value
4008 * This function gets the time set for @p obj, returning
4009 * it on the variables passed as the arguments to function
4011 * @note Use @c NULL pointers on the time values you're not
4012 * interested in: they'll be ignored by the function.
4016 EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
4019 * Set whether a given clock widget is under <b>edition mode</b> or
4020 * under (default) displaying-only mode.
4022 * @param obj The clock object
4023 * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
4024 * put it back to "displaying only" mode
4026 * This function makes a clock's time to be editable or not <b>by
4027 * user interaction</b>. When in edition mode, clocks @b stop
4028 * ticking, until one brings them back to canonical mode. The
4029 * elm_clock_digit_edit_set() function will influence which digits
4030 * of the clock will be editable. By default, all of them will be
4031 * (#ELM_CLOCK_NONE).
4033 * @note am/pm sheets, if being shown, will @b always be editable
4034 * under edition mode.
4036 * @see elm_clock_edit_get()
4040 EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
4043 * Retrieve whether a given clock widget is under <b>edition
4044 * mode</b> or under (default) displaying-only mode.
4046 * @param obj The clock object
4047 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
4050 * This function retrieves whether the clock's time can be edited
4051 * or not by user interaction.
4053 * @see elm_clock_edit_set() for more details
4057 EAPI Eina_Bool elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4060 * Set what digits of the given clock widget should be editable
4061 * when in edition mode.
4063 * @param obj The clock object
4064 * @param digedit Bit mask indicating the digits to be editable
4065 * (values in #Elm_Clock_Digedit).
4067 * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
4068 * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
4071 * @see elm_clock_digit_edit_get()
4075 EAPI void elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
4078 * Retrieve what digits of the given clock widget should be
4079 * editable when in edition mode.
4081 * @param obj The clock object
4082 * @return Bit mask indicating the digits to be editable
4083 * (values in #Elm_Clock_Digedit).
4085 * @see elm_clock_digit_edit_set() for more details
4089 EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4092 * Set if the given clock widget must show hours in military or
4095 * @param obj The clock object
4096 * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
4099 * This function sets if the clock must show hours in military or
4100 * am/pm mode. In some countries like Brazil the military mode
4101 * (00-24h-format) is used, in opposition to the USA, where the
4102 * am/pm mode is more commonly used.
4104 * @see elm_clock_show_am_pm_get()
4108 EAPI void elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
4111 * Get if the given clock widget shows hours in military or am/pm
4114 * @param obj The clock object
4115 * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
4118 * This function gets if the clock shows hours in military or am/pm
4121 * @see elm_clock_show_am_pm_set() for more details
4125 EAPI Eina_Bool elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4128 * Set if the given clock widget must show time with seconds or not
4130 * @param obj The clock object
4131 * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
4133 * This function sets if the given clock must show or not elapsed
4134 * seconds. By default, they are @b not shown.
4136 * @see elm_clock_show_seconds_get()
4140 EAPI void elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
4143 * Get whether the given clock widget is showing time with seconds
4146 * @param obj The clock object
4147 * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
4149 * This function gets whether @p obj is showing or not the elapsed
4152 * @see elm_clock_show_seconds_set()
4156 EAPI Eina_Bool elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4159 * Set the interval on time updates for an user mouse button hold
4160 * on clock widgets' time edition.
4162 * @param obj The clock object
4163 * @param interval The (first) interval value in seconds
4165 * This interval value is @b decreased while the user holds the
4166 * mouse pointer either incrementing or decrementing a given the
4167 * clock digit's value.
4169 * This helps the user to get to a given time distant from the
4170 * current one easier/faster, as it will start to flip quicker and
4171 * quicker on mouse button holds.
4173 * The calculation for the next flip interval value, starting from
4174 * the one set with this call, is the previous interval divided by
4175 * 1.05, so it decreases a little bit.
4177 * The default starting interval value for automatic flips is
4180 * @see elm_clock_interval_get()
4184 EAPI void elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
4187 * Get the interval on time updates for an user mouse button hold
4188 * on clock widgets' time edition.
4190 * @param obj The clock object
4191 * @return The (first) interval value, in seconds, set on it
4193 * @see elm_clock_interval_set() for more details
4197 EAPI double elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4204 EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4205 EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4206 EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
4207 EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
4208 EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
4209 EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
4210 EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
4211 EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
4212 EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
4213 EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
4214 EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
4215 EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
4216 EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
4217 EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
4218 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);
4219 EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
4220 EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
4221 EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4222 EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
4223 EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
4224 EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
4225 EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
4226 EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
4227 EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
4228 EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
4229 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);
4230 EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
4232 * @def elm_layout_icon_set
4233 * Convienience macro to set the icon object in a layout that follows the
4234 * Elementary naming convention for its parts.
4238 #define elm_layout_icon_set(_ly, _obj) \
4241 elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
4242 if ((_obj)) sig = "elm,state,icon,visible"; \
4243 else sig = "elm,state,icon,hidden"; \
4244 elm_object_signal_emit((_ly), sig, "elm"); \
4248 * @def elm_layout_icon_get
4249 * Convienience macro to get the icon object from a layout that follows the
4250 * Elementary naming convention for its parts.
4254 #define elm_layout_icon_get(_ly) \
4255 elm_layout_content_get((_ly), "elm.swallow.icon")
4258 * @def elm_layout_end_set
4259 * Convienience macro to set the end object in a layout that follows the
4260 * Elementary naming convention for its parts.
4264 #define elm_layout_end_set(_ly, _obj) \
4267 elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
4268 if ((_obj)) sig = "elm,state,end,visible"; \
4269 else sig = "elm,state,end,hidden"; \
4270 elm_object_signal_emit((_ly), sig, "elm"); \
4274 * @def elm_layout_end_get
4275 * Convienience macro to get the end object in a layout that follows the
4276 * Elementary naming convention for its parts.
4280 #define elm_layout_end_get(_ly) \
4281 elm_layout_content_get((_ly), "elm.swallow.end")
4284 * @def elm_layout_label_set
4285 * Convienience macro to set the label in a layout that follows the
4286 * Elementary naming convention for its parts.
4289 * @deprecate use elm_object_text_* instead.
4291 #define elm_layout_label_set(_ly, _txt) \
4292 elm_layout_text_set((_ly), "elm.text", (_txt))
4295 * @def elm_layout_label_get
4296 * Convienience macro to get the label in a layout that follows the
4297 * Elementary naming convention for its parts.
4300 * @deprecate use elm_object_text_* instead.
4302 #define elm_layout_label_get(_ly) \
4303 elm_layout_text_get((_ly), "elm.text")
4305 /* smart callbacks called:
4309 typedef enum _Elm_Notify_Orient
4311 ELM_NOTIFY_ORIENT_TOP,
4312 ELM_NOTIFY_ORIENT_CENTER,
4313 ELM_NOTIFY_ORIENT_BOTTOM,
4314 ELM_NOTIFY_ORIENT_LEFT,
4315 ELM_NOTIFY_ORIENT_RIGHT,
4316 ELM_NOTIFY_ORIENT_TOP_LEFT,
4317 ELM_NOTIFY_ORIENT_TOP_RIGHT,
4318 ELM_NOTIFY_ORIENT_BOTTOM_LEFT,
4319 ELM_NOTIFY_ORIENT_BOTTOM_RIGHT,
4320 ELM_NOTIFY_ORIENT_LAST
4321 } Elm_Notify_Orient;
4322 EAPI Evas_Object *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4323 EAPI void elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4324 EAPI Evas_Object *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4325 EAPI Evas_Object *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4326 EAPI void elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4327 EAPI Evas_Object *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4328 EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
4329 EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4330 EAPI void elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
4331 EAPI double elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4332 EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
4333 EAPI Eina_Bool elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4334 /* smart callbacks called:
4335 * "timeout" - when timeout happens on notify and it's hidden
4336 * "block,clicked" - when it's hidden by a click outside of the notify's view
4340 typedef enum _Elm_Hover_Axis
4342 ELM_HOVER_AXIS_NONE,
4343 ELM_HOVER_AXIS_HORIZONTAL,
4344 ELM_HOVER_AXIS_VERTICAL,
4347 EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4348 EAPI void elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
4349 EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4350 EAPI void elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4351 EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4352 EAPI void elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
4353 EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
4354 EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
4355 EAPI const char *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
4356 /* available styles:
4362 /* smart callbacks called:
4363 * "clicked" - the user clicked the empty space in the hover to dismiss
4364 * "smart,changed" - a content object placed under the "smart"
4365 * policy was replaced to a new slot direction.
4369 typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
4370 struct _Elm_Entry_Anchor_Info
4374 Evas_Coord x, y, w, h;
4376 typedef enum _Elm_Icon_Type
4383 typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
4385 EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4386 EAPI void elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
4387 EAPI Eina_Bool elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4388 EAPI void elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
4389 EAPI Eina_Bool elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4390 EAPI void elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
4391 EAPI const char *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4392 EAPI void elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
4393 EAPI Eina_Bool elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4394 EAPI const char *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4395 EAPI void elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
4396 EAPI void elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
4397 EINA_DEPRECATED EAPI void elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
4398 EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4399 EAPI void elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
4400 EAPI Eina_Bool elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4401 EAPI void elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
4402 EAPI void elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
4403 EAPI Eina_Bool elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
4404 EAPI Eina_Bool elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
4405 EAPI Eina_Bool elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
4406 EAPI Eina_Bool elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
4407 EAPI void elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
4408 EAPI void elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
4409 EAPI void elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
4410 EAPI void elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
4411 EAPI void elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
4412 EAPI void elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
4413 EAPI Eina_Bool elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4414 EAPI Eina_Bool elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4415 EAPI const char *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4416 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);
4417 EAPI void elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
4418 EAPI int elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4419 EAPI void elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
4420 EAPI void elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
4421 EAPI void elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
4422 EAPI void elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
4423 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);
4424 EAPI void elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
4425 EAPI Eina_Bool elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4426 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);
4427 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);
4428 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);
4429 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);
4430 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);
4431 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);
4432 EAPI char *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
4433 EAPI char *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
4434 EAPI void elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
4435 EAPI void elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
4436 EAPI void elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
4437 EAPI void elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
4438 EAPI Eina_Bool elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4439 EAPI void elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
4440 EAPI Eina_Bool elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4441 EAPI void elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
4442 EAPI Eina_Bool elm_entry_scrollable_get(const Evas_Object *obj);
4443 EAPI void elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
4444 EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
4445 EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
4446 EAPI void elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
4447 EAPI void elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
4448 EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
4449 EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
4450 EAPI void elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
4451 EAPI void elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
4452 EAPI void elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
4453 EAPI void elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
4455 /* pre-made filters for entries */
4456 typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
4457 struct _Elm_Entry_Filter_Limit_Size
4462 EAPI void elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
4463 typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
4464 struct _Elm_Entry_Filter_Accept_Set
4466 const char *accepted;
4467 const char *rejected;
4469 EAPI void elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
4471 * Set the input panel layout of the entry
4473 * @param obj The entry object
4474 * @param layout layout type
4476 EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
4478 * Get the input panel layout of the entry
4480 * @param obj The entry object
4481 * @return layout type
4483 * @see elm_entry_input_panel_layout_set
4485 EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4487 * Set the autocapitalization type on the immodule.
4489 * @param obj The entry object
4490 * @param autocapital_type The type of autocapitalization
4492 EAPI void elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
4494 * Retrieve the autocapitalization type on the immodule.
4496 * @param obj The entry object
4497 * @return autocapitalization type
4499 EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4501 * Sets the attribute to show the input panel automatically.
4503 * @param obj The entry object
4504 * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
4506 EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4508 * Retrieve the attribute to show the input panel automatically.
4510 * @param obj The entry object
4511 * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
4513 EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
4515 EAPI void elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
4516 EAPI void elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
4517 EAPI void elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
4518 EAPI void elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
4519 EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
4520 EAPI void elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
4521 EAPI void elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
4523 EINA_DEPRECATED EAPI void elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
4524 EINA_DEPRECATED EAPI Evas_Coord elm_entry_wrap_width_get(const Evas_Object *obj);
4525 EINA_DEPRECATED EAPI void elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
4526 EINA_DEPRECATED EAPI void elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
4527 EINA_DEPRECATED EAPI void elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
4529 /* smart callbacks called:
4530 * "changed" - the text content changed
4531 * "selection,start" - the user started selecting text
4532 * "selection,changed" - the user modified the selection size/location
4533 * "selection,cleared" - the user cleared the selection
4534 * "selection,paste" - the user requested a paste of text
4535 * "selection,copy" - the user copied the text
4536 * "selection,cut" - the user cut the text
4537 * "cursor,changed" - the cursor changed position
4538 * "anchor,clicked" - achor called was clicked | event_info = Elm_Entry_Anchor_Info
4539 * "activated" - when the enter key is pressed (useful for single line)
4540 * "press" - when finger/mouse is pressed down
4541 * "clicked" - when finger/mouse is pressed and released (without a drag etc.)
4542 * "clicked,double" - when finger/mouse is double-pressed
4543 * "longpressed" - the entry has been longpressed
4544 * "focused" - the entry has received keyboard focus
4545 * "unfocused" - keyboard focus is gone
4548 /* composite widgets - these basically put together basic widgets above
4549 * in convenient packages that do more than basic stuff */
4553 * @defgroup Anchorview Anchorview
4555 * Anchorview is for displaying text that contains markup with anchors
4556 * like <c>\<a href=1234\>something\</\></c> in it.
4558 * Besides being styled differently, the anchorview widget provides the
4559 * necessary functionality so that clicking on these anchors brings up a
4560 * popup with user defined content such as "call", "add to contacts" or
4561 * "open web page". This popup is provided using the @ref Hover widget.
4563 * This widget is very similar to @ref Anchorblock, so refer to that
4564 * widget for an example. The only difference Anchorview has is that the
4565 * widget is already provided with scrolling functionality, so if the
4566 * text set to it is too large to fit in the given space, it will scroll,
4567 * whereas the @ref Anchorblock widget will keep growing to ensure all the
4568 * text can be displayed.
4570 * This widget emits the following signals:
4571 * @li "anchor,clicked": will be called when an anchor is clicked. The
4572 * @p event_info parameter on the callback will be a pointer of type
4573 * ::Elm_Entry_Anchorview_Info.
4575 * See @ref Anchorblock for an example on how to use both of them.
4584 * @typedef Elm_Entry_Anchorview_Info
4586 * The info sent in the callback for "anchor,clicked" signals emitted by
4587 * the Anchorview widget.
4589 typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
4591 * @struct _Elm_Entry_Anchorview_Info
4593 * The info sent in the callback for "anchor,clicked" signals emitted by
4594 * the Anchorview widget.
4596 struct _Elm_Entry_Anchorview_Info
4598 const char *name; /**< Name of the anchor, as indicated in its href
4600 int button; /**< The mouse button used to click on it */
4601 Evas_Object *hover; /**< The hover object to use for the popup */
4603 Evas_Coord x, y, w, h;
4604 } anchor, /**< Geometry selection of text used as anchor */
4605 hover_parent; /**< Geometry of the object used as parent by the
4607 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
4608 for content on the left side of
4609 the hover. Before calling the
4610 callback, the widget will make the
4611 necessary calculations to check
4612 which sides are fit to be set with
4613 content, based on the position the
4614 hover is activated and its distance
4615 to the edges of its parent object
4617 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
4618 the right side of the hover.
4619 See @ref hover_left */
4620 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
4621 of the hover. See @ref hover_left */
4622 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
4623 below the hover. See @ref
4627 * Add a new Anchorview object
4629 * @param parent The parent object
4630 * @return The new object or NULL if it cannot be created
4632 EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4634 * Set the text to show in the anchorview
4636 * Sets the text of the anchorview to @p text. This text can include markup
4637 * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
4638 * text that will be specially styled and react to click events, ended with
4639 * either of \</a\> or \</\>. When clicked, the anchor will emit an
4640 * "anchor,clicked" signal that you can attach a callback to with
4641 * evas_object_smart_callback_add(). The name of the anchor given in the
4642 * event info struct will be the one set in the href attribute, in this
4645 * Other markup can be used to style the text in different ways, but it's
4646 * up to the style defined in the theme which tags do what.
4647 * @deprecated use elm_object_text_set() instead.
4649 EINA_DEPRECATED EAPI void elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
4651 * Get the markup text set for the anchorview
4653 * Retrieves the text set on the anchorview, with markup tags included.
4655 * @param obj The anchorview object
4656 * @return The markup text set or @c NULL if nothing was set or an error
4658 * @deprecated use elm_object_text_set() instead.
4660 EINA_DEPRECATED EAPI const char *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4662 * Set the parent of the hover popup
4664 * Sets the parent object to use by the hover created by the anchorview
4665 * when an anchor is clicked. See @ref Hover for more details on this.
4666 * If no parent is set, the same anchorview object will be used.
4668 * @param obj The anchorview object
4669 * @param parent The object to use as parent for the hover
4671 EAPI void elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
4673 * Get the parent of the hover popup
4675 * Get the object used as parent for the hover created by the anchorview
4676 * widget. See @ref Hover for more details on this.
4678 * @param obj The anchorview object
4679 * @return The object used as parent for the hover, NULL if none is set.
4681 EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4683 * Set the style that the hover should use
4685 * When creating the popup hover, anchorview will request that it's
4686 * themed according to @p style.
4688 * @param obj The anchorview object
4689 * @param style The style to use for the underlying hover
4691 * @see elm_object_style_set()
4693 EAPI void elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4695 * Get the style that the hover should use
4697 * Get the style the hover created by anchorview will use.
4699 * @param obj The anchorview object
4700 * @return The style to use by the hover. NULL means the default is used.
4702 * @see elm_object_style_set()
4704 EAPI const char *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4706 * Ends the hover popup in the anchorview
4708 * When an anchor is clicked, the anchorview widget will create a hover
4709 * object to use as a popup with user provided content. This function
4710 * terminates this popup, returning the anchorview to its normal state.
4712 * @param obj The anchorview object
4714 EAPI void elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
4716 * Set bouncing behaviour when the scrolled content reaches an edge
4718 * Tell the internal scroller object whether it should bounce or not
4719 * when it reaches the respective edges for each axis.
4721 * @param obj The anchorview object
4722 * @param h_bounce Whether to bounce or not in the horizontal axis
4723 * @param v_bounce Whether to bounce or not in the vertical axis
4725 * @see elm_scroller_bounce_set()
4727 EAPI void elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
4729 * Get the set bouncing behaviour of the internal scroller
4731 * Get whether the internal scroller should bounce when the edge of each
4732 * axis is reached scrolling.
4734 * @param obj The anchorview object
4735 * @param h_bounce Pointer where to store the bounce state of the horizontal
4737 * @param v_bounce Pointer where to store the bounce state of the vertical
4740 * @see elm_scroller_bounce_get()
4742 EAPI void elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
4744 * Appends a custom item provider to the given anchorview
4746 * Appends the given function to the list of items providers. This list is
4747 * called, one function at a time, with the given @p data pointer, the
4748 * anchorview object and, in the @p item parameter, the item name as
4749 * referenced in its href string. Following functions in the list will be
4750 * called in order until one of them returns something different to NULL,
4751 * which should be an Evas_Object which will be used in place of the item
4754 * Items in the markup text take the form \<item relsize=16x16 vsize=full
4755 * href=item/name\>\</item\>
4757 * @param obj The anchorview object
4758 * @param func The function to add to the list of providers
4759 * @param data User data that will be passed to the callback function
4761 * @see elm_entry_item_provider_append()
4763 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);
4765 * Prepend a custom item provider to the given anchorview
4767 * Like elm_anchorview_item_provider_append(), but it adds the function
4768 * @p func to the beginning of the list, instead of the end.
4770 * @param obj The anchorview object
4771 * @param func The function to add to the list of providers
4772 * @param data User data that will be passed to the callback function
4774 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);
4776 * Remove a custom item provider from the list of the given anchorview
4778 * Removes the function and data pairing that matches @p func and @p data.
4779 * That is, unless the same function and same user data are given, the
4780 * function will not be removed from the list. This allows us to add the
4781 * same callback several times, with different @p data pointers and be
4782 * able to remove them later without conflicts.
4784 * @param obj The anchorview object
4785 * @param func The function to remove from the list
4786 * @param data The data matching the function to remove from the list
4788 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);
4795 * @defgroup Anchorblock Anchorblock
4797 * Anchorblock is for displaying text that contains markup with anchors
4798 * like <c>\<a href=1234\>something\</\></c> in it.
4800 * Besides being styled differently, the anchorblock widget provides the
4801 * necessary functionality so that clicking on these anchors brings up a
4802 * popup with user defined content such as "call", "add to contacts" or
4803 * "open web page". This popup is provided using the @ref Hover widget.
4805 * This widget emits the following signals:
4806 * @li "anchor,clicked": will be called when an anchor is clicked. The
4807 * @p event_info parameter on the callback will be a pointer of type
4808 * ::Elm_Entry_Anchorblock_Info.
4814 * Since examples are usually better than plain words, we might as well
4815 * try @ref tutorial_anchorblock_example "one".
4818 * @page tutorial_anchorblock_example Anchorblock/Anchorview example
4819 * This exampel will show both Anchorblock and @ref Anchorview,
4820 * since both are very similar and it's easier to show them once and side
4821 * by side, so the difference is more clear.
4823 * We'll show the relevant snippets of the code here, but the full example
4824 * can be found here... sorry, @ref anchorblock_example_01.c "here".
4826 * As for the actual example, it's just a simple window with an anchorblock
4827 * and an anchorview, both containing the same text. After including
4828 * Elementary.h and declaring some functions we'll need, we jump to our
4829 * elm_main (see ELM_MAIN) and create our window.
4830 * @dontinclude anchorblock_example_01.c
4835 * With the needed variables declared, we'll create the window and a box to
4836 * hold our widgets, but we don't need to go through that here.
4838 * In order to make clear where the anchorblock ends and the anchorview
4839 * begins, they'll be each inside a @ref Frame. After creating the frame,
4840 * the anchorblock follows.
4841 * @skip elm_frame_add
4842 * @until elm_frame_content_set
4844 * Nothing out of the ordinary there. What's worth mentioning is the call
4845 * to elm_anchorblock_hover_parent_set(). We are telling our widget that
4846 * when an anchor is clicked, the hover for the popup will cover the entire
4847 * window. This affects the area that will be obscured by the hover and
4848 * where clicking will dismiss it, as well as the calculations it does to
4849 * inform the best locations where to insert the popups content.
4850 * Other than that, the code is pretty standard. We also need to set our
4851 * callback for when an anchor is clicked, since it's our task to populate
4852 * the popup. There's no default for it.
4854 * The anchorview is no different, we only change a few things so it looks
4856 * @until elm_frame_content_set
4858 * Then we run, so stuff works and close our main function in the usual way.
4861 * Now, a little note. Normally you would use either one of anchorblock or
4862 * anchorview, set your one callback to clicks and do your stuff in there.
4863 * In this example, however, there are a few tricks to make it easier to
4864 * show both widgets in one go (and to save me some typing). So we have
4865 * two callbacks, one per widget, that will call a common function to do
4866 * the rest. The trick is using ::Elm_Entry_Anchorblock_Info for the
4867 * anchorview too, since both are equal, and passing a callback to use
4868 * for our buttons to end the hover, because each widget has a different
4870 * @until _anchorview_clicked_cb
4873 * The meat of our popup is in the following function. We check what kind
4874 * of menu we need to show, based on the name set to the anchor in the
4875 * markup text. If there's no type (something went wrong, no valid contact
4876 * in the address list) we are just putting a button that does nothing, but
4877 * it's perfectly reasonable to just end the hover and call it quits.
4879 * Our popup will consist of one main button in the middle of our hover,
4880 * and possibly a secondary button and a list of other options. We'll create
4881 * first our main button and check what kind of popup we need afterwards.
4884 * @until eina_stringshare_add
4887 * Each button has two callbacks, one is our hack to close the hover
4888 * properly based on which widget it belongs to, the other a simple
4889 * printf that will show the action with the anchors own data. This is
4890 * not how you would usually do it. Instead, the common case is to have
4891 * one callback for the button that will know which function to call to end
4892 * things, but since we are doing it this way it's worth noting that
4893 * smart callbacks will be called in reverse in respect to the order they
4894 * were added, and since our @c btn_end_cb will close the hover, and thus
4895 * delete our buttons, the other callback wouldn't be called if we had
4898 * After our telephone popup, there are a few others that are practically
4899 * the same, so they won't be shown here.
4901 * Once we are done with that, it's time to place our actions into our
4902 * hover. Main button goes in the middle without much questioning, and then
4903 * we see if we have a secondary button and a box of extra options.
4904 * Because I said so, secondary button goes on either side and box of
4905 * options either on top or below the main one, but to choose which
4906 * exactly, we use the hints our callback info has, which saves us from
4907 * having to do the math and see which side has more space available, with
4908 * a little special case where we delete our extra stuff if there's nowhere
4912 * @skip evas_object_smart
4913 * @until evas_object_del(box)
4917 * The example will look like this:
4918 * @image html screenshots/anchorblock_01.png
4919 * @image latex screenshots/anchorblock_01.eps
4921 * @example anchorblock_example_01.c
4924 * @addtogroup Anchorblock
4928 * @typedef Elm_Entry_Anchorblock_Info
4930 * The info sent in the callback for "anchor,clicked" signals emitted by
4931 * the Anchorblock widget.
4933 typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
4935 * @struct _Elm_Entry_Anchorblock_Info
4937 * The info sent in the callback for "anchor,clicked" signals emitted by
4938 * the Anchorblock widget.
4940 struct _Elm_Entry_Anchorblock_Info
4942 const char *name; /**< Name of the anchor, as indicated in its href
4944 int button; /**< The mouse button used to click on it */
4945 Evas_Object *hover; /**< The hover object to use for the popup */
4947 Evas_Coord x, y, w, h;
4948 } anchor, /**< Geometry selection of text used as anchor */
4949 hover_parent; /**< Geometry of the object used as parent by the
4951 Eina_Bool hover_left : 1; /**< Hint indicating if there's space
4952 for content on the left side of
4953 the hover. Before calling the
4954 callback, the widget will make the
4955 necessary calculations to check
4956 which sides are fit to be set with
4957 content, based on the position the
4958 hover is activated and its distance
4959 to the edges of its parent object
4961 Eina_Bool hover_right : 1; /**< Hint indicating content fits on
4962 the right side of the hover.
4963 See @ref hover_left */
4964 Eina_Bool hover_top : 1; /**< Hint indicating content fits on top
4965 of the hover. See @ref hover_left */
4966 Eina_Bool hover_bottom : 1; /**< Hint indicating content fits
4967 below the hover. See @ref
4971 * Add a new Anchorblock object
4973 * @param parent The parent object
4974 * @return The new object or NULL if it cannot be created
4976 EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4978 * Set the text to show in the anchorblock
4980 * Sets the text of the anchorblock to @p text. This text can include markup
4981 * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
4982 * of text that will be specially styled and react to click events, ended
4983 * with either of \</a\> or \</\>. When clicked, the anchor will emit an
4984 * "anchor,clicked" signal that you can attach a callback to with
4985 * evas_object_smart_callback_add(). The name of the anchor given in the
4986 * event info struct will be the one set in the href attribute, in this
4989 * Other markup can be used to style the text in different ways, but it's
4990 * up to the style defined in the theme which tags do what.
4991 * @deprecated use elm_object_text_set() instead.
4993 EINA_DEPRECATED EAPI void elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
4995 * Get the markup text set for the anchorblock
4997 * Retrieves the text set on the anchorblock, with markup tags included.
4999 * @param obj The anchorblock object
5000 * @return The markup text set or @c NULL if nothing was set or an error
5002 * @deprecated use elm_object_text_set() instead.
5004 EINA_DEPRECATED EAPI const char *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5006 * Set the parent of the hover popup
5008 * Sets the parent object to use by the hover created by the anchorblock
5009 * when an anchor is clicked. See @ref Hover for more details on this.
5011 * @param obj The anchorblock object
5012 * @param parent The object to use as parent for the hover
5014 EAPI void elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
5016 * Get the parent of the hover popup
5018 * Get the object used as parent for the hover created by the anchorblock
5019 * widget. See @ref Hover for more details on this.
5020 * If no parent is set, the same anchorblock object will be used.
5022 * @param obj The anchorblock object
5023 * @return The object used as parent for the hover, NULL if none is set.
5025 EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5027 * Set the style that the hover should use
5029 * When creating the popup hover, anchorblock will request that it's
5030 * themed according to @p style.
5032 * @param obj The anchorblock object
5033 * @param style The style to use for the underlying hover
5035 * @see elm_object_style_set()
5037 EAPI void elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
5039 * Get the style that the hover should use
5041 * Get the style the hover created by anchorblock will use.
5043 * @param obj The anchorblock object
5044 * @return The style to use by the hover. NULL means the default is used.
5046 * @see elm_object_style_set()
5048 EAPI const char *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5050 * Ends the hover popup in the anchorblock
5052 * When an anchor is clicked, the anchorblock widget will create a hover
5053 * object to use as a popup with user provided content. This function
5054 * terminates this popup, returning the anchorblock to its normal state.
5056 * @param obj The anchorblock object
5058 EAPI void elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
5060 * Appends a custom item provider to the given anchorblock
5062 * Appends the given function to the list of items providers. This list is
5063 * called, one function at a time, with the given @p data pointer, the
5064 * anchorblock object and, in the @p item parameter, the item name as
5065 * referenced in its href string. Following functions in the list will be
5066 * called in order until one of them returns something different to NULL,
5067 * which should be an Evas_Object which will be used in place of the item
5070 * Items in the markup text take the form \<item relsize=16x16 vsize=full
5071 * href=item/name\>\</item\>
5073 * @param obj The anchorblock object
5074 * @param func The function to add to the list of providers
5075 * @param data User data that will be passed to the callback function
5077 * @see elm_entry_item_provider_append()
5079 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);
5081 * Prepend a custom item provider to the given anchorblock
5083 * Like elm_anchorblock_item_provider_append(), but it adds the function
5084 * @p func to the beginning of the list, instead of the end.
5086 * @param obj The anchorblock object
5087 * @param func The function to add to the list of providers
5088 * @param data User data that will be passed to the callback function
5090 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);
5092 * Remove a custom item provider from the list of the given anchorblock
5094 * Removes the function and data pairing that matches @p func and @p data.
5095 * That is, unless the same function and same user data are given, the
5096 * function will not be removed from the list. This allows us to add the
5097 * same callback several times, with different @p data pointers and be
5098 * able to remove them later without conflicts.
5100 * @param obj The anchorblock object
5101 * @param func The function to remove from the list
5102 * @param data The data matching the function to remove from the list
5104 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);
5110 * @defgroup Bubble Bubble
5112 * @brief The Bubble is a widget to show text similarly to how speech is
5113 * represented in comics.
5115 * The bubble widget contains 5 important visual elements:
5116 * @li The frame is a rectangle with rounded rectangles and an "arrow".
5117 * @li The @p icon is an image to which the frame's arrow points to.
5118 * @li The @p label is a text which appears to the right of the icon if the
5119 * corner is "top_left" or "bottom_left" and is right aligned to the frame
5121 * @li The @p info is a text which appears to the right of the label. Info's
5122 * font is of a ligther color than label.
5123 * @li The @p content is an evas object that is shown inside the frame.
5125 * The position of the arrow, icon, label and info depends on which corner is
5126 * selected. The four available corners are:
5127 * @li "top_left" - Default
5130 * @li "bottom_right"
5132 * Signals that you can add callbacks for are:
5133 * @li "clicked" - This is called when a user has clicked the bubble.
5135 * For an example of using a buble see @ref bubble_01_example_page "this".
5140 * Add a new bubble to the parent
5142 * @param parent The parent object
5143 * @return The new object or NULL if it cannot be created
5145 * This function adds a text bubble to the given parent evas object.
5147 EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5149 * Set the label of the bubble
5151 * @param obj The bubble object
5152 * @param label The string to set in the label
5154 * This function sets the title of the bubble. Where this appears depends on
5155 * the selected corner.
5156 * @deprecated use elm_object_text_set() instead.
5158 EINA_DEPRECATED EAPI void elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5160 * Get the label of the bubble
5162 * @param obj The bubble object
5163 * @return The string of set in the label
5165 * This function gets the title of the bubble.
5166 * @deprecated use elm_object_text_set() instead.
5168 EINA_DEPRECATED EAPI const char *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5170 * Set the info of the bubble
5172 * @param obj The bubble object
5173 * @param info The given info about the bubble
5175 * This function sets the info of the bubble. Where this appears depends on
5176 * the selected corner.
5177 * @deprecated use elm_object_text_set() instead.
5179 EINA_DEPRECATED EAPI void elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
5181 * Get the info of the bubble
5183 * @param obj The bubble object
5185 * @return The "info" string of the bubble
5187 * This function gets the info text.
5188 * @deprecated use elm_object_text_set() instead.
5190 EINA_DEPRECATED EAPI const char *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5192 * Set the content to be shown in the bubble
5194 * Once the content object is set, a previously set one will be deleted.
5195 * If you want to keep the old content object, use the
5196 * elm_bubble_content_unset() function.
5198 * @param obj The bubble object
5199 * @param content The given content of the bubble
5201 * This function sets the content shown on the middle of the bubble.
5203 EAPI void elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
5205 * Get the content shown in the bubble
5207 * Return the content object which is set for this widget.
5209 * @param obj The bubble object
5210 * @return The content that is being used
5212 EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5214 * Unset the content shown in the bubble
5216 * Unparent and return the content object which was set for this widget.
5218 * @param obj The bubble object
5219 * @return The content that was being used
5221 EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5223 * Set the icon of the bubble
5225 * Once the icon object is set, a previously set one will be deleted.
5226 * If you want to keep the old content object, use the
5227 * elm_icon_content_unset() function.
5229 * @param obj The bubble object
5230 * @param icon The given icon for the bubble
5232 EAPI void elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5234 * Get the icon of the bubble
5236 * @param obj The bubble object
5237 * @return The icon for the bubble
5239 * This function gets the icon shown on the top left of bubble.
5241 EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5243 * Unset the icon of the bubble
5245 * Unparent and return the icon object which was set for this widget.
5247 * @param obj The bubble object
5248 * @return The icon that was being used
5250 EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5252 * Set the corner of the bubble
5254 * @param obj The bubble object.
5255 * @param corner The given corner for the bubble.
5257 * This function sets the corner of the bubble. The corner will be used to
5258 * determine where the arrow in the frame points to and where label, icon and
5261 * Possible values for corner are:
5262 * @li "top_left" - Default
5265 * @li "bottom_right"
5267 EAPI void elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
5269 * Get the corner of the bubble
5271 * @param obj The bubble object.
5272 * @return The given corner for the bubble.
5274 * This function gets the selected corner of the bubble.
5276 EAPI const char *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5278 EINA_DEPRECATED EAPI void elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
5279 EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5286 EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5287 EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
5288 EAPI void elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5289 EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
5290 EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5291 /* smart callbacks called:
5292 * "clicked" - the user clicked the icon
5293 * "drag,start" - Someone started dragging the image out of the object
5294 * "drag,end" - Dragged item was dropped (somewhere)
5298 /** @defgroup Elm_Gesture_Layer Gesture Layer */
5300 * @enum _Elm_Gesture_Types
5301 * Emum of supported gesture types.
5302 * @ingroup Elm_Gesture_Layer
5304 enum _Elm_Gesture_Types
5306 ELM_GESTURE_FIRST = 0,
5308 ELM_GESTURE_N_TAPS, /**< N fingers single taps */
5309 ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
5310 ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
5311 ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
5313 ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
5315 ELM_GESTURE_N_LINES, /**< N fingers line gesture */
5316 ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
5318 ELM_GESTURE_ZOOM, /**< Zoom */
5319 ELM_GESTURE_ROTATE, /**< Rotate */
5325 * @typedef Elm_Gesture_Types
5326 * Type for Emum of supported gesture types.
5327 * @ingroup Elm_Gesture_Layer
5329 typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
5332 * @enum _Elm_Gesture_State
5333 * Emum of gesture states.
5334 * @ingroup Elm_Gesture_Layer
5336 enum _Elm_Gesture_State
5338 ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
5339 ELM_GESTURE_STATE_START, /**< Gesture STARTed */
5340 ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
5341 ELM_GESTURE_STATE_END, /**< Gesture completed */
5342 ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
5345 * @typedef Elm_Gesture_State
5347 * @ingroup Elm_Gesture_Layer
5349 typedef enum _Elm_Gesture_State Elm_Gesture_State;
5352 * @struct _Elm_Gesture_Taps_Info
5353 * Struct holds taps info for user
5354 * @ingroup Elm_Gesture_Layer
5356 struct _Elm_Gesture_Taps_Info
5358 Evas_Coord x, y; /**< Holds center point between fingers */
5359 unsigned int n; /**< Number of fingers tapped */
5360 unsigned int timestamp; /**< event timestamp */
5364 * @typedef Elm_Gesture_Taps_Info
5365 * holds taps info for user
5366 * @ingroup Elm_Gesture_Layer
5368 typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
5371 * @struct _Elm_Gesture_Momentum_Info
5372 * Struct holds momentum info for user
5373 * x1 and y1 are not necessarily in sync
5374 * x1 holds x value of x direction starting point
5375 * and same holds for y1.
5376 * This is noticeable when doing V-shape movement
5377 * @ingroup Elm_Gesture_Layer
5379 struct _Elm_Gesture_Momentum_Info
5380 { /* Report line ends, timestamps, and momentum computed */
5381 Evas_Coord x1; /**< Final-swipe direction starting point on X */
5382 Evas_Coord y1; /**< Final-swipe direction starting point on Y */
5383 Evas_Coord x2; /**< Final-swipe direction ending point on X */
5384 Evas_Coord y2; /**< Final-swipe direction ending point on Y */
5386 unsigned int tx; /**< Timestamp of start of final x-swipe */
5387 unsigned int ty; /**< Timestamp of start of final y-swipe */
5389 Evas_Coord mx; /**< Momentum on X */
5390 Evas_Coord my; /**< Momentum on Y */
5392 unsigned int n; /**< Number of fingers */
5396 * @typedef Elm_Gesture_Momentum_Info
5397 * holds momentum info for user
5398 * @ingroup Elm_Gesture_Layer
5400 typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
5403 * @struct _Elm_Gesture_Line_Info
5404 * Struct holds line info for user
5405 * @ingroup Elm_Gesture_Layer
5407 struct _Elm_Gesture_Line_Info
5408 { /* Report line ends, timestamps, and momentum computed */
5409 Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
5410 /* FIXME should be radians, bot degrees */
5411 double angle; /**< Angle (direction) of lines */
5415 * @typedef _Elm_Gesture_Line_Info
5416 * Holds line info for user
5417 * @ingroup Elm_Gesture_Layer
5419 typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
5422 * @struct _Elm_Gesture_Zoom_Info
5423 * Struct holds zoom info for user
5424 * @ingroup Elm_Gesture_Layer
5426 struct _Elm_Gesture_Zoom_Info
5428 Evas_Coord x, y; /**< Holds zoom center point reported to user */
5429 Evas_Coord radius; /**< Holds radius between fingers reported to user */
5430 double zoom; /**< Zoom value: 1.0 means no zoom */
5431 double momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
5435 * @typedef Elm_Gesture_Zoom_Info
5436 * Holds zoom info for user
5437 * @ingroup Elm_Gesture_Layer
5439 typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
5442 * @struct _Elm_Gesture_Rotate_Info
5443 * Struct holds rotation info for user
5444 * @ingroup Elm_Gesture_Layer
5446 struct _Elm_Gesture_Rotate_Info
5448 Evas_Coord x, y; /**< Holds zoom center point reported to user */
5449 Evas_Coord radius; /**< Holds radius between fingers reported to user */
5450 double base_angle; /**< Holds start-angle */
5451 double angle; /**< Rotation value: 0.0 means no rotation */
5452 double momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
5456 * @typedef Elm_Gesture_Rotate_Info
5457 * Holds rotation info for user
5458 * @ingroup Elm_Gesture_Layer
5460 typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
5463 * @typedef Elm_Gesture_Event_Cb
5464 * User callback used to stream gesture info from gesture layer
5465 * @param data user data
5466 * @param event_info gesture report info
5467 * Returns a flag field to be applied on the causing event.
5468 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
5469 * upon the event, in an irreversible way.
5471 * @ingroup Elm_Gesture_Layer
5473 typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
5476 * Use function to set callbacks to be notified about
5477 * change of state of gesture.
5478 * When a user registers a callback with this function
5479 * this means this gesture has to be tested.
5481 * When ALL callbacks for a gesture are set to NULL
5482 * it means user isn't interested in gesture-state
5483 * and it will not be tested.
5485 * @param obj Pointer to gesture-layer.
5486 * @param idx The gesture you would like to track its state.
5487 * @param cb callback function pointer.
5488 * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
5489 * @param data user info to be sent to callback (usually, Smart Data)
5491 * @ingroup Elm_Gesture_Layer
5493 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);
5496 * Call this function to get repeat-events settings.
5498 * @param obj Pointer to gesture-layer.
5500 * @return repeat events settings.
5501 * @see elm_gesture_layer_hold_events_set()
5502 * @ingroup Elm_Gesture_Layer
5504 EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5507 * This function called in order to make gesture-layer repeat events.
5508 * Set this of you like to get the raw events only if gestures were not detected.
5509 * Clear this if you like gesture layer to fwd events as testing gestures.
5511 * @param obj Pointer to gesture-layer.
5512 * @param r Repeat: TRUE/FALSE
5514 * @ingroup Elm_Gesture_Layer
5516 EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
5519 * This function sets step-value for zoom action.
5520 * Set step to any positive value.
5521 * Cancel step setting by setting to 0.0
5523 * @param obj Pointer to gesture-layer.
5524 * @param s new zoom step value.
5526 * @ingroup Elm_Gesture_Layer
5528 EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
5531 * This function sets step-value for rotate action.
5532 * Set step to any positive value.
5533 * Cancel step setting by setting to 0.0
5535 * @param obj Pointer to gesture-layer.
5536 * @param s new roatate step value.
5538 * @ingroup Elm_Gesture_Layer
5540 EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
5543 * This function called to attach gesture-layer to an Evas_Object.
5544 * @param obj Pointer to gesture-layer.
5545 * @param t Pointer to underlying object (AKA Target)
5547 * @return TRUE, FALSE on success, failure.
5549 * @ingroup Elm_Gesture_Layer
5551 EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
5554 * Call this function to construct a new gesture-layer object.
5555 * This does not activate the gesture layer. You have to
5556 * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
5558 * @param parent the parent object.
5560 * @return Pointer to new gesture-layer object.
5562 * @ingroup Elm_Gesture_Layer
5564 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5567 typedef enum _Elm_Thumb_Animation_Setting
5569 ELM_THUMB_ANIMATION_START = 0, /* Play animation once */
5570 ELM_THUMB_ANIMATION_LOOP, /* Keep playing animation until stop is requested */
5571 ELM_THUMB_ANIMATION_STOP,
5572 ELM_THUMB_ANIMATION_LAST
5573 } Elm_Thumb_Animation_Setting;
5575 EAPI Evas_Object *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5576 EAPI void elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
5577 EAPI void elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
5578 EAPI void elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
5579 EAPI void elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
5580 EAPI void elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
5581 EAPI Elm_Thumb_Animation_Setting elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5582 EAPI void *elm_thumb_ethumb_client_get(void);
5583 EAPI Eina_Bool elm_thumb_ethumb_client_connected(void);
5584 EAPI Eina_Bool elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
5585 EAPI Eina_Bool elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5586 /* available styles:
5590 /* smart callbacks called:
5591 * "clicked" - This is called when a user has clicked the thumb without dragging around.
5592 * "clicked,double" - This is called when a user has double-clicked the thumb.
5593 * "press" - This is called when a user has pressed down the thumb.
5594 * "generate,start" - The thumbnail generation started.
5595 * "generate,stop" - The generation process stopped.
5596 * "generate,error" - The generation failed.
5597 * "load,error" - The thumbnail image loading failed.
5601 EAPI Evas_Object *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5602 EAPI void elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5603 EAPI Eina_Bool elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5604 EAPI void elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
5605 EAPI Evas_Object *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5606 EINA_DEPRECATED EAPI void elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5607 EINA_DEPRECATED EAPI const char *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5608 EAPI void elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5609 EAPI Evas_Object *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5610 EAPI Evas_Object *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5611 EAPI void elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
5612 EAPI void elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
5613 EAPI Eina_Bool elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5614 EAPI void elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5615 EAPI const Eina_List *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5616 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);
5617 EAPI void elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
5618 EAPI void elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5619 EAPI void *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
5620 EAPI const char *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
5621 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);
5622 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);
5623 /* smart callbacks called:
5624 * "clicked" - the user clicked the hoversel button and popped up the sel
5625 * "selected" - an item in the hoversel list is selected
5626 * "dismissed" - the hover is dismissed
5630 typedef enum _Elm_Toolbar_Shrink_Mode
5632 ELM_TOOLBAR_SHRINK_NONE, /**< set toolbar minimun size to fit all the items */
5633 ELM_TOOLBAR_SHRINK_HIDE, /**< hide excess items */
5634 ELM_TOOLBAR_SHRINK_SCROLL, /**< allow accessing excess items through a scroller */
5635 ELM_TOOLBAR_SHRINK_MENU /**< inserts a button to pop up a menu with excess items */
5636 } Elm_Toolbar_Shrink_Mode;
5638 typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item */
5639 typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /** State of a Elm_Toolbar_Item */
5641 EAPI Evas_Object *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5642 EAPI void elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
5643 EAPI int elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5644 EAPI void elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5645 EAPI Elm_Icon_Lookup_Order elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5646 EAPI void elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
5647 EAPI Eina_Bool elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5648 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);
5649 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);
5650 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);
5651 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);
5652 EAPI Elm_Toolbar_Item *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5653 EAPI Elm_Toolbar_Item *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5654 EAPI Elm_Toolbar_Item *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5655 EAPI Elm_Toolbar_Item *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5656 EAPI Evas_Object *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5657 EAPI void elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
5658 EAPI int elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5659 EAPI const char *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5660 EAPI const char *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5661 EAPI void elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
5662 EAPI void *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5663 EAPI void elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
5664 EAPI Elm_Toolbar_Item *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5665 EAPI Eina_Bool elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5666 EAPI void elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5667 EAPI Elm_Toolbar_Item *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5668 EAPI void elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
5669 EAPI void elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5670 EAPI void elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5671 EAPI Eina_Bool elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5672 EAPI void elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5673 EAPI void elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
5674 EAPI Eina_Bool elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5675 EAPI void elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
5676 EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5677 EAPI void elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5678 EAPI Eina_Bool elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5679 EINA_DEPRECATED EAPI void elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5680 EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5681 EAPI void elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
5682 EAPI Evas_Object *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5683 EAPI void elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
5684 EAPI double elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5685 EAPI void elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
5686 EAPI Evas_Object *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5687 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);
5688 EAPI Eina_Bool elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
5689 EAPI Eina_Bool elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
5690 EAPI void elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5691 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5692 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5693 EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
5694 EAPI void elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
5695 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);
5696 EAPI void elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5697 EAPI void elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
5698 EAPI const char *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5699 EAPI void elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
5700 EAPI const char *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5701 EAPI void elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5702 EAPI void elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
5703 EAPI const char *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5704 EAPI void elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5705 EAPI Eina_Bool elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
5706 /* smart callbacks called:
5707 * "clicked" - when the user clicks on a toolbar item and becomes selected
5709 /* available styles:
5711 * transparent (no background or shadow, just show the provided content)
5715 EAPI double elm_tooltip_delay_get(void);
5716 EAPI Eina_Bool elm_tooltip_delay_set(double delay);
5717 EAPI void elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
5718 EAPI void elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
5719 EAPI void elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
5720 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);
5721 EAPI void elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5722 EAPI void elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
5723 EAPI const char *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5724 EAPI void elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
5725 EAPI const char *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5726 EAPI void elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5727 EAPI void elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
5728 EAPI const char *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5729 EAPI void elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5730 EAPI Eina_Bool elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5733 EAPI int elm_cursor_engine_only_get(void);
5734 EAPI Eina_Bool elm_cursor_engine_only_set(int engine_only);
5737 typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
5738 EAPI Evas_Object *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5739 EAPI void elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
5740 EAPI Evas_Object *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5741 EAPI void elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
5742 EAPI void elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
5743 EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5744 EAPI Evas_Object *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5745 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);
5746 EAPI void elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
5747 EAPI const char *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5748 EAPI void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
5749 EAPI const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5750 EAPI const Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5751 EAPI void elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5752 EAPI Eina_Bool elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5753 EAPI void elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5754 EAPI Eina_Bool elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5755 EAPI Elm_Menu_Item *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
5756 EAPI Eina_Bool elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5757 EAPI void elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5758 EAPI void elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5759 EAPI void *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5760 EAPI void elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
5761 EAPI const Eina_List *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
5762 EAPI const Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
5763 EAPI const Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
5764 EAPI const Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
5765 EAPI const Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5766 EAPI const Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
5768 /* smart callbacks called:
5769 * "clicked" - the user clicked the empty space in the menu to dismiss. event_info is NULL.
5773 typedef enum _Elm_List_Mode
5775 ELM_LIST_COMPRESS = 0,
5781 typedef struct _Elm_List_Item Elm_List_Item; /**< Item of Elm_List. Sub-type of Elm_Widget_Item */
5782 EAPI Evas_Object *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5783 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);
5784 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);
5785 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);
5786 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);
5787 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);
5788 EAPI void elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5789 EAPI void elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
5790 EAPI void elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
5791 EAPI Eina_Bool elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5792 EAPI void elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
5793 EAPI Elm_List_Mode elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5794 EAPI void elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5795 EAPI Eina_Bool elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5796 EAPI void elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
5797 EAPI Eina_Bool elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5798 EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5799 EAPI Elm_List_Item *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5800 EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5801 EAPI void elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
5802 EAPI Eina_Bool elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5803 EAPI void elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
5804 EAPI Eina_Bool elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5805 EAPI void elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5806 EAPI void elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5807 EAPI void elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5808 EAPI void elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
5809 EAPI void *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5810 EAPI Evas_Object *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5811 EAPI void elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
5812 EAPI Evas_Object *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5813 EAPI void elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
5814 EAPI Evas_Object *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5815 EAPI const char *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5816 EAPI void elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
5817 EAPI Elm_List_Item *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5818 EAPI Elm_List_Item *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5819 EAPI void elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
5820 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);
5821 EAPI void elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5822 EAPI void elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
5823 EAPI const char *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5824 EAPI void elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
5825 EAPI const char *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5826 EAPI void elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
5827 EAPI void elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
5828 EAPI const char *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5829 EAPI void elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
5830 EAPI Eina_Bool elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
5831 EAPI void elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
5832 EAPI Eina_Bool elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
5833 EAPI void elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
5834 EAPI void elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
5835 EAPI void elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
5836 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);
5837 /* smart callbacks called:
5838 * "clicked,double" - when the user double-clicked an item
5839 * "selected" - when the user selected an item
5840 * "unselected" - when the user selected an item
5841 * "longpressed" - an item in the hoversel list is long-pressed
5842 * "scroll,edge,top" - the list is scrolled until the top edge
5843 * "scroll,edge,bottom" - the list is scrolled until the bottom edge
5844 * "scroll,edge,left" - the list is scrolled until the left edge
5845 * "scroll,edge,right" - the list is scrolled until the right edge
5849 EAPI Evas_Object *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5850 EINA_DEPRECATED EAPI void elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5851 EINA_DEPRECATED EAPI const char *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5852 EAPI void elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5853 EAPI Evas_Object *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5854 EAPI Evas_Object *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5855 EAPI void elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
5856 EAPI Evas_Object *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5857 EAPI Evas_Object *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5858 EAPI void elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
5859 EAPI Evas_Coord elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5860 EAPI void elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
5861 EAPI const char *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5862 EAPI void elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
5863 EAPI const char *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5864 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);
5865 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);
5866 EAPI void elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5867 EAPI Eina_Bool elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5868 EAPI void elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
5869 EAPI void elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
5870 EAPI void elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
5871 EAPI double elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5872 EAPI void elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
5873 EAPI Eina_Bool elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5874 EAPI void elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
5875 EAPI Eina_Bool elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5876 /* smart callbacks called:
5877 * "changed" - Whenever the slider value is changed by the user.
5878 * "slider,drag,start" - dragging the slider indicator around has started
5879 * "slider,drag,stop" - dragging the slider indicator around has stopped
5880 * "delay,changed" - A short time after the value is changed by the user.
5881 * This will be called only when the user stops dragging for a very short
5882 * period or when they release their finger/mouse, so it avoids possibly
5883 * expensive reactions to the value change.
5890 * @addtogroup Actionslider Actionslider
5892 * A actionslider is a switcher for 2 or 3 labels with customizable magnet
5893 * properties. The indicator is the element the user drags to choose a label.
5894 * When the position is set with magnet, when released the indicator will be
5895 * moved to it if it's nearest the magnetized position.
5897 * @note By default all positions are set as enabled.
5899 * Signals that you can add callbacks for are:
5901 * "selected" - when user selects an enabled position (the label is passed
5904 * "pos_changed" - when the indicator reaches any of the positions("left",
5905 * "right" or "center").
5907 * See an example of actionslider usage @ref actionslider_example_page "here"
5911 typedef enum _Elm_Actionslider_Indicator_Pos
5913 ELM_ACTIONSLIDER_INDICATOR_NONE,
5914 ELM_ACTIONSLIDER_INDICATOR_LEFT,
5915 ELM_ACTIONSLIDER_INDICATOR_RIGHT,
5916 ELM_ACTIONSLIDER_INDICATOR_CENTER
5917 } Elm_Actionslider_Indicator_Pos;
5919 typedef enum _Elm_Actionslider_Magnet_Pos
5921 ELM_ACTIONSLIDER_MAGNET_NONE = 0,
5922 ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
5923 ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
5924 ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
5925 ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
5926 ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
5927 } Elm_Actionslider_Magnet_Pos;
5929 typedef enum _Elm_Actionslider_Label_Pos
5931 ELM_ACTIONSLIDER_LABEL_LEFT,
5932 ELM_ACTIONSLIDER_LABEL_RIGHT,
5933 ELM_ACTIONSLIDER_LABEL_CENTER,
5934 ELM_ACTIONSLIDER_LABEL_BUTTON
5935 } Elm_Actionslider_Label_Pos;
5937 /* smart callbacks called:
5938 * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
5942 * Add a new actionslider to the parent.
5944 * @param parent The parent object
5945 * @return The new actionslider object or NULL if it cannot be created
5947 EAPI Evas_Object *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5950 * Set actionslider label.
5952 * @param[in] obj The actionslider object
5953 * @param[in] pos The position of the label.
5954 * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
5955 * @param label The label which is going to be set.
5957 EAPI void elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
5959 * Get actionslider labels.
5961 * @param obj The actionslider object
5962 * @param left_label A char** to place the left_label of @p obj into.
5963 * @param center_label A char** to place the center_label of @p obj into.
5964 * @param right_label A char** to place the right_label of @p obj into.
5966 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);
5968 * Get actionslider selected label.
5970 * @param obj The actionslider object
5971 * @return The selected label
5973 EAPI const char *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5975 * Set actionslider indicator position.
5977 * @param obj The actionslider object.
5978 * @param pos The position of the indicator.
5980 EAPI void elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
5982 * Get actionslider indicator position.
5984 * @param obj The actionslider object.
5985 * @return The position of the indicator.
5987 EAPI Elm_Actionslider_Indicator_Pos elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5989 * Set actionslider magnet position. To make multiple positions magnets @c or
5990 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
5992 * @param obj The actionslider object.
5993 * @param pos Bit mask indicating the magnet positions.
5995 EAPI void elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
5997 * Get actionslider magnet position.
5999 * @param obj The actionslider object.
6000 * @return The positions with magnet property.
6002 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6004 * Set actionslider enabled position. To set multiple positions as enabled @c or
6005 * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
6007 * @note All the positions are enabled by default.
6009 * @param obj The actionslider object.
6010 * @param pos Bit mask indicating the enabled positions.
6012 EAPI void elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
6014 * Get actionslider enabled position.
6016 * @param obj The actionslider object.
6017 * @return The enabled positions.
6019 EAPI Elm_Actionslider_Magnet_Pos elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6021 * Set the label used on the indicator.
6023 * @param obj The actionslider object
6024 * @param label The label to be set on the indicator.
6025 * @deprecated use elm_object_text_set() instead.
6027 EINA_DEPRECATED EAPI void elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6029 * Get the label used on the indicator object.
6031 * @param obj The actionslider object
6032 * @return The indicator label
6033 * @deprecated use elm_object_text_get() instead.
6035 EINA_DEPRECATED EAPI const char *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
6038 * Hold actionslider object movement.
6040 * @param[in] obj The actionslider object
6041 * @param[in] flag Actionslider hold/release
6042 * (EINA_TURE = hold/EIN_FALSE = release)
6044 * @ingroup Actionslider
6046 EAPI void elm_actionslider_hold(Evas_Object *obj, Eina_Bool flag) EINA_ARG_NONNULL(1);
6054 typedef enum _Elm_Genlist_Item_Flags
6056 ELM_GENLIST_ITEM_NONE = 0,
6057 ELM_GENLIST_ITEM_SUBITEMS = (1 << 0),
6058 ELM_GENLIST_ITEM_GROUP = (1 << 1)
6059 } Elm_Genlist_Item_Flags;
6060 typedef enum _Elm_Genlist_Item_Field_Flags
6062 ELM_GENLIST_ITEM_FIELD_ALL = 0,
6063 ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
6064 ELM_GENLIST_ITEM_FIELD_ICON = (1 << 1),
6065 ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
6066 } Elm_Genlist_Item_Field_Flags;
6067 typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;
6068 typedef struct _Elm_Genlist_Item Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
6069 typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
6070 typedef char *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
6071 typedef Evas_Object *(*GenlistItemIconGetFunc) (void *data, Evas_Object *obj, const char *part);
6072 typedef Eina_Bool (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
6073 typedef void (*GenlistItemDelFunc) (void *data, Evas_Object *obj);
6074 typedef void (*GenlistItemMovedFunc) ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
6076 struct _Elm_Genlist_Item_Class
6078 const char *item_style;
6080 GenlistItemLabelGetFunc label_get;
6081 GenlistItemIconGetFunc icon_get;
6082 GenlistItemStateGetFunc state_get;
6083 GenlistItemDelFunc del;
6084 GenlistItemMovedFunc moved;
6086 const char *edit_item_style;
6087 const char *mode_item_style;
6089 EAPI Evas_Object *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6090 EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6091 EAPI void elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
6092 EAPI Eina_Bool elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6093 EAPI void elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
6094 EAPI Elm_List_Mode elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6095 EAPI void elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
6096 EAPI Eina_Bool elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6097 EAPI void elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
6098 EAPI Eina_Bool elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6099 EAPI void elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
6100 EAPI Eina_Bool elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6101 EAPI void elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
6102 EAPI Eina_Bool elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6103 EAPI void elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6104 EAPI void elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6105 EAPI void elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
6106 EAPI Eina_Bool elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6107 EAPI void elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
6108 EAPI int elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6109 EAPI void elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
6110 EAPI double elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6111 /* operations to add items */
6112 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);
6113 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);
6114 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);
6115 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);
6116 /* operations to retrieve existing items */
6117 EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6118 EAPI const Eina_List *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6119 EAPI Eina_List *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6120 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);
6121 EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6122 EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6123 EAPI void elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6124 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);
6125 /* available item styles:
6127 * default_style - The text part is a textblock
6129 * icon_top_text_bottom
6131 /* Genlist Item operation */
6132 EAPI Elm_Genlist_Item *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6133 EAPI Elm_Genlist_Item *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6134 EAPI Evas_Object *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6135 EAPI Elm_Genlist_Item *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
6136 EAPI void elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6137 EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
6138 EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6139 EAPI void elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
6140 EAPI Eina_Bool elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6141 EAPI int elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
6142 EAPI void elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6143 EAPI Eina_Bool elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6144 EAPI void elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
6145 EAPI Eina_Bool elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
6146 EAPI void elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6147 EAPI void elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6148 EAPI void elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6149 EAPI void elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6150 EAPI void elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
6151 EAPI void elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
6152 EAPI void elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6153 EAPI void *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6154 EAPI void elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
6155 EAPI void elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
6156 EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
6157 EAPI void elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6158 EAPI void elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
6159 EAPI void elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
6160 EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
6161 EAPI void elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
6162 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);
6163 EAPI void elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6164 EAPI void elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
6165 EAPI const char *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6166 EAPI void elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
6167 EAPI const char *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6168 EAPI void elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6169 EAPI void elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
6170 EAPI const char *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6171 EAPI void elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
6172 EAPI Eina_Bool elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6173 EAPI void elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
6174 EAPI void elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
6175 EAPI const char *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6176 EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6177 EAPI void elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
6178 EAPI Eina_Bool elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6179 /* Signals that you can add callbacks for are:
6180 * "clicked,double" - This is called when a user has double-clicked an item.
6181 * The event_info parameter is the genlist item that was
6183 * "selected" - This is called when a user has made an item selected. The
6184 * event_info parameter is the genlist item that was selected.
6185 * "unselected" - This is called when a user has made an item unselected. The
6186 * event_info parameter is the genlist item that was unselected.
6187 * "expanded" - This is called when elm_genlist_item_expanded_set() is called
6188 * and the item is now meant to be expanded. The event_info parameter is the
6189 * genlist item that was indicated to expand. It is the job of this callback
6190 * to then fill in the child items.
6191 * "contracted" - This is called when elm_genlist_item_expanded_set() is called
6192 * and the item is now meant to be contracted. The event_info parameter is
6193 * the genlist item that was indicated to contract. It is the job of this
6194 * callback to then delete the child items.
6195 * "expand,request" - This is called when a user has indicated they want to
6196 * expand a tree branch item. The callback should decide if the item can
6197 * expand (has any children) and then call elm_genlist_item_expanded_set()
6198 * appropriately to set the state. The event_info parameter is the genlist
6199 * item that was indicated to expand.
6200 * "contract,request" - This is called when a user has indicated they want to
6201 * contract a tree branch item. The callback should decide if the item can
6202 * contract (has any children) and then call elm_genlist_item_expanded_set()
6203 * appropriately to set the state. The event_info parameter is the genlist
6204 * item that was indicated to contract.
6205 * "realized" - This is called when the item in the list is created as a real
6206 * evas object. event_info parameter is the genlist item that was created.
6207 * The object may be deleted at any time, so it is up to the caller to
6208 * not use the object pointer from elm_genlist_item_object_get() in a way
6209 * where it may point to freed objects.
6210 * "unrealized" - This is called just before an item is unrealized. After
6211 * this call icon objects provided will be deleted and the item object
6212 * itself delete or be put into a floating cache.
6213 * "drag,start,up" - This is called when the item in the list has been dragged
6214 * (not scrolled) up.
6215 * "drag,start,down" - This is called when the item in the list has been dragged
6216 * (not scrolled) down.
6217 * "drag,start,left" - This is called when the item in the list has been dragged i
6218 * (not scrolled) left.
6219 * "drag,start,right" - This is called when the item in the list has been dragged
6220 * (not scrolled) right.
6221 * "drag,stop" - This is called when the item in the list has stopped being
6223 * "drag" - This is called when the item in the list is being dragged.
6224 * "longpressed" - This is called when the item is pressed for a certain amount
6225 * of time. By default it's 1 second.
6226 * "scroll,anim,start" - This is called when scrolling animation has started.
6227 * "scroll,anim,stop" - This is called when scrolling animation has stopped.
6228 * "scroll,drag,start" - This is called when dragging the content has started.
6229 * "scroll,drag,stop" - This is called when dragging the content has stopped.
6230 * "scroll,edge,top" - This is called when the genlist is scrolled until the
6232 * "scroll,edge,bottom" - This is called when the genlist is scrolled until the
6234 * "scroll,edge,left" - This is called when the genlist is scrolled until the
6236 * "scroll,edge,right" - This is called when the genlist is scrolled until the
6238 * "multi,swipe,left" - This is called when the genlist is multi-touch swiped
6240 * "multi,swipe,right" - This is called when the genlist is multi-touch swiped
6242 * "multi,swipe,up" - This is called when the genlist is multi-touch swiped up.
6243 * "multi,swipe,down" - This is called when the genlist is multi-touch swiped
6245 * "multi,pinch,out" - This is called when the genlist is multi-touch pinched
6247 * "multi,pinch,in" - This is called when the genlist is multi-touch pinched in.
6250 EAPI void elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
6251 EAPI Eina_Bool elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6252 EAPI void elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
6253 EAPI Eina_Bool elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
6254 EAPI void elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
6255 EAPI void elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
6256 EAPI void elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
6257 EAPI void elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
6258 EAPI void elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
6259 EAPI Eina_Bool elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6262 * @page tutorial_check Check example
6263 * @dontinclude check_example_01.c
6265 * This example will show 2 checkboxes, one with just a label and the second
6266 * one with both a label and an icon. This example also ilustrates how to
6267 * have the checkbox change the value of a variable and how to react to those
6270 * We will start with the usual setup code:
6273 * And now we create our first checkbox, set its label, tell it to change
6274 * the value of @p value when the checkbox stats is changed and ask to be
6275 * notified of state changes:
6278 * For our second checkbox we are going to set an icon so we need to create
6281 * @note For simplicity we are using a rectangle as icon, but any evas object
6284 * And for our second checkbox we set the label, icon and state to true:
6287 * We now do some more setup:
6290 * And finally implement the callback that will be called when the first
6291 * checkbox's state changes. This callback will use @p data to print a
6294 * @note This work because @p data is @p value(from the main function) and @p
6295 * value is changed when the checkbox is changed.
6297 * Our example will look like this:
6298 * @image html screenshots/check_example_01.png
6299 * @image latex screenshots/check_example_01.eps
6301 * @example check_example_01.c
6304 * @defgroup Check Check
6306 * @brief The check widget allows for toggling a value between true and
6309 * Check objects are a lot like radio objects in layout and functionality
6310 * except they do not work as a group, but independently and only toggle the
6311 * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
6312 * the boolean state (1 for true, 0 for false), and elm_check_state_get()
6313 * returns the current state. For convenience, like the radio objects, you
6314 * can set a pointer to a boolean directly with elm_check_state_pointer_set()
6317 * Signals that you can add callbacks for are:
6318 * "changed" - This is called whenever the user changes the state of one of
6319 * the check object(event_info is NULL).
6321 * @ref tutorial_check should give you a firm grasp of how to use this widget.
6325 * @brief Add a new Check object
6327 * @param parent The parent object
6328 * @return The new object or NULL if it cannot be created
6330 EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6332 * @brief Set the text label of the check object
6334 * @param obj The check object
6335 * @param label The text label string in UTF-8
6337 * @deprecated use elm_object_text_set() instead.
6339 EINA_DEPRECATED EAPI void elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6341 * @brief Get the text label of the check object
6343 * @param obj The check object
6344 * @return The text label string in UTF-8
6346 * @deprecated use elm_object_text_get() instead.
6348 EINA_DEPRECATED EAPI const char *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6350 * @brief Set the icon object of the check object
6352 * @param obj The check object
6353 * @param icon The icon object
6355 * Once the icon object is set, a previously set one will be deleted.
6356 * If you want to keep that old content object, use the
6357 * elm_check_icon_unset() function.
6359 EAPI void elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6361 * @brief Get the icon object of the check object
6363 * @param obj The check object
6364 * @return The icon object
6366 EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6368 * @brief Unset the icon used for the check object
6370 * @param obj The check object
6371 * @return The icon object that was being used
6373 * Unparent and return the icon object which was set for this widget.
6375 EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6377 * @brief Set the on/off state of the check object
6379 * @param obj The check object
6380 * @param state The state to use (1 == on, 0 == off)
6382 * This sets the state of the check. If set
6383 * with elm_check_state_pointer_set() the state of that variable is also
6384 * changed. Calling this @b doesn't cause the "changed" signal to be emited.
6386 EAPI void elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
6388 * @brief Get the state of the check object
6390 * @param obj The check object
6391 * @return The boolean state
6393 EAPI Eina_Bool elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6395 * @brief Set a convenience pointer to a boolean to change
6397 * @param obj The check object
6398 * @param statep Pointer to the boolean to modify
6400 * This sets a pointer to a boolean, that, in addition to the check objects
6401 * state will also be modified directly. To stop setting the object pointed
6402 * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
6403 * then when this is called, the check objects state will also be modified to
6404 * reflect the value of the boolean @p statep points to, just like calling
6405 * elm_check_state_set().
6407 EAPI void elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
6413 EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6414 EINA_DEPRECATED EAPI void elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6415 EINA_DEPRECATED EAPI const char *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6416 EAPI void elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6417 EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6418 EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6419 EAPI void elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
6420 EAPI void elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
6421 EAPI int elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6422 EAPI void elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
6423 EAPI int elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6424 EAPI void elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
6425 /* smart callbacks called:
6426 * "changed" - when the radio status is changed
6430 EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6431 EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6432 EAPI void elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
6433 EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6434 EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6435 EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6436 EAPI void elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
6437 EAPI void elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
6439 /* available item styles:
6445 /* smart callbacks called:
6446 * "hide,finished" - when the previous page is hided
6449 typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class;
6450 typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func;
6451 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item; /**< Item of Elm_Slideshow. Sub-type of Elm_Widget_Item */
6452 typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj);
6453 typedef void (*SlideshowItemDelFunc) (void *data, Evas_Object *obj);
6455 struct _Elm_Slideshow_Item_Class
6457 struct _Elm_Slideshow_Item_Class_Func
6459 SlideshowItemGetFunc get;
6460 SlideshowItemDelFunc del;
6464 EAPI Evas_Object *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6465 EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
6466 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);
6467 EAPI void elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
6468 EAPI void elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
6469 EAPI void elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
6470 EAPI const Eina_List *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6471 EAPI void elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
6472 EAPI const char *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6473 EAPI void elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
6474 EAPI double elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6475 EAPI void elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
6476 EAPI Eina_Bool elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6477 EAPI void elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6478 EAPI const Eina_List *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6479 EAPI void elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
6480 EAPI void *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
6481 EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6482 EAPI Evas_Object* elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
6483 EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
6484 EAPI const char *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6485 EAPI void elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
6486 EAPI const Eina_List *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6487 EAPI void elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
6488 EAPI int elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6489 EAPI void elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
6490 EAPI int elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6491 EAPI unsigned int elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6492 /* smart callbacks called:
6493 * "changed" - when the slideshow switch to another item
6497 typedef enum _Elm_Fileselector_Mode
6499 ELM_FILESELECTOR_LIST = 0,
6500 ELM_FILESELECTOR_GRID,
6501 ELM_FILESELECTOR_LAST
6502 } Elm_Fileselector_Mode;
6504 EAPI Evas_Object *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6505 EAPI void elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
6506 EAPI Eina_Bool elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6507 EAPI void elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
6508 EAPI Eina_Bool elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6509 EAPI void elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
6510 EAPI Eina_Bool elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6511 EAPI Eina_Bool elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6512 EAPI void elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
6513 EAPI void elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6514 EAPI const char *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6515 EAPI const char *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6516 EAPI Eina_Bool elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6517 EAPI void elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
6518 EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6519 /* smart callbacks called:
6520 * "selected" - the user click on a file
6521 * "directory,open" - the list is populate with a new content. event_info is a directory.
6522 * "done" - the user click on the ok or cancel buttons
6526 EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6527 EAPI void elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
6528 EAPI Eina_Bool elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6529 EAPI void elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
6530 EAPI void elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
6531 EAPI double elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6532 EINA_DEPRECATED EAPI void elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6533 EINA_DEPRECATED EAPI const char *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6534 EAPI void elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6535 EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6536 EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6537 EAPI void elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
6538 EAPI Evas_Coord elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6539 EAPI void elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
6540 EAPI const char *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6541 EAPI void elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6542 EAPI Eina_Bool elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6543 EAPI void elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
6544 EAPI Eina_Bool elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6545 /* smart callbacks called:
6547 /* available item styles:
6549 * wheel (simple style, no text, no progression, only pulse is available)
6553 EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6554 EAPI void elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6555 EAPI Eina_Bool elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6556 /* smart callbacks called:
6560 EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6561 EAPI void elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
6562 EAPI const char *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6563 EAPI void elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
6564 EAPI void elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
6565 EAPI void elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
6566 EAPI double elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6567 EAPI void elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
6568 EAPI double elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6569 EAPI void elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
6570 EAPI Eina_Bool elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6571 EAPI void elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
6572 EAPI Eina_Bool elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6573 EAPI void elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
6574 EAPI void elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
6575 EAPI double elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6576 /* smart callbacks called:
6577 * "changed" - when the spinner value changes
6578 * "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).
6580 /* available item styles:
6582 * vertical (two up/down buttons at the right side and text left aligned)
6586 typedef struct _Elm_Index_Item Elm_Index_Item; /**< Item of Elm_Index. Sub-type of Elm_Widget_Item */
6588 EAPI Evas_Object *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6589 EAPI void elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
6590 EAPI Eina_Bool elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6591 EAPI void elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
6592 EAPI int elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6593 EAPI void *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
6594 EAPI void elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
6595 EAPI void elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
6596 EAPI void elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
6597 EAPI void elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
6598 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);
6599 EAPI void elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
6600 EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
6601 EAPI void elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6602 EAPI void elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
6603 EAPI void *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
6604 EAPI void elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
6605 EAPI void elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
6606 EAPI const char *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
6607 EAPI void elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
6608 /* smart callbacks called:
6609 * "changed" - when the selected index item changes
6610 * "delay,changed" - when the selected index item changes, but after some small idle period
6611 * "selected" - when the user releases a finger and selects an item
6612 * "level,up" - when the user moves a finger from the first level to the second level
6613 * "level,down" - when the user moves a finger from the second level to the first level
6617 typedef enum _Elm_Photocam_Zoom_Mode
6619 ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0,
6620 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT,
6621 ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL,
6622 ELM_PHOTOCAM_ZOOM_MODE_LAST
6623 } Elm_Photocam_Zoom_Mode;
6625 EAPI Evas_Object *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6626 EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
6627 EAPI const char *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6628 EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
6629 EAPI double elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6630 EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
6631 EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6632 EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
6633 EAPI void elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
6634 EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
6635 EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
6636 EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
6637 EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6638 EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6639 EAPI void elm_photocam_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6640 EAPI void elm_photocam_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6641 /* smart callbacks called:
6642 * "clicked" - when image clicked
6643 * "press" - when mouse/finger held down initially on image
6644 * "longpressed" - when mouse/finger held for long time on image
6645 * "clicked,double" - when mouse/finger double-clicked
6646 * "load" - when photo load begins
6647 * "loaded" - when photo load done
6648 * "load,detail" - when detailed image load begins
6649 * "loaded,detail" - when detailed image load done
6650 * "zoom,start" - when zooming started
6651 * "zoom,stop" - when zooming stopped
6652 * "zoom,change" - when auto zoom mode changed zoom level
6653 * "scroll - the content has been scrolled (moved)
6654 * "scroll,anim,start" - scrolling animation has started
6655 * "scroll,anim,stop" - scrolling animation has stopped
6656 * "scroll,drag,start" - dragging the contents around has started
6657 * "scroll,drag,stop" - dragging the contents around has stopped
6661 typedef enum _Elm_Map_Zoom_Mode
6663 ELM_MAP_ZOOM_MODE_MANUAL,
6664 ELM_MAP_ZOOM_MODE_AUTO_FIT,
6665 ELM_MAP_ZOOM_MODE_AUTO_FILL,
6666 ELM_MAP_ZOOM_MODE_LAST
6667 } Elm_Map_Zoom_Mode;
6669 typedef enum _Elm_Map_Route_Sources
6671 ELM_MAP_ROUTE_SOURCE_YOURS,
6672 ELM_MAP_ROUTE_SOURCE_MONAV,
6673 ELM_MAP_ROUTE_SOURCE_ORS,
6674 ELM_MAP_ROUTE_SOURCE_LAST
6675 } Elm_Map_Route_Sources;
6677 typedef enum _Elm_Map_Name_Sources
6679 ELM_MAP_NAME_SOURCE_NOMINATIM,
6680 ELM_MAP_NAME_SOURCE_LAST
6681 } Elm_Map_Name_Sources;
6683 typedef enum _Elm_Map_Route_Type
6685 ELM_MAP_ROUTE_TYPE_MOTOCAR,
6686 ELM_MAP_ROUTE_TYPE_BICYCLE,
6687 ELM_MAP_ROUTE_TYPE_FOOT,
6688 ELM_MAP_ROUTE_TYPE_LAST
6689 } Elm_Map_Route_Type;
6691 typedef enum _Elm_Map_Route_Method
6693 ELM_MAP_ROUTE_METHOD_FASTEST,
6694 ELM_MAP_ROUTE_METHOD_SHORTEST,
6695 ELM_MAP_ROUTE_METHOD_LAST
6696 } Elm_Map_Route_Method;
6698 typedef enum _Elm_Map_Name_Method
6700 ELM_MAP_NAME_METHOD_SEARCH,
6701 ELM_MAP_NAME_METHOD_REVERSE,
6702 ELM_MAP_NAME_METHOD_LAST
6703 } Elm_Map_Name_Method;
6705 typedef struct _Elm_Map_Marker Elm_Map_Marker;
6706 typedef struct _Elm_Map_Marker_Class Elm_Map_Marker_Class;
6707 typedef struct _Elm_Map_Group_Class Elm_Map_Group_Class;
6708 typedef struct _Elm_Map_Route Elm_Map_Route;
6709 typedef struct _Elm_Map_Name Elm_Map_Name;
6710 typedef struct _Elm_Map_Track Elm_Map_Track;
6712 typedef Evas_Object *(*ElmMapMarkerGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
6713 typedef void (*ElmMapMarkerDelFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o);
6714 typedef Evas_Object *(*ElmMapMarkerIconGetFunc) (Evas_Object *obj, Elm_Map_Marker *marker, void *data);
6715 typedef Evas_Object *(*ElmMapGroupIconGetFunc) (Evas_Object *obj, void *data);
6717 typedef char *(*ElmMapModuleSourceFunc) (void);
6718 typedef int (*ElmMapModuleZoomMinFunc) (void);
6719 typedef int (*ElmMapModuleZoomMaxFunc) (void);
6720 typedef char *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
6721 typedef int (*ElmMapModuleRouteSourceFunc) (void);
6722 typedef char *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
6723 typedef char *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
6724 typedef Eina_Bool (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
6725 typedef Eina_Bool (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
6727 EAPI Evas_Object *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6728 EAPI void elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
6729 EAPI int elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6730 EAPI void elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
6731 EAPI Elm_Map_Zoom_Mode elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6732 EAPI void elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
6733 EAPI void elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
6734 EAPI void elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
6735 EAPI void elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
6736 EAPI Eina_Bool elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6737 EAPI void elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
6738 EAPI Eina_Bool elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6739 EAPI void elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
6740 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);
6741 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);
6742 EAPI Elm_Map_Name *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
6743 EAPI Elm_Map_Name *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
6744 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);
6745 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);
6746 EAPI void elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
6747 EAPI void elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6748 EAPI void elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
6749 EAPI void elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6750 EAPI void elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6751 EAPI void elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
6752 EAPI Evas_Object *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6753 EAPI void elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
6754 EAPI void elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
6755 EAPI Elm_Map_Group_Class *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
6756 EAPI void elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
6757 EAPI void elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
6758 EAPI void elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
6759 EAPI void elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
6760 EAPI void elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
6761 EAPI void elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
6762 EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
6763 EAPI void elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
6764 EAPI void elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
6765 EAPI void elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
6766 EAPI void elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
6767 EAPI const char **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6768 EAPI void elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
6769 EAPI const char *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6770 EAPI void elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
6771 EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6772 EAPI void elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
6773 EAPI int elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6774 EAPI void elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
6775 EAPI int elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6776 EAPI void elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
6777 EAPI const char *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6778 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);
6779 EAPI void elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6780 EAPI void elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
6781 EAPI void elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
6782 EAPI double elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6783 EAPI const char *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6784 EAPI const char *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
6785 EAPI const char *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
6786 EAPI void elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
6787 EAPI void elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
6788 EAPI void elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
6789 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);
6790 EAPI void elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6791 EAPI Eina_Bool elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6793 EAPI Evas_Object *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
6795 EAPI void elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
6797 /* smart callbacks called:
6798 * "clicked" - when image clicked
6799 * "press" - when mouse/finger held down initially on image
6800 * "longpressed" - when mouse/finger held for long time on image
6801 * "clicked,double" - when mouse/finger double-clicked
6802 * "load,details" - when detailed image load begins
6803 * "loaded,details" - when detailed image load done
6804 * "zoom,start" - when zooming started
6805 * "zoom,stop" - when zooming stopped
6806 * "zoom,change" - when auto zoom mode changed zoom level
6807 * "scroll - the content has been scrolled (moved)
6808 * "scroll,anim,start" - scrolling animation has started
6809 * "scroll,anim,stop" - scrolling animation has stopped
6810 * "scroll,drag,start" - dragging the contents around has started
6811 * "scroll,drag,stop" - dragging the contents around has stopped
6815 EAPI Evas_Object *elm_route_add(Evas_Object *parent);
6817 EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
6819 EAPI double elm_route_lon_min_get(Evas_Object *obj);
6820 EAPI double elm_route_lat_min_get(Evas_Object *obj);
6821 EAPI double elm_route_lon_max_get(Evas_Object *obj);
6822 EAPI double elm_route_lat_max_get(Evas_Object *obj);
6826 typedef enum _Elm_Panel_Orient
6828 ELM_PANEL_ORIENT_TOP,
6829 ELM_PANEL_ORIENT_BOTTOM,
6830 ELM_PANEL_ORIENT_LEFT,
6831 ELM_PANEL_ORIENT_RIGHT,
6834 EAPI Evas_Object *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6835 EAPI void elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
6836 EAPI Elm_Panel_Orient elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6837 EAPI void elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6838 EAPI Evas_Object *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6839 EAPI Evas_Object *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6840 EAPI void elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
6841 EAPI Eina_Bool elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6842 EAPI void elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
6848 * Update the minimun height of the bar in the theme. No minimun should be set in the vertical theme
6849 * Add events (move, start ...)
6851 EAPI Evas_Object *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6852 EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6853 EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6854 EAPI Evas_Object *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6855 EAPI Evas_Object *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6856 EAPI Evas_Object *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6857 EAPI Evas_Object *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6858 EAPI double elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6859 EAPI void elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
6860 EAPI void elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6861 EAPI Eina_Bool elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6862 EAPI void elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
6863 EAPI Eina_Bool elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6866 typedef enum _Elm_Flip_Mode
6868 ELM_FLIP_ROTATE_Y_CENTER_AXIS,
6869 ELM_FLIP_ROTATE_X_CENTER_AXIS,
6870 ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
6871 ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
6873 ELM_FLIP_CUBE_RIGHT,
6877 ELM_FLIP_PAGE_RIGHT,
6881 typedef enum _Elm_Flip_Interaction
6883 ELM_FLIP_INTERACTION_NONE,
6884 ELM_FLIP_INTERACTION_ROTATE,
6885 ELM_FLIP_INTERACTION_CUBE,
6886 ELM_FLIP_INTERACTION_PAGE
6887 } Elm_Flip_Interaction;
6888 typedef enum _Elm_Flip_Direction
6890 ELM_FLIP_DIRECTION_UP,
6891 ELM_FLIP_DIRECTION_DOWN,
6892 ELM_FLIP_DIRECTION_LEFT,
6893 ELM_FLIP_DIRECTION_RIGHT
6894 } Elm_Flip_Direction;
6896 EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6897 EAPI void elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6898 EAPI void elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6899 EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6900 EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6901 EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6902 EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6903 EAPI Eina_Bool elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6904 EAPI void elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
6905 EAPI void elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
6906 EAPI void elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
6907 EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
6908 EAPI void elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
6909 EAPI Eina_Bool elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
6910 EAPI void elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
6911 EAPI double elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
6912 /* smart callbacks called:
6913 * "animate,begin" - when a flip animation was started
6914 * "animate,done" - when a flip animation is finished
6918 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6919 EINA_DEPRECATED EAPI void elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
6920 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6921 EINA_DEPRECATED EAPI void elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
6922 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6923 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
6924 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6925 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
6926 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6927 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6928 EINA_DEPRECATED EAPI void elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
6929 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
6930 EINA_DEPRECATED EAPI void elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
6931 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6932 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
6933 EINA_DEPRECATED EAPI void elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6934 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
6935 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
6936 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
6937 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
6938 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6939 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6940 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6941 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
6942 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
6943 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
6944 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6945 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6946 EINA_DEPRECATED EAPI const char *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6947 EINA_DEPRECATED EAPI void elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
6948 EINA_DEPRECATED EAPI int elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6949 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
6950 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
6951 EINA_DEPRECATED EAPI void elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
6952 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6953 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);
6954 EINA_DEPRECATED EAPI void elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
6955 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6956 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);
6957 EINA_DEPRECATED EAPI void elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6958 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);
6959 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
6960 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6961 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6962 EINA_DEPRECATED EAPI void elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6963 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
6964 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6965 EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6966 EINA_DEPRECATED EAPI void elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
6967 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);
6968 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);
6969 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);
6970 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);
6971 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);
6972 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);
6973 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
6974 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
6975 EINA_DEPRECATED EAPI void elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
6976 EINA_DEPRECATED EAPI void elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
6977 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6978 EINA_DEPRECATED EAPI void elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
6979 EINA_DEPRECATED EAPI Eina_Bool elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
6980 EINA_DEPRECATED EAPI void elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
6981 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
6982 EINA_DEPRECATED EAPI void elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
6983 EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
6984 EINA_DEPRECATED EAPI void elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
6985 EINA_DEPRECATED EAPI void elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
6988 EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6989 EAPI void elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6990 EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6991 EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6992 EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6995 EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6996 EAPI void elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
6997 EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6998 EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6999 EAPI void elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
7000 EAPI Eina_Bool elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7001 EAPI void elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
7002 EAPI Eina_Bool elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7003 EAPI void elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
7004 EAPI Eina_Bool elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7007 * @defgroup Flipselector Flip Selector
7009 * A flip selector is a widget to show a set of @b text items, one
7010 * at a time, with the same sheet switching style as the @ref Clock
7011 * "clock" widget, when one changes the current displaying sheet
7012 * (thus, the "flip" in the name).
7014 * User clicks to flip sheets which are @b held for some time will
7015 * make the flip selector to flip continuosly and automatically for
7016 * the user. The interval between flips will keep growing in time,
7017 * so that it helps the user to reach an item which is distant from
7018 * the current selection.
7020 * Smart callbacks one can register to:
7021 * - @c "selected" - when the widget's selected text item is changed
7022 * - @c "overflowed" - when the widget's current selection is changed
7023 * from the first item in its list to the last
7024 * - @c "underflowed" - when the widget's current selection is changed
7025 * from the last item in its list to the first
7027 * Available styles for it:
7030 * Here is an example on its usage:
7031 * @li @ref flipselector_example
7035 * @addtogroup Flipselector
7039 typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
7042 * Add a new flip selector widget to the given parent Elementary
7043 * (container) widget
7045 * @param parent The parent object
7046 * @return a new flip selector widget handle or @c NULL, on errors
7048 * This function inserts a new flip selector widget on the canvas.
7050 * @ingroup Flipselector
7052 EAPI Evas_Object *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7055 * Programmatically select the next item of a flip selector widget
7057 * @param obj The flipselector object
7059 * @note The selection will be animated. Also, if it reaches the
7060 * end of its list of member items, it will continue with the first
7063 * @ingroup Flipselector
7065 EAPI void elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
7068 * Programmatically select the previous item of a flip selector
7071 * @param obj The flipselector object
7073 * @note The selection will be animated. Also, if it reaches the
7074 * beginning of its list of member items, it will continue with the
7075 * last one backwards.
7077 * @ingroup Flipselector
7079 EAPI void elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
7082 * Append a (text) item to a flip selector widget
7084 * @param obj The flipselector object
7085 * @param label The (text) label of the new item
7086 * @param func Convenience callback function to take place when
7088 * @param data Data passed to @p func, above
7089 * @return A handle to the item added or @c NULL, on errors
7091 * The widget's list of labels to show will be appended with the
7092 * given value. If the user wishes so, a callback function pointer
7093 * can be passed, which will get called when this same item is
7096 * @note The current selection @b won't be modified by appending an
7097 * element to the list.
7099 * @note The maximum length of the text label is going to be
7100 * determined <b>by the widget's theme</b>. Strings larger than
7101 * that value are going to be @b truncated.
7103 * @ingroup Flipselector
7105 EAPI Elm_Flipselector_Item *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
7108 * Prepend a (text) item to a flip selector widget
7110 * @param obj The flipselector object
7111 * @param label The (text) label of the new item
7112 * @param func Convenience callback function to take place when
7114 * @param data Data passed to @p func, above
7115 * @return A handle to the item added or @c NULL, on errors
7117 * The widget's list of labels to show will be prepended with the
7118 * given value. If the user wishes so, a callback function pointer
7119 * can be passed, which will get called when this same item is
7122 * @note The current selection @b won't be modified by prepending
7123 * an element to the list.
7125 * @note The maximum length of the text label is going to be
7126 * determined <b>by the widget's theme</b>. Strings larger than
7127 * that value are going to be @b truncated.
7129 * @ingroup Flipselector
7131 EAPI Elm_Flipselector_Item *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
7134 * Get the internal list of items in a given flip selector widget.
7136 * @param obj The flipselector object
7137 * @return The list of items (#Elm_Flipselector_Item as data) or @c
7140 * This list is @b not to be modified in any way and must not be
7141 * freed. Use the list members with functions like
7142 * elm_flipselector_item_label_set(),
7143 * elm_flipselector_item_label_get(), elm_flipselector_item_del(),
7144 * elm_flipselector_item_del(),
7145 * elm_flipselector_item_selected_get(),
7146 * elm_flipselector_item_selected_set().
7148 * @warning This list is only valid until @p obj object's internal
7149 * items list is changed. It should be fetched again with another
7150 * call to this function when changes happen.
7152 * @ingroup Flipselector
7154 EAPI const Eina_List *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7157 * Get the first item in the given flip selector widget's list of
7160 * @param obj The flipselector object
7161 * @return The first item or @c NULL, if it has no items (and on
7164 * @see elm_flipselector_item_append()
7165 * @see elm_flipselector_last_item_get()
7167 * @ingroup Flipselector
7169 EAPI Elm_Flipselector_Item *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7172 * Get the last item in the given flip selector widget's list of
7175 * @param obj The flipselector object
7176 * @return The last item or @c NULL, if it has no items (and on
7179 * @see elm_flipselector_item_prepend()
7180 * @see elm_flipselector_first_item_get()
7182 * @ingroup Flipselector
7184 EAPI Elm_Flipselector_Item *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7187 * Get the currently selected item in a flip selector widget.
7189 * @param obj The flipselector object
7190 * @return The selected item or @c NULL, if the widget has no items
7193 * @ingroup Flipselector
7195 EAPI Elm_Flipselector_Item *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7198 * Set whether a given flip selector widget's item should be the
7199 * currently selected one.
7201 * @param item The flip selector item
7202 * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
7204 * This sets whether @p item is or not the selected (thus, under
7205 * display) one. If @p item is different than one under display,
7206 * the latter will be unselected. If the @p item is set to be
7207 * unselected, on the other hand, the @b first item in the widget's
7208 * internal members list will be the new selected one.
7210 * @see elm_flipselector_item_selected_get()
7212 * @ingroup Flipselector
7214 EAPI void elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
7217 * Get whether a given flip selector widget's item is the currently
7220 * @param item The flip selector item
7221 * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
7224 * @see elm_flipselector_item_selected_set()
7226 * @ingroup Flipselector
7228 EAPI Eina_Bool elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
7231 * Delete a given item from a flip selector widget.
7233 * @param item The item to delete
7235 * @ingroup Flipselector
7237 EAPI void elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
7240 * Get the label of a given flip selector widget's item.
7242 * @param item The item to get label from
7243 * @return The text label of @p item or @c NULL, on errors
7245 * @see elm_flipselector_item_label_set()
7247 * @ingroup Flipselector
7249 EAPI const char *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
7252 * Set the label of a given flip selector widget's item.
7254 * @param item The item to set label on
7255 * @param label The text label string, in UTF-8 encoding
7257 * @see elm_flipselector_item_label_get()
7259 * @ingroup Flipselector
7261 EAPI void elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
7264 * Gets the item before @p item in a flip selector widget's
7265 * internal list of items.
7267 * @param item The item to fetch previous from
7268 * @return The item before the @p item, in its parent's list. If
7269 * there is no previous item for @p item or there's an
7270 * error, @c NULL is returned.
7272 * @see elm_flipselector_item_next_get()
7274 * @ingroup Flipselector
7276 EAPI Elm_Flipselector_Item *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
7279 * Gets the item after @p item in a flip selector widget's
7280 * internal list of items.
7282 * @param item The item to fetch next from
7283 * @return The item after the @p item, in its parent's list. If
7284 * there is no next item for @p item or there's an
7285 * error, @c NULL is returned.
7287 * @see elm_flipselector_item_next_get()
7289 * @ingroup Flipselector
7291 EAPI Elm_Flipselector_Item *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
7294 * Set the interval on time updates for an user mouse button hold
7295 * on a flip selector widget.
7297 * @param obj The flip selector object
7298 * @param interval The (first) interval value in seconds
7300 * This interval value is @b decreased while the user holds the
7301 * mouse pointer either flipping up or flipping doww a given flip
7304 * This helps the user to get to a given item distant from the
7305 * current one easier/faster, as it will start to flip quicker and
7306 * quicker on mouse button holds.
7308 * The calculation for the next flip interval value, starting from
7309 * the one set with this call, is the previous interval divided by
7310 * 1.05, so it decreases a little bit.
7312 * The default starting interval value for automatic flips is
7315 * @see elm_flipselector_interval_get()
7317 * @ingroup Flipselector
7319 EAPI void elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
7322 * Get the interval on time updates for an user mouse button hold
7323 * on a flip selector widget.
7325 * @param obj The flip selector object
7326 * @return The (first) interval value, in seconds, set on it
7328 * @see elm_flipselector_interval_set() for more details
7330 * @ingroup Flipselector
7332 EAPI double elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7339 * @addtogroup Animator Animator
7340 * @ingroup Elementary
7342 * @brief Functions to ease creation of animations.
7344 * elm_animator is designed to provide an easy way to create animations.
7345 * Creating an animation with elm_animator is as simple as setting a
7346 * duration, an operating callback and telling it to run the animation.
7347 * However that is not the full extent of elm_animator's ability, animations
7348 * can be paused and resumed, reversed and the animation need not be linear.
7350 * To run an animation you must specify at least a duration and operation
7351 * callback, not setting any other properties will create a linear animation
7352 * that runs once and is not reversed.
7354 * @ref elm_animator_example_page_01 "This" example should make all of that
7357 * @warning elm_animator is @b not a widget.
7361 * @brief Type of curve desired for animation.
7363 * The speed in which an animation happens doesn't have to be linear, some
7364 * animations will look better if they're accelerating or decelerating, so
7365 * elm_animator provides four options in this regard:
7366 * @image html elm_animator_curve_style.png
7367 * @image latex elm_animator_curve_style.eps width=\textwidth
7368 * As can be seen in the image the speed of the animation will be:
7369 * @li ELM_ANIMATOR_CURVE_LINEAR constant
7370 * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
7371 * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
7372 * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
7376 ELM_ANIMATOR_CURVE_LINEAR,
7377 ELM_ANIMATOR_CURVE_IN_OUT,
7378 ELM_ANIMATOR_CURVE_IN,
7379 ELM_ANIMATOR_CURVE_OUT
7380 } Elm_Animator_Curve_Style;
7381 typedef struct _Elm_Animator Elm_Animator;
7383 * Called back per loop of an elementary animators cycle
7384 * @param data user-data given to elm_animator_operation_callback_set()
7385 * @param animator the animator being run
7386 * @param double the position in the animation
7388 typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
7390 * Called back when an elementary animator finishes
7391 * @param data user-data given to elm_animator_completion_callback_set()
7393 typedef void (*Elm_Animator_Completion_Cb) (void *data);
7396 * @brief Create a new animator.
7398 * @param[in] parent Parent object
7400 * The @a parent argument can be set to NULL for no parent. If a parent is set
7401 * there is no need to call elm_animator_del(), when the parent is deleted it
7402 * will delete the animator.
7403 * @deprecated Use @ref Transit instead.
7406 EINA_DEPRECATED EAPI Elm_Animator* elm_animator_add(Evas_Object *parent);
7408 * Deletes the animator freeing any resources it used. If the animator was
7409 * created with a NULL parent this must be called, otherwise it will be
7410 * automatically called when the parent is deleted.
7412 * @param[in] animator Animator object
7413 * @deprecated Use @ref Transit instead.
7415 EINA_DEPRECATED EAPI void elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
7417 * Set the duration of the animation.
7419 * @param[in] animator Animator object
7420 * @param[in] duration Duration in second
7421 * @deprecated Use @ref Transit instead.
7423 EINA_DEPRECATED EAPI void elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
7425 * @brief Set the callback function for animator operation.
7427 * @param[in] animator Animator object
7428 * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
7429 * @param[in] data Callback function user argument
7431 * The @p func callback will be called with a frame value in range [0, 1] which
7432 * indicates how far along the animation should be. It is the job of @p func to
7433 * actually change the state of any object(or objects) that are being animated.
7434 * @deprecated Use @ref Transit instead.
7436 EINA_DEPRECATED EAPI void elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
7438 * Set the callback function for the when the animation ends.
7440 * @param[in] animator Animator object
7441 * @param[in] func Callback function pointe
7442 * @param[in] data Callback function user argument
7444 * @warning @a func will not be executed if elm_animator_stop() is called.
7445 * @deprecated Use @ref Transit instead.
7447 EINA_DEPRECATED EAPI void elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
7449 * @brief Stop animator.
7451 * @param[in] animator Animator object
7453 * If called before elm_animator_animate() it does nothing. If there is an
7454 * animation in progress the animation will be stopped(the operation callback
7455 * will not be executed again) and it can't be restarted using
7456 * elm_animator_resume().
7457 * @deprecated Use @ref Transit instead.
7459 EINA_DEPRECATED EAPI void elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
7461 * Set the animator repeat count.
7463 * @param[in] animator Animator object
7464 * @param[in] repeat_cnt Repeat count
7465 * @deprecated Use @ref Transit instead.
7467 EINA_DEPRECATED EAPI void elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
7469 * @brief Start animation.
7471 * @param[in] animator Animator object
7473 * This function starts the animation if the nescessary properties(duration
7474 * and operation callback) have been set. Once started the animation will
7475 * run until complete or elm_animator_stop() is called.
7476 * @deprecated Use @ref Transit instead.
7478 EINA_DEPRECATED EAPI void elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
7480 * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
7482 * @param[in] animator Animator object
7483 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
7484 * @deprecated Use @ref Transit instead.
7486 EINA_DEPRECATED EAPI void elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
7488 * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
7490 * @param[in] animator Animator object
7491 * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
7492 * @deprecated Use @ref Transit instead.
7494 EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
7496 * @brief Sets wether the animation should be automatically reversed.
7498 * @param[in] animator Animator object
7499 * @param[in] reverse Reverse or not
7501 * This controls wether the animation will be run on reverse imediately after
7502 * running forward. When this is set together with repetition the animation
7503 * will run in reverse once for each time it ran forward.@n
7504 * Runnin an animation in reverse is accomplished by calling the operation
7505 * callback with a frame value starting at 1 and diminshing until 0.
7506 * @deprecated Use @ref Transit instead.
7508 EINA_DEPRECATED EAPI void elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
7510 * Gets wether the animation will automatically reversed
7512 * @param[in] animator Animator object
7513 * @deprecated Use @ref Transit instead.
7515 EINA_DEPRECATED EAPI Eina_Bool elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
7517 * Gets the status for the animator operation. The status of the animator @b
7518 * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
7519 * only informs if the animation was started and has not ended(either normally
7520 * or through elm_animator_stop()).
7522 * @param[in] animator Animator object
7523 * @deprecated Use @ref Transit instead.
7525 EINA_DEPRECATED EAPI Eina_Bool elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
7527 * Gets how many times the animation will be repeated
7529 * @param[in] animator Animator object
7530 * @deprecated Use @ref Transit instead.
7532 EINA_DEPRECATED EAPI unsigned int elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
7534 * Pause the animator.
7536 * @param[in] animator Animator object
7538 * This causes the animation to be temporarily stopped(the operation callback
7539 * will not be called). If the animation is not yet running this is a no-op.
7540 * Once an animation has been paused with this function it can be resumed
7541 * using elm_animator_resume().
7542 * @deprecated Use @ref Transit instead.
7544 EINA_DEPRECATED EAPI void elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
7546 * @brief Resumes the animator.
7548 * @param[in] animator Animator object
7550 * Resumes an animation that was paused using elm_animator_pause(), after
7551 * calling this function calls to the operation callback will happen
7552 * normally. If an animation is stopped by means of elm_animator_stop it
7553 * @b can't be restarted with this function.@n
7555 * @warning When an animation is resumed it doesn't start from where it was paused, it
7556 * will go to where it would have been if it had not been paused. If an
7557 * animation with a duration of 3 seconds is paused after 1 second for 1 second
7558 * it will resume as if it had ben animating for 2 seconds, the operating
7559 * callback will be called with a frame value of aproximately 2/3.
7560 * @deprecated Use @ref Transit instead.
7562 EINA_DEPRECATED EAPI void elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
7570 ELM_CALENDAR_UNIQUE,
7572 ELM_CALENDAR_WEEKLY,
7573 ELM_CALENDAR_MONTHLY,
7574 ELM_CALENDAR_ANNUALLY
7575 } Elm_Calendar_Mark_Repeat;
7576 typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark;
7578 EAPI Evas_Object *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7579 EAPI const char **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7580 EAPI void elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
7581 EAPI double elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7582 EAPI void elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
7583 EAPI void elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
7584 EAPI void elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
7585 EAPI Eina_Bool elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7586 EAPI void elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
7587 EAPI Eina_Bool elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
7588 EAPI void elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
7589 EAPI void elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
7590 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);
7591 EAPI void elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
7592 EAPI void elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7593 EAPI const Eina_List *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7594 EAPI void elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
7595 EINA_DEPRECATED EAPI void elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
7596 EINA_DEPRECATED EAPI void elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
7597 EINA_DEPRECATED EAPI void elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
7598 /* smart callbacks called:
7599 * changed - emitted when the user select a day or change the displayed
7604 typedef struct _Elm_Diskselector_Item Elm_Diskselector_Item;
7606 EAPI Evas_Object *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7607 EAPI Eina_Bool elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7608 EAPI void elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
7609 EINA_DEPRECATED EAPI int elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7610 EINA_DEPRECATED EAPI void elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
7611 EAPI int elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7612 EAPI void elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
7613 EAPI void elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7614 EAPI void elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7615 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);
7616 EAPI void elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7617 EAPI void elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7618 EAPI const Eina_List *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7619 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);
7620 EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7621 EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
7622 EAPI void *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7623 EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7624 EAPI void elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
7625 EAPI const char *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7626 EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
7627 EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7628 EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
7629 EAPI Eina_Bool elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7630 EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7631 EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7632 EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7633 EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7634 EAPI void elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
7635 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);
7636 EAPI void elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7637 EAPI void elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
7638 EAPI const char *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7639 EAPI void elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
7640 EAPI const char *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7641 EAPI void elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7642 EAPI void elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
7643 EAPI const char *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7644 EAPI void elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
7645 EAPI Eina_Bool elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
7646 EAPI void elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
7647 /* smart callbacks called:
7648 * "selected" - when item is selected (scroller stops)
7652 * @page tutorial_colorselector Color selector example
7653 * @dontinclude colorselector_example_01.c
7655 * This example shows how to change the color of a rectangle using a color
7656 * selector. We aren't going to explain a lot of the code since it's the
7660 * Now that we have a window with background and a rectangle we can create
7661 * our color_selector and set it's initial color to fully opaque blue:
7664 * Next we tell ask to be notified whenever the color changes:
7667 * We follow that we some more run of the mill setup code:
7670 * And now get to the callback that sets the color of the rectangle:
7673 * This example will look like this:
7674 * @image html screenshots/colorselector_example_01.png
7675 * @image latex screenshots/colorselector_example_01.eps
7677 * @example colorselector_example_01.c
7680 * @defgroup Colorselector Colorselector
7684 * @brief Widget for user to select a color.
7686 * Signals that you can add callbacks for are:
7687 * "changed" - When the color value changes(event_info is NULL).
7689 * See @ref tutorial_colorselector.
7692 * @brief Add a new colorselector to the parent
7694 * @param parent The parent object
7695 * @return The new object or NULL if it cannot be created
7697 * @ingroup Colorselector
7699 EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7701 * Set a color for the colorselector
7703 * @param obj Colorselector object
7704 * @param r r-value of color
7705 * @param g g-value of color
7706 * @param b b-value of color
7707 * @param a a-value of color
7709 * @ingroup Colorselector
7711 EAPI void elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
7713 * Get a color from the colorselector
7715 * @param obj Colorselector object
7716 * @param r integer pointer for r-value of color
7717 * @param g integer pointer for g-value of color
7718 * @param b integer pointer for b-value of color
7719 * @param a integer pointer for a-value of color
7721 * @ingroup Colorselector
7723 EAPI void elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
7728 /* Contextual Popup */
7729 typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
7731 typedef enum _Elm_Ctxpopup_Direction
7733 ELM_CTXPOPUP_DIRECTION_DOWN,
7734 ELM_CTXPOPUP_DIRECTION_RIGHT,
7735 ELM_CTXPOPUP_DIRECTION_LEFT,
7736 ELM_CTXPOPUP_DIRECTION_UP,
7737 ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
7738 } Elm_Ctxpopup_Direction;
7740 EAPI Evas_Object *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7741 EAPI Evas_Object *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7742 EAPI void elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
7743 EAPI const char *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7744 EAPI void elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
7745 EAPI void elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
7746 EAPI Evas_Object *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7747 EAPI void elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
7748 EAPI void elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
7749 EAPI Eina_Bool elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7750 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);
7751 EAPI void elm_ctxpopup_item_del(Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7752 EAPI void elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
7753 EAPI Eina_Bool elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
7754 EAPI void elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
7755 EAPI Evas_Object *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7756 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);
7757 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);
7758 EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7759 /* smart callbacks called:
7760 * "dismissed" - the ctxpopup was dismissed
7766 * @defgroup Transit Transit
7767 * @ingroup Elementary
7769 * Transit is designed to apply various animated transition effects to @c
7770 * Evas_Object, such like translation, rotation, etc. For using these
7771 * effects, create an @ref Elm_Transit and add the desired transition effects.
7773 * Once the effects are added into transit, they will be automatically
7774 * managed (their callback will be called until the duration is ended, and
7775 * they will be deleted on completion).
7779 * Elm_Transit *trans = elm_transit_add();
7780 * elm_transit_object_add(trans, obj);
7781 * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
7782 * elm_transit_duration_set(transit, 1);
7783 * elm_transit_auto_reverse_set(transit, EINA_TRUE);
7784 * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
7785 * elm_transit_repeat_times_set(transit, 3);
7788 * Some transition effects are used to change the properties of objects. They
7790 * @li @ref elm_transit_effect_translation_add
7791 * @li @ref elm_transit_effect_color_add
7792 * @li @ref elm_transit_effect_rotation_add
7793 * @li @ref elm_transit_effect_wipe_add
7794 * @li @ref elm_transit_effect_zoom_add
7795 * @li @ref elm_transit_effect_resizing_add
7797 * Other transition effects are used to make one object disappear and another
7798 * object appear on its old place. These effects are:
7800 * @li @ref elm_transit_effect_flip_add
7801 * @li @ref elm_transit_effect_resizable_flip_add
7802 * @li @ref elm_transit_effect_fade_add
7803 * @li @ref elm_transit_effect_blend_add
7805 * It's also possible to make a transition chain with @ref
7806 * elm_transit_chain_transit_add.
7808 * @warning We strongly recommend to use elm_transit just when edje can not do
7809 * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
7810 * animations can be manipulated inside the theme.
7813 * @li @ref transit_example_01_explained
7814 * @li @ref transit_example_02_explained
7815 * @li @ref transit_example_03_c
7816 * @li @ref transit_example_04_c
7822 * @enum Elm_Transit_Tween_Mode
7824 * The type of acceleration used in the transition.
7828 ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
7829 ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
7830 over time, then decrease again
7832 ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
7834 ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
7836 } Elm_Transit_Tween_Mode;
7839 * @enum Elm_Transit_Effect_Flip_Axis
7841 * The axis where flip effect should be applied.
7845 ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
7846 ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
7847 } Elm_Transit_Effect_Flip_Axis;
7849 * @enum Elm_Transit_Effect_Wipe_Dir
7851 * The direction where the wipe effect should occur.
7855 ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
7856 ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
7857 ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
7858 ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
7859 } Elm_Transit_Effect_Wipe_Dir;
7860 /** @enum Elm_Transit_Effect_Wipe_Type
7862 * Whether the wipe effect should show or hide the object.
7866 ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
7868 ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
7870 } Elm_Transit_Effect_Wipe_Type;
7873 * @typedef Elm_Transit
7875 * The Transit created with elm_transit_add(). This type has the information
7876 * about the objects which the transition will be applied, and the
7877 * transition effects that will be used. It also contains info about
7878 * duration, number of repetitions, auto-reverse, etc.
7880 typedef struct _Elm_Transit Elm_Transit;
7881 typedef void Elm_Transit_Effect;
7883 * @typedef Elm_Transit_Effect_Transition_Cb
7885 * Transition callback called for this effect on each transition iteration.
7887 typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
7889 * Elm_Transit_Effect_End_Cb
7891 * Transition callback called for this effect when the transition is over.
7893 typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
7896 * Elm_Transit_Del_Cb
7898 * A callback called when the transit is deleted.
7900 typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
7905 * @note Is not necessary to delete the transit object, it will be deleted at
7906 * the end of its operation.
7907 * @note The transit will start playing when the program enter in the main loop, is not
7908 * necessary to give a start to the transit.
7910 * @return The transit object.
7914 EAPI Elm_Transit *elm_transit_add(void);
7917 * Stops the animation and delete the @p transit object.
7919 * Call this function if you wants to stop the animation before the duration
7920 * time. Make sure the @p transit object is still alive with
7921 * elm_transit_del_cb_set() function.
7922 * All added effects will be deleted, calling its repective data_free_cb
7923 * functions. The function setted by elm_transit_del_cb_set() will be called.
7925 * @see elm_transit_del_cb_set()
7927 * @param transit The transit object to be deleted.
7930 * @warning Just call this function if you are sure the transit is alive.
7932 EAPI void elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
7935 * Add a new effect to the transit.
7937 * @note The cb function and the data are the key to the effect. If you try to
7938 * add an already added effect, nothing is done.
7939 * @note After the first addition of an effect in @p transit, if its
7940 * effect list become empty again, the @p transit will be killed by
7941 * elm_transit_del(transit) function.
7945 * Elm_Transit *transit = elm_transit_add();
7946 * elm_transit_effect_add(transit,
7947 * elm_transit_effect_blend_op,
7948 * elm_transit_effect_blend_context_new(),
7949 * elm_transit_effect_blend_context_free);
7952 * @param transit The transit object.
7953 * @param transition_cb The operation function. It is called when the
7954 * animation begins, it is the function that actually performs the animation.
7955 * It is called with the @p data, @p transit and the time progression of the
7956 * animation (a double value between 0.0 and 1.0).
7957 * @param effect The context data of the effect.
7958 * @param end_cb The function to free the context data, it will be called
7959 * at the end of the effect, it must finalize the animation and free the
7963 * @warning The transit free the context data at the and of the transition with
7964 * the data_free_cb function, do not use the context data in another transit.
7966 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);
7969 * Delete an added effect.
7971 * This function will remove the effect from the @p transit, calling the
7972 * data_free_cb to free the @p data.
7974 * @see elm_transit_effect_add()
7976 * @note If the effect is not found, nothing is done.
7977 * @note If the effect list become empty, this function will call
7978 * elm_transit_del(transit), that is, it will kill the @p transit.
7980 * @param transit The transit object.
7981 * @param transition_cb The operation function.
7982 * @param effect The context data of the effect.
7986 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);
7989 * Add new object to apply the effects.
7991 * @note After the first addition of an object in @p transit, if its
7992 * object list become empty again, the @p transit will be killed by
7993 * elm_transit_del(transit) function.
7994 * @note If the @p obj belongs to another transit, the @p obj will be
7995 * removed from it and it will only belong to the @p transit. If the old
7996 * transit stays without objects, it will die.
7997 * @note When you add an object into the @p transit, its state from
7998 * evas_object_pass_events_get(obj) is saved, and it is applied when the
7999 * transit ends, if you change this state whith evas_object_pass_events_set()
8000 * after add the object, this state will change again when @p transit stops to
8003 * @param transit The transit object.
8004 * @param obj Object to be animated.
8007 * @warning It is not allowed to add a new object after transit begins to go.
8009 EAPI void elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
8012 * Removes an added object from the transit.
8014 * @note If the @p obj is not in the @p transit, nothing is done.
8015 * @note If the list become empty, this function will call
8016 * elm_transit_del(transit), that is, it will kill the @p transit.
8018 * @param transit The transit object.
8019 * @param obj Object to be removed from @p transit.
8022 * @warning It is not allowed to remove objects after transit begins to go.
8024 EAPI void elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
8027 * Get the objects of the transit.
8029 * @param transit The transit object.
8030 * @return a Eina_List with the objects from the transit.
8034 EAPI const Eina_List *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
8037 * Enable/disable keeping up the objects states.
8038 * If it is not kept, the objects states will be reset when transition ends.
8040 * @note @p transit can not be NULL.
8041 * @note One state includes geometry, color, map data.
8043 * @param transit The transit object.
8044 * @param state_keep Keeping or Non Keeping.
8048 EAPI void elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
8051 * Get a value whether the objects states will be reset or not.
8053 * @note @p transit can not be NULL
8055 * @see elm_transit_objects_final_state_keep_set()
8057 * @param transit The transit object.
8058 * @return EINA_TRUE means the states of the objects will be reset.
8059 * If @p transit is NULL, EINA_FALSE is returned
8063 EAPI Eina_Bool elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
8066 * Set the event enabled when transit is operating.
8068 * If @p enabled is EINA_TRUE, the objects of the transit will receives
8069 * events from mouse and keyboard during the animation.
8070 * @note When you add an object with elm_transit_object_add(), its state from
8071 * evas_object_pass_events_get(obj) is saved, and it is applied when the
8072 * transit ends, if you change this state with evas_object_pass_events_set()
8073 * after adding the object, this state will change again when @p transit stops
8076 * @param transit The transit object.
8077 * @param enabled Events are received when enabled is @c EINA_TRUE, and
8078 * ignored otherwise.
8082 EAPI void elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
8085 * Get the value of event enabled status.
8087 * @see elm_transit_event_enabled_set()
8089 * @param transit The Transit object
8090 * @return EINA_TRUE, when event is enabled. If @p transit is NULL
8091 * EINA_FALSE is returned
8095 EAPI Eina_Bool elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
8098 * Set the user-callback function when the transit is deleted.
8100 * @note Using this function twice will overwrite the first function setted.
8101 * @note the @p transit object will be deleted after call @p cb function.
8103 * @param transit The transit object.
8104 * @param cb Callback function pointer. This function will be called before
8105 * the deletion of the transit.
8106 * @param data Callback funtion user data. It is the @p op parameter.
8110 EAPI void elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
8113 * Set reverse effect automatically.
8115 * If auto reverse is setted, after running the effects with the progress
8116 * parameter from 0 to 1, it will call the effecs again with the progress
8117 * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
8118 * where the duration was setted with the function elm_transit_add and
8119 * the repeat with the function elm_transit_repeat_times_set().
8121 * @param transit The transit object.
8122 * @param reverse EINA_TRUE means the auto_reverse is on.
8126 EAPI void elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
8129 * Get if the auto reverse is on.
8131 * @see elm_transit_auto_reverse_set()
8133 * @param transit The transit object.
8134 * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
8135 * EINA_FALSE is returned
8139 EAPI Eina_Bool elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
8142 * Set the transit repeat count. Effect will be repeated by repeat count.
8144 * This function sets the number of repetition the transit will run after
8145 * the first one, that is, if @p repeat is 1, the transit will run 2 times.
8146 * If the @p repeat is a negative number, it will repeat infinite times.
8148 * @note If this function is called during the transit execution, the transit
8149 * will run @p repeat times, ignoring the times it already performed.
8151 * @param transit The transit object
8152 * @param repeat Repeat count
8156 EAPI void elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
8159 * Get the transit repeat count.
8161 * @see elm_transit_repeat_times_set()
8163 * @param transit The Transit object.
8164 * @return The repeat count. If @p transit is NULL
8169 EAPI int elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
8172 * Set the transit animation acceleration type.
8174 * This function sets the tween mode of the transit that can be:
8175 * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
8176 * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
8177 * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
8178 * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
8180 * @param transit The transit object.
8181 * @param tween_mode The tween type.
8185 EAPI void elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
8188 * Get the transit animation acceleration type.
8190 * @note @p transit can not be NULL
8192 * @param transit The transit object.
8193 * @return The tween type. If @p transit is NULL
8194 * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
8198 EAPI Elm_Transit_Tween_Mode elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
8201 * Set the transit animation time
8203 * @note @p transit can not be NULL
8205 * @param transit The transit object.
8206 * @param duration The animation time.
8210 EAPI void elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
8213 * Get the transit animation time
8215 * @note @p transit can not be NULL
8217 * @param transit The transit object.
8219 * @return The transit animation time.
8223 EAPI double elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
8226 * Starts the transition.
8227 * Once this API is called, the transit begins to measure the time.
8229 * @note @p transit can not be NULL
8231 * @param transit The transit object.
8235 EAPI void elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
8238 * Pause/Resume the transition.
8240 * If you call elm_transit_go again, the transit will be started from the
8241 * beginning, and will be unpaused.
8243 * @note @p transit can not be NULL
8245 * @param transit The transit object.
8246 * @param paused Whether the transition should be paused or not.
8250 EAPI void elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
8253 * Get the value of paused status.
8255 * @see elm_transit_paused_set()
8257 * @note @p transit can not be NULL
8259 * @param transit The transit object.
8260 * @return EINA_TRUE means transition is paused. If @p transit is NULL
8261 * EINA_FALSE is returned
8265 EAPI Eina_Bool elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
8268 * Get the time progression of the animation (a double value between 0.0 and 1.0).
8270 * The value returned is a fraction (current time / total time). It
8271 * represents the progression position relative to the total.
8273 * @note @p transit can not be NULL
8275 * @param transit The transit object.
8277 * @return The time progression value. If @p transit is NULL
8282 EAPI double elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
8285 * Makes the chain relationship between two transits.
8287 * @note @p transit can not be NULL. Transit would have multiple chain transits.
8288 * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
8290 * @param transit The transit object.
8291 * @param chain_transit The chain transit object. This transit will be operated
8292 * after transit is done.
8294 * This function adds @p chain_transit transition to a chain after the @p
8295 * transit, and will be started as soon as @p transit ends. See @ref
8296 * transit_example_02_explained for a full example.
8300 EAPI void elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
8303 * Cut off the chain relationship between two transits.
8305 * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
8306 * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
8308 * @param transit The transit object.
8309 * @param chain_transit The chain transit object.
8311 * This function remove the @p chain_transit transition from the @p transit.
8315 EAPI void elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
8318 * Get the current chain transit list.
8320 * @note @p transit can not be NULL.
8322 * @param transit The transit object.
8323 * @return chain transit list.
8327 EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *transit);
8330 * Add the Resizing Effect to Elm_Transit.
8332 * @note This API is one of the facades. It creates resizing effect context
8333 * and add it's required APIs to elm_transit_effect_add.
8335 * @see elm_transit_effect_add()
8337 * @param transit Transit object.
8338 * @param from_w Object width size when effect begins.
8339 * @param from_h Object height size when effect begins.
8340 * @param to_w Object width size when effect ends.
8341 * @param to_h Object height size when effect ends.
8342 * @return Resizing effect context data.
8346 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);
8349 * Add the Translation Effect to Elm_Transit.
8351 * @note This API is one of the facades. It creates translation effect context
8352 * and add it's required APIs to elm_transit_effect_add.
8354 * @see elm_transit_effect_add()
8356 * @param transit Transit object.
8357 * @param from_dx X Position variation when effect begins.
8358 * @param from_dy Y Position variation when effect begins.
8359 * @param to_dx X Position variation when effect ends.
8360 * @param to_dy Y Position variation when effect ends.
8361 * @return Translation effect context data.
8364 * @warning It is highly recommended just create a transit with this effect when
8365 * the window that the objects of the transit belongs has already been created.
8366 * This is because this effect needs the geometry information about the objects,
8367 * and if the window was not created yet, it can get a wrong information.
8369 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);
8372 * Add the Zoom Effect to Elm_Transit.
8374 * @note This API is one of the facades. It creates zoom effect context
8375 * and add it's required APIs to elm_transit_effect_add.
8377 * @see elm_transit_effect_add()
8379 * @param transit Transit object.
8380 * @param from_rate Scale rate when effect begins (1 is current rate).
8381 * @param to_rate Scale rate when effect ends.
8382 * @return Zoom effect context data.
8385 * @warning It is highly recommended just create a transit with this effect when
8386 * the window that the objects of the transit belongs has already been created.
8387 * This is because this effect needs the geometry information about the objects,
8388 * and if the window was not created yet, it can get a wrong information.
8390 EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
8393 * Add the Flip Effect to Elm_Transit.
8395 * @note This API is one of the facades. It creates flip effect context
8396 * and add it's required APIs to elm_transit_effect_add.
8397 * @note This effect is applied to each pair of objects in the order they are listed
8398 * in the transit list of objects. The first object in the pair will be the
8399 * "front" object and the second will be the "back" object.
8401 * @see elm_transit_effect_add()
8403 * @param transit Transit object.
8404 * @param axis Flipping Axis(X or Y).
8405 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
8406 * @return Flip effect context data.
8409 * @warning It is highly recommended just create a transit with this effect when
8410 * the window that the objects of the transit belongs has already been created.
8411 * This is because this effect needs the geometry information about the objects,
8412 * and if the window was not created yet, it can get a wrong information.
8414 EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
8417 * Add the Resizable Flip Effect to Elm_Transit.
8419 * @note This API is one of the facades. It creates resizable flip effect context
8420 * and add it's required APIs to elm_transit_effect_add.
8421 * @note This effect is applied to each pair of objects in the order they are listed
8422 * in the transit list of objects. The first object in the pair will be the
8423 * "front" object and the second will be the "back" object.
8425 * @see elm_transit_effect_add()
8427 * @param transit Transit object.
8428 * @param axis Flipping Axis(X or Y).
8429 * @param cw Flipping Direction. EINA_TRUE is clock-wise.
8430 * @return Resizable flip effect context data.
8433 * @warning It is highly recommended just create a transit with this effect when
8434 * the window that the objects of the transit belongs has already been created.
8435 * This is because this effect needs the geometry information about the objects,
8436 * and if the window was not created yet, it can get a wrong information.
8438 EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
8441 * Add the Wipe Effect to Elm_Transit.
8443 * @note This API is one of the facades. It creates wipe effect context
8444 * and add it's required APIs to elm_transit_effect_add.
8446 * @see elm_transit_effect_add()
8448 * @param transit Transit object.
8449 * @param type Wipe type. Hide or show.
8450 * @param dir Wipe Direction.
8451 * @return Wipe effect context data.
8454 * @warning It is highly recommended just create a transit with this effect when
8455 * the window that the objects of the transit belongs has already been created.
8456 * This is because this effect needs the geometry information about the objects,
8457 * and if the window was not created yet, it can get a wrong information.
8459 EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
8462 * Add the Color Effect to Elm_Transit.
8464 * @note This API is one of the facades. It creates color effect context
8465 * and add it's required APIs to elm_transit_effect_add.
8467 * @see elm_transit_effect_add()
8469 * @param transit Transit object.
8470 * @param from_r RGB R when effect begins.
8471 * @param from_g RGB G when effect begins.
8472 * @param from_b RGB B when effect begins.
8473 * @param from_a RGB A when effect begins.
8474 * @param to_r RGB R when effect ends.
8475 * @param to_g RGB G when effect ends.
8476 * @param to_b RGB B when effect ends.
8477 * @param to_a RGB A when effect ends.
8478 * @return Color effect context data.
8482 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);
8485 * Add the Fade Effect to Elm_Transit.
8487 * @note This API is one of the facades. It creates fade effect context
8488 * and add it's required APIs to elm_transit_effect_add.
8489 * @note This effect is applied to each pair of objects in the order they are listed
8490 * in the transit list of objects. The first object in the pair will be the
8491 * "before" object and the second will be the "after" object.
8493 * @see elm_transit_effect_add()
8495 * @param transit Transit object.
8496 * @return Fade effect context data.
8499 * @warning It is highly recommended just create a transit with this effect when
8500 * the window that the objects of the transit belongs has already been created.
8501 * This is because this effect needs the color information about the objects,
8502 * and if the window was not created yet, it can get a wrong information.
8504 EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
8507 * Add the Blend Effect to Elm_Transit.
8509 * @note This API is one of the facades. It creates blend effect context
8510 * and add it's required APIs to elm_transit_effect_add.
8511 * @note This effect is applied to each pair of objects in the order they are listed
8512 * in the transit list of objects. The first object in the pair will be the
8513 * "before" object and the second will be the "after" object.
8515 * @see elm_transit_effect_add()
8517 * @param transit Transit object.
8518 * @return Blend effect context data.
8521 * @warning It is highly recommended just create a transit with this effect when
8522 * the window that the objects of the transit belongs has already been created.
8523 * This is because this effect needs the color information about the objects,
8524 * and if the window was not created yet, it can get a wrong information.
8526 EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
8529 * Add the Rotation Effect to Elm_Transit.
8531 * @note This API is one of the facades. It creates rotation effect context
8532 * and add it's required APIs to elm_transit_effect_add.
8534 * @see elm_transit_effect_add()
8536 * @param transit Transit object.
8537 * @param from_degree Degree when effect begins.
8538 * @param to_degree Degree when effect is ends.
8539 * @return Rotation effect context data.
8542 * @warning It is highly recommended just create a transit with this effect when
8543 * the window that the objects of the transit belongs has already been created.
8544 * This is because this effect needs the geometry information about the objects,
8545 * and if the window was not created yet, it can get a wrong information.
8547 EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
8550 * Add the ImageAnimation Effect to Elm_Transit.
8552 * @note This API is one of the facades. It creates image animation effect context
8553 * and add it's required APIs to elm_transit_effect_add.
8554 * The @p images parameter is a list images paths. This list and
8555 * its contents will be deleted at the end of the effect by
8556 * elm_transit_effect_image_animation_context_free() function.
8560 * char buf[PATH_MAX];
8561 * Eina_List *images = NULL;
8562 * Elm_Transit *transi = elm_transit_add();
8564 * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
8565 * images = eina_list_append(images, eina_stringshare_add(buf));
8567 * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
8568 * images = eina_list_append(images, eina_stringshare_add(buf));
8569 * elm_transit_effect_image_animation_add(transi, images);
8573 * @see elm_transit_effect_add()
8575 * @param transit Transit object.
8576 * @param images Eina_List of images file paths. This list and
8577 * its contents will be deleted at the end of the effect by
8578 * elm_transit_effect_image_animation_context_free() function.
8579 * @return Image Animation effect context data.
8583 EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
8589 typedef struct _Elm_Store Elm_Store;
8590 typedef struct _Elm_Store_DBsystem Elm_Store_DBsystem;
8591 typedef struct _Elm_Store_Filesystem Elm_Store_Filesystem;
8592 typedef struct _Elm_Store_Item Elm_Store_Item;
8593 typedef struct _Elm_Store_Item_DBsystem Elm_Store_Item_DBsystem;
8594 typedef struct _Elm_Store_Item_Filesystem Elm_Store_Item_Filesystem;
8595 typedef struct _Elm_Store_Item_Info Elm_Store_Item_Info;
8596 typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
8597 typedef struct _Elm_Store_Item_Mapping Elm_Store_Item_Mapping;
8598 typedef struct _Elm_Store_Item_Mapping_Empty Elm_Store_Item_Mapping_Empty;
8599 typedef struct _Elm_Store_Item_Mapping_Icon Elm_Store_Item_Mapping_Icon;
8600 typedef struct _Elm_Store_Item_Mapping_Photo Elm_Store_Item_Mapping_Photo;
8601 typedef struct _Elm_Store_Item_Mapping_Custom Elm_Store_Item_Mapping_Custom;
8603 typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
8604 typedef void (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
8605 typedef void (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
8606 typedef void (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
8607 typedef int (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
8608 typedef void (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
8609 typedef void *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
8613 ELM_STORE_ITEM_MAPPING_NONE = 0,
8614 ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
8615 ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
8616 ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
8617 ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
8618 ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
8619 // can add more here as needed by common apps
8620 ELM_STORE_ITEM_MAPPING_LAST
8621 } Elm_Store_Item_Mapping_Type;
8623 struct _Elm_Store_Item_Mapping_Icon
8625 // FIXME: allow edje file icons
8627 Elm_Icon_Lookup_Order lookup_order;
8628 Eina_Bool standard_name : 1;
8629 Eina_Bool no_scale : 1;
8630 Eina_Bool smooth : 1;
8631 Eina_Bool scale_up : 1;
8632 Eina_Bool scale_down : 1;
8635 struct _Elm_Store_Item_Mapping_Empty
8640 struct _Elm_Store_Item_Mapping_Photo
8645 struct _Elm_Store_Item_Mapping_Custom
8647 Elm_Store_Item_Mapping_Cb func;
8650 struct _Elm_Store_Item_Mapping
8652 Elm_Store_Item_Mapping_Type type;
8656 Elm_Store_Item_Mapping_Empty empty;
8657 Elm_Store_Item_Mapping_Icon icon;
8658 Elm_Store_Item_Mapping_Photo photo;
8659 Elm_Store_Item_Mapping_Custom custom;
8660 // add more types here
8664 struct _Elm_Store_Item_Info
8670 int pre_group_index;
8672 Elm_Genlist_Item_Class *item_class;
8673 const Elm_Store_Item_Mapping *mapping;
8678 struct _Elm_Store_Item_Info_Filesystem
8680 Elm_Store_Item_Info base;
8684 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
8685 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
8687 EAPI Elm_Store *elm_store_dbsystem_new(void);
8688 EAPI void elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
8689 EAPI void elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
8690 EAPI void elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
8691 EAPI void elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
8692 EAPI int elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8693 EAPI void *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8694 EAPI void elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
8695 EAPI int elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8696 EAPI Elm_Store_Item *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
8697 EAPI void elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8698 EAPI void elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
8699 EAPI void elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8700 EAPI void elm_store_free(Elm_Store *st);
8701 EAPI Elm_Store *elm_store_filesystem_new(void);
8702 EAPI void elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
8703 EAPI const char *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8704 EAPI const char *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8705 EAPI void elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
8706 EAPI void elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
8707 EAPI int elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8708 EAPI void elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
8709 EAPI void elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
8710 EAPI void elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
8711 EAPI Eina_Bool elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8712 EAPI void elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
8713 EAPI void elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
8714 EAPI Eina_Bool elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
8715 EAPI void elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
8716 EAPI void *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8717 EAPI const Elm_Store *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8718 EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
8720 /* SegmentControl */
8721 typedef struct _Elm_Segment_Item Elm_Segment_Item;
8722 EAPI Evas_Object *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8723 EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
8724 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);
8725 EAPI void elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
8726 EAPI void elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8727 EAPI int elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8728 EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8729 EAPI const char *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8730 EAPI void elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
8731 EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
8732 EAPI void elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
8733 EAPI int elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
8734 EAPI Evas_Object *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
8735 EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8736 EAPI void elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
8737 /* smart callbacks called:
8738 * "changed" -when the user clicks on a segment item which is not previously
8739 * selected and get selected. The event_info parameter is the
8740 * segment item index.
8743 EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
8744 EAPI void elm_grid_size_set(Evas_Object *obj, int w, int h);
8745 EAPI void elm_grid_size_get(Evas_Object *obj, int *w, int *h);
8746 EAPI void elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
8747 EAPI void elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
8748 EAPI void elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
8749 EAPI void elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
8750 EAPI void elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
8752 EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
8753 EAPI void elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
8755 EAPI Evas_Object *elm_video_add(Evas_Object *parent);
8756 EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
8757 EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
8758 EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
8759 EAPI void elm_video_play(Evas_Object *video);
8760 EAPI void elm_video_pause(Evas_Object *video);
8761 EAPI void elm_video_stop(Evas_Object *video);
8762 EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
8763 EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
8764 EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
8765 EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
8766 EAPI double elm_video_audio_level_get(Evas_Object *video);
8767 EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
8768 EAPI double elm_video_play_position_get(Evas_Object *video);
8769 EAPI void elm_video_play_position_set(Evas_Object *video, double position);
8770 EAPI double elm_video_play_length_get(Evas_Object *video);
8771 EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
8772 EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
8773 EAPI const char *elm_video_title_get(Evas_Object *video);
8775 EAPI Evas_Object *elm_player_add(Evas_Object *parent);
8776 EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
8778 // FIXME: incomplete - carousel. don't use this until this comment is removed
8779 typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
8780 EAPI Evas_Object *elm_carousel_add(Evas_Object *parent);
8781 EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
8782 EAPI void elm_carousel_item_del(Elm_Carousel_Item *item);
8783 EAPI void elm_carousel_item_select(Elm_Carousel_Item *item);
8784 /* smart callbacks called:
8785 * "clicked" - when the user clicks on a carousel item and becomes selected
8790 typedef enum _Elm_Datefield_ItemType
8792 ELM_DATEFIELD_YEAR = 0,
8793 ELM_DATEFIELD_MONTH,
8796 ELM_DATEFIELD_MINUTE,
8798 } Elm_Datefield_ItemType;
8800 EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
8801 EAPI void elm_datefield_format_set(Evas_Object *obj, const char *fmt);
8802 EAPI char *elm_datefield_format_get(const Evas_Object *obj);
8803 EAPI void elm_datefield_item_enabled_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, Eina_Bool enable);
8804 EAPI Eina_Bool elm_datefield_item_enabled_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8805 EAPI void elm_datefield_item_value_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value);
8806 EAPI int elm_datefield_item_value_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8807 EAPI void elm_datefield_item_min_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
8808 EAPI int elm_datefield_item_min_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8809 EAPI Eina_Bool elm_datefield_item_min_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8810 EAPI void elm_datefield_item_max_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
8811 EAPI int elm_datefield_item_max_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8812 EAPI Eina_Bool elm_datefield_item_max_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
8814 /* smart callbacks called:
8815 * "changed" - when datefield value is changed, this signal is sent.
8818 ////////////////////// DEPRECATED ///////////////////////////////////
8820 typedef enum _Elm_Datefield_Layout
8822 ELM_DATEFIELD_LAYOUT_TIME,
8823 ELM_DATEFIELD_LAYOUT_DATE,
8824 ELM_DATEFIELD_LAYOUT_DATEANDTIME
8825 } Elm_Datefield_Layout;
8827 EINA_DEPRECATED EAPI void elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
8828 EINA_DEPRECATED EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
8829 EINA_DEPRECATED EAPI void elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
8830 EINA_DEPRECATED EAPI const char *elm_datefield_date_format_get(const Evas_Object *obj);
8831 EINA_DEPRECATED EAPI void elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
8832 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_time_mode_get(const Evas_Object *obj);
8833 EINA_DEPRECATED EAPI void elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
8834 EINA_DEPRECATED EAPI void elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
8835 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
8836 EINA_DEPRECATED EAPI void elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
8837 EINA_DEPRECATED EAPI Eina_Bool elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
8838 EINA_DEPRECATED EAPI void elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
8839 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);
8840 EINA_DEPRECATED EAPI void elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
8841 /////////////////////////////////////////////////////////////////////
8844 typedef enum _Elm_Popup_Response
8846 ELM_POPUP_RESPONSE_NONE = -1,
8847 ELM_POPUP_RESPONSE_TIMEOUT = -2,
8848 ELM_POPUP_RESPONSE_OK = -3,
8849 ELM_POPUP_RESPONSE_CANCEL = -4,
8850 ELM_POPUP_RESPONSE_CLOSE = -5
8851 } Elm_Popup_Response;
8853 typedef enum _Elm_Popup_Mode
8855 ELM_POPUP_TYPE_NONE = 0,
8856 ELM_POPUP_TYPE_ALERT = (1 << 0)
8859 typedef enum _Elm_Popup_Orient
8861 ELM_POPUP_ORIENT_TOP,
8862 ELM_POPUP_ORIENT_CENTER,
8863 ELM_POPUP_ORIENT_BOTTOM,
8864 ELM_POPUP_ORIENT_LEFT,
8865 ELM_POPUP_ORIENT_RIGHT,
8866 ELM_POPUP_ORIENT_TOP_LEFT,
8867 ELM_POPUP_ORIENT_TOP_RIGHT,
8868 ELM_POPUP_ORIENT_BOTTOM_LEFT,
8869 ELM_POPUP_ORIENT_BOTTOM_RIGHT
8872 /* smart callbacks called:
8873 * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
8876 EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
8877 EAPI void elm_popup_desc_set(Evas_Object *obj, const char *text);
8878 EAPI const char *elm_popup_desc_get(Evas_Object *obj);
8879 EAPI void elm_popup_title_label_set(Evas_Object *obj, const char *text);
8880 EAPI const char *elm_popup_title_label_get(Evas_Object *obj);
8881 EAPI void elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
8882 EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
8883 EAPI void elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
8884 EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
8885 EAPI void elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text, ...);
8886 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, ... );
8887 EAPI void elm_popup_timeout_set(Evas_Object *obj, double timeout);
8888 EAPI void elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
8889 EAPI void elm_popup_response(Evas_Object *obj, int response_id);
8890 EAPI void elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
8891 EAPI int elm_popup_run(Evas_Object *obj);
8894 #define NAVIBAR_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
8895 #define NAVIBAR_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
8899 ELM_NAVIGATIONBAR_FUNCTION_BUTTON1,
8900 ELM_NAVIGATIONBAR_FUNCTION_BUTTON2,
8901 ELM_NAVIGATIONBAR_FUNCTION_BUTTON3,
8902 ELM_NAVIGATIONBAR_BACK_BUTTON
8903 } Elm_Navi_Button_Type;
8905 EAPI Evas_Object *elm_navigationbar_add(Evas_Object *parent);
8906 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);
8907 EAPI void elm_navigationbar_pop(Evas_Object *obj);
8908 EAPI void elm_navigationbar_to_content_pop(Evas_Object *obj, Evas_Object *content);
8909 EAPI void elm_navigationbar_title_label_set(Evas_Object *obj, Evas_Object *content, const char *title);
8910 EAPI const char *elm_navigationbar_title_label_get(Evas_Object *obj, Evas_Object *content);
8911 EAPI void elm_navigationbar_title_object_add(Evas_Object *obj, Evas_Object *content, Evas_Object *title_obj);
8912 EAPI Evas_Object *elm_navigationbar_title_object_get(Evas_Object *obj, Evas_Object *content);
8913 EAPI Eina_List *elm_navigationbar_title_object_list_get(Evas_Object *obj, Evas_Object *content);
8914 EAPI Evas_Object *elm_navigationbar_content_top_get(Evas_Object *obj);
8915 EAPI Evas_Object *elm_navigationbar_content_bottom_get(Evas_Object *obj);
8916 EAPI void elm_navigationbar_hidden_set(Evas_Object *obj, Eina_Bool hidden);
8917 EAPI void elm_navigationbar_title_button_set(Evas_Object *obj, Evas_Object *content, Evas_Object *button, Elm_Navi_Button_Type button_type);
8918 EAPI Evas_Object *elm_navigationbar_title_button_get(Evas_Object *obj, Evas_Object *content, Elm_Navi_Button_Type button_type);
8919 EAPI const char *elm_navigationbar_subtitle_label_get(Evas_Object *obj, Evas_Object *content);
8920 EAPI void elm_navigationbar_subtitle_label_set(Evas_Object *obj, Evas_Object *content, const char *subtitle);
8921 EAPI void elm_navigationbar_title_object_list_unset(Evas_Object *obj, Evas_Object *content, Eina_List **list);
8922 EAPI void elm_navigationbar_animation_disabled_set(Evas_Object *obj, Eina_Bool disable);
8923 EAPI void elm_navigationbar_title_object_visible_set(Evas_Object *obj, Evas_Object *content, Eina_Bool visible);
8924 Eina_Bool elm_navigationbar_title_object_visible_get(Evas_Object *obj, Evas_Object *content);
8925 EAPI void elm_navigationbar_title_icon_set(Evas_Object *obj, Evas_Object *content, Evas_Object *icon);
8926 EAPI Evas_Object *elm_navigationbar_title_icon_get(Evas_Object *obj, Evas_Object *content);
8929 #define NAVIBAR_EX_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
8930 #define NAVIBAR_EX_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
8934 ELM_NAVIGATIONBAR_EX_BACK_BUTTON,
8935 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON1,
8936 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON2,
8937 ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON3,
8938 ELM_NAVIGATIONBAR_EX_MAX
8939 } Elm_Navi_ex_Button_Type;
8940 typedef struct _Elm_Navigationbar_ex_Item Elm_Navigationbar_ex_Item;
8942 EAPI Evas_Object *elm_navigationbar_ex_add(Evas_Object *parent);
8943 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_push(Evas_Object *obj, Evas_Object *content, const char *item_style);
8944 EAPI void elm_navigationbar_ex_item_pop(Evas_Object *obj);
8945 EAPI void elm_navigationbar_ex_item_promote(Elm_Navigationbar_ex_Item* item);
8946 EAPI void elm_navigationbar_ex_to_item_pop(Elm_Navigationbar_ex_Item* item);
8947 EAPI void elm_navigationbar_ex_item_title_label_set(Elm_Navigationbar_ex_Item *item, const char *title);
8948 EAPI const char *elm_navigationbar_ex_item_title_label_get(Elm_Navigationbar_ex_Item* item);
8949 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_top_get(const Evas_Object *obj);
8950 EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_bottom_get(const Evas_Object *obj);
8951 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);
8952 EAPI Evas_Object *elm_navigationbar_ex_item_title_button_get(Elm_Navigationbar_ex_Item* item, int button_type);
8953 EAPI void elm_navigationbar_ex_item_title_object_set(Elm_Navigationbar_ex_Item* item, Evas_Object *title_obj);
8954 EAPI Evas_Object *elm_navigationbar_ex_item_title_object_unset(Elm_Navigationbar_ex_Item* item);
8955 EAPI void elm_navigationbar_ex_item_title_hidden_set(Elm_Navigationbar_ex_Item* item, Eina_Bool hidden);
8956 EAPI Evas_Object *elm_navigationbar_ex_item_title_object_get(Elm_Navigationbar_ex_Item* item);
8957 EAPI const char *elm_navigationbar_ex_item_subtitle_label_get(Elm_Navigationbar_ex_Item* item);
8958 EAPI void elm_navigationbar_ex_item_subtitle_label_set( Elm_Navigationbar_ex_Item* item, const char *subtitle);
8959 EAPI void elm_navigationbar_ex_item_style_set(Elm_Navigationbar_ex_Item* item, const char* item_style);
8960 EAPI const char *elm_navigationbar_ex_item_style_get(Elm_Navigationbar_ex_Item* item);
8961 EAPI Evas_Object *elm_navigationbar_ex_item_content_unset(Elm_Navigationbar_ex_Item* item);
8962 EAPI Evas_Object *elm_navigationbar_ex_item_content_get(Elm_Navigationbar_ex_Item* item);
8963 EAPI void elm_navigationbar_ex_delete_on_pop_set(Evas_Object *obj, Eina_Bool del_on_pop);
8964 EAPI Evas_Object *elm_navigationbar_ex_item_icon_get(Elm_Navigationbar_ex_Item* item);
8965 EAPI void elm_navigationbar_ex_item_icon_set(Elm_Navigationbar_ex_Item* item, Evas_Object *icon);
8966 EAPI Evas_Object *elm_navigationbar_ex_item_title_button_unset(Elm_Navigationbar_ex_Item* item, int button_type);
8967 EAPI void elm_navigationbar_ex_animation_disable_set(Evas_Object *obj, Eina_Bool disable);
8968 EAPI void elm_navigationbar_ex_title_object_visible_set(Elm_Navigationbar_ex_Item* item, Eina_Bool visible);
8969 Eina_Bool elm_navigationbar_ex_title_object_visible_get(Elm_Navigationbar_ex_Item* item);
8972 #define ELM_NAVIFRAME_ITEM_CONTENT "elm.swallow.content"
8973 #define ELM_NAVIFRAME_ITEM_ICON "elm.swallow.icon"
8974 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER "elm.swallow.optionheader"
8975 #define ELM_NAVIFRAME_ITEM_OPTIONHEADER2 "elm.swallow.optionheader2"
8976 #define ELM_NAVIFRAME_ITEM_TITLE_LABEL "elm.text.title"
8977 #define ELM_NAVIFRAME_ITEM_PREV_BTN "elm.swallow.prev_btn"
8978 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_CLOSE "elm,state,optionheader,close", ""
8979 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_OPEN "elm,state,optionheader,open", ""
8980 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_CLOSE "elm,state,optionheader,instant_close", ""
8981 #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_OPEN "elm,state,optionheader,instant_open", ""
8984 * @defgroup Naviframe Naviframe
8986 * @brief Naviframe is a kind of view manager for the applications.
8988 * Naviframe provides functions to switch different pages with stack
8989 * mechanism. It means if one page(item) needs to be changed to the new one,
8990 * then naviframe would push the new page to it's internal stack. Of course,
8991 * it can be back to the previous page by popping the top page. Naviframe
8992 * provides some transition effect while the pages are switching (same as
8995 * Since each item could keep the different styles, users could keep the
8996 * same look & feel for the pages or different styles for the items in it's
8999 * Signals that you can add callback for are:
9001 * @li "transition,finished" - When the transition is finished in changing
9003 * @li "title,clicked" - User clicked title area
9005 * Default contents parts for the naviframe items that you can use for are:
9007 * @li "elm.swallow.content" - The main content of the page
9008 * @li "elm.swallow.prev_btn" - The button to go to the previous page
9009 * @li "elm.swallow.next_btn" - The button to go to the next page
9011 * Default text parts of naviframe items that you can be used are:
9013 * @li "elm.text.title" - The title label in the title area
9015 * @ref tutorial_naviframe gives a good overview of the usage of the API.
9019 * @brief Add a new Naviframe object to the parent.
9021 * @param parent Parent object
9022 * @return New object or @c NULL, if it cannot be created
9024 EAPI Evas_Object *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9026 * @brief Push a new item to the top of the naviframe stack (and show it).
9028 * @param obj The naviframe object
9029 * @param title_label The label in the title area. The name of the title
9030 * label part is "elm.text.title"
9031 * @param prev_btn The button to go to the previous item. If it is NULL,
9032 * then naviframe will create a back button automatically. The name of
9033 * the prev_btn part is "elm.swallow.prev_btn"
9034 * @param next_btn The button to go to the next item. Or It could be just an
9035 * extra function button. The name of the next_btn part is
9036 * "elm.swallow.next_btn"
9037 * @param content The main content object. The name of content part is
9038 * "elm.swallow.content"
9039 * @param item_style The current item style name. @c NULL would be default.
9040 * @return The created item or @c NULL upon failure.
9042 * The item pushed becomes one page of the naviframe, this item will be
9043 * deleted when it is popped.
9045 * @see also elm_naviframe_item_style_set()
9047 * The following styles are available for this item:
9050 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);
9052 * @brief Pop an item that is on top of the stack
9054 * @param obj The naviframe object
9055 * @return @c NULL or the content object(if the
9056 * elm_naviframe_content_preserve_on_pop_get is true).
9058 * This pops an item that is on the top(visible) of the naviframe, makes it
9059 * disappear, then deletes the item. The item that was underneath it on the
9060 * stack will become visible.
9062 * @see also elm_naviframe_content_preserve_on_pop_get()
9064 EAPI Evas_Object *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
9066 * @brief Pop the items between the top and the above one on the given item.
9068 * @param it The naviframe item
9070 EAPI void elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
9072 * Promote an item already in the naviframe stack to the top of the stack
9074 * @param it The naviframe item
9076 * This will take the indicated item and promote it to the top of the stack
9077 * as if it had been pushed there. The item must already be inside the
9078 * naviframe stack to work.
9081 EAPI void elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
9083 * @brief Delete the given item instantly.
9085 * @param it The naviframe item
9087 * This just deletes the given item from the naviframe item list instantly.
9088 * So this would not emit any signals for view transitions but just change
9089 * the current view if the given item is a top one.
9092 EAPI void elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
9094 * @brief preserve the content objects when items are popped.
9096 * @param obj The naviframe object
9097 * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
9099 * @see also elm_naviframe_content_preserve_on_pop_get()
9101 EAPI void elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
9103 * @brief Get a value whether preserve mode is enabled or not.
9105 * @param obj The naviframe object
9106 * @return If @c EINA_TRUE, preserve mode is enabled
9108 * @see also elm_naviframe_content_preserve_on_pop_set()
9110 EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9112 * @brief Get a top item on the naviframe stack
9114 * @param obj The naviframe object
9115 * @return The top item on the naviframe stack or @c NULL, if the stack is
9118 EAPI Elm_Object_Item *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9120 * @brief Get a bottom item on the naviframe stack
9122 * @param obj The naviframe object
9123 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
9126 EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9128 * @brief Set an item style
9130 * @param obj The naviframe item
9131 * @param item_style The current item style name. @c NULL would be default
9133 * The following styles are available for this item:
9136 * @see also elm_naviframe_item_style_get()
9138 EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
9140 * @brief Get an item style
9142 * @param obj The naviframe item
9143 * @return The current item style name
9145 * @see also elm_naviframe_item_style_set()
9147 EAPI const char *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
9149 * @brief Show/Hide the title area
9151 * @param it The naviframe item
9152 * @param visible If @c EINA_TRUE, title area will be visible, hidden
9155 * When the title area is invisible, then the controls would be hidden so as * to expand the content area to full-size.
9157 * @see also elm_naviframe_item_title_visible_get()
9159 EAPI void elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
9161 * @brief Get a value whether title area is visible or not.
9163 * @param it The naviframe item
9164 * @return If @c EINA_TRUE, title area is visible
9166 * @see also elm_naviframe_item_title_visible_set()
9168 EAPI Eina_Bool elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
9170 * @brief Set creating prev button automatically or not
9172 * @param obj The naviframe object
9173 * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
9174 * be created internally when you pass the @c NULL to the prev_btn
9175 * parameter in elm_naviframe_item_push
9177 * @see also elm_naviframe_item_push()
9179 EAPI void elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
9181 * @brief Get a value whether prev button(back button) will be auto pushed or
9184 * @param obj The naviframe object
9185 * @return If @c EINA_TRUE, prev button will be auto pushed.
9187 * @see also elm_naviframe_item_push()
9188 * elm_naviframe_prev_btn_auto_pushed_set()
9190 EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
9193 #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
9194 #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
9195 #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
9196 #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
9197 #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
9198 #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
9199 #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
9200 #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
9201 #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
9203 typedef enum _Elm_Controlbar_Mode_Type
9205 ELM_CONTROLBAR_MODE_DEFAULT = 0,
9206 ELM_CONTROLBAR_MODE_TRANSLUCENCE,
9207 ELM_CONTROLBAR_MODE_TRANSPARENCY,
9208 ELM_CONTROLBAR_MODE_LARGE,
9209 ELM_CONTROLBAR_MODE_SMALL,
9210 ELM_CONTROLBAR_MODE_LEFT,
9211 ELM_CONTROLBAR_MODE_RIGHT
9212 } Elm_Controlbar_Mode_Type;
9214 typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
9215 EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
9216 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
9217 EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
9218 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);
9219 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);
9220 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);
9221 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);
9222 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);
9223 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);
9224 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
9225 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
9226 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
9227 EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
9228 EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
9229 EAPI void elm_controlbar_item_del(Elm_Controlbar_Item *it);
9230 EAPI void elm_controlbar_item_select(Elm_Controlbar_Item *it);
9231 EAPI void elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
9232 EAPI Eina_Bool elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
9233 EAPI void elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
9234 EAPI Eina_Bool elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
9235 EAPI void elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
9236 EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
9237 EAPI void elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
9238 EAPI const char *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
9239 EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
9240 EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
9241 EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
9242 EAPI const Eina_List *elm_controlbar_items_get(const Evas_Object *obj);
9243 EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
9244 EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
9245 EAPI void elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
9246 EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
9247 EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
9248 EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
9249 EAPI void elm_controlbar_mode_set(Evas_Object *obj, int mode);
9250 EAPI void elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
9251 EAPI void elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
9252 EAPI void elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
9255 EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
9256 EAPI void elm_searchbar_text_set(Evas_Object *obj, const char *entry);
9257 EAPI const char *elm_searchbar_text_get(Evas_Object *obj);
9258 EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
9259 EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
9260 EAPI void elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
9261 EAPI void elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
9262 EAPI void elm_searchbar_clear(Evas_Object *obj);
9263 EAPI void elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
9265 EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
9266 EAPI void elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
9267 EAPI void elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
9268 EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
9271 EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
9272 EAPI void elm_nocontents_label_set(Evas_Object *obj, const char *label);
9273 EAPI const char *elm_nocontents_label_get(const Evas_Object *obj);
9274 EAPI void elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
9275 EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
9280 ELM_TICKERNOTI_ORIENT_TOP = 0,
9281 ELM_TICKERNOTI_ORIENT_BOTTOM,
9282 ELM_TICKERNOTI_ORIENT_LAST
9283 } Elm_Tickernoti_Orient;
9285 EAPI Evas_Object *elm_tickernoti_add (Evas_Object *parent);
9286 EAPI void elm_tickernoti_orient_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
9287 EAPI Elm_Tickernoti_Orient elm_tickernoti_orient_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
9288 EAPI int elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
9289 EAPI void elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
9290 EAPI Evas_Object *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
9291 /* #### Below APIs and data structures are going to be deprecated, announcment will be made soon ####*/
9294 ELM_TICKERNOTI_DEFAULT,
9295 ELM_TICKERNOTI_DETAILVIEW
9296 } Elm_Tickernoti_Mode;
9297 EAPI void elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
9298 EAPI const char *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
9299 EAPI void elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
9300 EAPI Evas_Object *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
9301 EAPI void elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
9302 EAPI Evas_Object *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
9303 EAPI Evas_Object *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
9304 EAPI void elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
9305 EAPI Elm_Tickernoti_Mode elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
9306 EAPI void elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
9307 EAPI Elm_Tickernoti_Orient elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
9308 EAPI void elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
9309 EAPI const char *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
9310 EAPI void elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
9311 EAPI Evas_Object *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
9312 EAPI void elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
9313 EAPI Evas_Object *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
9314 /* ############################################################################### */
9316 * Parts which can be used with elm_object_text_part_set() and
9317 * elm_object_text_part_get():
9319 * @li NULL/"default" - Operates on tickernoti content-text
9321 * Parts which can be used with elm_object_content_part_set() and
9322 * elm_object_content_part_get():
9324 * @li "icon" - Operates on tickernoti's icon
9325 * @li "button" - Operates on tickernoti's button
9327 * smart callbacks called:
9328 * @li "clicked" - emitted when tickernoti is clicked, except at the
9329 * swallow/button region, if any.
9330 * @li "hide" - emitted when the tickernoti is completely hidden. In case of
9331 * any hide animation, this signal is emitted after the animation.
9335 typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
9337 struct _Colorpalette_Color
9339 unsigned int r, g, b;
9342 EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
9343 EAPI void elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
9344 EAPI void elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
9345 /* smart callbacks called:
9346 * "clicked" - when image clicked
9350 EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
9351 EAPI void elm_editfield_label_set(Evas_Object *obj, const char *label);
9352 EAPI const char *elm_editfield_label_get(Evas_Object *obj);
9353 EAPI void elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
9354 EAPI const char *elm_editfield_guide_text_get(Evas_Object *obj);
9355 EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
9356 // EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
9357 EAPI void elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
9358 EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
9359 EAPI void elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
9360 EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
9361 EAPI void elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
9362 EAPI Eina_Bool elm_editfield_entry_single_line_get(Evas_Object *obj);
9363 EAPI void elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
9364 EAPI Eina_Bool elm_editfield_eraser_get(Evas_Object *obj);
9365 /* smart callbacks called:
9366 * "clicked" - when an editfield is clicked
9367 * "unfocused" - when an editfield is unfocused
9371 /* Sliding Drawer */
9372 typedef enum _Elm_SlidingDrawer_Pos
9374 ELM_SLIDINGDRAWER_BOTTOM,
9375 ELM_SLIDINGDRAWER_LEFT,
9376 ELM_SLIDINGDRAWER_RIGHT,
9377 ELM_SLIDINGDRAWER_TOP
9378 } Elm_SlidingDrawer_Pos;
9380 typedef struct _Elm_SlidingDrawer_Drag_Value
9383 } Elm_SlidingDrawer_Drag_Value;
9385 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_add(Evas_Object *parent);
9386 EINA_DEPRECATED EAPI void elm_slidingdrawer_content_set (Evas_Object *obj, Evas_Object *content);
9387 EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_content_unset(Evas_Object *obj);
9388 EINA_DEPRECATED EAPI void elm_slidingdrawer_pos_set(Evas_Object *obj, Elm_SlidingDrawer_Pos pos);
9389 EINA_DEPRECATED EAPI void elm_slidingdrawer_max_drag_value_set(Evas_Object *obj, double dw, double dh);
9390 EINA_DEPRECATED EAPI void elm_slidingdrawer_drag_value_set(Evas_Object *obj, double dx, double dy);
9392 /* multibuttonentry */
9393 typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
9394 typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
9395 EAPI Evas_Object *elm_multibuttonentry_add(Evas_Object *parent);
9396 EAPI const char *elm_multibuttonentry_label_get(Evas_Object *obj);
9397 EAPI void elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
9398 EAPI Evas_Object *elm_multibuttonentry_entry_get(Evas_Object *obj);
9399 EAPI const char * elm_multibuttonentry_guide_text_get(Evas_Object *obj);
9400 EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
9401 EAPI int elm_multibuttonentry_contracted_state_get(Evas_Object *obj);
9402 EAPI void elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
9403 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
9404 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
9405 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
9406 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
9407 EAPI const Eina_List *elm_multibuttonentry_items_get(Evas_Object *obj);
9408 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(Evas_Object *obj);
9409 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(Evas_Object *obj);
9410 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(Evas_Object *obj);
9411 EAPI void elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
9412 EAPI void elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
9413 EAPI void elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
9414 EAPI void elm_multibuttonentry_items_del(Evas_Object *obj);
9415 EAPI const char *elm_multibuttonentry_item_label_get(Elm_Multibuttonentry_Item *item);
9416 EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
9417 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
9418 EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
9419 EAPI void *elm_multibuttonentry_item_data_get(Elm_Multibuttonentry_Item *item);
9420 EAPI void elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
9421 EAPI void elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
9422 /* smart callback called:
9423 * "selected" - This signal is emitted when the selected item of multibuttonentry is changed.
9424 * "added" - This signal is emitted when a new multibuttonentry item is added.
9425 * "deleted" - This signal is emitted when a multibuttonentry item is deleted.
9426 * "expanded" - This signal is emitted when a multibuttonentry is expanded.
9427 * "contracted" - This signal is emitted when a multibuttonentry is contracted.
9428 * "contracted,state,changed" - This signal is emitted when the contracted state of multibuttonentry is changed.
9429 * "item,selected" - This signal is emitted when the selected item of multibuttonentry is changed.
9430 * "item,added" - This signal is emitted when a new multibuttonentry item is added.
9431 * "item,deleted" - This signal is emitted when a multibuttonentry item is deleted.
9432 * "item,clicked" - This signal is emitted when a multibuttonentry item is clicked.
9433 * "clicked" - This signal is emitted when a multibuttonentry is clicked.
9434 * "unfocused" - This signal is emitted when a multibuttonentry is unfocused.
9436 /* available styles:
9441 typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
9442 EAPI Evas_Object *elm_stackedicon_add(Evas_Object *parent);
9443 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
9444 EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
9445 EAPI void elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
9446 EAPI Eina_List *elm_stackedicon_item_list_get(Evas_Object *obj);
9447 /* smart callback called:
9448 * "expanded" - This signal is emitted when a stackedicon is expanded.
9449 * "clicked" - This signal is emitted when a stackedicon is clicked.
9451 /* available styles:
9456 typedef struct _Dialogue_Item Dialogue_Item;
9458 typedef enum _Elm_Dialoguegourp_Item_Style
9460 ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
9461 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
9462 ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
9463 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
9464 ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
9465 ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
9466 ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
9467 ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
9468 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
9469 ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
9470 ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
9471 } Elm_Dialoguegroup_Item_Style;
9473 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_add(Evas_Object *parent);
9474 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
9475 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
9476 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
9477 EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
9478 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove(Dialogue_Item *item);
9479 EINA_DEPRECATED EAPI void elm_dialoguegroup_remove_all(Evas_Object *obj);
9480 EINA_DEPRECATED EAPI void elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
9481 EINA_DEPRECATED EAPI const char *elm_dialoguegroup_title_get(Evas_Object *obj);
9482 EINA_DEPRECATED EAPI void elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
9483 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
9484 EINA_DEPRECATED EAPI Evas_Object *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
9485 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
9486 EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style elm_dialoguegroup_item_style_get(Dialogue_Item *item);
9487 EINA_DEPRECATED EAPI void elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
9488 EINA_DEPRECATED EAPI Eina_Bool elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
9493 ELM_DAYSELECTOR_SUN,
9494 ELM_DAYSELECTOR_MON,
9495 ELM_DAYSELECTOR_TUE,
9496 ELM_DAYSELECTOR_WED,
9497 ELM_DAYSELECTOR_THU,
9498 ELM_DAYSELECTOR_FRI,
9500 } Elm_DaySelector_Day;
9502 EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
9503 EAPI Eina_Bool elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
9504 EAPI void elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
9507 typedef struct _Imageslider_Item Elm_Imageslider_Item;
9508 typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
9509 EAPI Evas_Object *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9510 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);
9511 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);
9512 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);
9513 EAPI void elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
9514 EAPI Elm_Imageslider_Item *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
9515 EAPI Eina_Bool elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
9516 EAPI void elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
9517 EAPI const char *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
9518 EAPI Elm_Imageslider_Item *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
9519 EAPI Elm_Imageslider_Item *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
9520 EAPI void elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
9521 EAPI void elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
9522 EAPI void elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
9523 EAPI void elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);